com.sendbird.android

Class MessageListParams

java.lang.Object

com.sendbird.android.MessageListParams

public class MessageListParams
extends java.lang.Object

Represents a message list params. BaseChannel.getMessagesByTimestamp(long, MessageListParams, BaseChannel.GetMessagesHandler). BaseChannel.getMessagesByMessageId(long, MessageListParams, BaseChannel.GetMessagesHandler).

Since:

3.0.130

Constructor Summary

Constructors

Constructor and Description
MessageListParams()
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, java.util.Collection<java.lang.String> customTypes, java.util.List<java.lang.String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageText, boolean includeThreadInfo, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, java.util.Collection<java.lang.String> customTypes, java.util.List<java.lang.String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, java.lang.String customType, java.util.List<java.lang.String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageText, boolean includeThreadInfo, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, java.lang.String customType, java.util.List<java.lang.String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)

Method Summary

Modifier and Type	Method and Description
boolean	belongsTo(BaseMessage message) Verify that the given channel information matches the current query filter.
MessageListParams	clone() Clones and returns a new instance of MessageListParams.
java.lang.String	getCustomType() Returns the custom type of message.
java.util.Collection<java.lang.String>	getCustomTypes() Returns the custom types of message.
MessagePayloadFilter	getMessagePayloadFilter() Returns the MessagePayloadFilter set in this param.
BaseChannel.MessageTypeFilter	getMessageType() Returns the message type.
int	getNextResultSize() Returns the number of newer messages that you want to get.
int	getPreviousResultSize() Returns the number of previous messages that you want to get.
java.util.List<java.lang.String>	getSenderUserIds() Returns the sender user ids.
boolean	isInclusive() Returns a value whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.
void	setCustomType(java.lang.String customType) Restricts the search scope only to retrieve the messages with the specified custom message type.
void	setCustomTypes(java.util.Collection<java.lang.String> customTypes) Restricts the search scope only to retrieve the messages that match any of given custom types.
void	setIncludeMetaArray(boolean includeMetaArray) Determines whether to include the meta array information of the updated messages in the results.
void	setIncludeParentMessageText(boolean includeParentMessageText) Determines whether to include the parent message text in the results when the updated messages are replies in a thread.
void	setIncludePollDetails(boolean includePollDetails) Determines whether to include the poll of the returned messages in the results.
void	setIncludeReactions(boolean includeReactions) Determines whether to include the reactions to the updated messages in the results.
void	setIncludeReplies(boolean includeReplies) Determines whether to include the replies of the updated messages in the results.
void	setIncludeThreadInfo(boolean includeThreadInfo) Determines whether to include the thread information of the updated messages in the results when the results contain parent messages.
void	setInclusive(boolean inclusive) Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.
void	setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter) Sets the MessagePayloadFilter to be used in retrieving message lists.
void	setMessageType(BaseChannel.MessageTypeFilter messageType) Restricts the search scope only to retrieve the messages with the specified message type.
void	setNextResultSize(int nextResultSize) Set the number of newer messages added either before the timestamp or the message that has a specific message ID.
void	setPreviousResultSize(int previousResultSize) Set the number of previous messages added either before the timestamp or the message that has a specific message ID.
void	setReverse(boolean reverse) Determines whether to sort the retrieved messages in reverse order.
void	setSenderUserIds(java.util.List<java.lang.String> senderUserIds) Restricts the search scope only to retrieve the messages sent by the users with the specified user IDs.
void	setShowSubchannelMessagesOnly(boolean showSubchannelMessagesOnly) If set to true, only messages that belong to current user's subchannel is fetched.
boolean	shouldIncludeMetaArray() Returns whether the meta arrays should be included in the results.
boolean	shouldIncludeParentMessageText() Returns whether the text of a parent message should be included in the reply messages included in the results.
boolean	shouldIncludePollDetails() Returns whether to include the poll of the returned messages in the results.
boolean	shouldIncludeReactions() Returns whether the reaction data should be included in the results.
boolean	shouldIncludeReplies() Returns whether the replies should be included in the results.
boolean	shouldIncludeThreadInfo() Returns whether the thread information should be included in the results.
boolean	shouldReverse() Returns whether the results should be reversed.
boolean	shouldShowSubchannelMessagesOnly() If true, only messages that belong to current user's subchannel is fetched.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageListParams

public MessageListParams()

MessageListParams

public MessageListParams(int previousResultSize,
                         int nextResultSize,
                         BaseChannel.MessageTypeFilter messageType,
                         java.lang.String customType,
                         java.util.List<java.lang.String> senderUserIds,
                         boolean inclusive,
                         boolean reverse,
                         MessagePayloadFilter messagePayloadFilter,
                         boolean includeReplies)

