com.bt.sdk.capabilities.session.conferencing
Class SessionConferencingManager

java.lang.Object
  extended by com.bt.sdk.capabilities.session.conferencing.SessionConferencingManager

public class SessionConferencingManager
extends java.lang.Object

Conference call offers a convenient way for two or more people to talk with each other at the same time. You initiate a call, bring people onto a call and remove people from the call, programmatically.


Constructor Summary
SessionConferencingManager()
           
 
Method Summary
 ConferenceCall createConference()
          Creates a new conference.
 void disconnectParticipant(java.lang.String participantId)
          Removes a participant from the conference.
 void endConference(java.lang.String conferenceId)
          Closes the conference call.
 com.bt.sdk.capabilities.session.conferencing.ConferenceInfo getConferenceInfo(java.lang.String conferenceId)
          Returns status information about the requested conference.
 com.bt.sdk.capabilities.session.conferencing.ParticipantInfos getParticipants(java.lang.String conferenceId)
          Returns status information about all the participants associated with this conference.
 java.lang.String inviteParticipant(java.lang.String conferenceId, java.lang.String participantUri)
          Invite a new participant to the conference.
 java.lang.String inviteParticipant(java.lang.String conferenceId, java.lang.String participantUri, int announcementType)
          Invite a new participant to the conference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionConferencingManager

public SessionConferencingManager()
Method Detail

createConference

public ConferenceCall createConference()
Creates a new conference. This must be called first before inviting participants.

Returns:
ConferenceCall

endConference

public void endConference(java.lang.String conferenceId)
Closes the conference call. Any active participants will be hung up.

Parameters:
conferenceId - The system generated conference call identifier.

getConferenceInfo

public com.bt.sdk.capabilities.session.conferencing.ConferenceInfo getConferenceInfo(java.lang.String conferenceId)
Returns status information about the requested conference.

Parameters:
conferenceId - The system generated conference call identifier.
Returns:
ConferenceInfo A databag that contains call information. Namely: duration, status, number of particpants, start time.

inviteParticipant

public java.lang.String inviteParticipant(java.lang.String conferenceId,
                                          java.lang.String participantUri)
Invite a new participant to the conference. This causes the participant to be called. If they answer the call they will be joined to the conference call.

Parameters:
conferenceId - The system generated conference call identifier.
participantUri - The string URI of the participant's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
Returns:
participantId The unique participant identifier.

inviteParticipant

public java.lang.String inviteParticipant(java.lang.String conferenceId,
                                          java.lang.String participantUri,
                                          int announcementType)
Invite a new participant to the conference. This causes the participant to be called. If they answer the call they will be joined to the conference call.

Parameters:
conferenceId - The system generated conference call identifier.
participantUri - The string URI of the participant's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
announcementType - Value indicating the type of announcement played on joining a conference. See the sdk portal for information on these values.
Returns:
participantId The unique participant identifier.

disconnectParticipant

public void disconnectParticipant(java.lang.String participantId)
Removes a participant from the conference. The participant's call will be hung up.

Parameters:
participantId - The unique participant identifier.

getParticipants

public com.bt.sdk.capabilities.session.conferencing.ParticipantInfos getParticipants(java.lang.String conferenceId)
Returns status information about all the participants associated with this conference. This includes all participants that have been on the conference i.e. it includes participants who have either left the call or have been disconnected.

Parameters:
conferenceId - The system generated conference call identifier.
Returns:
ParticipantInfos A Collection of ParticipantInfo objects.