com.bandwidth.sdk.model

Class Message

java.lang.Object

com.bandwidth.sdk.model.ModelBase

com.bandwidth.sdk.model.ResourceBase

com.bandwidth.sdk.model.Message

public class Message
extends ResourceBase

Information about message.

Author:

vpotapenko

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
Message(BandwidthClient client, org.json.simple.JSONObject jsonObject)

Method Summary

Methods

Modifier and Type	Method and Description
static Message	create(BandwidthClient client, Map<String,Object> params) Factory method to send a message from a params object, given a client instance
static Message	create(Map<String,Object> params) Convenience factory method to send a message, given a set of params
static Message	create(String to, String from, String text) Convenience factory method to send a message, given the to number, the from number and the text
static Message	create(String to, String from, String text, MediaFile media) Convenience factory method to send MMS messages.
static Message	create(String to, String from, String text, ReceiptRequest receiptRequest) Convenience factory method to send a message with receipt, given the to number, the from number and the text
static Message	get(BandwidthClient client, String id) Gets information about a previously sent or received message.
static Message	get(String id) Gets information about a previously sent or received message.
Long	getCallbackTimeout()
String	getCallbackUrl()
String	getDirection()
String	getFallbackUrl()
String	getFrom()
String	getMessageId()
String	getReceiptRequested()
String	getState()
String	getText()
Date	getTime()
String	getTo()
protected String	getUri()
static ResourceList<Message>	list() Factory method for Message list, returns a list of Message objects with default page, size
static ResourceList<Message>	list(BandwidthClient client, int page, int size) Factory method for Message list, returns a list of Message objects with page, size preference
static ResourceList<Message>	list(int page, int size) Factory method for Message list, returns a list of Message objects with page, size preference
protected void	setUp(org.json.simple.JSONObject jsonObject)
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

Message

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

Method Detail

get

public static Message get(String id)
                   throws Exception

Gets information about a previously sent or received message.

Parameters:

id - message id

Returns:

information about message

Throws:

IOException - unexpected error

Exception

get

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

Gets information about a previously sent or received message.

Parameters:

client - the client.

id - message id

Returns:

information about message

Throws:

IOException - unexpected error

Exception

list

public static ResourceList<Message> list()
                                  throws Exception

Factory method for Message list, returns a list of Message objects with default page, size

Returns:

the list

Throws:

IOException - unexpected error

Exception

list

public static ResourceList<Message> list(int page,
                         int size)
                                  throws Exception

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

Parameters:

page - the page

size - the page size

Returns:

the list

Throws:

IOException - unexpected error

Exception

list

public static ResourceList<Message> list(BandwidthClient client,
                         int page,
                         int size)
                                  throws Exception

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

Parameters:

client - the client.

page - the page

size - the page size

Returns:

the list

Throws:

IOException - unexpected error

Exception

create

public static Message create(String to,
             String from,
             String text)
                      throws Exception

Convenience factory method to send a message, given the to number, the from number and the text

Parameters:

to - the from number

from - the to number

text - the text

Returns:

the message

Throws:

IOException - unexpected error

Exception

create

public static Message create(String to,
             String from,
             String text,
             ReceiptRequest receiptRequest)
                      throws Exception

Convenience factory method to send a message with receipt, given the to number, the from number and the text

Parameters:

to - the from number

from - the to number

text - the text

receiptRequest - the receipt request option

Returns:

the message

Throws:

IOException - unexpected error

Exception

create

public static Message create(String to,
             String from,
             String text,
             MediaFile media)
                      throws Exception

Convenience factory method to send MMS messages. Create a MediaFile object using the Media upload method and pass that in.

Parameters:

to - the from number

from - the to number

text - the text

media - the media

Returns:

the message

Throws:

Exception - error.

create

public static Message create(Map<String,Object> params)
                      throws Exception

Convenience factory method to send a message, given a set of params

Parameters:

params - the params

Returns:

the message

Throws:

IOException - unexpected error

Exception

create

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

Factory method to send a message from a params object, given a client instance

Parameters:

client - the client

params - the params

Returns:

the message

Throws:

IOException - unexpected error

Exception

setUp

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

Specified by:

setUp in class ResourceBase

getUri

protected String getUri()

getMessageId

public String getMessageId()

getFrom

public String getFrom()

getTo

public String getTo()

getState

public String getState()

getDirection

public String getDirection()

getCallbackUrl

public String getCallbackUrl()

getFallbackUrl

public String getFallbackUrl()

getText

public String getText()

getTime

public Date getTime()

getCallbackTimeout

public Long getCallbackTimeout()

getReceiptRequested

public String getReceiptRequested()

toString

public String toString()

Overrides:

toString in class Object