com.sendbird.android

Class MessagePayloadFilter

java.lang.Object

com.sendbird.android.MessagePayloadFilter

public final class MessagePayloadFilter
extends java.lang.Object

Represents a filter for BaseMessage's additional payload.

Since:

3.0.171

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessagePayloadFilter.Builder A Builder class to build a MessagePayloadFilter

Method Summary

Modifier and Type	Method and Description
MessagePayloadFilter	clone() Clones and returns a new instance of MessagePayloadFilter.
boolean	shouldIncludeMetaArray() Returns whether the meta arrays should be included in the results.
boolean	shouldIncludeParentMessageInfo() Returns whether the information of a parent message should be included in the reply messages included in the results.
boolean	shouldIncludeParentMessageText() Deprecated. As of 3.0.173, replaced by shouldIncludeParentMessageInfo().
boolean	shouldIncludeReactions() Returns whether the reaction data should be included in the results.
boolean	shouldIncludeThreadInfo() Returns whether the thread information should be included in the results.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

shouldIncludeMetaArray

public boolean shouldIncludeMetaArray()

Returns whether the meta arrays should be included in the results.

Returns:

Whether the meta arrays should be included in the results.

Since:

3.0.171

shouldIncludeReactions

public boolean shouldIncludeReactions()

Returns whether the reaction data should be included in the results.

Returns:

Whether the reaction data should be included in the results.

Since:

3.0.171

shouldIncludeParentMessageText

@Deprecated
public boolean shouldIncludeParentMessageText()

Deprecated. As of 3.0.173, replaced by shouldIncludeParentMessageInfo().

Returns whether the text of a parent message should be included in the reply messages included in the results.

Returns:

Whether the text of a parent message should be included in the reply messages included in the results.

Since:

3.0.171

shouldIncludeParentMessageInfo

public boolean shouldIncludeParentMessageInfo()

Returns whether the information of a parent message should be included in the reply messages included in the results.

Returns:

Whether the information of a parent message should be included in the reply messages included in the results.

Since:

3.0.173

shouldIncludeThreadInfo

public boolean shouldIncludeThreadInfo()

Returns whether the thread information should be included in the results.

Returns:

Whether thread information should be included in the results.

Since:

3.0.171

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public MessagePayloadFilter clone()

Clones and returns a new instance of MessagePayloadFilter.

Overrides:

clone in class java.lang.Object

Returns:

a cloned new instance of this MessagePayloadFilter.

Since:

3.0.171