MessageListParams

public MessageListParams(int previousResultSize,
                         int nextResultSize,
                         BaseChannel.MessageTypeFilter messageType,
                         java.util.Collection<java.lang.String> customTypes,
                         java.util.List<java.lang.String> senderUserIds,
                         boolean inclusive,
                         boolean reverse,
                         MessagePayloadFilter messagePayloadFilter,
                         boolean includeReplies)

MessageListParams

public MessageListParams(int previousResultSize,
                         int nextResultSize,
                         BaseChannel.MessageTypeFilter messageType,
                         java.lang.String customType,
                         java.util.List<java.lang.String> senderUserIds,
                         boolean inclusive,
                         boolean reverse,
                         boolean includeMetaArray,
                         boolean includeReactions,
                         boolean includeParentMessageText,
                         boolean includeThreadInfo,
                         boolean includeReplies)

MessageListParams

public MessageListParams(int previousResultSize,
                         int nextResultSize,
                         BaseChannel.MessageTypeFilter messageType,
                         java.util.Collection<java.lang.String> customTypes,
                         java.util.List<java.lang.String> senderUserIds,
                         boolean inclusive,
                         boolean reverse,
                         boolean includeMetaArray,
                         boolean includeReactions,
                         boolean includeParentMessageText,
                         boolean includeThreadInfo,
                         boolean includeReplies)

Method Detail

setIncludeThreadInfo

public void setIncludeThreadInfo(boolean includeThreadInfo)

Determines whether to include the thread information of the updated messages in the results when the results contain parent messages. Internally, this will be set on MessagePayloadFilter.setIncludeThreadInfo(boolean).

Parameters:

includeThreadInfo - If true the result will be returned with thread information included.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeReplies

public void setIncludeReplies(boolean includeReplies)

Determines whether to include the replies of the updated messages in the results.

Parameters:

includeReplies - If true the result will be returned with reply messages included.

Since:

3.0.130

setShowSubchannelMessagesOnly

public void setShowSubchannelMessagesOnly(boolean showSubchannelMessagesOnly)

If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.

Parameters:

showSubchannelMessagesOnly - If false, all messages will be returned. If true, only messages in the subchannel will be returned.

Since:

3.0.149

shouldIncludeThreadInfo

public boolean shouldIncludeThreadInfo()

Returns whether the thread information should be included in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether thread information should be included in the results.

Since:

3.0.136

shouldIncludeReplies

public boolean shouldIncludeReplies()

Returns whether the replies should be included in the results.

Returns:

Whether the replies should be included in the results.

Since:

3.0.136

shouldShowSubchannelMessagesOnly

public boolean shouldShowSubchannelMessagesOnly()

If true, only messages that belong to current user's subchannel is fetched. If false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.

Returns:

whether only the messages that belong to a subchannel should be fetched.

Since:

3.0.149

clone

public MessageListParams clone()

Clones and returns a new instance of MessageListParams.

Overrides:

clone in class java.lang.Object

Returns:

a cloned new instance of this MessageListParams.

Since:

3.0.130

toString

public java.lang.String toString()

belongsTo

public boolean belongsTo(BaseMessage message)

Verify that the given channel information matches the current query filter.

Parameters:

message - BaseMessage to check. Returns false if the message is not matched with the params's filter.

Returns:

whether the message isn't matched with the filter.

Since:

3.0.167

setPreviousResultSize

public void setPreviousResultSize(int previousResultSize)

Set the number of previous messages added either before the timestamp or the message that has a specific message ID.

Parameters:

previousResultSize - number of loaded message size.

Since:

3.0.130

setNextResultSize

public void setNextResultSize(int nextResultSize)

Set the number of newer messages added either before the timestamp or the message that has a specific message ID.

Parameters:

nextResultSize - number of loaded message size.

Since:

3.0.130

setMessageType

public void setMessageType(BaseChannel.MessageTypeFilter messageType)

Restricts the search scope only to retrieve the messages with the specified message type.

Parameters:

messageType - type of messages that should be loaded.

Since:

3.0.130

setCustomType

public void setCustomType(java.lang.String customType)

Restricts the search scope only to retrieve the messages with the specified custom message type. When the custom type filtering is not needed, the value should be set to null.

Parameters:

customType - custom type for messages.

Since:

3.0.130

setCustomTypes

public void setCustomTypes(java.util.Collection<java.lang.String> customTypes)

Restricts the search scope only to retrieve the messages that match any of given custom types. When the custom type filtering is not needed, the value should be set to null. When a empty string is given, messages that does not have a custom type will also be returned.

