SendbirdChat/com.sendbird.android.message.query/PreviousMessageListQuery

PreviousMessageListQuery

class PreviousMessageListQuery

A class representing query to retrieve previous message list for channels.

Currently, 1 kind of message list can be queried.

  • The list of previous messages for a channel.

The query can be get by calling OpenChannel.createPreviousMessageListQuery or GroupChannel.createPreviousMessageListQuery.

Properties

Link copied to clipboard
var channel: BaseChannel?

The current channel.

Link copied to clipboard
val channelType: ChannelType

The type of the channel to get messages from.

Link copied to clipboard
val channelUrl: String

The url of the channel to get messages from.

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

The custom type filter of the message.

Link copied to clipboard
var hasMore: Boolean

Whether there is more page to load.

Link copied to clipboard
@get:Synchronized
var isLoading: Boolean

Whether the current query is in communication progress with server.

Link copied to clipboard
val limit: Int

The maximum number of messages per queried page.

Link copied to clipboard
val 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. The initial value will be a value from PreviousMessageListQueryParams.messageTimestamp. After each call of load, this value will change to the oldest BaseMessage.createdAt value of the message that have been fetched.

Link copied to clipboard
Link copied to clipboard
val replyType: ReplyType

Determines the reply types to include in the results.

Link copied to clipboard
val 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
val senderUserIdsFilter: List<String>?

Sender user ids filter.

Link copied to clipboard
val 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.

Functions

Link copied to clipboard
@Synchronized
fun load(handler: BaseMessagesHandler?)

Requests query result for the previous messages. The queried result is passed to handler as list.