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
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
SetGlobalProperties

Class SetGlobalProperties

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

Sets value(s) for the specified global property(ies)

Function Group: Base

HMILevel needs to be FULL, LIMITED or BACKGROUND

AudioStreamingState:

Any

SystemContext:

Any

Parameter List

Param Name Type Description Req. Notes Version Available
helpPrompt TTSChunk The help prompt. An array of text chunks of type TTSChunk. See TTSChunk.The array must have at least one item. N Array must have at least one element.

Only optional it timeoutPrompt has been specified.

minsize:1; maxsize: 100		 SmartDeviceLink 1.0
timeoutPrompt TTSChunk Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT. N Array must have at least one element. Only optional it helpPrompt has been specified

minsize: 1; maxsize: 100

 SmartDeviceLink 1.0
vrHelpTitle string Text, which is shown as title of the VR help screen used in an interaction started by PTT. N If omitted on supported displays, the default SDL help title will be used.

If omitted and one or more vrHelp items are provided, the request will be rejected.

maxLength: 500		 SmartDeviceLink 1.0
vrHelp VrHelp Items listed in the VR help screen used in an interaction started by PTT. N If omitted on supported displays, the default SDL VR help / What Can I Say? screen will be used

If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected.

If omitted and a vrHelpTitle is provided, the request will be rejected.

minsize:1; maxsize: 100 		SmartDeviceLink 1.0
menuTitle Optional text to label an app menu button (for certain touchscreen platforms). N maxlength: 500 SmartDeviceLink 1.0
menuIcon Image Optional icon to draw on an app menu button (for certain touchscreen platforms). N SmartDeviceLink 1.0
keyboardProperties KeyboardProperties On-screen keyboard configuration (if available). N SmartDeviceLink 1.0
menuLayout 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. SmartDeviceLink 6.0

Note: Your application shall send a SetGlobalProperties to establish an advanced help prompt before sending any voice commands.

Response

Indicates whether the requested Global Properties were successfully set.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

Quick Jump

Fields
Constructors
Methods

Fields

KEY_VR_HELP_TITLE

public static final java.lang.String KEY_VR_HELP_TITLE
Constant Value
"vrHelpTitle"

KEY_MENU_TITLE

public static final java.lang.String KEY_MENU_TITLE
Constant Value
"menuTitle"

KEY_MENU_ICON

public static final java.lang.String KEY_MENU_ICON
Constant Value
"menuIcon"

KEY_KEYBOARD_PROPERTIES

public static final java.lang.String KEY_KEYBOARD_PROPERTIES
Constant Value
"keyboardProperties"

KEY_HELP_PROMPT

public static final java.lang.String KEY_HELP_PROMPT
Constant Value
"helpPrompt"

KEY_TIMEOUT_PROMPT

public static final java.lang.String KEY_TIMEOUT_PROMPT
Constant Value
"timeoutPrompt"

KEY_VR_HELP

public static final java.lang.String KEY_VR_HELP
Constant Value
"vrHelp"

KEY_USER_LOCATION

public static final java.lang.String KEY_USER_LOCATION
Constant Value
"userLocation"

KEY_MENU_LAYOUT

public static final java.lang.String KEY_MENU_LAYOUT
Constant Value
"menuLayout"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

SetGlobalProperties()

Constructs a new SetGlobalProperties object 

public SetGlobalProperties()

SetGlobalProperties( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new SetGlobalProperties object indicated by the Hashtable parameter 

public SetGlobalProperties(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

Methods

getHelpPrompt()

Gets a List for Help Prompt representing Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT 

public java.util.List getHelpPrompt()

setHelpPrompt( java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> helpPrompt )

Sets a List for Help Prompt that Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setHelpPrompt(java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> helpPrompt)

Method Parameters

helpPrompt
a List of one or more TTSChunk elements

Notes:
  • Array must have at least one element
  • Only optional it timeoutPrompt has been specified

getTimeoutPrompt()

Gets a List for Timeout Prompt representing Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT 

public java.util.List getTimeoutPrompt()

setTimeoutPrompt( java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutPrompt )

Sets a List for Timeout Prompt representing Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setTimeoutPrompt(java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutPrompt)

Method Parameters

timeoutPrompt

getVrHelpTitle()

Gets a voice recognition Help Title 

public java.lang.String getVrHelpTitle()

setVrHelpTitle( String vrHelpTitle )

Sets a voice recognition Help Title 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setVrHelpTitle(String vrHelpTitle)

Method Parameters

vrHelpTitle
a String value representing a voice recognition Help Title

Notes:
  • If omitted on supported displays, the default SDL help title will be used
  • If omitted and one or more vrHelp items are provided, the request will be rejected.
  • String Maxlength = 500

getVrHelp()

Gets items listed in the VR help screen used in an interaction started by PTT 

public java.util.List getVrHelp()

setVrHelp( java.util.List<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp )

Sets the items listed in the VR help screen used in an interaction started by PTT 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setVrHelp(java.util.List<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp)

Method Parameters

vrHelp
a List value representing items listed in the VR help screen used in an interaction started by PTT

Notes:
  • If omitted on supported displays, the default SmartDeviceLink VR help / What Can I Say? screen will be used
  • If the list of VR Help Items contains non-sequential positions (e.g. [1,2,4]), the RPC will be rejected
  • If omitted and a vrHelpTitle is provided, the request will be rejected
  • Array Minsize: = 1
  • Array Maxsize = 100

getMenuTitle()

public java.lang.String getMenuTitle()

setMenuTitle( String menuTitle )

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setMenuTitle(String menuTitle)

Method Parameters

menuTitle

setMenuIcon( Image menuIcon )

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setMenuIcon(Image menuIcon)

Method Parameters

menuIcon

getMenuIcon()

public com.smartdevicelink.proxy.rpc.Image getMenuIcon()

setKeyboardProperties( KeyboardProperties keyboardProperties )

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setKeyboardProperties(KeyboardProperties keyboardProperties)

Method Parameters

keyboardProperties

setUserLocation( SeatLocation location )

Sets the user seat location 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setUserLocation(SeatLocation location)

Method Parameters

location
the location to be set

getUserLocation()

Gets the user seat location 

public com.smartdevicelink.proxy.rpc.SeatLocation getUserLocation()

getKeyboardProperties()

public com.smartdevicelink.proxy.rpc.KeyboardProperties getKeyboardProperties()

setMenuLayout( MenuLayout 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. 

public com.smartdevicelink.proxy.rpc.SetGlobalProperties setMenuLayout(MenuLayout menuLayout)

Method Parameters

menuLayout
- the menuLayout

getMenuLayout()

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. 

public com.smartdevicelink.proxy.rpc.enums.MenuLayout getMenuLayout()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section