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.
To Top
To Bottom
CancelInteraction Class Reference
Constructors
Instance Methods
- getCancelID() ⇒
Number - getFunctionIDParam() ⇒
Number - setCancelID(id) ⇒
CancelInteraction - setFunctionIDParam(id) ⇒
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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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. |