Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
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 - The desired CancelID. `CancelInteraction` RPC.

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.

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 - The desired SoftButtons. defined "Close" SoftButton will be displayed.

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. - The desired Timeout. scrolling message resets timeout).
View on GitHub.com
Previous Section Next Section