public class MessageChangeLogsParams
extends java.lang.Object
BaseChannel.getMessageChangeLogsSinceTimestamp(long, MessageChangeLogsParams, BaseChannel.GetMessageChangeLogsHandler)
.
BaseChannel.getMessageChangeLogsSinceToken(String, MessageChangeLogsParams, BaseChannel.GetMessageChangeLogsHandler)
.Constructor and Description |
---|
MessageChangeLogsParams() |
MessageChangeLogsParams(boolean includeMetaArray,
boolean includeReactions,
boolean includeThreadInfo,
boolean includeReplies,
boolean includeParentMessageText) |
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter,
ReplyTypeFilter replyTypeFilter) |
Modifier and Type | Method and Description |
---|---|
MessageChangeLogsParams |
clone()
Clones and returns a new instance of
MessageChangeLogsParams . |
static MessageChangeLogsParams |
from(MessageListParams params)
Create
MessageChangeLogsParams from a given MessageListParams instance. |
static MessageChangeLogsParams |
from(PreviousMessageListQuery query)
Create
MessageChangeLogsParams from a given PreviousMessageListQuery instance. |
static MessageChangeLogsParams |
from(ThreadMessageListParams params)
Create
MessageChangeLogsParams from a given ThreadMessageListParams instance. |
MessagePayloadFilter |
getMessagePayloadFilter()
Returns the
MessagePayloadFilter set in this param. |
ReplyTypeFilter |
getReplyTypeFilter()
Returns the
ReplyTypeFilter which should be included in the results. |
boolean |
isIncludeParentMessageText()
Deprecated.
As of 3.0.173, replaced by
MessagePayloadFilter.shouldIncludeParentMessageInfo() from getMessagePayloadFilter() . |
void |
setIncludeMetaArray(boolean includeMetaArray)
Determines whether to include the meta array information of the updated messages in the results.
|
void |
setIncludeParentMessageText(boolean includeParentMessageText)
Deprecated.
As of 3.0.173, replaced by
setMessagePayloadFilter(MessagePayloadFilter) with MessagePayloadFilter.Builder.setIncludeParentMessageInfo(boolean) . |
void |
setIncludeReactions(boolean includeReactions)
Determines whether to include the reactions of the updated messages in the results.
|
void |
setIncludeReplies(boolean includeReplies)
Deprecated.
As of 3.0.173, replaced by
setReplyTypeFilter(ReplyTypeFilter) . |
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 |
setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
Sets the
MessagePayloadFilter to be used in retrieving message lists. |
void |
setReplyTypeFilter(ReplyTypeFilter replyTypeFilter)
Determines the reply types to include in the results.
|
boolean |
shouldIncludeMetaArray()
Returns whether to include the meta array information of the updated messages in the results.
|
boolean |
shouldIncludeReactions()
Returns whether to include the reactions of the updated messages in the results.
|
boolean |
shouldIncludeReplies()
Deprecated.
As of 3.0.173, replaced by
getReplyTypeFilter() . |
boolean |
shouldIncludeThreadInfo()
Returns whether to include the thread information of the updated messages in the results when the results contain parent messages.
|
java.lang.String |
toString() |
public MessageChangeLogsParams()
public MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)
public MessageChangeLogsParams(boolean includeMetaArray, boolean includeReactions, boolean includeThreadInfo, boolean includeReplies, boolean includeParentMessageText)
public void setIncludeMetaArray(boolean includeMetaArray)
MessagePayloadFilter.setIncludeMetaArray(boolean)
.includeMetaArray
- If true
the result will be returned with meta array.setMessagePayloadFilter(MessagePayloadFilter).
public void setIncludeReactions(boolean includeReactions)
MessagePayloadFilter.setIncludeReactions(boolean)
.includeReactions
- If true
the result will be returned with reactions.setMessagePayloadFilter(MessagePayloadFilter).
public void setIncludeThreadInfo(boolean includeThreadInfo)
MessagePayloadFilter.setIncludeThreadInfo(boolean)
.includeThreadInfo
- If true
the result will be returned with thread information included.setMessagePayloadFilter(MessagePayloadFilter).
@Deprecated public void setIncludeReplies(boolean includeReplies)
setReplyTypeFilter(ReplyTypeFilter)
.includeReplies
- If true
the result will be returned with reply messages included.@Deprecated public void setIncludeParentMessageText(boolean includeParentMessageText)
setMessagePayloadFilter(MessagePayloadFilter)
with MessagePayloadFilter.Builder.setIncludeParentMessageInfo(boolean)
.BaseMessage.getMessage()
.
If it is FileMessage, the value is the name of the uploaded file.
Internally, this will be set on MessagePayloadFilter.Builder.setIncludeParentMessageInfo(boolean)
.includeParentMessageText
- If true
the result will be returned with messages with parent's message's text, if the message is a reply message. setReplyTypeFilter(ReplyTypeFilter)
must be set to ReplyTypeFilter.ALL
.setMessagePayloadFilter(MessagePayloadFilter).
public void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
MessagePayloadFilter
to be used in retrieving message lists.messagePayloadFilter
- MessagePayloadFilter
with preferred filters set.public void setReplyTypeFilter(ReplyTypeFilter replyTypeFilter)
replyTypeFilter
- The ReplyTypeFilter
of the replies to include in the result.public boolean shouldIncludeMetaArray()
getMessagePayloadFilter()
.public boolean shouldIncludeReactions()
getMessagePayloadFilter()
.public boolean shouldIncludeThreadInfo()
getMessagePayloadFilter()
.@Deprecated public boolean shouldIncludeReplies()
getReplyTypeFilter()
.@Deprecated public boolean isIncludeParentMessageText()
MessagePayloadFilter.shouldIncludeParentMessageInfo()
from getMessagePayloadFilter()
.getMessagePayloadFilter()
.public MessagePayloadFilter getMessagePayloadFilter()
MessagePayloadFilter
set in this param.MessagePayloadFilter
.public ReplyTypeFilter getReplyTypeFilter()
ReplyTypeFilter
which should be included in the results.ReplyTypeFilter
which should be included in the results.public MessageChangeLogsParams clone()
MessageChangeLogsParams
.clone
in class java.lang.Object
MessageChangeLogsParams
.public static MessageChangeLogsParams from(PreviousMessageListQuery query)
MessageChangeLogsParams
from a given PreviousMessageListQuery
instance.query
- PreviousMessageListQuery
instance to clone from.public static MessageChangeLogsParams from(MessageListParams params)
MessageChangeLogsParams
from a given MessageListParams
instance.params
- MessageListParams
instance to clone from.public static MessageChangeLogsParams from(ThreadMessageListParams params)
MessageChangeLogsParams
from a given ThreadMessageListParams
instance.params
- ThreadMessageListParams
instance to clone from.MessageChangeLogsParams
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.