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
HMI Documentation
SetGlobalProperties

SetGlobalProperties

Type
Function
Sender
SDL
Purpose
Set the UI properties of an application.

Description

SDL requests to set-up the data for VR help layout, the name and icon for in-application menu and the properties of the touchscreen keyboard (such as providing custom special characters to display at the root level of the keyboard layout).

Request

The request may arrive for the application whether being active or in background on HMI (depends on the Policy Table permissions applicable to mobile application request, by default allowed to operate in all HMI levels except NONE).

The vrHelp parameter of the SetGlobalProperties RPC is used by the system to display the help items on the screen, and the helpPrompt parameter is used by the system for playing out the associated TTS help prompt.

SDL Core sends SetGlobalProperties request with specific vrHelp and vrHelpTitle values to HMI in the following cases:

  1. If at any point in time, the application sends SetGlobalProperties RPC with the vrHelp and helpPrompt parameters, then SDL Core shall continue with the existing behavior of forwarding such requests to HMI and SDL Core shall delete its internal list and stop sending SetGlobalProperties RPC to HMI after each AddCommand/DeleteCommand request received from mobile.
  2. If at any point in time, the application sends SetGlobalProperties RPC with either of vrHelp or helpPrompt parameters, then SDL Core shall continue with the existing behavior of forwarding such requests to HMI and SDL Core shall not delete its internal list and shall continue to update the parameter which was not provided by the application.
  3. In case mobile application sends AddCommand with CommandType = Command, SDL Core must send updated values of vrHelp via SetGlobalProperties to HMI. (Note: AddCommand requests related to choice set must NOT trigger the update of vrHelp)
  4. In case mobile application sends SetGlobalProperties request to SDL Core:
    • SDL Core must omit the autoCompleteText parameter when forwarding to the HMI
      • if autoCompleteText is present and autoCompleteList is omitted, SDL Core forwards autoCompleteList with a single value, taken from autoCompleteText.
Must
  1. Store the information and associate it with appID.
    • Note: Initially, the appID together with other application-related information is provided by SDL within UpdateAppList or OnAppRegistered RPCs.
  2. When the system receives a new list of strings in autoCompleteList for a particular application, the system must delete the previous list and replace it with the new list for that application.
  3. Whenever the User activates VR or sets up the requested values for VR help layout, HMI must display the list of commands available for voice recognition. SDL Core provides the title for this list (vrHelpTitle parameter) and the list of commands itself (vrHelp parameter which is an array of VrHelpItem).
    • Important Note: If HMI-defined VR commands are accessible together with those provided by SDL Core via VR.AddCommand, HMI must:
      • add the corresponding VR HMI-defined commands to the list of VR help items provided by SDL via UI.SetGlobalProperties
      • display the complete list of available VR commands (SDL-defined and HMI-defined ones) when the User activates VR.
  4. HMI displays the in-application menu for every active application upon the User's request. It must contain SDL-requested commands (UI.AddCommand) and sub-menus (UI.AddSubMenu). SDL provides the values for the name (menuTitle parameter) and for the icon (menuIcon parameter) of this in-application menu. The values for in-application menu and touchscreen keyboard are allowed by SDL Core for navigation type of application only.
  5. In case SDL sends request with some values in customKeys array, HMI must:
    • use these values to change the special characters shown in customizable keys
    • keep default values in the remaining keys, if the array is less than or equal to customizable keys amount
  6. Depending on the value of maskInputCharacters, the HMI must do the following when displaying the keyboard:
    • DISABLE_INPUT_KEY_MASK (default if not set) - Display input characters submitted by the user in the input box normally
    • ENABLE_INPUT_KEY_MASK - Mask input characters submitted by the user in the input box
    • USER_CHOICE_INPUT_KEY_MASK - Mask input characters by default and provide a toggle option for the user to disable masking

Note: HMI should not duplicate special characters on keyboard.

Note

By default vrHelpTitle value is set to application name.

Notes for HMI expected behavior:

  1. The system shall have the ability to receive and store multiple strings from autoCompleteList per application.
  2. When any of the keyboard layouts are being used, the system shall reference the autoCompleteList strings for that application.
  3. As the User enters data on the keyboard, the system shall display values from autoCompleteList which match the entry.
  4. The number of matching autoCompleteList strings displayed shall only be limited by the character length constraints of the HMI.
  5. The system shall provide the User with the ability to select one of the displayed matching autoCompleteList strings without having to enter the entire string.
  6. When the User selects one of the displayed matching autoCompleteList strings, the system shall submit that entry and not require further User input for submission.
  7. The system shall allow applications to customize the special characters in each keyboard layout depending on the KeyboardCapabilities it provides.
  8. The system shall allow applications to decide whether or not to mask input characters submitted by the user if this capability is enabled in KeyboardCapabilities.

Parameters

Name Type Mandatory Additional
vrHelpTitle String false maxlength: 500
vrHelp Common.VrHelpItem false array: true
minsize: 1
maxsize: 100
menuTitle String false maxlength: 500
menuIcon Common.Image false
keyboardProperties Common.KeyboardProperties false
appID Integer true
menuLayout Common.MenuLayout false

Response

Note

In case HMI does not respond to SDL Core request during SDL-default timeout (10 sec), SDL Core returns "GENERIC_ERROR" result code to the corresponding mobile application request.

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 116,
  "jsonrpc" : "2.0",
  "method" : "UI.SetGlobalProperties",
  "params" :
  {
    "vrHelpTitle" : "Choose the action",
    "vrHelp" :
    [
        {
         "text" : "Pause",
         "image" :
          {
             "value" : "tmp/SDL/app/Pandora/icon_1067.jpg",
             "imageType" : "DYNAMIC"
          },
         "position" : 1
        },
        {
         "text" : "Resume",
         "image" :
          {
             "value" : "tmp/SDL/app/Pandora/icon_1083.jpeg",
             "imageType" : "DYNAMIC"
          },
         "position" : 2
        },
        {
         "text" : "Skip",
         "image" :
          {
             "value" : "tmp/SDL/app/Pandora/icon_1013.jpeg",
             "imageType" : "DYNAMIC"
          },
         "position" : 3
        },
        {
         "text" : "Bookmark",
         "image" :
          {
             "value" : "tmp/SDL/app/Pandora/icon_1046.jpeg",
             "imageType" : "DYNAMIC"
          },
         "position" : 4
        }
    ],
    "appID" : 53880
  }
}

Example Response

{
  "id" : 116,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "UI.SetGlobalProperties"
  }
}

Example Error

{
  "id" : 116,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 11,
    "message" : "Invalid data",
    "data" :
    {
      "method" : "UI.SetGlobalProperties"
    }
  }
}
View on GitHub.com
Previous Section Next Section