Parameters:

customTypes - custom types for the messages.

Since:

3.0.154

setSenderUserIds

public void setSenderUserIds(java.util.List<java.lang.String> senderUserIds)

Restricts the search scope only to retrieve the messages sent by the users with the specified user IDs. When the user ID filtering is not needed, the value should be set to null.

Parameters:

senderUserIds - list of sender's user ids.

Since:

3.0.130

setInclusive

public void setInclusive(boolean inclusive)

Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

Parameters:

inclusive - If true, the result will include messages with createdAt same as the given timestamp.

Since:

3.0.130

setReverse

public void setReverse(boolean reverse)

Determines whether to sort the retrieved messages in reverse order.

Parameters:

reverse - If true the result will be returned by creation time descending order.

Since:

3.0.130

setIncludeMetaArray

public void setIncludeMetaArray(boolean includeMetaArray)

Determines whether to include the meta array information of the updated messages in the results. Internally, this will be set on MessagePayloadFilter.setIncludeMetaArray(boolean).

Parameters:

includeMetaArray - If true the result will be returned with message meta array.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeReactions

public void setIncludeReactions(boolean includeReactions)

Determines whether to include the reactions to the updated messages in the results. Internally, this will be set on MessagePayloadFilter.setIncludeReactions(boolean).

Parameters:

includeReactions - If true the result will be returned with message reactions.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeParentMessageText

public void setIncludeParentMessageText(boolean includeParentMessageText)

Determines whether to include the parent message text in the results when the updated messages are replies in a thread. If the type of the parent message is UserMessage, the value is a BaseMessage.getMessage() of the parent message. If it is FileMessage, the value is the name of the uploaded file. Internally, this will be set on MessagePayloadFilter.setIncludeParentMessageText(boolean).

Parameters:

includeParentMessageText - If true the result will be returned with messages with parent's message's text, if the message is a reply message.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludePollDetails

public void setIncludePollDetails(boolean includePollDetails)

Determines whether to include the poll of the returned messages in the results. Internally, this will be set on MessagePayloadFilter.setIncludePollDetails(boolean).

Parameters:

includePollDetails - If true the queried result will be returned with poll.

Since:

3.0.171

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setMessagePayloadFilter

public void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)

Sets the MessagePayloadFilter to be used in retrieving message lists. This is more preferred way of setting other include flags.

Parameters:

messagePayloadFilter - MessagePayloadFilter with preferred filters set.

Since:

3.0.171

getPreviousResultSize

public int getPreviousResultSize()

Returns the number of previous messages that you want to get.

Returns:

number of loaded message size.

Since:

3.0.136

getNextResultSize

public int getNextResultSize()

Returns the number of newer messages that you want to get.

Returns:

number of loaded message size.

Since:

3.0.136

getMessageType

public BaseChannel.MessageTypeFilter getMessageType()

Returns the message type.

Returns:

The message type.

Since:

3.0.136

getCustomType

public java.lang.String getCustomType()

Returns the custom type of message.

Returns:

The custom type of message.

Since:

3.0.136

getCustomTypes

public java.util.Collection<java.lang.String> getCustomTypes()

Returns the custom types of message.

Returns:

The custom types of message.

Since:

3.0.154

getSenderUserIds

public java.util.List<java.lang.String> getSenderUserIds()

Returns the sender user ids.

Returns:

The sender user ids.

Since:

3.0.136

isInclusive

public boolean isInclusive()

Returns a value whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

Returns:

Whether messages sent exactly on the timestamp should be loaded.

Since:

3.0.136

shouldReverse

public boolean shouldReverse()

Returns whether the results should be reversed.

Returns:

whether the results should be reversed.

Since:

3.0.136

shouldIncludeMetaArray

public boolean shouldIncludeMetaArray()

Returns whether the meta arrays should be included in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the meta arrays should be included in the results.

Since:

3.0.136

shouldIncludeReactions

public boolean shouldIncludeReactions()

Returns whether the reaction data should be included in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the reaction data should be included in the results.

Since:

3.0.136

shouldIncludeParentMessageText

public boolean shouldIncludeParentMessageText()

Returns whether the text of a parent message should be included in the reply messages included in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the text of a parent message should be included in the reply messages included in the results.

Since:

3.0.136

shouldIncludePollDetails

public boolean shouldIncludePollDetails()

Returns whether to include the poll of the returned messages in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether to include the poll of the returned messages in the results.

Since:

3.0.171

getMessagePayloadFilter

public MessagePayloadFilter getMessagePayloadFilter()

Returns the MessagePayloadFilter set in this param.

Returns:

MessagePayloadFilter.

Since:

3.0.171