com.bandwidth.sdk.model

Class Conference

java.lang.Object

com.bandwidth.sdk.model.ModelBase

com.bandwidth.sdk.model.BaseModelObject

com.bandwidth.sdk.model.Conference

public class Conference
extends BaseModelObject

Information about conference.

Author:

vpotapenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Conference.ConferenceAudioBuilder

Field Summary

Fields inherited from class com.bandwidth.sdk.model.BaseModelObject

client

Fields inherited from class com.bandwidth.sdk.model.ModelBase

dateFormat, properties

Constructor Summary

Constructors

Constructor and Description
Conference(BandwidthRestClient client, org.json.simple.JSONObject jsonObject)

Method Summary

Methods

Modifier and Type	Method and Description
void	complete() Terminates conference.
Conference.ConferenceAudioBuilder	conferenceAudioBuilder() Creates new builder for playing an audio file or speaking a sentence in a conference.
static Conference	createConference(BandwidthRestClient client, Map<String,Object> params) Factory method to create a conference given a set of params and a client object
static Conference	createConference(Map<String,Object> params) Factory method to create a conference given a set of params
Long	getActiveMembers()
Long	getCallbackTimeout()
String	getCallbackUrl()
Date	getCompletedTime()
static Conference	getConference(BandwidthRestClient client, String id) Retrieves the conference information.
static Conference	getConference(String id) Retrieves the conference information.
Date	getCreatedTime()
String	getFallbackUrl()
String	getFrom()
List<ConferenceMember>	getMembers() Gets list all members from a conference.
String	getState()
protected String	getUri()
void	mute() Prevent all members from speaking.
String	toString()

Methods inherited from class com.bandwidth.sdk.model.BaseModelObject

getClient

Methods inherited from class com.bandwidth.sdk.model.ModelBase

getId, getProperty, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, putProperty, toMap, updateProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Conference

public Conference(BandwidthRestClient client,
          org.json.simple.JSONObject jsonObject)

Method Detail

getConference

public static Conference getConference(String id)
                                throws IOException

Retrieves the conference information.

Parameters:

id - conference id

Returns:

conference information.

Throws:

IOException

getConference

public static Conference getConference(BandwidthRestClient client,
                       String id)
                                throws IOException

Retrieves the conference information.

Parameters:

id - conference id

Returns:

conference information.

Throws:

IOException

createConference

public static Conference createConference(Map<String,Object> params)
                                   throws IOException

Factory method to create a conference given a set of params

Parameters:

params -

Returns:

Throws:

IOException

createConference

public static Conference createConference(BandwidthRestClient client,
                          Map<String,Object> params)
                                   throws IOException

Factory method to create a conference given a set of params and a client object

Parameters:

params -

Returns:

Throws:

IOException

getUri

protected String getUri()

Specified by:

getUri in class BaseModelObject

getFrom

public String getFrom()

getCallbackUrl

public String getCallbackUrl()

getFallbackUrl

public String getFallbackUrl()

getState

public String getState()

getActiveMembers

public Long getActiveMembers()

getCallbackTimeout

public Long getCallbackTimeout()

getCompletedTime

public Date getCompletedTime()

getCreatedTime

public Date getCreatedTime()

complete

public void complete()
              throws IOException

Terminates conference.

Throws:

IOException

mute

public void mute()
          throws IOException

Prevent all members from speaking.

Throws:

IOException

getMembers

public List<ConferenceMember> getMembers()
                                  throws IOException

Gets list all members from a conference. If a member had already hung up or removed from conference it will be displayed as completed.

Returns:

list of members

Throws:

IOException

conferenceAudioBuilder

public Conference.ConferenceAudioBuilder conferenceAudioBuilder()

Creates new builder for playing an audio file or speaking a sentence in a conference.
Example:
conference.conferenceAudioBuilder().fileUrl("url_to_file").create();

Returns:

new builder

toString

public String toString()

Overrides:

toString in class Object