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
CancelInteraction

CancelInteraction Class Reference

Constructors

Instance Methods

Constructors

new CancelInteraction(parameters)

Initalizes an instance of CancelInteraction.

Instance Methods

cancelInteraction.getCancelID() ⇒ Number

Get the CancelID

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

cancelInteraction.getFunctionIDParam() ⇒ Number

Get the FunctionIDParam

Kind: Instance method of CancelInteraction
Returns: Number - the KEY_FUNCTION_ID value

cancelInteraction.setCancelID(id) ⇒ CancelInteraction

Set the CancelID

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

ParamTypeDescription
id Number The ID of the specific interaction you want to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed. - The desired CancelID.

cancelInteraction.setFunctionIDParam(id) ⇒ CancelInteraction

Set the FunctionIDParam

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

ParamTypeDescription
id Number The ID of the type of interaction the developer wants to dismiss. Only values 10, (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), 26 (SliderID), and 64 (SubtleAlertID) are permitted. - The desired FunctionIDParam.
View on GitHub.com
Previous Section Next Section