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

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

public class ConferenceCall
extends java.lang.Object

Data representing a Conference Call.


Constructor Summary
ConferenceCall()
          Default Constructor
 
Method Summary
 void disconnectParticipant(java.lang.String participantId)
          Disconnects an active participant from the conference call.
 void endConference()
          Terminates the active conference.
 java.lang.String getConferenceId()
           
 com.bt.sdk.capabilities.session.conferencing.ConferenceInfo getConferenceInfo()
           
 java.util.Collection<com.bt.sdk.capabilities.session.conferencing.ParticipantInfo> getParticipantInfos()
           
 java.lang.String inviteParticipant(java.lang.String participantUri)
          Invites a participant to the call.
 java.lang.String inviteParticipant(java.lang.String participantUri, int announcementType)
          Invites a participant to the call.
 void setConferenceId(java.lang.String newValue)
           
 void setConferenceInfo(com.bt.sdk.capabilities.session.conferencing.ConferenceInfo newValue)
           
 void setParticipantInfos(java.util.Collection<com.bt.sdk.capabilities.session.conferencing.ParticipantInfo> newValue)
           
 void updateConferenceStatus()
          Updates the status of the conference from the service.
 void updateParticipants()
          Updates the list and information of the ParticipantInfos from the service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConferenceCall

public ConferenceCall()
Default Constructor

Method Detail

getConferenceId

public java.lang.String getConferenceId()
Returns:
conferenceId The system generated conference call identifier.

setConferenceId

public void setConferenceId(java.lang.String newValue)
Parameters:
conferenceId - The system generated conference call identifier.

getConferenceInfo

public com.bt.sdk.capabilities.session.conferencing.ConferenceInfo getConferenceInfo()
Returns:
conferenceInfo A databag that contains call information. Namely: duration, status, number of particpants, start time.

setConferenceInfo

public void setConferenceInfo(com.bt.sdk.capabilities.session.conferencing.ConferenceInfo newValue)
Parameters:
conferenceInfo - A databag that contains call information. Namely: duration, status, number of particpants, start time.

getParticipantInfos

public java.util.Collection<com.bt.sdk.capabilities.session.conferencing.ParticipantInfo> getParticipantInfos()
Returns:
participantInfos A Collection of ParticipantInfo objects.

setParticipantInfos

public void setParticipantInfos(java.util.Collection<com.bt.sdk.capabilities.session.conferencing.ParticipantInfo> newValue)
Parameters:
participantInfos - A Collection of ParticipantInfo objects.

updateConferenceStatus

public void updateConferenceStatus()
Updates the status of the conference from the service.


updateParticipants

public void updateParticipants()
Updates the list and information of the ParticipantInfos from the service.


inviteParticipant

public java.lang.String inviteParticipant(java.lang.String participantUri)
Invites a participant to the call. Then updates the ParticipantInfos and ConferenceInfo from the service.

Parameters:
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 participantUri,
                                          int announcementType)
Invites a participant to the call. Then updates the ParticipantInfos and ConferenceInfo from the service.

Parameters:
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)
Disconnects an active participant from the conference call. Then updates the ParticipantInfos and ConferenceInfo from the service.

Parameters:
participantId - The unique participant identifier.

endConference

public void endConference()
Terminates the active conference. Then updates the ConferenceInfo from the service.