de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UcpFunctionKeyRequests


@RpcInterface(value="ucp.v30.requests.functionKey")
@UciService(value="ucp.v30.requests.functionKey")
public interface UcpFunctionKeyRequests

This interface defines the function key requests provided by the UCI server.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 Map<String,Object> getALLFunctionKeys()
          This request allows the UCI client to retrieve all function keys.
 List<Map<String,Object>> getCallInfoForKey(String functionKeyId)
          This request allows the UCI client to query information about the calls currently being held or received by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.
 Map<String,Object> getContactInfoForKey(String functionKeyId)
          This request allows the UCI client to query the contact information of the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.
 List<Map<String,Object>> getFunctionKeys()
          This request allows the UCI client to retrieve the function keys of the current user.
 Map<String,Object> getImageForKey(String functionKeyId)
          This request allows the UCI client to query the image of the key.
 List<Map<String,Object>> getRedirectSettingsForKey(String functionKeyId)
          This request allows the UCI client to query which redirect always settings have been activated by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.
 void pressKey(String functionKeyId, List<Object> parameters)
          This request allows the UCI client to virtually press a function key of the current user.
 Map<String,Object> searchFunctionKeys(String searchTerm, String searchId)
          This request allows the UCI client to retrieve the function keys containing the given term in name or phone number.
 Map<String,Object> searchFunctionKeysByEmail(String emailAddress, String searchId)
          This request allows the UCI client to retrieve the function keys by email address.
 Map<String,Object> searchFunctionKeysByJabberId(String jabberId, String searchId)
          This request allows the UCI client to retrieve the function keys by jabber id.
 void terminateSearchRequest(String searchId)
          To unsubscribe a search Request.
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

getFunctionKeys

List<Map<String,Object>> getFunctionKeys()
                                         throws UciException
This request allows the UCI client to retrieve the function keys of the current user.

Returns:
A List of Map containing the function keys with the values as defined in FunctionKeyProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getALLFunctionKeys

Map<String,Object> getALLFunctionKeys()
                                      throws UciException
This request allows the UCI client to retrieve all function keys.

Returns:
A List of Map containing the function keys with the values as defined in FunctionKeyProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

terminateSearchRequest

void terminateSearchRequest(String searchId)
                            throws UciException
To unsubscribe a search Request.

Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

searchFunctionKeys

Map<String,Object> searchFunctionKeys(String searchTerm,
                                      String searchId)
                                      throws UciException
This request allows the UCI client to retrieve the function keys containing the given term in name or phone number.

Parameters:
searchId - an existing search id or null if requesting a new one
searchTerm - string to search for in name or phone number
Returns:
A List of FunctionKey containing the function keys
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

searchFunctionKeysByJabberId

Map<String,Object> searchFunctionKeysByJabberId(String jabberId,
                                                String searchId)
                                                throws UciException
This request allows the UCI client to retrieve the function keys by jabber id. It is necessary to search with the whole jabberId.

Parameters:
jabberId - string to search for in jabber id
searchId - an existing search id or null if requesting a new one
Returns:
A List of FunctionKey containing the function keys
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

searchFunctionKeysByEmail

Map<String,Object> searchFunctionKeysByEmail(String emailAddress,
                                             String searchId)
                                             throws UciException
This request allows the UCI client to retrieve the function keys by email address. It is necessary to search with the whole email address.

Parameters:
emailAddress - string to search for in email address
searchId - an existing search id or null if requesting a new one
Returns:
A List of FunctionKey containing the function keys
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

pressKey

void pressKey(String functionKeyId,
              List<Object> parameters)
              throws UciException
This request allows the UCI client to virtually press a function key of the current user. A function key press usually leads to an action on the server depending on the FunctionKeyType of the key.

Parameters:
functionKeyId - the id of the function key to be pressed.
parameters - additional parameters used to modify the behavior of the action to be activated upon the key press. The meaning of the parameters depends on the function key to be pressed. It is documented together with the FunctionKeyType.
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getRedirectSettingsForKey

List<Map<String,Object>> getRedirectSettingsForKey(String functionKeyId)
                                                   throws UciException
This request allows the UCI client to query which redirect always settings have been activated by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.

Parameters:
functionKeyId - the id of the function key to obtain the settings for
Returns:
a list with the redirect settings as List of Map containing values as defined in RedirectSettingProperties.
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getContactInfoForKey

Map<String,Object> getContactInfoForKey(String functionKeyId)
                                        throws UciException
This request allows the UCI client to query the contact information of the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.

Parameters:
functionKeyId - the id of the function key to obtain the contact information for
Returns:
the contact information of the user or group as Map containing values as defined in ContactInfoProperties.
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getCallInfoForKey

List<Map<String,Object>> getCallInfoForKey(String functionKeyId)
                                           throws UciException
This request allows the UCI client to query information about the calls currently being held or received by the user or group the key of type FunctionKeyType.BUSY_LAMP_FIELD shows the status of.

Parameters:
functionKeyId - the id of the function key to obtain the call information for
Returns:
the information about the calls in a List of Map with values as defined in CallInfoProperties.
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getImageForKey

Map<String,Object> getImageForKey(String functionKeyId)
                                  throws UciException
This request allows the UCI client to query the image of the key. A key has an image if its property FunctionKeyProperties.imageHash is not empty. Currently only keys of type FunctionKeyType.BUSY_LAMP_FIELD that show the status of a user can have an image which then is the avatar image of the user.

Parameters:
functionKeyId - the id of the function key to obtain the image for
Returns:
the image of the key as Map with values as defined by ImageProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or if the request with the given parameters is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).


Copyright © 2012 STARFACE GmbH. All rights reserved.