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

DeleteCommand

Type
Function
Sender
SDL
Purpose
Delete a command from the specified application's menu or submenu

UI.DeleteCommand represents a request to remove a previously added command (added via UI.AddCommand) from the application's menu.

Must

The application's menu must no longer display the command whose cmdID matches the RPC's cmdID when the user accesses the applications menu

Request

Parameters

Name Type Mandatory Additional
cmdID Integer true minvalue: 0
maxvalue: 2000000000
appID Integer true

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

Example Request

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "method" : "UI. DeleteCommand",
  "params" :
  {
    "cmdID" : 2318,
    "appID" : 65409
  }
}

Example Response

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "UI. DeleteCommand"
  }
}

Example Error

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 13,
    "message" : "One of the provided IDs is not valid",
    "data" :
    {
      "UI. DeleteCommand"
    }
  }
}
View on GitHub.com
Previous Section Next Section