|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.functionKey") @RpcInterface(value="ucp.v30.requests.functionKey") @RpcValueTranslation(version=30) public interface UciFunctionKeyRequests
This interface defines the function key requests provided by the UCI server.
| Method Summary | |
|---|---|
FunctionKeySearchResult |
getAllFunctionKeys()
This request allows the UCI client to retrieve all function keys. |
List<CallInfo> |
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. |
ContactInfo |
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<FunctionKey> |
getFunctionKeys()
This request allows the UCI client to retrieve the function keys of the current user. |
Image |
getImageForKey(String functionKeyId)
This request allows the UCI client to query the image of the key. |
List<RedirectSetting> |
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,
Object... parameters)
This request allows the UCI client to virtually press a function key of the current user. |
FunctionKeySearchResult |
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. |
FunctionKeySearchResult |
searchFunctionKeysByEmail(String emailAddress,
String searchId)
This request allows the UCI client to retrieve the function keys by email address. |
FunctionKeySearchResult |
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. |
| Method Detail |
|---|
List<FunctionKey> getFunctionKeys()
throws UciException
List of FunctionKey containing the function keys
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).
FunctionKeySearchResult getAllFunctionKeys()
throws UciException
List of FunctionKey containing the function keys
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).
FunctionKeySearchResult searchFunctionKeys(String searchTerm,
String searchId)
throws UciException
searchId - an existing search id or null if requesting a new onesearchTerm - string to search for in name or phone number
List of FunctionKey containing the function keys
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).
FunctionKeySearchResult searchFunctionKeysByJabberId(String jabberId,
String searchId)
throws UciException
jabberId - string to search for in jabber idsearchId - an existing search id or null if requesting a new one
List of FunctionKey containing the function keys
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).
FunctionKeySearchResult searchFunctionKeysByEmail(String emailAddress,
String searchId)
throws UciException
emailAddress - string to search for in email addresssearchId - an existing search id or null if requesting a new one
List of FunctionKey containing the function keys
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).
void terminateSearchRequest(String searchId)
throws UciException
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).
void pressKey(String functionKeyId,
Object... parameters)
throws UciException
FunctionKeyType of the key.
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.
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).
List<RedirectSetting> getRedirectSettingsForKey(String functionKeyId)
throws UciException
FunctionKeyType.BUSY_LAMP_FIELD shows
the status of.
functionKeyId - the id of the function key to obtain the settings for
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).
ContactInfo getContactInfoForKey(String functionKeyId)
throws UciException
FunctionKeyType.BUSY_LAMP_FIELD shows the status of.
functionKeyId - the id of the function key to obtain the contact information for
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).
List<CallInfo> getCallInfoForKey(String functionKeyId)
throws UciException
FunctionKeyType.BUSY_LAMP_FIELD
shows the status of.
functionKeyId - the id of the function key to obtain the call information for
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).
Image getImageForKey(String functionKeyId)
throws UciException
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.
functionKeyId - the id of the function key to obtain the image for
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).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||