com.sendbird.android

Class MessageRetrievalParams

java.lang.Object

com.sendbird.android.MessageRetrievalParams

public class MessageRetrievalParams
extends java.lang.Object

Represents a message list params. BaseMessage.getMessage(MessageRetrievalParams, BaseMessage.GetMessageHandler).

Since:

3.0.130

Constructor Summary

Constructors

Constructor and Description
MessageRetrievalParams(java.lang.String channelUrl, BaseChannel.ChannelType channelType, long messageId) Create a MessageRetrievalParams to use in BaseMessage.getMessage(MessageRetrievalParams, BaseMessage.GetMessageHandler).

Method Summary

Modifier and Type	Method and Description
MessageRetrievalParams	clone() Clones and returns a new instance of MessageRetrievalParams.
BaseChannel.ChannelType	getChannelType() Returns the BaseChannel.ChannelType.
java.lang.String	getChannelUrl() Returns the channel url.
long	getMessageId() Returns the message ID.
MessagePayloadFilter	getMessagePayloadFilter() Returns the MessagePayloadFilter set in this param.
void	setIncludeMetaArray(boolean includeMetaArray) Determines whether a meta array of the message is included in the results.
void	setIncludeParentMessageText(boolean includeParentMessageText) Deprecated. As of 3.0.173, replaced by setMessagePayloadFilter(MessagePayloadFilter) with MessagePayloadFilter.Builder.setIncludeParentMessageInfo(boolean).
void	setIncludeThreadInfo(boolean includeThreadInfo) Determines whether the thread information is included in the results set when the returned message is a parent message.
void	setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter) Sets the MessagePayloadFilter to be used in retrieving message.
boolean	shouldIncludeMetaArray() Returns whether the result message should include meta array.
boolean	shouldIncludeParentMessageText() Deprecated. As of 3.0.173, replaced by MessagePayloadFilter.shouldIncludeParentMessageInfo() from getMessagePayloadFilter().
boolean	shouldIncludeThreadInfo() Returns whether the thread information is included in the results set when the returned message is a parent message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageRetrievalParams

public MessageRetrievalParams(java.lang.String channelUrl,
                              BaseChannel.ChannelType channelType,
                              long messageId)

Create a MessageRetrievalParams to use in BaseMessage.getMessage(MessageRetrievalParams, BaseMessage.GetMessageHandler).

Parameters:

channelUrl - Specifies the URL of the channel to retrieve the message.

channelType - Specifies the type of the channel.

messageId - Specifies the unique ID of the message to retrieve.

Since:

3.0.130

Method Detail

setIncludeMetaArray

public void setIncludeMetaArray(boolean includeMetaArray)

Determines whether a meta array of the message is included in the results. Internally, this will be set on MessagePayloadFilter.setIncludeMetaArray(boolean).

Parameters:

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

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setIncludeThreadInfo

public void setIncludeThreadInfo(boolean includeThreadInfo)

Determines whether the thread information is included in the results set when the returned message is a parent message. 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).

setIncludeParentMessageText

@Deprecated
public void setIncludeParentMessageText(boolean includeParentMessageText)

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

Determines whether the text of a parent message is included in the results when the returned message is a reply in a thread. 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.

Since:

3.0.130

See Also:

setMessagePayloadFilter(MessagePayloadFilter).

setMessagePayloadFilter

public void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)

Sets the MessagePayloadFilter to be used in retrieving message. This is more preferred way of setting other include flags.

Parameters:

messagePayloadFilter - MessagePayloadFilter with preferred filters set.

Since:

3.0.171

getChannelUrl

public java.lang.String getChannelUrl()

Returns the channel url.

Returns:

The channel url.

Since:

3.0.136

getChannelType

public BaseChannel.ChannelType getChannelType()

Returns the BaseChannel.ChannelType.

Returns:

The BaseChannel.ChannelType.

Since:

3.0.136

getMessageId

public long getMessageId()

Returns the message ID.

Returns:

The message ID.

Since:

3.0.136

shouldIncludeMetaArray

public boolean shouldIncludeMetaArray()

Returns whether the result message should include meta array. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the result message should include meta array.

Since:

3.0.136

shouldIncludeThreadInfo

public boolean shouldIncludeThreadInfo()

Returns whether the thread information is included in the results set when the returned message is a parent message. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the thread information is included in the results set when the returned message is a parent message.

Since:

3.0.136

shouldIncludeParentMessageText

@Deprecated
public boolean shouldIncludeParentMessageText()

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

Returns whether the text of a parent message is included in the results when the returned message is a reply in a thread. Can also be checked by getMessagePayloadFilter().

Returns:

Whether the text of a parent message is included in the results when the returned message is a reply in a thread.

Since:

3.0.136

getMessagePayloadFilter

public MessagePayloadFilter getMessagePayloadFilter()

Returns the MessagePayloadFilter set in this param.

Returns:

MessagePayloadFilter.

Since:

3.0.171

clone

public MessageRetrievalParams clone()

Clones and returns a new instance of MessageRetrievalParams.

Overrides:

clone in class java.lang.Object

Returns:

a cloned new instance of this MessageRetrievalParams.

Since:

3.1.7

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object