com.sendbird.android

Class MessageCollection

java.lang.Object

com.sendbird.android.MessageCollection

public final class MessageCollection
extends java.lang.Object

Collection that handles message lists, also supporting local caching.

Since:

3.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageCollection.Builder A builder to create the MessageCollection.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes current MessageCollection and stops all events from being received.
GroupChannel	getChannel() Returns the GroupChannel tracked by MessageCollection
java.util.Comparator<BaseMessage>	getComparator() Returns a new for sorting succeeded BaseMessage using the BaseMessageListParams.shouldReverse() set in this collection.
java.util.List<BaseMessage>	getFailedMessages() Return read-only failed message lists.
java.util.List<BaseMessage>	getPendingMessages() Return read-only pending message lists.
long	getStartingPoint() Returns the starting point of the collection.
java.util.List<BaseMessage>	getSucceededMessages() Returns list of succeeded message list in this collection.
boolean	hasNext() Returns whether there's more data to load in next (latest) direction.
boolean	hasPrevious() Returns whether there's more data to load in previous (oldest) direction.
void	initialize(MessageCollectionInitPolicy initPolicy, MessageCollectionInitHandler handler) Initializes this collection from startingPoint.
void	loadNext(BaseChannel.GetMessagesHandler handler) Loads next (latest direction) message lists.
void	loadPrevious(BaseChannel.GetMessagesHandler handler) Loads previous (oldest direction) message lists.
void	removeAllFailedMessages(RemoveAllFailedMessagesHandler handler) Remove all failed messages of this MessageCollection
void	removeFailedMessages(java.util.List<BaseMessage> failedMessages, RemoveFailedMessagesHandler handler) Remove specific failed messages of this MessageCollection
void	setMessageCollectionHandler(MessageCollectionHandler handler) Sets the message collection handler to be used for this MessageCollection.

Methods inherited from class java.lang.Object

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

Method Detail

setMessageCollectionHandler

public void setMessageCollectionHandler(MessageCollectionHandler handler)

Sets the message collection handler to be used for this MessageCollection.

Parameters:

handler - MessageCollectionHandler.

Since:

3.1.0

getComparator

public java.util.Comparator<BaseMessage> getComparator()

Returns a new for sorting succeeded BaseMessage using the BaseMessageListParams.shouldReverse() set in this collection. Noted that it's working correctly only for succeeded messages

Returns:

the new comparator object.

Since:

3.1.0

See Also:

BaseMessageListParams.setReverse(boolean)

dispose

public void dispose()

Disposes current MessageCollection and stops all events from being received.

Since:

3.1.0

getSucceededMessages

public java.util.List<BaseMessage> getSucceededMessages()

Returns list of succeeded message list in this collection.

Returns:

list of succeeded message list in this collection.

Since:

3.1.0

getStartingPoint

public long getStartingPoint()

Returns the starting point of the collection.

Returns:

the starting point of the collection.

Since:

3.1.0

hasNext

public boolean hasNext()

Returns whether there's more data to load in next (latest) direction.

Returns:

whether there's more data to load.

Since:

3.1.0

hasPrevious

public boolean hasPrevious()

Returns whether there's more data to load in previous (oldest) direction.

Returns:

whether there's more data to load.

Since:

3.1.0

initialize

public void initialize(MessageCollectionInitPolicy initPolicy,
                       MessageCollectionInitHandler handler)

Initializes this collection from startingPoint.

Parameters:

initPolicy - MessageCollectionInitPolicy used in how to deal with cache results and api results.

handler - MessageCollectionInitHandler used in providing the cache results and api results.

Since:

3.1.0

getPendingMessages

public java.util.List<BaseMessage> getPendingMessages()

Return read-only pending message lists. If you try to modify the list, it will crash.

Returns:

read-only pending message list

Since:

3.1.0

getFailedMessages

public java.util.List<BaseMessage> getFailedMessages()

Return read-only failed message lists. If you try to modify the list, it will crash.

Returns:

failed message list

Since:

3.1.0

loadNext

public void loadNext(BaseChannel.GetMessagesHandler handler)

Loads next (latest direction) message lists.

Parameters:

handler - BaseMessage.GetMessageHandler to receive the message list.

Since:

3.1.0

loadPrevious

public void loadPrevious(BaseChannel.GetMessagesHandler handler)

Loads previous (oldest direction) message lists.

Parameters:

handler - BaseMessage.GetMessageHandler to receive the message list.

Since:

3.1.0

removeFailedMessages

public void removeFailedMessages(java.util.List<BaseMessage> failedMessages,
                                 RemoveFailedMessagesHandler handler)

Remove specific failed messages of this MessageCollection

Parameters:

failedMessages - failed messages that want to remove

handler - RemoveFailedMessagesHandler used in providing the removal results

Since:

3.1.0

removeAllFailedMessages

public void removeAllFailedMessages(RemoveAllFailedMessagesHandler handler)

Remove all failed messages of this MessageCollection

Parameters:

handler - RemoveAllFailedMessagesHandler used in providing the removal results

Since:

3.1.0

getChannel

public GroupChannel getChannel()

Returns the GroupChannel tracked by MessageCollection

Returns:

the GroupChannel tracked by MessageCollection

Since:

3.1.0