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

PinnedMessageListQuery

class PinnedMessageListQuery

A class representing query to retrieve lists related to pinned messages.

Since

4.8.0

See also

SendbirdChat.createPinnedMessageListQuery

GroupChannel.pinMessage

GroupChannel.pinnedMessageIds

Properties

val channelType: ChannelType

The ChannelType of the channel you want to get pinned messages from.

val channelUrl: String

The channel url of the channel you want to get pinned messages from.

var hasNext: Boolean

Whether there is a next page.

includePollDetails

val includePollDetails: Boolean?

whether the poll details should be included in the results.

@get:Synchronized

var isLoading: Boolean

Whether the current query is in communication progress with server.

val limit: Int?

The maximum number of items per queried page.

messagePayloadParams

val messagePayloadParams: MessagePayloadParams?

The MessagePayloadParams of the message you want to get.

Functions

fun next(handler: PinnedMessagesHandler?)

Gets the list of PinnedMessages. The queried result is passed to handler as List. If this method is repeatedly called after each next is finished, it retrieves the following pages of the PinnedMessage list. If there is no more pages to be read, an empty List (not null) is returned to handler.