-
public final class MessagePayloadFilter.Builder
A Builder class to build a MessagePayloadFilter
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
includeMetaArray
private boolean
includeReactions
private boolean
includeThreadInfo
private boolean
includePollDetails
private boolean
includeParentMessageInfo
-
Constructor Summary
Constructors Constructor Description MessagePayloadFilter.Builder()
-
Method Summary
Modifier and Type Method Description MessagePayloadFilter.Builder
setIncludeMetaArray(boolean includeMetaArray)
Determines whether to include the meta array information of the updated messages in the results. MessagePayloadFilter.Builder
setIncludeReactions(boolean includeReactions)
Determines whether to include the reactions to the updated messages in the results. MessagePayloadFilter.Builder
setIncludeThreadInfo(boolean includeThreadInfo)
Determines whether to include the thread information of the updated messages in the results when the results contain parent messages. MessagePayloadFilter.Builder
setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results. MessagePayloadFilter.Builder
setIncludeParentMessageInfo(boolean includeParentMessageInfo)
Determines whether to include the parent message's information in the results when the updated messages are replies in a thread. MessagePayloadFilter.Builder
setIncludeParentMessageText(boolean includeParentMessageText)
Determines whether to include the parent message text in the results when the updated messages are replies in a thread. MessagePayloadFilter
build()
-
-
Method Detail
-
setIncludeMetaArray
MessagePayloadFilter.Builder setIncludeMetaArray(boolean includeMetaArray)
Determines whether to include the meta array information of the updated messages in the results.
- Parameters:
includeMetaArray
- Iftrue
the result will be returned with message meta array.
-
setIncludeReactions
MessagePayloadFilter.Builder setIncludeReactions(boolean includeReactions)
Determines whether to include the reactions to the updated messages in the results.
- Parameters:
includeReactions
- Iftrue
the result will be returned with message reactions.
-
setIncludeThreadInfo
MessagePayloadFilter.Builder setIncludeThreadInfo(boolean includeThreadInfo)
Determines whether to include the thread information of the updated messages in the results when the results contain parent messages.
- Parameters:
includeThreadInfo
- Iftrue
the result will be returned with thread information included.
-
setIncludePollDetails
MessagePayloadFilter.Builder setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results.
- Parameters:
includePollDetails
- Iftrue
the queried result will be returned with poll.
-
setIncludeParentMessageInfo
MessagePayloadFilter.Builder setIncludeParentMessageInfo(boolean includeParentMessageInfo)
Determines whether to include the parent message's information in the results when the updated messages are replies in a thread.Information includes:- parent message’s message- parent message’s sender- parent message’s message type- parent message’s file info (for file message)- file name- file type (mime)- url (file url)- parent message’s createdAt
- Parameters:
includeParentMessageInfo
- Iftrue
the result will be returned with messages with parent's message's information, if the message is a reply message.
-
setIncludeParentMessageText
@Deprecated() MessagePayloadFilter.Builder 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 getMessage of the parent message.If it is FileMessage, the value is the name of the uploaded file.
- Parameters:
includeParentMessageText
- Iftrue
the result will be returned with messages with parent's message's text, if the message is a reply message.
-
build
MessagePayloadFilter build()
-
-
-
-