-
public class MessageListParams extends BaseMessageListParams
Represents a message list params. getMessagesByTimestamp. getMessagesByMessageId.
-
-
Field Summary
Fields Modifier and Type Field Description protected ReplyTypeFilter
replyTypeFilter
protected boolean
showSubchannelMessagesOnly
-
Constructor Summary
Constructors Constructor Description MessageListParams()
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter, boolean showSubchannelMessagesOnly)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter, boolean showSubchannelMessagesOnly)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageInfo, boolean includeThreadInfo, boolean includeReplies)
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageInfo, boolean includeThreadInfo, boolean includeReplies)
-
Method Summary
Modifier and Type Method Description ReplyTypeFilter
getReplyTypeFilter()
Returns the ReplyTypeFilter which should be included in the results. void
setReplyTypeFilter(@NonNull() ReplyTypeFilter replyTypeFilter)
Determines the reply types to include in the results. 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. 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
setIncludeReplies(boolean includeReplies)
Determines whether to include the replies of the updated messages in the results. boolean
shouldIncludeThreadInfo()
Returns whether the thread information should be included in the results. boolean
shouldIncludeReplies()
Returns whether the replies should be included in the results. boolean
shouldShowSubchannelMessagesOnly()
If true, only messages that belong to current user's subchannel is fetched.If false, all messages will be fetched. MessageListParams
clone()
Clones and returns a new instance of MessageListParams
.String
toString()
boolean
belongsTo(@NonNull() BaseMessage message)
Verify that the given channel information matches the current query filter. boolean
belongsTo(@NonNull() BaseMessageParams params)
Verify that the given BaseMessageParams
information matches the current query filter.-
Methods inherited from class com.sendbird.android.BaseMessageListParams
getCustomType, getCustomTypes, getMessagePayloadFilter, getMessageType, getNextResultSize, getPreviousResultSize, getSenderUserIds, isInclusive, setCustomType, setCustomTypes, setIncludeMetaArray, setIncludeParentMessageText, setIncludePollDetails, setIncludeReactions, setInclusive, setMessagePayloadFilter, setMessageType, setNextResultSize, setPreviousResultSize, setReverse, setSenderUserIds, shouldIncludeMetaArray, shouldIncludeParentMessageText, shouldIncludePollDetails, shouldIncludeReactions, shouldReverse
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
MessageListParams
MessageListParams()
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter, boolean showSubchannelMessagesOnly)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter, boolean showSubchannelMessagesOnly)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, String customType, List<String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageInfo, boolean includeThreadInfo, boolean includeReplies)
-
MessageListParams
MessageListParams(int previousResultSize, int nextResultSize, BaseChannel.MessageTypeFilter messageType, Collection<String> customTypes, List<String> senderUserIds, boolean inclusive, boolean reverse, boolean includeMetaArray, boolean includeReactions, boolean includeParentMessageInfo, boolean includeThreadInfo, boolean includeReplies)
-
-
Method Detail
-
getReplyTypeFilter
@NonNull() ReplyTypeFilter getReplyTypeFilter()
Returns the ReplyTypeFilter which should be included in the results.
-
setReplyTypeFilter
void setReplyTypeFilter(@NonNull() ReplyTypeFilter replyTypeFilter)
Determines the reply types to include in the results.
- Parameters:
replyTypeFilter
- The ReplyTypeFilter of the replies to include in the result.
-
setShowSubchannelMessagesOnly
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.
-
setIncludeThreadInfo
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 setIncludeThreadInfo.
- Parameters:
includeThreadInfo
- Iftrue
the result will be returned with thread information included.
-
setIncludeReplies
@Deprecated() void setIncludeReplies(boolean includeReplies)
Determines whether to include the replies of the updated messages in the results.
- Parameters:
includeReplies
- Iftrue
the result will be returned with reply messages included.
-
shouldIncludeThreadInfo
boolean shouldIncludeThreadInfo()
Returns whether the thread information should be included in the results.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeReplies
@Deprecated() boolean shouldIncludeReplies()
Returns whether the replies should be included in the results.
-
shouldShowSubchannelMessagesOnly
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.
-
clone
MessageListParams clone()
Clones and returns a new instance of
MessageListParams
.
-
belongsTo
boolean belongsTo(@NonNull() BaseMessage message)
Verify that the given channel information matches the current query filter.
- Parameters:
message
- BaseMessage to check.
-
belongsTo
boolean belongsTo(@NonNull() BaseMessageParams params)
Verify that the given
BaseMessageParams
information matches the current query filter.- Parameters:
params
-BaseMessageParams
to check.
-
-
-
-