com.sendbird.android

Class MessagePayloadFilter.Builder

java.lang.Object

com.sendbird.android.MessagePayloadFilter.Builder

Enclosing class:

MessagePayloadFilter

public static final class MessagePayloadFilter.Builder
extends java.lang.Object

A Builder class to build a MessagePayloadFilter

Since:

3.0.171

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MessagePayloadFilter	build()
MessagePayloadFilter.Builder	setIncludeMetaArray(boolean includeMetaArray) Determines whether to include the meta array information of the updated 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) Deprecated. As of 3.0.173, replaced by setIncludeParentMessageInfo(boolean).
MessagePayloadFilter.Builder	setIncludePollDetails(boolean includePollDetails) Determines whether to include the poll of the returned 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setIncludeMetaArray

public MessagePayloadFilter.Builder setIncludeMetaArray(boolean includeMetaArray)

Determines whether to include the meta array information of the updated messages in the results.

Parameters:

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

Since:

3.0.171

setIncludeReactions

public MessagePayloadFilter.Builder setIncludeReactions(boolean includeReactions)

Determines whether to include the reactions to the updated messages in the results.

Parameters:

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

Since:

3.0.171

setIncludeParentMessageText

@Deprecated
public MessagePayloadFilter.Builder setIncludeParentMessageText(boolean includeParentMessageText)

Deprecated. As of 3.0.173, replaced by setIncludeParentMessageInfo(boolean).

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.

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.171

setIncludeParentMessageInfo

public 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 - If true the result will be returned with messages with parent's message's information, if the message is a reply message.

Since:

3.0.173

setIncludeThreadInfo

public 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 - If true the result will be returned with thread information included.

Since:

3.0.171

setIncludePollDetails

public MessagePayloadFilter.Builder setIncludePollDetails(boolean includePollDetails)

Determines whether to include the poll of the returned messages in the results.

Parameters:

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

Since:

3.0.171

build

public MessagePayloadFilter build()