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
SubtleAlert

SubtleAlert Class Reference

Constructors

Instance Methods

Constructors

new SubtleAlert(parameters)

Initalizes an instance of SubtleAlert.

Instance Methods

subtleAlert.getAlertIcon() ⇒ Image

Get the AlertIcon

Kind: Instance method of SubtleAlert
Returns: Image - the KEY_ALERT_ICON value

subtleAlert.getAlertText1() ⇒ String

Get the AlertText1

Kind: Instance method of SubtleAlert
Returns: String - the KEY_ALERT_TEXT_1 value

subtleAlert.getAlertText2() ⇒ String

Get the AlertText2

Kind: Instance method of SubtleAlert
Returns: String - the KEY_ALERT_TEXT_2 value

subtleAlert.getCancelID() ⇒ Number

Get the CancelID

Kind: Instance method of SubtleAlert
Returns: Number - the KEY_CANCEL_ID value

subtleAlert.getDuration() ⇒ Number

Get the Duration

Kind: Instance method of SubtleAlert
Returns: Number - the KEY_DURATION value

subtleAlert.getSoftButtons() ⇒ Array.<SoftButton>

Get the SoftButtons

Kind: Instance method of SubtleAlert
Returns: Array.<SoftButton> - the KEY_SOFT_BUTTONS value

subtleAlert.getTtsChunks() ⇒ Array.<TTSChunk>

Get the TtsChunks

Kind: Instance method of SubtleAlert
Returns: Array.<TTSChunk> - the KEY_TTS_CHUNKS value

subtleAlert.setAlertIcon(icon) ⇒ SubtleAlert

Set the AlertIcon

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

ParamTypeDescription
icon Image Image to be displayed for the corresponding alert. See Image. If omitted on supported displays, no (or the default if applicable) icon should be displayed. - The desired AlertIcon.

subtleAlert.setAlertText1(text1) ⇒ SubtleAlert

Set the AlertText1

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

ParamTypeDescription
text1 String The first line of the alert text field - The desired AlertText1. {'string_min_length': 1, 'string_max_length': 500}

subtleAlert.setAlertText2(text2) ⇒ SubtleAlert

Set the AlertText2

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

ParamTypeDescription
text2 String The second line of the alert text field - The desired AlertText2. {'string_min_length': 1, 'string_max_length': 500}

subtleAlert.setCancelID(id) ⇒ SubtleAlert

Set the CancelID

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

ParamTypeDescription
id Number An ID for this specific alert to allow cancellation through the `CancelInteraction` RPC. - The desired CancelID.

subtleAlert.setDuration(duration) ⇒ SubtleAlert

Set the Duration

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

ParamTypeDescription
duration Number Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to 5s. - The desired Duration. {'num_min_value': 3000, 'num_max_value': 10000}

subtleAlert.setSoftButtons(buttons) ⇒ SubtleAlert

Set the SoftButtons

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

ParamTypeDescription
buttons Array.<SoftButton> App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons. - The desired SoftButtons. {'array_min_size': 0, 'array_max_size': 2}

subtleAlert.setTtsChunks(chunks) ⇒ SubtleAlert

Set the TtsChunks

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

ParamTypeDescription
chunks Array.<TTSChunk> An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item. - The desired TtsChunks. {'array_min_size': 1, 'array_max_size': 100}
View on GitHub.com
Previous Section Next Section