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
- Type
- Function
- Sender
- SDL
- Purpose
- Close an interaction of the specified type
Request
Must
Send BC.OnResetTimeout notification to SDL to reset the timeout in case HMI needs more time to process the request.
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| appID | Integer | true | |
| cancelID | Integer | false | |
| functionID | Integer | true | Can be any one of AlertID, PerformInteractionID, SliderID, ScrollableMessageID, or SubtleAlertID |
Response
Parameters
This RPC has no additional parameter requirements
Sequence Diagrams
JSON Message Examples
Example Request
{ "id" : 7408, "jsonrpc" : "2.0", "method" : "UI.CancelInteraction", "params" : { "appID" : 190838891, "cancelID" : 42, "functionID" : 12 } }
Example Response
{ "id" : 7408, "jsonrpc" : "2.0", "result" : { "code" : 0, "method" : "UI.CancelInteraction" } }
Example Error
{ "id" : 7408, "jsonrpc" : "2.0", "error" : { "code" : 4, "message" : "Request is ignored, because the intended result is already in effect.", "data" : { "method" : "UI.CancelInteraction" } } }