Choice Class Reference
Constructors
Instance Methods
- getChoiceID() ⇒
Number - getImage() ⇒
Image - getMenuName() ⇒
String - getSecondaryImage() ⇒
Image - getSecondaryText() ⇒
String - getTertiaryText() ⇒
String - getVrCommands() ⇒
Array.<String> - setChoiceID(id) ⇒
Choice - setImage(image) ⇒
Choice - setMenuName(name) ⇒
Choice - setSecondaryImage(image) ⇒
Choice - setSecondaryText(text) ⇒
Choice - setTertiaryText(text) ⇒
Choice - setVrCommands(commands) ⇒
Choice
Instance Methods
choice.getChoiceID() ⇒ Number
Get the ChoiceID
Kind: Instance method of Choice
Returns: Number - the KEY_CHOICE_ID value
choice.getImage() ⇒ Image
Get the Image
Kind: Instance method of Choice
Returns: Image - the KEY_IMAGE value
choice.getMenuName() ⇒ String
Get the MenuName
Kind: Instance method of Choice
Returns: String - the KEY_MENU_NAME value
choice.getSecondaryImage() ⇒ Image
Get the SecondaryImage
Kind: Instance method of Choice
Returns: Image - the KEY_SECONDARY_IMAGE value
choice.getSecondaryText() ⇒ String
Get the SecondaryText
Kind: Instance method of Choice
Returns: String - the KEY_SECONDARY_TEXT value
choice.getTertiaryText() ⇒ String
Get the TertiaryText
Kind: Instance method of Choice
Returns: String - the KEY_TERTIARY_TEXT value
choice.getVrCommands() ⇒ Array.<String>
Get the VrCommands
Kind: Instance method of Choice
Returns: Array.<String> - the KEY_VR_COMMANDS value
choice.setChoiceID(id) ⇒ Choice
Set the ChoiceID
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
The desired ChoiceID. {'num_min_value': 0, 'num_max_value': 65535} |
choice.setImage(image) ⇒ Choice
Set the Image
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| image | Image |
The desired Image. |
choice.setMenuName(name) ⇒ Choice
Set the MenuName
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
The desired MenuName. {'string_min_length': 1, 'string_max_length': 500} |
choice.setSecondaryImage(image) ⇒ Choice
Set the SecondaryImage
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| image | Image |
Optional secondary image struct for choice - The desired SecondaryImage. |
choice.setSecondaryText(text) ⇒ Choice
Set the SecondaryText
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text | String |
Optional secondary text to display; e.g. address of POI in a search result entry - The desired SecondaryText. {'string_min_length': 1, 'string_max_length': 500} |
choice.setTertiaryText(text) ⇒ Choice
Set the TertiaryText
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text | String |
Optional tertiary text to display; e.g. distance to POI for a search result entry - The desired TertiaryText. {'string_min_length': 1, 'string_max_length': 500} |
choice.setVrCommands(commands) ⇒ Choice
Set the VrCommands
Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| commands | Array.<String> |
The desired VrCommands. {'array_min_size': 1, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 99} |