com.bandwidth.sdk.model

Class Bridge

java.lang.Object

com.bandwidth.sdk.model.ModelBase

com.bandwidth.sdk.model.ResourceBase

com.bandwidth.sdk.model.Bridge

public class Bridge
extends ResourceBase

Information about a specific bridge

Author:

vpotapenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Bridge.NewBridgeAudioBuilder

Field Summary

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

client, id, properties

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

dateFormat

Constructor Summary

Constructors

Constructor and Description
Bridge(BandwidthClient client, org.json.simple.JSONObject jsonObject)

Method Summary

Methods

Modifier and Type	Method and Description
void	commit() Makes changes ob the bridge.
static Bridge	create(BandwidthClient client, Map<String,Object> params) Convenience factory method to create a Bridge object from a params maps
static Bridge	create(BandwidthClient client, String callId1, String callId2) Convenience method to create a Bridge object from two call ids
static Bridge	create(Call call1, Call call2) Convenience factory method to create a Bridge object from two Call objects
static Bridge	create(String id) Convenience factory method for Bridge, returns Bridge object from an id
static Bridge	create(String callId1, String callId2) Convenience factory method to create a Bridge object from two call ids
static Bridge	get(BandwidthClient client, String id) Convenience method to return a bridge object given a client and an id
static Bridge	get(String id) Convenience method to get information about a specific bridge.
Date	getActivatedTime()
List<Call>	getBridgeCalls() Gets list of calls that are on the bridge
String[]	getCallIds()
String	getCalls()
Date	getCompletedTime()
Date	getCreatedTime()
String	getState()
protected String	getUri()
boolean	isBridgeAudio()
static ResourceList<Bridge>	list() Factory method for Bridge list, returns list of Bridge objects with default page setting
static ResourceList<Bridge>	list(BandwidthClient client, int page, int size) Factory method for Bridge list, returns list of Bridge objects with page, size preference
static ResourceList<Bridge>	list(int page, int size) Factory method for Bridge list, returns list of Bridge objects with page, size preference
Bridge.NewBridgeAudioBuilder	newBridgeAudioBuilder() Creates new builder for playing an audio file or speaking a sentence in a bridge.
void	setBridgeAudio(boolean bridgeAudio) Sets bridge audio
void	setCallIds(String[] callIds) Sets call ids
protected void	setUp(org.json.simple.JSONObject jsonObject)
void	stopAudioFilePlaying() Stop an audio file playing.
void	stopSentence() Stop an audio sentence.
String	toString()

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

getClient, getId, getProperties, setId, toJSONArray, toJSONObject

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

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

Bridge

public Bridge(BandwidthClient client,
      org.json.simple.JSONObject jsonObject)

Method Detail

get

public static Bridge get(String id)
                  throws Exception

Convenience method to get information about a specific bridge. Returns a Bridge object given an id

Parameters:

id - bridge id

Returns:

information about a specific bridge

Throws:

IOException

Exception

get

public static Bridge get(BandwidthClient client,
         String id)
                  throws Exception

Convenience method to return a bridge object given a client and an id

Parameters:

client -

id -

Returns:

Throws:

IOException

Exception

create

public static Bridge create(String id)
                     throws Exception

Convenience factory method for Bridge, returns Bridge object from an id

Parameters:

callId -

Returns:

Throws:

IOException

Exception

create

public static Bridge create(Call call1,
            Call call2)
                     throws Exception

Convenience factory method to create a Bridge object from two Call objects

Parameters:

call1 -

call2 -

Returns:

Throws:

IOException

Exception

create

public static Bridge create(String callId1,
            String callId2)
                     throws Exception

Convenience factory method to create a Bridge object from two call ids

Parameters:

callId1 -

callId2 -

Returns:

Throws:

IOException

Exception

create

public static Bridge create(BandwidthClient client,
            String callId1,
            String callId2)
                     throws Exception

Convenience method to create a Bridge object from two call ids

Parameters:

callId1 -

callId2 -

Returns:

Throws:

IOException

Exception

create

public static Bridge create(BandwidthClient client,
            Map<String,Object> params)
                     throws Exception

Convenience factory method to create a Bridge object from a params maps

Parameters:

callId1 -

callId2 -

Returns:

Throws:

IOException

Exception

list

public static ResourceList<Bridge> list()
                                 throws IOException

Factory method for Bridge list, returns list of Bridge objects with default page setting

Returns:

Throws:

IOException

list

public static ResourceList<Bridge> list(int page,
                        int size)
                                 throws IOException

Factory method for Bridge list, returns list of Bridge objects with page, size preference

Parameters:

page -

size -

Returns:

Throws:

IOException

list

public static ResourceList<Bridge> list(BandwidthClient client,
                        int page,
                        int size)
                                 throws IOException

Factory method for Bridge list, returns list of Bridge objects with page, size preference

Parameters:

page -

size -

Returns:

Throws:

IOException

setUp

protected void setUp(org.json.simple.JSONObject jsonObject)

Specified by:

setUp in class ResourceBase

getUri

protected String getUri()

getBridgeCalls

public List<Call> getBridgeCalls()
                          throws Exception

Gets list of calls that are on the bridge

Returns:

list of calls

Throws:

IOException

Exception

setCallIds

public void setCallIds(String[] callIds)

Sets call ids

Parameters:

callIds - new value

setBridgeAudio

public void setBridgeAudio(boolean bridgeAudio)

Sets bridge audio

Parameters:

bridgeAudio - new value

commit

public void commit()
            throws IOException

Makes changes ob the bridge.

Throws:

IOException

getState

public String getState()

getCallIds

public String[] getCallIds()

getCalls

public String getCalls()

isBridgeAudio

public boolean isBridgeAudio()

getCompletedTime

public Date getCompletedTime()

getCreatedTime

public Date getCreatedTime()

getActivatedTime

public Date getActivatedTime()

newBridgeAudioBuilder

public Bridge.NewBridgeAudioBuilder newBridgeAudioBuilder()

Creates new builder for playing an audio file or speaking a sentence in a bridge.
Example:
bridge.newBridgeAudioBuilder().sentence("Hello").create();

Returns:

new builder

stopAudioFilePlaying

public void stopAudioFilePlaying()
                          throws IOException

Stop an audio file playing.

Throws:

IOException

stopSentence

public void stopSentence()
                  throws IOException

Stop an audio sentence.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object