com.twilio.chat

Class Message.Options

java.lang.Object

com.twilio.chat.Message.Options

Enclosing class:

Message

public static final class Message.Options
extends java.lang.Object

Used to construct new message before sending.

To avoid races between message create and send the SDK first collects all information about the message to create and then creates and sends the message in a single operation.

There are two major types of messages: TEXT and MEDIA.

Method Summary

Modifier and Type	Method and Description
Message.Options	withAttributes(org.json.JSONObject attributes) Set new message attributes.
Message.Options	withBody(java.lang.String body) Create message with given body text.
Message.Options	withMedia(java.io.InputStream in, java.lang.String mimeType) Create message with given media stream.
Message.Options	withMediaFileName(java.lang.String filename) Provide optional filename for media.
Message.Options	withMediaProgressListener(ProgressListener listener) Set upload progress listener for media.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withBody

public Message.Options withBody(java.lang.String body)

Create message with given body text. If you specify withBody() then you will not be able to specify withMedia(java.io.InputStream, java.lang.String) because they are mutually exclusive message types. Created message type will be Message.Type.TEXT.

Parameters:

body - Message text body.

Returns:

Options object for chaining.

withAttributes

public Message.Options withAttributes(org.json.JSONObject attributes)

Set new message attributes.

Parameters:

attributes - Attributes for the message as a JSON object.

Returns:

Options object for chaining.

withMedia

public Message.Options withMedia(java.io.InputStream in,
                                 java.lang.String mimeType)

Create message with given media stream. If you specify withMedia() then you will not be able to specify withBody(java.lang.String) because they are mutually exclusive message types. Created message type will be Message.Type.MEDIA.

Parameters:

in - Input stream to read media data from. Provided stream could be any subclass of java.io.InputStream inluding ByteArrayInputStream, so you could upload media from memory or even generate it on the go.

mimeType - MIME type for the media. Media service supports popular text, picture and video formats.

Returns:

Options object for chaining.

Throws:

java.lang.IllegalStateException - When attempt is made to set media on a text-only message.

java.lang.IllegalArgumentException - When attempt is made to use null input stream.

withMediaFileName

public Message.Options withMediaFileName(java.lang.String filename)

Provide optional filename for media.

Parameters:

filename - [description]

Returns:

Options object for chaining.

withMediaProgressListener

public Message.Options withMediaProgressListener(ProgressListener listener)

Set upload progress listener for media.

Parameters:

listener - [description]

Returns:

Options object for chaining.