API reference

TextStreamHandler Class

Extends DownloadHandlerScript, Meta.WitAi.Requests.IVRequestDownloadDecoder
A download handler for UnityWebRequest that decodes text data as it is received and returns it via a partial response delegate.

Constructors

TextStreamHandler ( partialResponseDelegate , partialDelimiter , finalDelimiter )
Signature
Meta.WitAi.Requests.TextStreamHandler.TextStreamHandler(TextStreamResponseDelegate partialResponseDelegate, string partialDelimiter=DEFAULT_PARTIAL_DELIMITER, string finalDelimiter=DEFAULT_FINAL_DELIMITER)
Parameters
partialResponseDelegate: TextStreamResponseDelegate
partialDelimiter: string
finalDelimiter: string

Fields

DEFAULT_FINAL_DELIMITER : const string
The default final delimiter
Signature
const string Meta.WitAi.Requests.TextStreamHandler.DEFAULT_FINAL_DELIMITER
DEFAULT_PARTIAL_DELIMITER : const string
The default partial delimiter
Signature
const string Meta.WitAi.Requests.TextStreamHandler.DEFAULT_PARTIAL_DELIMITER

Properties

Completion : TaskCompletionSource< bool >
[Get]
Completion source task
Signature
TaskCompletionSource<bool> Meta.WitAi.Requests.TextStreamHandler.Completion
IsComplete : bool
[Get]
Whether or not complete
Signature
bool Meta.WitAi.Requests.TextStreamHandler.IsComplete
IsStarted : bool
[Get]
Whether data has arrived
Signature
bool Meta.WitAi.Requests.TextStreamHandler.IsStarted
Progress : float
[Get]
Current progress of the download
Signature
float Meta.WitAi.Requests.TextStreamHandler.Progress

Events

OnFirstResponse : VRequestResponseDelegate
Signature
VRequestResponseDelegate Meta.WitAi.Requests.TextStreamHandler.OnFirstResponse
OnProgress : VRequestProgressDelegate
Callback for download progress
Signature
VRequestProgressDelegate Meta.WitAi.Requests.TextStreamHandler.OnProgress
OnResponse : VRequestResponseDelegate
Signature
VRequestResponseDelegate Meta.WitAi.Requests.TextStreamHandler.OnResponse

Protected Methods

CompleteContent ()
Signature
override void Meta.WitAi.Requests.TextStreamHandler.CompleteContent()
Returns
override void
GetData ()
Signature
override byte [] Meta.WitAi.Requests.TextStreamHandler.GetData()
Returns
override byte []
GetProgress ()
Signature
override float Meta.WitAi.Requests.TextStreamHandler.GetProgress()
Returns
override float
GetText ()
Signature
override string Meta.WitAi.Requests.TextStreamHandler.GetText()
Returns
override string
HandlePartial ( newPartial )
Signature
virtual void Meta.WitAi.Requests.TextStreamHandler.HandlePartial(string newPartial)
Parameters
newPartial: string
Returns
void
ReceiveContentLengthHeader ( contentLength )
Signature
override void Meta.WitAi.Requests.TextStreamHandler.ReceiveContentLengthHeader(ulong contentLength)
Parameters
contentLength: ulong
Returns
override void
ReceiveData ( receiveData , dataLength )
Signature
override bool Meta.WitAi.Requests.TextStreamHandler.ReceiveData(byte[] receiveData, int dataLength)
Parameters
receiveData: byte []
dataLength: int
Returns
override bool

Methods

TextStreamResponseDelegate ( rawText )
The delegate for returning text from the text stream handler
Signature
delegate void Meta.WitAi.Requests.TextStreamHandler.TextStreamResponseDelegate(string rawText)
Parameters
rawText: string
Returns
delegate void

Static Methods

DecodeBytes ( receiveData , start , length )
Simple decode method from bytes to text
Signature
static string Meta.WitAi.Requests.TextStreamHandler.DecodeBytes(byte[] receiveData, int start, int length)
Parameters
receiveData: byte []  The data received
start: int  The array start index
length: int  The amount of bytes in the data to convert
Returns
string  Returns decoded text
GetDecodedLength ( totalBits )
Gets the length of the string that should be created with the total amount of bits
Signature
static int Meta.WitAi.Requests.TextStreamHandler.GetDecodedLength(ulong totalBits)
Parameters
totalBits: ulong  The total amount of bits
Returns
int  Returns string length of decoded bytes
SplitText ( source , delimiter )
Splits text with a string delimiter
Signature
static string [] Meta.WitAi.Requests.TextStreamHandler.SplitText(string source, string delimiter)
Parameters
source: string  Original source text
delimiter: string  Delimiter to be split on
Returns
string []  The source string split on the delimiter

Internal Methods

Complete ()
Signature
void Meta.WitAi.Requests.TextStreamHandler.Complete()
Returns
void
ReceiveData ( receiveData )
Signature
bool Meta.WitAi.Requests.TextStreamHandler.ReceiveData(byte[] receiveData)
Parameters
receiveData: byte []
Returns
bool