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


@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

hangupCall

void hangupCall(String callId)
                throws UciException
This request tells the UCI server to hang up the call identified by the given UUID.

Parameters:
callId - the UUID of the call to be hung up
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).

transferToConference

void transferToConference(String roomId,
                          String uuidToTransfer)
                          throws UciException
This request tells the UCI server to transfer a call to a conference.

Parameters:
roomId - a conference room id.
uuidToTransfer - the call to be transfered to the conference.
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).

joinToConference

void joinToConference(String roomId,
                      String phone)
                      throws UciException
This request tells the UCI server to join a conference.

Parameters:
roomId - a conference room id.
phone - the phone to use.
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).

muteToConference

void muteToConference(String uuidConferenceCall,
                      boolean mute)
                      throws UciException
This request tells the UCI server to mute or unmute the call.

Parameters:
uuidConferenceCall - a call that is in the conference.
mute - set the mute option on or off on the uuidConferenceCall.
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).

listenToConference

void listenToConference(String uuidConferenceCall,
                        boolean listen)
                        throws UciException
This request tells the UCI server that the confernce call can hear or not hear the outher participants.

Parameters:
uuidConferenceCall - a call that is in the conference.
listen - set the listen option on or off on the uuidConferenceCall.
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).

wantToTalkToConference

void wantToTalkToConference(String uuidConferenceCall)
                            throws UciException
This request tells the UCI server that the confernce call wants to talk.

Parameters:
uuidConferenceCall - a call that is in the conference.
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).

callNumberToConference

void callNumberToConference(String roomId,
                            String number)
                            throws UciException
This request tells the UCI server to call that the phone number into the conference.

Parameters:
roomId - a conference room id.
number - the phonenumber to add to conference.
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).

leaveConference

void leaveConference(String roomId)
                     throws UciException
This request tells the UCI server to leave the conference.

Parameters:
roomId - a conference room id.
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).

quitConference

void quitConference(String roomId)
                    throws UciException
This request tells the UCI server to quit the conference.

Parameters:
roomId - a conference room id.
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).

getAllConferences

List<String> getAllConferences()
                               throws UciException
This request tells the UCI server to get all conference ids.

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

getAllConferenceCallsInRoom

List<ConferenceCall> getAllConferenceCallsInRoom(String roomId)
                                                 throws UciException
This request tells the UCI server to get all conference call ids.

Parameters:
roomId - the conference room id.
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).

allHearInRoom

void allHearInRoom(String roomId)
                   throws UciException
This request tells the UCI server to set all conference participants to hear.

Parameters:
roomId - the conference room id.
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).

allCanSpeakInRoom

void allCanSpeakInRoom(String roomId)
                       throws UciException
This request tells the UCI server to enable speaking on all participants.

Parameters:
roomId - the conference room id.
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).

onlyOneCanSpeakInRoom

void onlyOneCanSpeakInRoom(String uuidConferenceCall)
                           throws UciException
This request tells the UCI server to enable speaking for one participant.

Parameters:
uuidConferenceCall - a call that is in the conference.
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).

startManagedConferenceById

void startManagedConferenceById(String conferenceId,
                                String phoneId)
                                throws UciException
This request tells the UCI server to start the conference with the given id. If no conferenceId is given a conference is startet with the given phone.

Parameters:
conferenceId - id of the conference.
phoneId - phone to dial to the conference.
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.