com.smartdevicelink.proxy.rpc.enums

Enum SystemContext

java.lang.Object

java.lang.Enum<SystemContext>

com.smartdevicelink.proxy.rpc.enums.SystemContext

All Implemented Interfaces:

Serializable, Comparable<SystemContext>

public enum SystemContext
extends Enum<SystemContext>

Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR).

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
SYSCTXT_ALERT Broadcast only to whichever app has an alert currently being displayed.
SYSCTXT_HMI_OBSCURED The app's display HMI is currently being obscured by either a system or other app's overlay.
SYSCTXT_MAIN No user interaction (user-initiated or app-initiated) is in progress.
SYSCTXT_MENU Menu-oriented, user-initiated or app-initiated interaction is in-progress.
SYSCTXT_VRSESSION VR-oriented, user-initiated or app-initiated interaction is in-progress.

Method Summary

Modifier and Type	Method and Description
String	toString()
static SystemContext	valueForString(String value)
static SystemContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemContext[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYSCTXT_MAIN

public static final SystemContext SYSCTXT_MAIN

No user interaction (user-initiated or app-initiated) is in progress.

Since:

SmartDeviceLink 1.0

SYSCTXT_VRSESSION

public static final SystemContext SYSCTXT_VRSESSION

VR-oriented, user-initiated or app-initiated interaction is in-progress.

Since:

SmartDeviceLink 1.0

SYSCTXT_MENU

public static final SystemContext SYSCTXT_MENU

Menu-oriented, user-initiated or app-initiated interaction is in-progress.

Since:

SmartDeviceLink 1.0

SYSCTXT_HMI_OBSCURED

public static final SystemContext SYSCTXT_HMI_OBSCURED

The app's display HMI is currently being obscured by either a system or other app's overlay.

Since:

SmartDeviceLink 2.0

SYSCTXT_ALERT

public static final SystemContext SYSCTXT_ALERT

Broadcast only to whichever app has an alert currently being displayed.

Since:

SmartDeviceLink 2.0

Method Detail

values

public static SystemContext[] 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 (SystemContext c : SystemContext.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemContext 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

toString

public String toString()

Overrides:

toString in class Enum<SystemContext>

valueForString

public static SystemContext valueForString(String value)