SetGlobalProperties Class Reference
Constructors
Instance Methods
- getHelpPrompt() ⇒
Array.<TTSChunk> - getKeyboardProperties() ⇒
KeyboardProperties - getMenuIcon() ⇒
Image - getMenuLayout() ⇒
MenuLayout - getMenuTitle() ⇒
String - getTimeoutPrompt() ⇒
Array.<TTSChunk> - getUserLocation() ⇒
SeatLocation - getVrHelp() ⇒
Array.<VrHelpItem> - getVrHelpTitle() ⇒
String - setHelpPrompt(prompt) ⇒
SetGlobalProperties - setKeyboardProperties(properties) ⇒
SetGlobalProperties - setMenuIcon(icon) ⇒
SetGlobalProperties - setMenuLayout(layout) ⇒
SetGlobalProperties - setMenuTitle(title) ⇒
SetGlobalProperties - setTimeoutPrompt(prompt) ⇒
SetGlobalProperties - setUserLocation(location) ⇒
SetGlobalProperties - setVrHelp(help) ⇒
SetGlobalProperties - setVrHelpTitle(title) ⇒
SetGlobalProperties
Instance Methods
setGlobalProperties.getHelpPrompt() ⇒ Array.<TTSChunk>
Get the HelpPrompt
Kind: Instance method of SetGlobalProperties
Returns: Array.<TTSChunk> - the KEY_HELP_PROMPT value
setGlobalProperties.getKeyboardProperties() ⇒ KeyboardProperties
Get the KeyboardProperties
Kind: Instance method of SetGlobalProperties
Returns: KeyboardProperties - the KEY_KEYBOARD_PROPERTIES value
setGlobalProperties.getMenuIcon() ⇒ Image
Get the MenuIcon
Kind: Instance method of SetGlobalProperties
Returns: Image - the KEY_MENU_ICON value
setGlobalProperties.getMenuLayout() ⇒ MenuLayout
Get the MenuLayout
Kind: Instance method of SetGlobalProperties
Returns: MenuLayout - the KEY_MENU_LAYOUT value
setGlobalProperties.getMenuTitle() ⇒ String
Get the MenuTitle
Kind: Instance method of SetGlobalProperties
Returns: String - the KEY_MENU_TITLE value
setGlobalProperties.getTimeoutPrompt() ⇒ Array.<TTSChunk>
Get the TimeoutPrompt
Kind: Instance method of SetGlobalProperties
Returns: Array.<TTSChunk> - the KEY_TIMEOUT_PROMPT value
setGlobalProperties.getUserLocation() ⇒ SeatLocation
Get the UserLocation
Kind: Instance method of SetGlobalProperties
Returns: SeatLocation - the KEY_USER_LOCATION value
setGlobalProperties.getVrHelp() ⇒ Array.<VrHelpItem>
Get the VrHelp
Kind: Instance method of SetGlobalProperties
Returns: Array.<VrHelpItem> - the KEY_VR_HELP value
setGlobalProperties.getVrHelpTitle() ⇒ String
Get the VrHelpTitle
Kind: Instance method of SetGlobalProperties
Returns: String - the KEY_VR_HELP_TITLE value
setGlobalProperties.setHelpPrompt(prompt) ⇒ SetGlobalProperties
Set the HelpPrompt
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| prompt | Array.<TTSChunk> |
The help prompt. An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item. - The desired HelpPrompt. {'array_min_size': 1, 'array_max_size': 100} |
setGlobalProperties.setKeyboardProperties(properties) ⇒ SetGlobalProperties
Set the KeyboardProperties
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| properties | KeyboardProperties |
On-screen keyboard configuration (if available). - The desired KeyboardProperties. |
setGlobalProperties.setMenuIcon(icon) ⇒ SetGlobalProperties
Set the MenuIcon
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| icon | Image |
Optional icon to draw on an app menu button (for certain touchscreen platforms). - The desired MenuIcon. |
setGlobalProperties.setMenuLayout(layout) ⇒ SetGlobalProperties
Set the MenuLayout
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| layout | MenuLayout |
Sets the layout of the main menu screen. If this is sent while a menu is already on-screen, the head unit will change the display to the new layout type. - The desired MenuLayout. |
setGlobalProperties.setMenuTitle(title) ⇒ SetGlobalProperties
Set the MenuTitle
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| title | String |
Optional text to label an app menu button (for certain touchscreen platforms). - The desired MenuTitle. {'string_min_length': 1, 'string_max_length': 500} |
setGlobalProperties.setTimeoutPrompt(prompt) ⇒ SetGlobalProperties
Set the TimeoutPrompt
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| prompt | Array.<TTSChunk> |
Help text for a wait timeout. An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item. - The desired TimeoutPrompt. {'array_min_size': 1, 'array_max_size': 100} |
setGlobalProperties.setUserLocation(location) ⇒ SetGlobalProperties
Set the UserLocation
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| location | SeatLocation |
Location of the user's seat. Default is driver's seat location if it is not set yet. - The desired UserLocation. |
setGlobalProperties.setVrHelp(help) ⇒ SetGlobalProperties
Set the VrHelp
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| help | Array.<VrHelpItem> |
VR Help Items. If omitted on supported displays, the default SmartDeviceLink VR help / What Can I Say? screen shall be used. If the list of VR Help Items contains nonsequential positions (e.g. [1,2,4]), the RPC shall be rejected. If omitted and a vrHelpTitle is provided, the request will be rejected. - The desired VrHelp. {'array_min_size': 1, 'array_max_size': 100} |
setGlobalProperties.setVrHelpTitle(title) ⇒ SetGlobalProperties
Set the VrHelpTitle
Kind: Instance method of SetGlobalProperties
Returns: SetGlobalProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| title | String |
VR Help Title text. If omitted on supported displays, the default module help title shall be used. If omitted and one or more vrHelp items are provided, the request will be rejected. - The desired VrHelpTitle. {'string_min_length': 1, 'string_max_length': 500} |