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
AddCommand
- Type
- Function
- Sender
- SDL
- Purpose
- Add a command to the specified application's menu or sub menu
UI.AddCommand represents a request from an application to add a command to the application's menu or sub-menu. This RPC can be sent to the HMI for an application that is registered and in any state (FULL, BACKGROUND, etc.)
Must
- The commands sent for the application via AddCommand must be accessible from a Menu
- The user must be able to enter the Menu while the related application is in the FULL state
- Store the data provided in this RPC with the requesting application's appID
- Add the command to the application's menu at the position specified in the
menuParams
Note
- If SDL sends the HMI a UI.AddCommand and a VR.AddCommand, and receives a SUCCESS from one and a failure from the other, SDL will send a UI.DeleteCommand for the AddCommand which succeeded.
- If the
menuParamscontains aparentIDthe command is part of a sub menu. SDL adds SubMenu Commands to the top level Menu via UI.AddSubMenu
Request
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| cmdID | Integer | true | minvalue: 0 maxvalue: 2000000000 |
| menuParams | Common.MenuParams | false | |
| cmdIcon | Common.Image | false | |
| appID | Integer | true |
Response
Parameters
This RPC has no additional parameter requirements
Sequence Diagrams
JSON Message Examples
Example Request
{ "id" : 215, "jsonrpc" : "2.0", "method" : "UI.AddCommand", "params" : { "cmdID" : 2318, "menuParams" : { "parentID" : 6, "position" : 0, "menuName" : "Show weather for tomorrow" }, "cmdIcon" : { "value" : "tmp/SDL/app/Gis_meteo/1245_28.jpeg", "imageType" : "DYNAMIC" }, "appID" : 65409 } }
Example Response
{ "id" : 215, "jsonrpc" : "2.0", "result" : { "code" : 0, "method" : "UI.AddCommand" } }
Example Error
{ "id" : 215, "jsonrpc" : "2.0", "error" : { "code" : 13, "message" : "There’s no app with received appID registered", "data" : { "method" : "UI.AddCommand" } } }