Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Choice

Choice Class Reference

Constructors

Instance Methods

Constructors

new Choice(parameters)

Initalizes an instance of 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.

ParamTypeDescription
id Number The desired ChoiceID.

choice.setImage(image) ⇒ Choice

Set the Image

Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.

ParamTypeDescription
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.

ParamTypeDescription
name String The desired MenuName.

choice.setSecondaryImage(image) ⇒ Choice

Set the SecondaryImage

Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.

ParamTypeDescription
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.

ParamTypeDescription
text String Optional secondary text to display; e.g. address of POI in a search result entry - The desired SecondaryText.

choice.setTertiaryText(text) ⇒ Choice

Set the TertiaryText

Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.

ParamTypeDescription
text String Optional tertiary text to display; e.g. distance to POI for a search result entry - The desired TertiaryText.

choice.setVrCommands(commands) ⇒ Choice

Set the VrCommands

Kind: Instance method of Choice
Returns: Choice - The class instance for method chaining.

ParamTypeDescription
commands Array.<String> The desired VrCommands.
View on GitHub.com
Previous Section Next Section