VoiceRequest Class

Implements Lib.Wit.Runtime.Utilities.Logging.ILogSource

Abstract class for all voice requests

Constructors

VoiceRequest ( newOptions , newEvents )

Constructor class for voice requests

Signature

Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.VoiceRequest(TOptions newOptions, TEvents newEvents)

Parameters

newOptions: TOptions The request parameters to be used

newEvents: TEvents The request events to be called throughout it's lifecycle

Fields

CanSend : bool	Whether request can currently transmit data Signature bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.CanSend
IsActive : bool	Active if not currently canceled, failed or successful Signature bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.IsActive

Static Fields

simulatedResponse : SimulatedResponse

Signature

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

Properties

Completion : TaskCompletionSource< bool > [Get]	The completion source for the voice request Signature TaskCompletionSource<bool> Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Completion
DownloadProgress : float [Get]	Download progress of the current request transmission if available Signature float Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.DownloadProgress
Events : TEvents [Get]	Events specific to this voice request Signature TEvents Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Events
HoldTask : Task [Get][Set]	Whether transmission should hold prior to send Signature Task Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HoldTask
Logger : IVLogger [Get]	Signature virtual IVLogger Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Logger
Options : TOptions [Get]	Options sent as the request parameters Signature TOptions Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Options
Results : TResults [Get]	Results returned from the request Signature TResults Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Results
State : VoiceRequestState [Get]	The states of a voice request Signature VoiceRequestState Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.State
UploadProgress : float [Get]	Upload progress of the current request transmission if available Signature float Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.UploadProgress

Protected Methods

GetNewResults ()	Method for generating results, can be overwritten for custom generation Signature virtual TResults Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.GetNewResults() Returns `TResults`
GetSendError ()	Internal way to determine send error Signature virtual string Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.GetSendError() Returns `string`
HandleCancel ()	Handle cancelation in subclass Signature abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleCancel() Returns `abstract void`
HandleFailure ( error )	Method for handling failure with only an error string Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleFailure(string error) Parameters `error: string` The error to be returned Returns `void`
HandleFailure ( errorStatusCode , errorMessage )	Method for handling failure that takes an error status code or an error itself Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleFailure(int errorStatusCode, string errorMessage) Parameters `errorStatusCode: int` The error status code if applicable `errorMessage: string` The error to be returned Returns `void`
HandleSend ()	Child class send implementation Call HandleFailure, HandleCancel from this class Signature abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleSend() Returns `abstract void`
HandleSuccess ()	Method for handling success with a full result object Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HandleSuccess() Returns `void`
HoldSend ()	Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.HoldSend() Returns `void`
Log ( log , logLevel )	Internal method for Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Log(string log, VLoggerVerbosity logLevel=VLoggerVerbosity.Info) Parameters `log: string` `logLevel: VLoggerVerbosity` Returns `void`
LogE ( log , e )	Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.LogE(string log, Exception e) Parameters `log: string` `e: Exception` Returns `void`
LogW ( log )	Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.LogW(string log) Parameters `log: string` Returns `void`
MainThreadCallback ( action )	Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.MainThreadCallback(Action action) Parameters `action: Action` Returns `void`
OnCancel ()	Call after cancellation state set Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnCancel() Returns `void`
OnComplete ()	Call after failure, success or cancellation Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnComplete() Returns `void`
OnFailed ()	Call after failure state set Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnFailed() Returns `void`
OnInit ()	Call after initialization Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnInit() Returns `void`
OnSend ()	Call after transmission begins Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSend() Returns `void`
OnSimulateResponse ()	Determines if response is being simulated Signature virtual bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSimulateResponse() Returns `bool`
OnStateChange ()	Method for calling state change delegates Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnStateChange() Returns `void`
OnSuccess ()	Call after success state set Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.OnSuccess() Returns `void`
RaiseEvent ( requestEvent )	Raises a voice request event Signature abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.RaiseEvent(TUnityEvent requestEvent) Parameters `requestEvent: TUnityEvent` Event to be performed Returns `abstract void`
SetDownloadProgress ( newProgress )	Set current request download progress Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetDownloadProgress(float newProgress) Parameters `newProgress: float` New progress value Returns `void`
SetEventListeners ( newEvents , addListeners )	Subscribes or unsubscribes all provided events from this request's Events callbacks. Signature abstract void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetEventListeners(TEvents newEvents, bool addListeners) Parameters `newEvents: TEvents` The events to subscribe or unsubscribe to the request.Events `addListeners: bool` Whether to add listeners or remove listeners Returns `abstract void`
SetState ( newState )	Apply the voice request state Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetState(VoiceRequestState newState) Parameters `newState: VoiceRequestState` Returns `void`
SetUploadProgress ( newProgress )	Set current request upload progress Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.SetUploadProgress(float newProgress) Parameters `newProgress: float` New progress value Returns `void`
ShouldIgnoreError ( errorStatusCode , errorMessage )	Check for ignored error status codes & messages. Signature virtual bool Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.ShouldIgnoreError(int errorStatusCode, string errorMessage) Parameters `errorStatusCode: int` The error status code if applicable `errorMessage: string` The error to be returned Returns `bool`
WaitForHold ( onReady )	Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.WaitForHold(Action onReady) Parameters `onReady: Action` Returns `void`

Methods

AddEventListeners ( newEvents )	Adds listeners for all events provided Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.AddEventListeners(TEvents newEvents) Parameters `newEvents: TEvents` Returns `void`
Cancel ( reason )	Cancel the request immediately Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Cancel(string reason=WitConstants.CANCEL_MESSAGE_DEFAULT) Parameters `reason: string` Returns `void`
RemoveEventListeners ( newEvents )	Removes listeners for all events provided Signature void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.RemoveEventListeners(TEvents newEvents) Parameters `newEvents: TEvents` Returns `void`
Send ()	Public request to transmit data Signature virtual void Meta.Voice.VoiceRequest< TUnityEvent, TOptions, TEvents, TResults >.Send() Returns `void`