Sendbird Chat/com.sendbird.android.params/PreviousMessageListQueryParams

PreviousMessageListQueryParams

data class PreviousMessageListQueryParams @JvmOverloads constructor(var customTypesFilter: Collection<String>? = null, var messageTimestamp: Long = Long.MAX_VALUE, var reverse: Boolean = false, var messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, var senderUserIdsFilter: List<String>? = null, var replyType: ReplyType = ReplyType.NONE, var messagePayloadFilter: MessagePayloadFilter = MessagePayloadFilter(), var showSubchannelMessagesOnly: Boolean = false, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a PreviousMessageListQuery object.

Since

4.0.0

See also

Constructors

Link copied to clipboard
@JvmOverloads
constructor(customTypesFilter: Collection<String>? = null, messageTimestamp: Long = Long.MAX_VALUE, reverse: Boolean = false, messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, senderUserIdsFilter: List<String>? = null, replyType: ReplyType = ReplyType.NONE, messagePayloadFilter: MessagePayloadFilter = MessagePayloadFilter(), showSubchannelMessagesOnly: Boolean = false, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

Link copied to clipboard
var customTypesFilter: Collection<String>?

The custom type filter of the message. When set, only messages with customType that equals to one of customTypes will be returned. When a customType is an empty string (""), all messages without a custom type will be returned.

Link copied to clipboard
var limit: Int

The maximum number of items per queried page.

Link copied to clipboard
var messagePayloadFilter: MessagePayloadFilter

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

Link copied to clipboard
var messageTimestamp: Long

The time of a request.

Link copied to clipboard
Link copied to clipboard
var replyType: ReplyType

Determines the reply types to include in the results.

Link copied to clipboard
var reverse: Boolean

Indicates whether the queried result will be reversed. If true, the result will be returned by creation time descending order.

Link copied to clipboard
var senderUserIdsFilter: List<String>?

Sender user ids filter.

Link copied to clipboard
var showSubchannelMessagesOnly: Boolean

If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.