com.smartdevicelink.proxy.rpc.enums

Enum InteractionMode

java.lang.Object

java.lang.Enum<InteractionMode>

com.smartdevicelink.proxy.rpc.enums.InteractionMode

All Implemented Interfaces:

Serializable, Comparable<InteractionMode>

public enum InteractionMode
extends Enum<InteractionMode>

For application-initiated interactions (PerformInteraction), this specifies the mode by which the user is prompted and by which the user's selection is indicated

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly.
MANUAL_ONLY This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display.
VR_ONLY This mode causes the interaction to occur only through TTS and VR.

Method Summary

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

MANUAL_ONLY

public static final InteractionMode MANUAL_ONLY

This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User's selection is indicated with the OK button

VR_ONLY

public static final InteractionMode VR_ONLY

This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice's synonyms

BOTH

public static final InteractionMode BOTH

This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY. If the user views selections as described in MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the interaction itself is still in progress). If the user interacts with the VR session in any way (e.g. speaks a phrase, even if it is not a recognized choice), the interaction becomes strictly, and irreversibly, a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no longer be honored)

The TriggerSource parameter of the PerformInteraction response will indicate which interaction mode the user finally chose to attempt the selection (even if the interaction did not end with a selection being made)

Method Detail

values

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

Returns:

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

valueOf

public static InteractionMode 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 InteractionMode valueForString(String value)

Returns InteractionMode (MANUAL_ONLY, VR_ONLY or BOTH)

Parameters:

value - a String

Returns:

InteractionMode -MANUAL_ONLY, VR_ONLY or BOTH