com.smartdevicelink.proxy.rpc.enums

Enum GlobalProperty

java.lang.Object

java.lang.Enum<GlobalProperty>

com.smartdevicelink.proxy.rpc.enums.GlobalProperty

All Implemented Interfaces:

Serializable, Comparable<GlobalProperty>

public enum GlobalProperty
extends Enum<GlobalProperty>

Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HELPPROMPT The help prompt to be spoken if the user needs assistance during a user-initiated interaction.
KEYBOARDPROPERTIES The on-screen keyboard configuration of setGlobalProperties
MENUICON The property in-app menu icon of setGlobalProperties
MENUNAME The property in-app menu name of setGlobalProperties
TIMEOUTPROMPT The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input.
USER_LOCATION The user seat location of setGlobalProperties
USERLOCATION Deprecated.
VRHELPITEMS The property array of vrHelp of setGlobalProperties
VRHELPTITLE The property vrHelpTitle of setGlobalProperties

Method Summary

Modifier and Type	Method and Description
static GlobalProperty	valueForString(String value) Convert String to GlobalProperty
static GlobalProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static GlobalProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HELPPROMPT

public static final GlobalProperty HELPPROMPT

The help prompt to be spoken if the user needs assistance during a user-initiated interaction.

TIMEOUTPROMPT

public static final GlobalProperty TIMEOUTPROMPT

The prompt to be spoken if the user-initiated interaction times out waiting for the user's verbal input.

VRHELPTITLE

public static final GlobalProperty VRHELPTITLE

The property vrHelpTitle of setGlobalProperties

VRHELPITEMS

public static final GlobalProperty VRHELPITEMS

The property array of vrHelp of setGlobalProperties

MENUNAME

public static final GlobalProperty MENUNAME

The property in-app menu name of setGlobalProperties

MENUICON

public static final GlobalProperty MENUICON

The property in-app menu icon of setGlobalProperties

KEYBOARDPROPERTIES

public static final GlobalProperty KEYBOARDPROPERTIES

The on-screen keyboard configuration of setGlobalProperties

USERLOCATION

@Deprecated
public static final GlobalProperty USERLOCATION

Deprecated.

USER_LOCATION

public static final GlobalProperty USER_LOCATION

The user seat location of setGlobalProperties

Method Detail

values

public static GlobalProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GlobalProperty c : GlobalProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GlobalProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueForString

public static GlobalProperty valueForString(String value)

Convert String to GlobalProperty

Parameters:

value - String

Returns:

GlobalProperty