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
Documentation
PerformInteractionResponse

PerformInteractionResponse Class Reference

Constructors

Instance Methods

Constructors

new PerformInteractionResponse(parameters)

Initalizes an instance of PerformInteractionResponse.

Instance Methods

performInteractionResponse.getChoiceID() ⇒ Number

Get the ChoiceID

Kind: Instance method of PerformInteractionResponse
Returns: Number - the KEY_CHOICE_ID value

performInteractionResponse.getManualTextEntry() ⇒ String

Get the ManualTextEntry

Kind: Instance method of PerformInteractionResponse
Returns: String - the KEY_MANUAL_TEXT_ENTRY value

performInteractionResponse.getTriggerSource() ⇒ TriggerSource

Get the TriggerSource

Kind: Instance method of PerformInteractionResponse
Returns: TriggerSource - the KEY_TRIGGER_SOURCE value

performInteractionResponse.setChoiceID(id) ⇒ PerformInteractionResponse

Set the ChoiceID

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

ParamTypeDescription
id Number ID of the choice that was selected in response to PerformInteraction. Only is valid if general result is "success:true". - The desired ChoiceID. {'num_min_value': 0, 'num_max_value': 2000000000}

performInteractionResponse.setManualTextEntry(entry) ⇒ PerformInteractionResponse

Set the ManualTextEntry

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

ParamTypeDescription
entry String Manually entered text selection, e.g. through keyboard Can be returned in lieu of choiceID, depending on trigger source - The desired ManualTextEntry. {'string_min_length': 1, 'string_max_length': 500}

performInteractionResponse.setTriggerSource(source) ⇒ PerformInteractionResponse

Set the TriggerSource

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

ParamTypeDescription
source TriggerSource See TriggerSource Only is valid if resultCode is SUCCESS. - The desired TriggerSource.
View on GitHub.com
Previous Section Next Section