Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
JavaScript Suite Documentation
ChoiceCell

ChoiceCell Class Reference

Constructors

Instance Methods

Constructors

new ChoiceCell(text)

Creates a new instance of ChoiceCell

Instance Methods

choiceCell.clone() ⇒ ChoiceCell

Creates a deep copy of the object

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A deep copy of the object

choiceCell.equals(other) ⇒ Boolean

Checks whether two ChoiceCells can be considered equivalent

Kind: Instance method of ChoiceCell
Returns: Boolean - Whether the objects are the same or not

ParamTypeDescription
other ChoiceCell The object to compare

choiceCell.getArtwork() ⇒ SdlArtwork

Get the state artwork

Kind: Instance method of ChoiceCell
Returns: SdlArtwork - The SdlArtwork

choiceCell.getSecondaryArtwork() ⇒ SdlArtwork

Get the state secondaryArtwork

Kind: Instance method of ChoiceCell
Returns: SdlArtwork - The SdlArtwork

choiceCell.getSecondaryText() ⇒ String

Get the state secondaryText

Kind: Instance method of ChoiceCell
Returns: String - The secondary text of the cell

choiceCell.getTertiaryText() ⇒ String

Get the state tertiaryText

Kind: Instance method of ChoiceCell
Returns: String - The tertiary text of the cell

choiceCell.getText() ⇒ String

Get the state text

Kind: Instance method of ChoiceCell
Returns: String - The primary text of the cell

choiceCell.getVoiceCommands() ⇒ [Array.<String>, null]

Get the state voiceCommands

Kind: Instance method of ChoiceCell
Returns: [Array.<String>, null] - The list of voice command strings

choiceCell.setArtwork(artwork) ⇒ ChoiceCell

Set the state artwork Maps to Choice.image. Optional image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
artwork SdlArtwork The SdlArtwork

choiceCell.setSecondaryArtwork(secondaryArtwork) ⇒ ChoiceCell

Set the state secondaryArtwork Maps to Choice.secondaryImage. Optional secondary image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
secondaryArtwork SdlArtwork The SdlArtwork

choiceCell.setSecondaryText(secondaryText) ⇒ ChoiceCell

Set the state secondaryText Maps to Choice.secondaryText. Optional secondary text of the cell, if available. Duplicates within an `ChoiceSet` are permitted.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
secondaryText String The secondary text of the cell

choiceCell.setTertiaryText(tertiaryText) ⇒ ChoiceCell

Set the state tertiaryText Maps to Choice.tertiaryText. Optional tertiary text of the cell, if available. Duplicates within an `ChoiceSet` are permitted.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
tertiaryText String The tertiary text of the cell

choiceCell.setText(text) ⇒ ChoiceCell

Set the state text Maps to Choice.menuName. The primary text of the cell. Duplicates within an `ChoiceSet` are not permitted and will result in the ChoiceSet failing to initialize.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
text String The primary text of the cell

choiceCell.setVoiceCommands(voiceCommands) ⇒ ChoiceCell

Set the state voiceCommands Maps to Choice.vrCommands. Optional voice commands the user can speak to activate the cell. If not set and the head unit requires it, this will be set to the number in the list that this item appears. However, this would be a very poor experience for a user if the choice set is presented as a voice only interaction or both interaction mode. Therefore, consider not setting this only when you know the choice set will be presented as a touch only interaction.

Kind: Instance method of ChoiceCell
Returns: ChoiceCell - A reference to this instance to support method chaining

ParamTypeDescription
voiceCommands Array.<String> The list of voice command strings
View on GitHub.com
Previous Section Next Section