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
ScrollableMessage

ScrollableMessage Class Reference

Constructors

Instance Methods

Constructors

new ScrollableMessage(parameters)

Initalizes an instance of ScrollableMessage.

Instance Methods

scrollableMessage.getCancelID() ⇒ Number

Get the CancelID

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

scrollableMessage.getScrollableMessageBody() ⇒ String

Get the ScrollableMessageBody

Kind: Instance method of ScrollableMessage
Returns: String - the KEY_SCROLLABLE_MESSAGE_BODY value

scrollableMessage.getSoftButtons() ⇒ Array.<SoftButton>

Get the SoftButtons

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

scrollableMessage.getTimeout() ⇒ Number

Get the Timeout

Kind: Instance method of ScrollableMessage
Returns: Number - the KEY_TIMEOUT value

scrollableMessage.setCancelID(id) ⇒ ScrollableMessage

Set the CancelID

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

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

scrollableMessage.setScrollableMessageBody(body) ⇒ ScrollableMessage

Set the ScrollableMessageBody

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

ParamTypeDescription
body String Body of text that can include newlines and tabs. - The desired ScrollableMessageBody. {'string_min_length': 1, 'string_max_length': 500}

scrollableMessage.setSoftButtons(buttons) ⇒ ScrollableMessage

Set the SoftButtons

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

ParamTypeDescription
buttons Array.<SoftButton> App defined SoftButtons. If omitted on supported displays, only the system defined "Close" SoftButton will be displayed. - The desired SoftButtons. {'array_min_size': 0, 'array_max_size': 8}

scrollableMessage.setTimeout(timeout) ⇒ ScrollableMessage

Set the Timeout

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

ParamTypeDescription
timeout Number App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout). - The desired Timeout. {'num_min_value': 1000, 'num_max_value': 65535}
View on GitHub.com
Previous Section Next Section