|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.phone") @RpcInterface(value="ucp.v30.requests.phone") @RpcValueTranslation(version=30) public interface UciPhoneRequests
This interface defines the phone requests provided by the UCI server.
| Method Summary | |
|---|---|
List<PhoneNumber> |
getAvailableDisplayNumbers()
This request allows the UCI client to obtain a list of phone number that are available to be set as display number for the user. |
boolean |
getCallWaitingIndication()
This request allows the UCI client to check if the call waiting indication is used for simultaneous phone calls. |
String |
getDisplayNumberId()
This request allows the UCI client to retrieve the phone number that is signaled to the other party during a call on an outgoing line. |
List<String> |
getPhoneIds()
The UCI client may call getPhoneIds to have the server send a response with a list of telephone ids of the phones assigned to the user. |
String |
getPrimaryPhoneId()
This request allows the UCI client to retrieve the id of the primary phone of the user. |
boolean |
isSipPhoneInUse(SoftPhoneSetting softPhoneSetting)
This request allows the UCI client to check wether a SipPhone with the softPhoneId of the given SoftPhoneSetting is currently registered for the user. |
SoftPhoneConfig |
registerSipPhone(SoftPhoneSetting softPhoneSetting)
This request allows the UCI client to get SIP credentials for a SoftPhone. |
void |
setCallWaitingIndication(boolean callWaitingIndication)
This request allows the UCI client to configure the usage of call waiting indication for simultaneous phone calls. |
void |
setDisplayNumberId(String phoneNumberId)
This request allows the UCI client to set the phone number that is signaled to the other party during a call on an outgoing line. |
void |
setPrimaryPhoneId(String phoneId)
This request allows the UCI client to set the primary phone of the user. |
| Method Detail |
|---|
List<String> getPhoneIds()
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).
String getPrimaryPhoneId()
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 setPrimaryPhoneId(String phoneId)
throws UciException
phoneId - the id of the primary phone to be set. This can be any id obtained by
getPhoneIds()
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).
String getDisplayNumberId()
throws UciException
String if
the display number is being suppressed. Possible values can be retrieved using
getAvailableDisplayNumbers() request.
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 setDisplayNumberId(String phoneNumberId)
throws UciException
phoneNumberId - the id of the phone number to be set as display number or an empty String if
the display number should be suppressed. Possible values can be retrieved using
getAvailableDisplayNumbers() request.
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<PhoneNumber> getAvailableDisplayNumbers()
throws UciException
List of PhoneNumber containing the phone numbers
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).
boolean getCallWaitingIndication()
throws UciException
true if call waiting indication is active, false otherwise
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 setCallWaitingIndication(boolean callWaitingIndication)
throws UciException
callWaitingIndication - a flag indicating if call waiting indication should be activated or deactivated.
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).
boolean isSipPhoneInUse(SoftPhoneSetting softPhoneSetting)
throws UciException
softPhoneSetting - the SoftPhoneSetting that identifies the requested SoftPhone by its
softPhoneId, other fields of the SoftPhoneSetting will be ignored
UciException
SoftPhoneConfig registerSipPhone(SoftPhoneSetting softPhoneSetting)
throws UciException
softPhoneSetting - the SoftPhoneSetting that identifies the requested SoftPhone
UciException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||