AT&T API Platform SDK for Microsoft®  2.3.2
Wrapper classes that allow developers to build robust applications using .NET
 All Classes Namespaces Functions Enumerations Enumerator Properties Groups Pages
ATT_MSSDK.Speechv3.TVXArgs Class Reference

This class contains the parameters specific to TV Context. More...

Public Member Functions

 TVXArgs ()
 Initializes a new instance of TVXArgs. More...
 
override string ToString ()
 Returns the string format of the properties. More...
 

Properties

bool Search [get, set]
 Gets or sets the value of Search. More...
 
string Lineup [get, set]
 Gets or sets the value of Lineup. The Lineup is a 5 digit code identifying one of 66 U-Verse market lineups. More...
 
string DeviceId [get, set]
 Gets or sets the value of DeviceId. The device identifier should be an anonymized hash string identifying the device with a high likelihood of uniqueness while not providing any identifiable string or algorithmic method of recovering the original unique device identifier (UDID). More...
 
int NumResults [get, set]
 Gets or sets the vlaue of NumResults. The size of the results returned is capped by this number. Use this parameter to limit the size of the returned program list. More...
 
string PageRequest [get, set]
 Gets or sets the value of PageRequest. Used to guide response messages and select next or previous page of partial search results. Use with “ResultKeys - FirstResultKey and LastResultKey” to get next or previous results. Valid values are: next or prev. More...
 
string FirstResultKey [get, set]
 Gets or sets the value of FirstResultKey. Used with “prev” option to identify the first result from the previous response. The response will include search items from before this response. More...
 
string LastResultKey [get, set]
 Gets or sets the value of LastResultKey. Used with “next” Page-Request option to get next results. This string identifies the last result the user saw in the previous response. More...
 

Detailed Description

This class contains the parameters specific to TV Context.

Constructor & Destructor Documentation

ATT_MSSDK.Speechv3.TVXArgs.TVXArgs ( )

Initializes a new instance of TVXArgs.

Member Function Documentation

override string ATT_MSSDK.Speechv3.TVXArgs.ToString ( )

Returns the string format of the properties.

Returns
Returns the string format of the properties.

Property Documentation

string ATT_MSSDK.Speechv3.TVXArgs.DeviceId
getset

Gets or sets the value of DeviceId. The device identifier should be an anonymized hash string identifying the device with a high likelihood of uniqueness while not providing any identifiable string or algorithmic method of recovering the original unique device identifier (UDID).

string ATT_MSSDK.Speechv3.TVXArgs.FirstResultKey
getset

Gets or sets the value of FirstResultKey. Used with “prev” option to identify the first result from the previous response. The response will include search items from before this response.

string ATT_MSSDK.Speechv3.TVXArgs.LastResultKey
getset

Gets or sets the value of LastResultKey. Used with “next” Page-Request option to get next results. This string identifies the last result the user saw in the previous response.

string ATT_MSSDK.Speechv3.TVXArgs.Lineup
getset

Gets or sets the value of Lineup. The Lineup is a 5 digit code identifying one of 66 U-Verse market lineups.

int ATT_MSSDK.Speechv3.TVXArgs.NumResults
getset

Gets or sets the vlaue of NumResults. The size of the results returned is capped by this number. Use this parameter to limit the size of the returned program list.

string ATT_MSSDK.Speechv3.TVXArgs.PageRequest
getset

Gets or sets the value of PageRequest. Used to guide response messages and select next or previous page of partial search results. Use with “ResultKeys - FirstResultKey and LastResultKey” to get next or previous results. Valid values are: next or prev.

bool ATT_MSSDK.Speechv3.TVXArgs.Search
getset

Gets or sets the value of Search.