com.sendbird.android

Class MessageChangeLogsParams

java.lang.Object

com.sendbird.android.MessageChangeLogsParams

public class MessageChangeLogsParams
extends java.lang.Object

Represents a message list params. BaseChannel.getMessageChangeLogsSinceTimestamp(long, MessageChangeLogsParams, BaseChannel.GetMessageChangeLogsHandler). BaseChannel.getMessageChangeLogsSinceToken(String, MessageChangeLogsParams, BaseChannel.GetMessageChangeLogsHandler).

Since:

3.0.130

Constructor Summary

Constructors

Constructor and Description
MessageChangeLogsParams()
MessageChangeLogsParams(boolean includeMetaArray, boolean includeReactions, boolean includeThreadInfo, boolean includeReplies, boolean includeParentMessageText)
MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter, ReplyTypeFilter replyTypeFilter)

Method Summary

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	setIncludePollDetails(boolean includePollDetails) Determines whether to include the poll of the returned messages in the results.
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	shouldIncludePollDetails() Returns whether to include the poll of the returned 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()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageChangeLogsParams

public MessageChangeLogsParams()

MessageChangeLogsParams

public MessageChangeLogsParams(MessagePayloadFilter messagePayloadFilter,
                               ReplyTypeFilter replyTypeFilter)

MessageChangeLogsParams

public MessageChangeLogsParams(boolean includeMetaArray,
                               boolean includeReactions,
                               boolean includeThreadInfo,
                               boolean includeReplies,
                               boolean includeParentMessageText)

Method Detail

setIncludeMetaArray

public 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 MessagePayloadFilter.setIncludeMetaArray(boolean).

Parameters:

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

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeReactions

public void setIncludeReactions(boolean includeReactions)

Determines whether to include the reactions of the updated messages in the results. Internally, this will be set on MessagePayloadFilter.setIncludeReactions(boolean).

Parameters:

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

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeThreadInfo

public 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 MessagePayloadFilter.setIncludeThreadInfo(boolean).

Parameters:

includeThreadInfo - If true the result will be returned with thread information included.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeReplies

@Deprecated
public void setIncludeReplies(boolean includeReplies)

Deprecated. As of 3.0.173, replaced by setReplyTypeFilter(ReplyTypeFilter).

Determines whether to include the updated replies in the results.

Parameters:

includeReplies - If true the result will be returned with reply messages included.

Since:

3.0.130

setIncludeParentMessageText

@Deprecated
public void setIncludeParentMessageText(boolean includeParentMessageText)

Deprecated. As of 3.0.173, replaced by setMessagePayloadFilter(MessagePayloadFilter) with MessagePayloadFilter.Builder.setIncludeParentMessageInfo(boolean).

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

Parameters:

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.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludePollDetails

public void setIncludePollDetails(boolean includePollDetails)

Determines whether to include the poll of the returned messages in the results. Internally, this will be set on MessagePayloadFilter.setIncludePollDetails(boolean).

Parameters:

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

Since:

3.0.171

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setMessagePayloadFilter

public void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)

Sets the MessagePayloadFilter to be used in retrieving message lists.

Parameters:

messagePayloadFilter - MessagePayloadFilter with preferred filters set.

Since:

3.0.171

setReplyTypeFilter

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

Since:

3.0.173

shouldIncludeMetaArray

public boolean shouldIncludeMetaArray()

Returns whether to include the meta array information of the updated messages in the results. Can also be checked by getMessagePayloadFilter().

Returns:

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

Since:

3.0.136

shouldIncludeReactions

public boolean shouldIncludeReactions()

Returns whether to include the reactions of the updated messages in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether to include the reactions of the updated messages in the results.

Since:

3.0.136

shouldIncludeThreadInfo

public 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().

Returns:

Whether to include the thread information of the updated messages in the results when the results contain parent messages.

Since:

3.0.136

shouldIncludeReplies

@Deprecated
public boolean shouldIncludeReplies()

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

Returns whether to include the updated replies in the results.

Returns:

Whether to include the updated replies in the results.

Since:

3.0.136

isIncludeParentMessageText

@Deprecated
public boolean isIncludeParentMessageText()

Deprecated. As of 3.0.173, replaced by MessagePayloadFilter.shouldIncludeParentMessageInfo() from getMessagePayloadFilter().

Returns whether to include the parent message text in the results when the updated messages are threaded replies. Can also be checked by getMessagePayloadFilter().

Returns:

Whether to include the parent message text in the results when the updated messages are threaded replies.

Since:

3.0.136

shouldIncludePollDetails

public boolean shouldIncludePollDetails()

Returns whether to include the poll of the returned messages in the results. Can also be checked by getMessagePayloadFilter().

Returns:

Whether to include the poll of the returned messages in the results.

Since:

3.0.171

getMessagePayloadFilter

public MessagePayloadFilter getMessagePayloadFilter()

Returns the MessagePayloadFilter set in this param.

Returns:

MessagePayloadFilter.

Since:

3.0.171

getReplyTypeFilter

public ReplyTypeFilter getReplyTypeFilter()

Returns the ReplyTypeFilter which should be included in the results.

Returns:

The ReplyTypeFilter which should be included in the results.

Since:

3.0.173

clone

public MessageChangeLogsParams clone()

Clones and returns a new instance of MessageChangeLogsParams.

Overrides:

clone in class java.lang.Object

Returns:

a cloned new instance of this MessageChangeLogsParams.

Since:

3.0.130

from

public static MessageChangeLogsParams from(PreviousMessageListQuery query)

Create MessageChangeLogsParams from a given PreviousMessageListQuery instance.

Parameters:

query - PreviousMessageListQuery instance to clone from.

Returns:

A created instance of MessageChangeLogsParams

Since:

3.0.136

from

public static MessageChangeLogsParams from(MessageListParams params)

Create MessageChangeLogsParams from a given MessageListParams instance.

Parameters:

params - MessageListParams instance to clone from.

Returns:

A created instance of MessageChangeLogsParams

Since:

3.0.136

from

public static MessageChangeLogsParams from(ThreadMessageListParams params)

Create MessageChangeLogsParams from a given ThreadMessageListParams instance.

Parameters:

params - ThreadMessageListParams instance to clone from.

Returns:

A created instance of MessageChangeLogsParams

Since:

3.0.136

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object