com.adobe.connectpro.telephony.adaptor
Enum UserOption

java.lang.Object
  extended by java.lang.Enum<UserOption>
      extended by com.adobe.connectpro.telephony.adaptor.UserOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UserOption>

public enum UserOption
extends java.lang.Enum<UserOption>

Phone user options.


Enum Constant Summary
HOLD
          Places the phone user on hold.
MIC_LEVEL
          Sets the volume level of a phone user input in the conference.
MUTE
          Mutes the phone user.
PAUSE
          Pauses the phone user's video.
 
Field Summary
static java.lang.String VALUE_HIGH
          High volume level for MIC_LEVEL option
static java.lang.String VALUE_LOW
          Low volume level for MIC_LEVEL option
static java.lang.String VALUE_NORMAL
          Normal volume level for MIC_LEVEL option
 
Method Summary
 java.lang.String toString()
          String value of the enum constant
static UserOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UserOption valueOfCustom(java.lang.String customName)
          Returns the enum constant based on String value of the same
static UserOption[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

MUTE

public static final UserOption MUTE
Mutes the phone user. This is an on/off option with value 'true', 'false'


HOLD

public static final UserOption HOLD
Places the phone user on hold. This is an on/off option with value 'true', 'false'


PAUSE

public static final UserOption PAUSE
Pauses the phone user's video. This is an on/off option with value 'true', 'false'


MIC_LEVEL

public static final UserOption MIC_LEVEL
Sets the volume level of a phone user input in the conference. Possible values high, normal, low

Field Detail

VALUE_HIGH

public static final java.lang.String VALUE_HIGH
High volume level for MIC_LEVEL option

See Also:
Constant Field Values

VALUE_NORMAL

public static final java.lang.String VALUE_NORMAL
Normal volume level for MIC_LEVEL option

See Also:
Constant Field Values

VALUE_LOW

public static final java.lang.String VALUE_LOW
Low volume level for MIC_LEVEL option

See Also:
Constant Field Values
Method Detail

values

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

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

valueOf

public static UserOption valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()
String value of the enum constant

Overrides:
toString in class java.lang.Enum<UserOption>

valueOfCustom

public static UserOption valueOfCustom(java.lang.String customName)
Returns the enum constant based on String value of the same