-
public class MessageChangeLogsParams
Represents a message list params. getMessageChangeLogsSinceTimestamp. getMessageChangeLogsSinceToken.
-
-
Field Summary
Fields Modifier and Type Field Description protected MessagePayloadFilter
messagePayloadFilter
protected ReplyTypeFilter
replyTypeFilter
protected boolean
includePollDetails
-
Constructor Summary
Constructors Constructor Description MessageChangeLogsParams()
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
MessageChangeLogsParams(boolean includeMetaArray, boolean includeReactions, boolean includeThreadInfo, boolean includeReplies, boolean includeParentMessageText)
-
Method Summary
Modifier and Type Method Description MessagePayloadFilter
getMessagePayloadFilter()
Returns the MessagePayloadFilter set in this param. void
setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
Sets the MessagePayloadFilter to be used in retrieving message lists. ReplyTypeFilter
getReplyTypeFilter()
Returns the ReplyTypeFilter which should be included in the results. void
setReplyTypeFilter(ReplyTypeFilter replyTypeFilter)
Determines the reply types to include in the results. void
setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results. void
setIncludeMetaArray(boolean includeMetaArray)
Determines whether to include the meta array information of the updated messages in the results. void
setIncludeReactions(boolean includeReactions)
Determines whether to include the reactions 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
setIncludeReplies(boolean includeReplies)
Determines whether to include the updated replies in the results. void
setIncludeParentMessageText(boolean includeParentMessageText)
Determines whether to include the parent message text in the results when the updated messages are threaded replies. 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
shouldIncludeThreadInfo()
Returns whether to include the thread information of the updated messages in the results when the results contain parent messages. boolean
shouldIncludeReplies()
Returns whether to include the updated replies in the results. boolean
isIncludeParentMessageText()
Returns whether to include the parent message text in the results when the updated messages are threaded replies. boolean
shouldIncludePollDetails()
Returns whether to include the poll of the returned messages in the results. MessageChangeLogsParams
clone()
Clones and returns a new instance of MessageChangeLogsParams
.static MessageChangeLogsParams
from(PreviousMessageListQuery query)
Create MessageChangeLogsParams from a given PreviousMessageListQuery instance. static MessageChangeLogsParams
from(MessageListParams params)
Create MessageChangeLogsParams from a given MessageListParams instance. static MessageChangeLogsParams
from(ThreadMessageListParams params)
Create MessageChangeLogsParams from a given ThreadMessageListParams instance. String
toString()
-
-
Constructor Detail
-
MessageChangeLogsParams
MessageChangeLogsParams()
-
MessageChangeLogsParams
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)
-
MessageChangeLogsParams
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, boolean includeReplies)
-
MessageChangeLogsParams
MessageChangeLogsParams(boolean includeMetaArray, boolean includeReactions, boolean includeThreadInfo, boolean includeReplies, boolean includeParentMessageText)
-
-
Method Detail
-
getMessagePayloadFilter
MessagePayloadFilter getMessagePayloadFilter()
Returns the MessagePayloadFilter set in this param.
-
setMessagePayloadFilter
void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
Sets the MessagePayloadFilter to be used in retrieving message lists.
- Parameters:
messagePayloadFilter
- MessagePayloadFilter with preferred filters set.
-
getReplyTypeFilter
ReplyTypeFilter getReplyTypeFilter()
Returns the ReplyTypeFilter which should be included in the results.
-
setReplyTypeFilter
void setReplyTypeFilter(ReplyTypeFilter replyTypeFilter)
Determines the reply types to include in the results.
- Parameters:
replyTypeFilter
- The ReplyTypeFilter of the replies to include in the result.
-
setIncludePollDetails
void setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results.Internally, this will be set on setIncludePollDetails.
- Parameters:
includePollDetails
- Iftrue
the queried result will be returned with poll.
-
setIncludeMetaArray
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 setIncludeMetaArray.
- Parameters:
includeMetaArray
- Iftrue
the result will be returned with meta array.
-
setIncludeReactions
void setIncludeReactions(boolean includeReactions)
Determines whether to include the reactions of the updated messages in the results.Internally, this will be set on setIncludeReactions.
- Parameters:
includeReactions
- Iftrue
the result will be returned with reactions.
-
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 updated replies in the results.
- Parameters:
includeReplies
- Iftrue
the result will be returned with reply messages included.
-
setIncludeParentMessageText
@Deprecated() void setIncludeParentMessageText(boolean includeParentMessageText)
Determines whether to include the parent message text in the results when the updated messages are threaded replies.If the type of the parent message is UserMessage, the value is a getMessage.If it is FileMessage, the value is the name of the uploaded file.Internally, this will be set on setIncludeParentMessageInfo.
- Parameters:
includeParentMessageText
- Iftrue
the result will be returned with messages with parent's message's text, if the message is a reply message.
-
shouldIncludeMetaArray
boolean shouldIncludeMetaArray()
Returns whether to include the meta array information of the updated messages in the results.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeReactions
boolean shouldIncludeReactions()
Returns whether to include the reactions of the updated messages in the results.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeThreadInfo
boolean shouldIncludeThreadInfo()
Returns whether to include the thread information of the updated messages in the results when the results contain parent messages.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeReplies
@Deprecated() boolean shouldIncludeReplies()
Returns whether to include the updated replies in the results.
-
isIncludeParentMessageText
@Deprecated() boolean isIncludeParentMessageText()
Returns whether to include the parent message text in the results when the updated messages are threaded replies.Can also be checked by getMessagePayloadFilter.
-
shouldIncludePollDetails
boolean shouldIncludePollDetails()
Returns whether to include the poll of the returned messages in the results.Can also be checked by getMessagePayloadFilter.
-
clone
@NonNull() MessageChangeLogsParams clone()
Clones and returns a new instance of
MessageChangeLogsParams
.
-
from
static MessageChangeLogsParams from(PreviousMessageListQuery query)
Create MessageChangeLogsParams from a given PreviousMessageListQuery instance.
- Parameters:
query
- PreviousMessageListQuery instance to clone from.
-
from
static MessageChangeLogsParams from(MessageListParams params)
Create MessageChangeLogsParams from a given MessageListParams instance.
- Parameters:
params
- MessageListParams instance to clone from.
-
from
static MessageChangeLogsParams from(ThreadMessageListParams params)
Create MessageChangeLogsParams from a given ThreadMessageListParams instance.
- Parameters:
params
- ThreadMessageListParams instance to clone from.
-
-
-
-