Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
CancelInteraction

CancelInteraction

Type
Function
Sender
SDL
Purpose
Close an interaction of the specified type

Request

Parameters

Name Type Mandatory Description
appID Integer true
cancelID Integer false
functionID Integer true Can be any one of AlertID, PerformInteractionID, SliderID or ScrollableMessageID

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"
    }
  }
}
View on GitHub.com
Previous Section Next Section