API reference

IWitWebSocketRequest Interface

An interface used to handle web socket upload and download communication.

Properties

Code : string
[Get]
The response code if applicable
Signature
string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Code
Completion : TaskCompletionSource< bool >
[Get]
A task that is used to track completion of this request
Signature
TaskCompletionSource<bool> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Completion
Error : string
[Get]
Error that occured during upload and/or download
Signature
string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Error
IsComplete : bool
[Get]
Whether request is currently complete
Signature
bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsComplete
IsDownloading : bool
[Get]
Whether currently downloading data
Signature
bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsDownloading
IsUploading : bool
[Get]
Whether currently uploading data
Signature
bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsUploading
OnComplete : Action< IWitWebSocketRequest >
[Get][Set]
Callback method the request should perform once completed
Signature
Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.OnComplete
OnFirstResponse : Action< IWitWebSocketRequest >
[Get][Set]
Callback method the request should perform on first download
Signature
Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.OnFirstResponse
OnRawResponse : Action< string >
[Get][Set]
Callback method when raw json response is received
Signature
Action<string> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.OnRawResponse
RequestId : string
[Get]
The priority of data submission
Signature
string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.RequestId
TimeoutMs : int
[Get][Set]
The request timeout in milliseconds
Signature
int Meta.Voice.Net.WebSockets.IWitWebSocketRequest.TimeoutMs
TopicId : string
[Get][Set]
The specific topic id that is being published to or received via subscription, if applicable.
Signature
string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.TopicId

Methods

Cancel ()
Method that can be used to perform a cancellation on a request
Signature
void Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Cancel()
Returns
void
HandleDownload ( jsonString , jsonData , binaryData )
Called one or more times from the background thread when a chunk has returned
Signature
void Meta.Voice.Net.WebSockets.IWitWebSocketRequest.HandleDownload(string jsonString, WitResponseNode jsonData, byte[] binaryData)
Parameters
jsonString: string  Raw json string.
jsonData: WitResponseNode  Decoded json data object.
binaryData: byte []  Decoded binary data chunk which may be null or empty.
Returns
void
HandleUpload ( uploadChunk )
Called once from the main thread to begin the upload process.
Signature
void Meta.Voice.Net.WebSockets.IWitWebSocketRequest.HandleUpload(UploadChunkDelegate uploadChunk)
Parameters
uploadChunk: UploadChunkDelegate  The method to be called as each json and/or binary chunk is ready to be uploaded
Returns
void