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
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
HMI Documentation
DeleteCommand

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
  1. The application's menu must no longer display the command whose cmdID matches the RPC's cmdID when the user accesses the applications menu.
  2. Send BC.OnResetTimeout notification to SDL to reset the timeout in case HMI needs more time to process the request.

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

Sequence Diagram

Delete Command with Menu Open

View Diagram
Sequence Diagram

Delete Command Application Inactive

View Diagram

JSON Message Examples

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" :
    {
      "method": "UI.DeleteCommand"
    }
  }
}
View on GitHub.com
Previous Section Next Section