de.starface.integration.uci.java.v30.values
Enum UserStateProperties

java.lang.Object
  extended by java.lang.Enum<UserStateProperties>
      extended by de.starface.integration.uci.java.v30.values.UserStateProperties
All Implemented Interfaces:
Serializable, Comparable<UserStateProperties>

public enum UserStateProperties
extends Enum<UserStateProperties>

This enum holds constants with the names ot the properties of the user state as returned by UcpUserStateRequests.getUserState()


Enum Constant Summary
avatarHash
          The SHA-1 hash of the users avatar image as String if one is set.
chatPresence
          The current chat presence of the user as String with one of the values of ChatPresence
chatPresenceMessage
          The current chat presence message of the user as String
doNotDisturbSetting
          A Boolean flag indicating whether the user has DND set to active
redirectAlwaysActive
          A Boolean flag indicating whether the user has any redirect always settings enabled
telephonyState
          The current telephony state of the user as String with one of the values of TelephonyState.
 
Method Summary
 Class<?> getType()
           
static UserStateProperties valueOf(String name)
          Returns the enum constant of this type with the specified name.
static UserStateProperties[] 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

doNotDisturbSetting

public static final UserStateProperties doNotDisturbSetting
A Boolean flag indicating whether the user has DND set to active


redirectAlwaysActive

public static final UserStateProperties redirectAlwaysActive
A Boolean flag indicating whether the user has any redirect always settings enabled


chatPresence

public static final UserStateProperties chatPresence
The current chat presence of the user as String with one of the values of ChatPresence


chatPresenceMessage

public static final UserStateProperties chatPresenceMessage
The current chat presence message of the user as String


avatarHash

public static final UserStateProperties avatarHash
The SHA-1 hash of the users avatar image as String if one is set. The image itself can be queried with UcpUserStateRequests.getAvatarImage().


telephonyState

public static final UserStateProperties telephonyState
The current telephony state of the user as String with one of the values of TelephonyState.

Method Detail

values

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

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

valueOf

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

getType

public Class<?> getType()
Returns:
the java type of the property


Copyright © 2012 STARFACE GmbH. All rights reserved.