com.smartdevicelink.proxy.rpc

Class SetGlobalProperties

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SetGlobalProperties

All Implemented Interfaces:

Cloneable

public class SetGlobalProperties
extends RPCRequest

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

Since:

SmartDeviceLink 1.0

See Also:

ResetGlobalProperties

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_HELP_PROMPT
static String	KEY_KEYBOARD_PROPERTIES
static String	KEY_MENU_ICON
static String	KEY_MENU_LAYOUT
static String	KEY_MENU_TITLE
static String	KEY_TIMEOUT_PROMPT
static String	KEY_USER_LOCATION
static String	KEY_VR_HELP
static String	KEY_VR_HELP_TITLE

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SetGlobalProperties() Constructs a new SetGlobalProperties object
SetGlobalProperties(Hashtable<String,Object> hash) Constructs a new SetGlobalProperties object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
List<TTSChunk>	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
KeyboardProperties	getKeyboardProperties()
Image	getMenuIcon()
MenuLayout	getMenuLayout() Sets the layout of the main menu screen.
String	getMenuTitle()
List<TTSChunk>	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
SeatLocation	getUserLocation() Gets the user seat location
List<VrHelpItem>	getVrHelp() Gets items listed in the VR help screen used in an interaction started by PTT
String	getVrHelpTitle() Gets a voice recognition Help Title
SetGlobalProperties	setHelpPrompt(List<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
SetGlobalProperties	setKeyboardProperties(KeyboardProperties keyboardProperties)
SetGlobalProperties	setMenuIcon(Image menuIcon)
SetGlobalProperties	setMenuLayout(MenuLayout menuLayout) Sets the layout of the main menu screen.
SetGlobalProperties	setMenuTitle(String menuTitle)
SetGlobalProperties	setTimeoutPrompt(List<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
SetGlobalProperties	setUserLocation(SeatLocation location) Sets the user seat location
SetGlobalProperties	setVrHelp(List<VrHelpItem> vrHelp) Sets the items listed in the VR help screen used in an interaction started by PTT
SetGlobalProperties	setVrHelpTitle(String vrHelpTitle) Sets a voice recognition Help Title

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_VR_HELP_TITLE

public static final String KEY_VR_HELP_TITLE

See Also:

Constant Field Values

KEY_MENU_TITLE

public static final String KEY_MENU_TITLE

See Also:

Constant Field Values

KEY_MENU_ICON

public static final String KEY_MENU_ICON

See Also:

Constant Field Values

KEY_KEYBOARD_PROPERTIES

public static final String KEY_KEYBOARD_PROPERTIES

See Also:

Constant Field Values

KEY_HELP_PROMPT

public static final String KEY_HELP_PROMPT

See Also:

Constant Field Values

KEY_TIMEOUT_PROMPT

public static final String KEY_TIMEOUT_PROMPT

See Also:

Constant Field Values

KEY_VR_HELP

public static final String KEY_VR_HELP

See Also:

Constant Field Values

KEY_USER_LOCATION

public static final String KEY_USER_LOCATION

See Also:

Constant Field Values

KEY_MENU_LAYOUT

public static final String KEY_MENU_LAYOUT

See Also:

Constant Field Values

Constructor Detail

SetGlobalProperties

public SetGlobalProperties()

Constructs a new SetGlobalProperties object

SetGlobalProperties

public SetGlobalProperties(Hashtable<String,Object> hash)

Constructs a new SetGlobalProperties object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

getHelpPrompt

public List<TTSChunk> 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

Returns:

List -an Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT

setHelpPrompt

public SetGlobalProperties setHelpPrompt(List<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

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

public List<TTSChunk> 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

Returns:

List -an Array of one or more TTSChunk elements specifying the help prompt used in an interaction started by PTT

setTimeoutPrompt

public SetGlobalProperties setTimeoutPrompt(List<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

getVrHelpTitle

public String getVrHelpTitle()

Gets a voice recognition Help Title

Returns:

String - a String value representing the text, which is shown as title of the VR help screen used in an interaction started by PTT

Since:

SmartDeviceLink 2.0

setVrHelpTitle

public SetGlobalProperties setVrHelpTitle(String vrHelpTitle)

Sets a voice recognition Help Title

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

Since:

SmartDeviceLink 2.0

getVrHelp

public List<VrHelpItem> getVrHelp()

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

Returns:

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

Since:

SmartDeviceLink 2.0

setVrHelp

public SetGlobalProperties setVrHelp(List<VrHelpItem> vrHelp)

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

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

Since:

SmartDeviceLink 2.0

getMenuTitle

public String getMenuTitle()

setMenuTitle

public SetGlobalProperties setMenuTitle(String menuTitle)

setMenuIcon

public SetGlobalProperties setMenuIcon(Image menuIcon)

getMenuIcon

public Image getMenuIcon()

setKeyboardProperties

public SetGlobalProperties setKeyboardProperties(KeyboardProperties keyboardProperties)

setUserLocation

public SetGlobalProperties setUserLocation(SeatLocation location)

Sets the user seat location

Parameters:

location - the location to be set

getUserLocation

public SeatLocation getUserLocation()

Gets the user seat location

Returns:

the user seat location

getKeyboardProperties

public KeyboardProperties getKeyboardProperties()

setMenuLayout

public SetGlobalProperties 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.

Parameters:

menuLayout - - the menuLayout

getMenuLayout

public 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.

Returns:

the MenuLayout