API reference
API reference
Select your platform
No SDKs available
No versions available
IWitWebSocketRequest Interface
An interface used to handle web socket upload and download communication.
Overview
Properties
string | RequestId[Get] The priority of data submission |
string | TopicId[Get] The specific topic id that is being published to or received via subscription, if applicable. |
bool | IsUploading[Get] Whether currently uploading data |
bool | IsDownloading[Get] Whether currently downloading data |
bool | IsComplete[Get] Whether request is currently complete |
string | Code[Get] The response code if applicable |
string | Error[Get] Error that occured during upload and/or download |
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 |
Public Member Functions
void | HandleUpload ( UploadChunkDelegate uploadChunk ) Called once from the main thread to begin the upload process. |
void | Called one or more times from the background thread when a chunk has returned |
void | Cancel ( ) Method that can be used to perform a cancellation on a request |
Details
Properties
| string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.RequestId |
|---|
The priority of data submission |
| string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.TopicId |
|---|
The specific topic id that is being published to or received via subscription, if applicable. |
| bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsUploading |
|---|
Whether currently uploading data |
| bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsDownloading |
|---|
Whether currently downloading data |
| bool Meta.Voice.Net.WebSockets.IWitWebSocketRequest.IsComplete |
|---|
Whether request is currently complete |
| string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Code |
|---|
The response code if applicable |
| string Meta.Voice.Net.WebSockets.IWitWebSocketRequest.Error |
|---|
Error that occured during upload and/or download |
| Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.OnFirstResponse |
|---|
Callback method the request should perform on first download |
| Action<IWitWebSocketRequest> Meta.Voice.Net.WebSockets.IWitWebSocketRequest.OnComplete |
|---|
Callback method the request should perform once completed |
Member Functions
| void Meta.Voice.Net.WebSockets.IWitWebSocketRequest.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 Meta.Voice.Net.WebSockets.IWitWebSocketRequest.HandleDownload ( WitResponseNode jsonData, byte [] binaryData ) |
|---|
Called one or more times from the background thread when a chunk has returned Parameters jsonData Decoded json data object. binaryDataDecoded binary data chunk which may be null or empty. |
| void Meta.Voice.Net.WebSockets.IWitWebSocketRequest.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