com.twilio.chat.Messages Class Reference

Representation of a Chat channel's message list. More...

Public Member Functions
Actions
void	sendMessage (Message.Options options, CallbackListener< Message > listener)
	Sends a message to the channel. More...
void	removeMessage (Message message, StatusListener listener)
	Removes a message from the channel. More...
Getters
native Long	getLastConsumedMessageIndex ()
	Return user last consumed message index for the channel. More...
void	getMessagesBefore (long index, int count,@NonNull CallbackListener< List< Message >> listener)
	Fetch at most count messages including and prior to the specified index. More...
void	getMessagesAfter (long index, int count,@NonNull CallbackListener< List< Message >> listener)
	Fetch at most count messages including and subsequent to the specified index. More...
void	getLastMessages (int count,@NonNull CallbackListener< List< Message >> listener)
	Load last messages in chat. More...
void	getMessageByIndex (long index,@NonNull CallbackListener< Message > listener)
	Get message object by known index. More...
Setters
void	setLastConsumedMessageIndexWithResult (long lastConsumedMessageIndex, CallbackListener< Long > listener)
	Set user last consumed message index for the channel. More...
void	advanceLastConsumedMessageIndexWithResult (long lastConsumedMessageIndex, CallbackListener< Long > listener)
	Increase user last consumed message index for the channel. More...
void	setAllMessagesConsumedWithResult (CallbackListener< Long > listener)
	Set last consumed message index to last message index in channel. More...
void	setNoMessagesConsumedWithResult (CallbackListener< Long > listener)
	Set last consumed message index before the first message index in channel. More...

Detailed Description

Representation of a Chat channel's message list.

Member Function Documentation

void com.twilio.chat.Messages.advanceLastConsumedMessageIndexWithResult	(	long	lastConsumedMessageIndex,
		CallbackListener< Long >	listener
	)

Increase user last consumed message index for the channel.

Index is ignored if it is smaller than user current index.

Parameters

lastConsumedMessageIndex	consumed message index
listener	Status listener to report result of the operation that receives current number of unconsumed messages.

native Long com.twilio.chat.Messages.getLastConsumedMessageIndex

(

)

Return user last consumed message index for the channel.

Returns

consumed message index. Null if not set

void com.twilio.chat.Messages.getLastMessages	(	int	count,
		@NonNull CallbackListener< List< Message >>	listener
	)

Load last messages in chat.

Parameters

count	count of messages to load
listener	operation callback listener

void com.twilio.chat.Messages.getMessageByIndex	(	long	index,
		@NonNull CallbackListener< Message >	listener
	)

Get message object by known index.

Parameters

index	Message index.
listener	Listener for Message object at index.

void com.twilio.chat.Messages.getMessagesAfter	(	long	index,
		int	count,
		@NonNull CallbackListener< List< Message >>	listener
	)

Fetch at most count messages including and subsequent to the specified index.

Parameters

index	start index
count	count of messages to load
listener	operation callback listener

void com.twilio.chat.Messages.getMessagesBefore	(	long	index,
		int	count,
		@NonNull CallbackListener< List< Message >>	listener
	)

Fetch at most count messages including and prior to the specified index.

Parameters

index	start index
count	count of messages to load
listener	operation callback listener

void com.twilio.chat.Messages.removeMessage	(	Message	message,
		StatusListener	listener
	)

Removes a message from the channel.

Parameters

message	The message to remove.
listener	Status listener to report result of the operation.

void com.twilio.chat.Messages.sendMessage	(	Message.Options	options,
		CallbackListener< Message >	listener
	)

Sends a message to the channel.

// Messages messagesObject;
messagesObject.sendMessage(
    Message.options()
        .withMedia(new FileInputStream("/path/to/Somefile.txt"), "text/plain")
        .withMediaFileName("file.txt")
        .withMediaProgressListener(new ProgressListener() {
            @Override
            public void onStarted() {
                Timber.d("Upload started");
            }

            @Override
            public void onProgress(long bytes) {
                Timber.d("Uploaded " + bytes + " bytes");
            }

            @Override
            public void onCompleted(String mediaSid) {
                Timber.d("Upload completed");
            }
        }),
    new CallbackListener<Message>() {
        @Override
        public void onSuccess(Message msg) {
            Timber.d("Successfully sent MEDIA message");
        }

        @Override
        public void onError(ErrorInfo error) {
            Timber.e("Error sending MEDIA message");
        }
    });

Parameters

options	The message construction options.
listener	Status listener to report result of the operation that receives sent Message object.

Exceptions

IllegalArgumentException

If passed in options object is null.

void com.twilio.chat.Messages.setAllMessagesConsumedWithResult

(

CallbackListener< Long >

listener

)

Set last consumed message index to last message index in channel.

Parameters

listener

Status listener to report result of the operation that receives current number of unconsumed messages.

void com.twilio.chat.Messages.setLastConsumedMessageIndexWithResult	(	long	lastConsumedMessageIndex,
		CallbackListener< Long >	listener
	)

Set user last consumed message index for the channel.

Parameters

lastConsumedMessageIndex	consumed message index
listener	Status listener to report result of the operation that receives current number of unconsumed messages.

void com.twilio.chat.Messages.setNoMessagesConsumedWithResult

(

CallbackListener< Long >

listener

)

Set last consumed message index before the first message index in channel.

Parameters

listener

Status listener to report result of the operation that receives current number of unconsumed messages.