API reference
VoiceRequest Class
Abstract class for all voice requests
Others
TRequest
The type of request to be returned in event callbacks
TOptions
The type containing all specific options to be passed to the end service.
TEvents
The type containing all events of TSession to be called throughout the lifecycle of the request.
TResults
The type containing all data that can be returned from the end service.
Public Statics
static SimulatedResponse simulatedResponse[Get]
Properties
VoiceRequestState State[Get]
The states of a voice request
float DownloadProgress[Get]
Download progress of the current request transmission if available
float UploadProgress[Get]
Upload progress of the current request transmission if available
TOptions Options[Get]
Options sent as the request parameters
TEvents Events[Get]
Events specific to this voice request
TResults Results[Get]
Results returned from the request
Fields
bool IsActive[Get]
Active if not currently canceled, failed or successful
bool OnHold[Get]
Whether transmission should hold prior to send
bool CanSend[Get]
Whether request can currently transmit data
Member Functions
VoiceRequest
( TOptions newOptions,
TEvents newEvents )
Constructor class for voice requests
Parameters
newOptions
The request parameters to be used
newEvents
The request events to be called throughout it's lifecycle
void AddEventListeners
( TEvents newEvents )
Adds listeners for all events provided
void RemoveEventListeners
( TEvents newEvents )
Removes listeners for all events provided
virtual void Send ( )
Public request to transmit data
virtual void Cancel
( string reason )
Cancel the request immediately
Protected Functions
virtual TResults GetNewResults ( )
Method for generating results, can be overwritten for custom generation
abstract void SetEventListeners
( TEvents newEvents,
bool addListeners )
Subscribes or unsubscribes all provided events from this request's Events callbacks.
Parameters
newEvents
The events to subscribe or unsubscribe to the request.Events
addListeners
Whether to add listeners or remove listeners
abstract void RaiseEvent
( TUnityEvent requestEvent )
Raises a voice request event
Parameters
requestEvent
Event to be performed
virtual void OnInit ( )
Call after initialization
virtual void SetState
( VoiceRequestState newState )
Apply the voice request state
virtual void OnStateChange ( )
Method for calling state change delegates
virtual IEnumerator WaitForHold
( Action onReady )
virtual void OnCanSend ( )
void SetDownloadProgress
( float newProgress )
Set current request download progress
Parameters
newProgress
New progress value
void SetUploadProgress
( float newProgress )
Set current request upload progress
Parameters
newProgress
New progress value
void Log
( string log,
VLoggerVerbosity logLevel )
Internal method for
void LogW
( string log )
void LogE
( string log,
Exception e )
virtual void AppendLogData
( StringBuilder log,
VLoggerVerbosity logLevel )
Append request specific data to log
Parameters
log
Building log
warning
True if this is a warning log
virtual string GetSendError ( )
Internal way to determine send error
virtual void OnSend ( )
Call after transmission begins
abstract void HandleSend ( )
Child class send implementation Call HandleFailure, HandleCancel from this class
virtual bool OnSimulateResponse ( )
Returns
True if the response was simulated
virtual void HandleFailure
( string error )
Method for handling failure with only an error string
Parameters
error
The error to be returned
virtual void HandleFailure
( int errorStatusCode,
string errorMessage )
Method for handling failure that takes an error status code or an error itself
Parameters
errorStatusCode
The error status code if applicable
errorMessage
The error to be returned
virtual bool ShouldIgnoreError
( int errorStatusCode,
string errorMessage )
Check for ignored error status codes & messages.
Parameters
errorStatusCode
The error status code if applicable
errorMessage
The error to be returned
virtual void OnFailed ( )
Call after failure state set
virtual void HandleSuccess ( )
Method for handling success with a full result object
Parameters
error
The error to be returned
virtual void OnSuccess ( )
Call after success state set
abstract void HandleCancel ( )
Handle cancelation in subclass
virtual void OnCancel ( )
Call after cancellation state set
virtual void OnComplete ( )
Call after failure, success or cancellation
void MainThreadCallback
( Action action )
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