SmartDeviceLink - HMI Documentation

SetAppIcon

Type: Function
Sender: SDL
Purpose: Display the application's specified icon in the HMI's application list.

Request

Must

Keep track and store the name and file referencing the app icon each time a successful SetAppIcon request occurs from the mobile app.
Display the requested icon together with the application name in the HMI list of registered applications:
- Right away if the list of registered applications is currently displayed
- When the list of registered applications is displayed upon User's request on HMI
Display default app icon if the mobile application had not previously set an icon successfully and/or the file does not exist on HMI.
Send BC.OnResetTimeout notification to SDL to reset the timeout in case HMI needs more time to process the request.

Parameters

Name	Type	Mandatory	Additional
syncFileName	Common.Image	true
appID	Integer	true

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

Sequence Diagram

SetAppIcon

View Diagram

JSON Message Examples

Example Request

{
  "id" : 88,
  "jsonrpc" : "2.0",
  "method" : "UI.SetAppIcon",
  "params" :
  {
    "syncFileName" :
    {
         "value" : "tmp/SDL/app/Best_Media/12345.jpg",
         "imageType" : "DYNAMIC"
    },
    "appID" : 65146
  }
}

Example Response

{
  "id" : 88,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
   "method" : "UI.SetAppIcon"
  }
}

Example Error

{
  "id" : 88,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 2,
    "message" : "Unsupported resource",
    "data" :
    {
      "method" : "UI.SetAppIcon"
    }
  }
}

View on GitHub.com

Previous Section Next Section