de.starface.integration.uci.java.v30.messages.requests
Interface UciPhoneRequests


@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

getPhoneIds

List<String> getPhoneIds()
                         throws UciException
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.

Returns:
a list of strings representing the ids of the users telephones
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).

getPrimaryPhoneId

String getPrimaryPhoneId()
                         throws UciException
This request allows the UCI client to retrieve the id of the primary phone of the user. This is the phone that is used to place an outgoing call if no explicit phone is selected during the place call request.

Returns:
the id of the primary phone
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).

setPrimaryPhoneId

void setPrimaryPhoneId(String phoneId)
                       throws UciException
This request allows the UCI client to set the primary phone of the user. This is the phone that is used to place an outgoing call if no explicit phone is selected during the place call request.

Parameters:
phoneId - the id of the primary phone to be set. This can be any id obtained by getPhoneIds()
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).

getDisplayNumberId

String getDisplayNumberId()
                          throws UciException
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.

Returns:
the id of the phone number to be set as display number or an empty String if the display number is being suppressed. Possible values can be retrieved using getAvailableDisplayNumbers() 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).

setDisplayNumberId

void setDisplayNumberId(String phoneNumberId)
                        throws UciException
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.

Parameters:
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.
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).

getAvailableDisplayNumbers

List<PhoneNumber> getAvailableDisplayNumbers()
                                             throws UciException
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.

Returns:
a List of PhoneNumber containing the phone numbers
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).

getCallWaitingIndication

boolean getCallWaitingIndication()
                                 throws UciException
This request allows the UCI client to check if the call waiting indication is used for simultaneous phone calls.

Returns:
true if call waiting indication is active, false otherwise
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).

setCallWaitingIndication

void setCallWaitingIndication(boolean callWaitingIndication)
                              throws UciException
This request allows the UCI client to configure the usage of call waiting indication for simultaneous phone calls.

Parameters:
callWaitingIndication - a flag indicating if call waiting indication should be activated or deactivated.
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).

isSipPhoneInUse

boolean isSipPhoneInUse(SoftPhoneSetting softPhoneSetting)
                        throws UciException
This request allows the UCI client to check wether a SipPhone with the softPhoneId of the given SoftPhoneSetting is currently registered for the user.

Parameters:
softPhoneSetting - the SoftPhoneSetting that identifies the requested SoftPhone by its softPhoneId, other fields of the SoftPhoneSetting will be ignored
Returns:
true if the SipPhone is in use by another SoftPhone instance, otherwise false
Throws:
UciException

registerSipPhone

SoftPhoneConfig registerSipPhone(SoftPhoneSetting softPhoneSetting)
                                 throws UciException
This request allows the UCI client to get SIP credentials for a SoftPhone. If the requested SoftPhone has not already been registered a new SoftPhone will be autoprovisioned and assigned to the user.

Parameters:
softPhoneSetting - the SoftPhoneSetting that identifies the requested SoftPhone
Returns:
the SoftPhoneConfig holding SIP credentials for the requested SoftPhone
Throws:
UciException


Copyright © 2012 STARFACE GmbH. All rights reserved.