com.twilio.ipmessaging

Interface Messages

public interface Messages

Representation of an IP Messaging channel's message list.

Method Summary

Modifier and Type	Method and Description
void	advanceLastConsumedMessageIndex(long lastConsumedMessageIndex) Increase user last consumed message index for the channel.
Message	createMessage(java.lang.String message) Method to createMessage.
java.lang.Long	getLastConsumedMessageIndex() Return user last consumed message index for the channel
Message[]	getMessages() Returns messages received so far from backend, messages are loaded asynchronously so this may not fully represent all history available for channel.
void	removeMessage(Message message, Constants.StatusListener listener) Removes a message to the channel.
void	sendMessage(Message message, Constants.StatusListener listener) Sends a message to the channel.
void	setAllMessagesConsumed() Set last consumed message index to last message index in channel.
void	setLastConsumedMessageIndex(long lastConsumedMessageIndex) Set user last consumed message index for the channel

Method Detail

createMessage

Message createMessage(java.lang.String message)

Method to createMessage.

Parameters:

message - Message body

Returns:

the newly created message.

sendMessage

void sendMessage(Message message,
                 Constants.StatusListener listener)

Sends a message to the channel.

Parameters:

message - The message to send.

listener - Status listener to report result of the operation.

removeMessage

void removeMessage(Message message,
                   Constants.StatusListener listener)

Removes a message to the channel.

Parameters:

message - The message to remove.

listener - Status listener to report result of the operation.

getMessages

Message[] getMessages()

Returns messages received so far from backend, messages are loaded asynchronously so this may not fully represent all history available for channel.

getLastConsumedMessageIndex

java.lang.Long getLastConsumedMessageIndex()

Return user last consumed message index for the channel

Returns:

consumed message index. Null if not set

setLastConsumedMessageIndex

void setLastConsumedMessageIndex(long lastConsumedMessageIndex)

Set user last consumed message index for the channel

Parameters:

lastConsumedMessageIndex - consumed message index

advanceLastConsumedMessageIndex

void advanceLastConsumedMessageIndex(long lastConsumedMessageIndex)

Increase user last consumed message index for the channel. Index is ignored if it is smaller than user current index.

Parameters:

lastConsumedMessageIndex -

setAllMessagesConsumed

void setAllMessagesConsumed()

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