Meta Developers

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

Data 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

Public Member Functions

	VoiceRequest ( TOptions newOptions, TEvents newEvents ) Constructor class for voice requests
void	AddEventListeners ( TEvents newEvents ) Adds listeners for all events provided
void	RemoveEventListeners ( TEvents newEvents ) Removes listeners for all events provided
void	Send ( ) Public request to transmit data
void	Cancel ( string reason ) Cancel the request immediately

Object Data

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.
abstract void	RaiseEvent ( TUnityEvent requestEvent ) Raises a voice request event
void	OnInit ( ) Call after initialization
void	SetState ( VoiceRequestState newState ) Apply the voice request state
void	OnStateChange ( ) Method for calling state change delegates
IEnumerator	WaitForHold ( Action onReady )
void	OnCanSend ( )
void	SetDownloadProgress ( float newProgress ) Set current request download progress
void	SetUploadProgress ( float newProgress ) Set current request upload progress
void	Log ( string log, VLogLevel logLevel ) Internal method for
void	LogW ( string log )
void	LogE ( string log, Exception e )
void	AppendLogData ( StringBuilder log, VLogLevel logLevel ) Append request specific data to log
string	GetSendError ( ) Internal way to determine send error
void	OnSend ( ) Call after transmission begins
abstract void	HandleSend ( ) Child class send implementation Call HandleFailure, HandleCancel from this class
bool	OnSimulateResponse ( )
void	HandleFailure ( string error ) Method for handling failure with only an error string
void	HandleFailure ( int errorStatusCode, string errorMessage ) Method for handling failure that takes an error status code or an error itself
bool	ShouldIgnoreError ( int errorStatusCode, string errorMessage ) Check for ignored error status codes & messages.
void	OnFailed ( ) Call after failure state set
void	HandleSuccess ( ) Method for handling success with a full result object
void	OnSuccess ( ) Call after success state set
abstract void	HandleCancel ( ) Handle cancelation in subclass
void	OnCancel ( ) Call after cancellation state set
void	OnComplete ( ) Call after failure, success or cancellation
void	MainThreadCallback ( Action action )

Details

Detailed Description

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

SimulatedResponse Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.simulatedResponse
No description available.

Properties

VoiceRequestState Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.State
The states of a voice request

float Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.DownloadProgress
Download progress of the current request transmission if available

float Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.UploadProgress
Upload progress of the current request transmission if available

TOptions Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Options
Options sent as the request parameters

TEvents Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Events
Events specific to this voice request

TResults Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Results
Results returned from the request

Fields

bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.IsActive
Active if not currently canceled, failed or successful

bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnHold
Whether transmission should hold prior to send

bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.CanSend
Whether request can currently transmit data

Member Functions

Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.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 Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.AddEventListeners ( TEvents newEvents )
Adds listeners for all events provided

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.RemoveEventListeners ( TEvents newEvents )
Removes listeners for all events provided

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Send ( )
Public request to transmit data

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Cancel ( string reason )
Cancel the request immediately

Object Data

virtual TResults Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.GetNewResults ( )
Method for generating results, can be overwritten for custom generation

abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.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 Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.RaiseEvent ( TUnityEvent requestEvent )
Raises a voice request event Parameters requestEvent Event to be performed

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnInit ( )
Call after initialization

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetState ( VoiceRequestState newState )
Apply the voice request state

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStateChange ( )
Method for calling state change delegates

virtual IEnumerator Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.WaitForHold ( Action onReady )
No description available.

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnCanSend ( )
No description available.

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetDownloadProgress ( float newProgress )
Set current request download progress Parameters newProgress New progress value

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetUploadProgress ( float newProgress )
Set current request upload progress Parameters newProgress New progress value

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Log ( string log, VLogLevel logLevel )
Internal method for

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.LogW ( string log )
No description available.

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.LogE ( string log, Exception e )
No description available.

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.AppendLogData ( StringBuilder log, VLogLevel logLevel )
Append request specific data to log Parameters log Building log warning True if this is a warning log

virtual string Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.GetSendError ( )
Internal way to determine send error

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSend ( )
Call after transmission begins

abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleSend ( )
Child class send implementation Call HandleFailure, HandleCancel from this class

virtual bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSimulateResponse ( )
Returns True if the response was simulated

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleFailure ( string error )
Method for handling failure with only an error string Parameters error The error to be returned

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.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 Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.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 Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnFailed ( )
Call after failure state set

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleSuccess ( )
Method for handling success with a full result object Parameters error The error to be returned

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSuccess ( )
Call after success state set

abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleCancel ( )
Handle cancelation in subclass

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnCancel ( )
Call after cancellation state set

virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnComplete ( )
Call after failure, success or cancellation

void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.MainThreadCallback ( Action action )
No description available.

Did you find this page helpful?