Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

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 VrHelep 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 nonsequential 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 keybaord configuration (if available). N SmartDeviceLink 1.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

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"

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)

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 void setHelpPrompt(java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> helpPrompt)

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 void setTimeoutPrompt(java.util.List<com.smartdevicelink.proxy.rpc.TTSChunk> timeoutPrompt)

Parameters

timeoutPrompt

getVrHelpTitle()

Gets a voice recognition Help Title

public java.lang.String getVrHelpTitle()

setVrHelpTitle( String vrHelpTitle )

Sets a voice recognition Help Title

public void setVrHelpTitle(String vrHelpTitle)

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 void setVrHelp(java.util.List<com.smartdevicelink.proxy.rpc.VrHelpItem> vrHelp)

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 nonsequential 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 void setMenuTitle(String menuTitle)

Parameters

menuTitle

setMenuIcon( Image menuIcon )

public void setMenuIcon(Image menuIcon)

Parameters

menuIcon

getMenuIcon()

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

setKeyboardProperties( KeyboardProperties keyboardProperties )

public void setKeyboardProperties(KeyboardProperties keyboardProperties)

Parameters

keyboardProperties

getKeyboardProperties()

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

Inherited Methods

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