API reference

WitVRequest Class

Constructors

WitVRequest ( configuration , requestId , useServerToken , onDownloadProgress , onFirstResponse )
Constructor that takes in a configuration interface
Signature
Meta.WitAi.Requests.WitVRequest.WitVRequest(IWitRequestConfiguration configuration, string requestId, bool useServerToken=false, RequestProgressDelegate onDownloadProgress=null, RequestFirstResponseDelegate onFirstResponse=null)
Parameters
configuration: IWitRequestConfiguration  The configuration interface to be used
requestId: string  A unique identifier that can be used to track the request
useServerToken: bool  Editor only option to use server token instead of client token
onDownloadProgress: RequestProgressDelegate  The callback for progress related to downloading
onFirstResponse: RequestFirstResponseDelegate  The callback for the first response of data from a request

Static Fields

OnProvideCustomHeaders : Action< Dictionary< string, string > >
Header customization delegate
Signature
Action<Dictionary<string, string> > Meta.WitAi.Requests.WitVRequest.OnProvideCustomHeaders
OnProvideCustomUri : Func< UriBuilder, UriBuilder >
Uri customization delegate
Signature
Func<UriBuilder, UriBuilder> Meta.WitAi.Requests.WitVRequest.OnProvideCustomUri
OnProvideCustomUserAgent : Action< StringBuilder >
User agent customization delegate
Signature
Action<StringBuilder> Meta.WitAi.Requests.WitVRequest.OnProvideCustomUserAgent

Properties

Configuration : IWitRequestConfiguration
[Get]
The configuration used for voice requests
Signature
IWitRequestConfiguration Meta.WitAi.Requests.WitVRequest.Configuration
RequestId : string
[Get]
The unique identifier used by Wit to track requests
Signature
string Meta.WitAi.Requests.WitVRequest.RequestId

Protected Methods

GetHeaders ()
Signature
override Dictionary<string, string> Meta.WitAi.Requests.WitVRequest.GetHeaders()
Returns
override Dictionary< string, string >

Methods

GetUri ( path , queryParams )
Signature
Uri Meta.WitAi.Requests.WitVRequest.GetUri(string path, Dictionary< string, string > queryParams=null)
Parameters
path: string
queryParams: Dictionary< string, string >
Returns
Uri
Request ( unityRequest , onComplete )
Perform a unity request with coroutines
Signature
override bool Meta.WitAi.Requests.WitVRequest.Request(UnityWebRequest unityRequest, RequestCompleteDelegate< UnityWebRequest > onComplete)
Parameters
unityRequest: UnityWebRequest  The request to be managed
onComplete: RequestCompleteDelegate< UnityWebRequest >  The callback delegate on request completion
Returns
override bool  False if the request cannot be performed
RequestAsync< TData > ( unityRequest , onDecode )
Initialize with a request & return an error if applicable
Signature
override async Task<RequestCompleteResponse<TData> > Meta.WitAi.Requests.WitVRequest.RequestAsync< TData >(UnityWebRequest unityRequest, Func< UnityWebRequest, TData > onDecode)
Parameters
unityRequest: UnityWebRequest  The unity request to be performed
onDecode: Func< UnityWebRequest, TData >
Returns
override async Task< RequestCompleteResponse< TData > >  Any errors encountered during the request
RequestWitGet< TData > ( uriEndpoint , uriParams , onComplete , onPartial )
Get request to a wit endpoint
Signature
bool Meta.WitAi.Requests.WitVRequest.RequestWitGet< TData >(string uriEndpoint, Dictionary< string, string > uriParams, RequestCompleteDelegate< TData > onComplete, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >  Endpoint url parameters
onComplete: RequestCompleteDelegate< TData >  The callback delegate on request completion
onPartial: RequestCompleteDelegate< TData >
Returns
bool  False if the request cannot be performed
RequestWitGetAsync< TData > ( uriEndpoint , uriParams , onPartial )
Get request to a wit endpoint asynchronously
Signature
async Task<RequestCompleteResponse<TData> > Meta.WitAi.Requests.WitVRequest.RequestWitGetAsync< TData >(string uriEndpoint, Dictionary< string, string > uriParams=null, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >
onPartial: RequestCompleteDelegate< TData >
Returns
async Task< RequestCompleteResponse< TData > >  Returns the request complete data including a parsed result if possible
RequestWitPost< TData > ( uriEndpoint , uriParams , postText , onComplete , onPartial )
Post text request to a wit endpoint
Signature
bool Meta.WitAi.Requests.WitVRequest.RequestWitPost< TData >(string uriEndpoint, Dictionary< string, string > uriParams, string postText, RequestCompleteDelegate< TData > onComplete, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >  Endpoint url parameters
postText: string  Text to be sent to endpoint
onComplete: RequestCompleteDelegate< TData >  The callback delegate on request completion
onPartial: RequestCompleteDelegate< TData >  The callback delegate when a partial response is received
Returns
bool  False if the request cannot be performed
RequestWitPostAsync< TData > ( uriEndpoint , uriParams , postText , onPartial )
Post request to a wit endpoint asynchronously
Signature
async Task<RequestCompleteResponse<TData> > Meta.WitAi.Requests.WitVRequest.RequestWitPostAsync< TData >(string uriEndpoint, Dictionary< string, string > uriParams, string postText, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >  Endpoint url parameters
postText: string  Text to be sent to endpoint
onPartial: RequestCompleteDelegate< TData >
Returns
async Task< RequestCompleteResponse< TData > >  Returns the request complete data including a parsed result if possible
RequestWitPut< TData > ( uriEndpoint , uriParams , putText , onComplete , onPartial )
Put text request to a wit endpoint
Signature
bool Meta.WitAi.Requests.WitVRequest.RequestWitPut< TData >(string uriEndpoint, Dictionary< string, string > uriParams, string putText, RequestCompleteDelegate< TData > onComplete, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >  Endpoint url parameters
putText: string  Text to be sent to endpoint
onComplete: RequestCompleteDelegate< TData >  The delegate upon completion
onPartial: RequestCompleteDelegate< TData >  The callback delegate when a partial response is received
Returns
bool  False if the request cannot be performed
RequestWitPutAsync< TData > ( uriEndpoint , uriParams , putText , onPartial )
Put text request to a wit endpoint asynchronously
Signature
async Task<RequestCompleteResponse<TData> > Meta.WitAi.Requests.WitVRequest.RequestWitPutAsync< TData >(string uriEndpoint, Dictionary< string, string > uriParams, string putText, RequestCompleteDelegate< TData > onPartial=null)
Parameters
uriEndpoint: string  Endpoint name
uriParams: Dictionary< string, string >  Endpoint url parameters
putText: string  Text to be sent to endpoint
onPartial: RequestCompleteDelegate< TData >
Returns
async Task< RequestCompleteResponse< TData > >  Returns the request complete data including a parsed result if possible