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

MessageSearchQuery

A class representing query to retrieve list of BaseMessages that matches a given query with given filters. MessageSearchQuery can be generated by using SendbirdChat.createMessageSearchQuery

Since

3.0.116

Types

Companion

object Companion

Order

enum Order : Enum<MessageSearchQuery.Order>

The order in which the query result will be based on. SCORE query returns the result as by their matching score. TIMESTAMP query returns the result as by BaseMessage's timestamp.

Properties

channelCustomType

val channelCustomType: String?

The current custom type of channel set as the search scope.

channelUrl

val channelUrl: String?

The current channel url set as the search scope.

exactMatch

val exactMatch: Boolean

Whether the current search query should be an exact match or not.

hasNext

var hasNext: Boolean

Whether there is a next page.

isAdvancedQuery

val isAdvancedQuery: Boolean

Whether the current search query should be an advanced query or not.

isLoading

@get:Synchronized

var isLoading: Boolean

Whether the current query is in communication progress with server.

keyword

val keyword: String

The current search keyword.

limit

val limit: Int

The maximum number of BaseMessages per single query.

messageTimestampFrom

val messageTimestampFrom: Long

The start message timestamp set as the search range.

messageTimestampTo

val messageTimestampTo: Long

The end message timestamp set as the search range.

order

val order: MessageSearchQuery.Order

The current order method.

reverse

val reverse: Boolean

Whether the current search result is set to be reversed or not.

targetFields

val targetFields: List<String>?

The target fields of the current query as the search scope.

totalCount

var totalCount: Int

The total count of results that matches the given search.

Functions

@Synchronized

fun next(handler: BaseMessagesHandler?)

Gets the list of BaseMessages that matches the given search. The queried result is passed to handler as list. If this method is repeatedly called after each next() is finished, it retrieves the following search results as BaseMessage list. If there is no more search results, an empty List (not null) is returned to handler.

serialize

fun serialize(): ByteArray

Serializes the [MessageSearchQuery] instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.