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

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

public enum FunctionKeyProperties
extends Enum<FunctionKeyProperties>

This enum holds constants with the property names of the function keys as returned by UcpFunctionKeyRequests.getFunctionKeys().


Enum Constant Summary
chatId
          The Xmpp chat id of the corresponding user as String
email
          The email address of the corresponding account.
fax
          The fax number of the corresponding account.
homePhoneNumber
          The home phone number of the corresponding account.
id
          The id of the function key as String
imageHash
          The hash of the key's image if an image is assigned to the key the image itself can then be requested using UcpFunctionKeyRequests.getImageForKey(String)
internalPhoneNumber
          The internal number of the corresponding account.
mobilePhoneNumber
          The mobile phone number of the corresponding account.
name
          The display name of the function key as String
phoneNumber
          The phone number of the corresponding account.
phoneNumber2
          The second phone number of the corresponding account.
position
          The position of the key in the users function key settings
state
          The state of the function key with one of the constants of FunctionKeyState as String
type
          The type of the function key with one of the constants of FunctionKeyType as String
userState
          The user state of the function key if the key is of type FunctionKeyType.BUSY_LAMP_FIELD as a Map containing values for the keys defined in UserStateProperties
 
Method Summary
 Class<?> getType()
           
static FunctionKeyProperties valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FunctionKeyProperties[] 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

id

public static final FunctionKeyProperties id
The id of the function key as String


name

public static final FunctionKeyProperties name
The display name of the function key as String


state

public static final FunctionKeyProperties state
The state of the function key with one of the constants of FunctionKeyState as String


type

public static final FunctionKeyProperties type
The type of the function key with one of the constants of FunctionKeyType as String


chatId

public static final FunctionKeyProperties chatId
The Xmpp chat id of the corresponding user as String


userState

public static final FunctionKeyProperties userState
The user state of the function key if the key is of type FunctionKeyType.BUSY_LAMP_FIELD as a Map containing values for the keys defined in UserStateProperties


imageHash

public static final FunctionKeyProperties imageHash
The hash of the key's image if an image is assigned to the key the image itself can then be requested using UcpFunctionKeyRequests.getImageForKey(String)


position

public static final FunctionKeyProperties position
The position of the key in the users function key settings


email

public static final FunctionKeyProperties email
The email address of the corresponding account.


phoneNumber

public static final FunctionKeyProperties phoneNumber
The phone number of the corresponding account.


phoneNumber2

public static final FunctionKeyProperties phoneNumber2
The second phone number of the corresponding account.


mobilePhoneNumber

public static final FunctionKeyProperties mobilePhoneNumber
The mobile phone number of the corresponding account.


homePhoneNumber

public static final FunctionKeyProperties homePhoneNumber
The home phone number of the corresponding account.


internalPhoneNumber

public static final FunctionKeyProperties internalPhoneNumber
The internal number of the corresponding account.


fax

public static final FunctionKeyProperties fax
The fax number of the corresponding account.

Method Detail

values

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

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

valueOf

public static FunctionKeyProperties 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.