|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.conferencecall") @RpcInterface(value="ucp.v30.requests.conferencecall") @RpcValueTranslation(version=30) public interface UciConferenceCallRequests
This interface defines the confrence call requests provided by the UCI server.
| Method Summary | |
|---|---|
void |
allCanSpeakInRoom(String roomId)
This request tells the UCI server to enable speaking on all participants. |
void |
allHearInRoom(String roomId)
This request tells the UCI server to set all conference participants to hear. |
void |
callNumberToConference(String roomId,
String number)
This request tells the UCI server to call that the phone number into the conference. |
List<ConferenceCall> |
getAllConferenceCallsInRoom(String roomId)
This request tells the UCI server to get all conference call ids. |
List<String> |
getAllConferences()
This request tells the UCI server to get all conference ids. |
void |
hangupCall(String callId)
This request tells the UCI server to hang up the call identified by the given UUID. |
void |
joinToConference(String roomId,
String phone)
This request tells the UCI server to join a conference. |
void |
leaveConference(String roomId)
This request tells the UCI server to leave the conference. |
void |
listenToConference(String uuidConferenceCall,
boolean listen)
This request tells the UCI server that the confernce call can hear or not hear the outher participants. |
void |
muteToConference(String uuidConferenceCall,
boolean mute)
This request tells the UCI server to mute or unmute the call. |
void |
onlyOneCanSpeakInRoom(String uuidConferenceCall)
This request tells the UCI server to enable speaking for one participant. |
void |
quitConference(String roomId)
This request tells the UCI server to quit the conference. |
void |
startManagedConferenceById(String conferenceId,
String phoneId)
This request tells the UCI server to start the conference with the given id. |
void |
transferToConference(String roomId,
String uuidToTransfer)
This request tells the UCI server to transfer a call to a conference. |
void |
wantToTalkToConference(String uuidConferenceCall)
This request tells the UCI server that the confernce call wants to talk. |
| Method Detail |
|---|
void hangupCall(String callId)
throws UciException
callId - the UUID of the call to be hung up
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).
void transferToConference(String roomId,
String uuidToTransfer)
throws UciException
roomId - a conference room id.uuidToTransfer - the call to be transfered to the conference.
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).
void joinToConference(String roomId,
String phone)
throws UciException
roomId - a conference room id.phone - the phone to use.
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).
void muteToConference(String uuidConferenceCall,
boolean mute)
throws UciException
uuidConferenceCall - a call that is in the conference.mute - set the mute option on or off on the uuidConferenceCall.
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).
void listenToConference(String uuidConferenceCall,
boolean listen)
throws UciException
uuidConferenceCall - a call that is in the conference.listen - set the listen option on or off on the uuidConferenceCall.
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).
void wantToTalkToConference(String uuidConferenceCall)
throws UciException
uuidConferenceCall - a call that is in the conference.
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).
void callNumberToConference(String roomId,
String number)
throws UciException
roomId - a conference room id.number - the phonenumber to add to conference.
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).
void leaveConference(String roomId)
throws UciException
roomId - a conference room id.
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).
void quitConference(String roomId)
throws UciException
roomId - a conference room id.
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<String> getAllConferences()
throws UciException
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<ConferenceCall> getAllConferenceCallsInRoom(String roomId)
throws UciException
roomId - the conference room id.
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).
void allHearInRoom(String roomId)
throws UciException
roomId - the conference room id.
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).
void allCanSpeakInRoom(String roomId)
throws UciException
roomId - the conference room id.
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).
void onlyOneCanSpeakInRoom(String uuidConferenceCall)
throws UciException
uuidConferenceCall - a call that is in the conference.
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).
void startManagedConferenceById(String conferenceId,
String phoneId)
throws UciException
conferenceId - id of the conference.phoneId - phone to dial to the conference.
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 | |||||||||