API reference
IWitWebSocketRequest Interface
An interface used to handle web socket upload and download communication.
Properties
string RequestId[Get]
The unique request identifier
string ClientUserId[Get]
The client user identifier that is making the request
string TopicId[Get]
The specific topic id that is being published to or received via subscription, if applicable.
PubSubResponseOptions PublishOptions[Get]
The specific publish options for pubsub
int TimeoutMs[Get]
The request timeout in milliseconds
bool IsUploading[Get]
Whether currently uploading data
bool IsDownloading[Get]
Whether currently downloading data
bool IsComplete[Get]
Whether request is currently complete
TaskCompletionSource< bool > Completion[Get]
A task that is used to track completion of this request
string Code[Get]
The response code if applicable
string Error[Get]
Error that occured during upload and/or download
Action< string > OnRawResponse[Get]
Callback method when raw json response is received
Action< IWitWebSocketRequest > OnFirstResponse[Get]
Callback method the request should perform on first download
Action< IWitWebSocketRequest > OnComplete[Get]
Callback method the request should perform once completed
Member Functions
void HandleUpload
( UploadChunkDelegate uploadChunk )
Called once from the main thread to begin the upload process.
Parameters
uploadChunk
The method to be called as each json and/or binary chunk is ready to be uploaded
void HandleDownload
( string jsonString,
WitResponseNode jsonData,
byte [] binaryData )
Called one or more times from the background thread when a chunk has returned
Parameters
jsonString
Raw json string.
jsonData
Decoded json data object.
binaryData
Decoded binary data chunk which may be null or empty.
void Cancel ( )
Method that can be used to perform a cancellation on a request
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta