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
Documentation
ShowAppMenu

ShowAppMenu

Type
Function
Sender
SDL
Purpose
Show an app's menu or a corresponding sub-menu.
Must

After opening the menu, the HMI must send a UI.OnSystemContext notification with systemContext: "MENU" to SDL.

Request

Parameters

Name Type Mandatory Additional Description
menuID Integer false minvalue: 1
maxvalue: 2000000000
If omitted the HMI opens the app's menu.
If set to a sub-menu ID the HMI opens the corresponding sub-menu previously added using UI.AddSubMenu
appID Integer true

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 120,
  "jsonrpc" : "2.0",
  "method" : "UI.ShowAppMenu",
  "params" :
  {
    "menuID" : 313,
    "appID" : 8726
  }
}

Example Response

{
  "id" : 120,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "UI.ShowAppMenu"
  }
}

Example Error

{
  "id" : 176,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 22,
    "message" : "Request timeout",
    "data" :
    {
      "method" : "UI.ShowAppMenu"
    }
  }
}
View on GitHub.com
Previous Section Next Section