MessageSearchQueryParams

data class MessageSearchQueryParams @JvmOverloads constructor(val keyword: String, var reverse: Boolean = false, var exactMatch: Boolean = false, var limit: Int = QUERY_DEFAULT_LIMIT, var messageTimestampFrom: Long = 0, var messageTimestampTo: Long = Long.MAX_VALUE, var channelUrl: String? = "", var channelCustomType: String? = null, var order: MessageSearchQuery.Order = MessageSearchQuery.Order.SCORE, var advancedQuery: Boolean = false, var targetFields: List<String>? = null)

Params for creating a MessageSearchQuery object.

Since

3.0.116

See also

Constructors

Link copied to clipboard
constructor(keyword: String, reverse: Boolean = false, exactMatch: Boolean = false, limit: Int = QUERY_DEFAULT_LIMIT, messageTimestampFrom: Long = 0, messageTimestampTo: Long = Long.MAX_VALUE, channelUrl: String? = "", channelCustomType: String? = null, order: MessageSearchQuery.Order = MessageSearchQuery.Order.SCORE, advancedQuery: Boolean = false, targetFields: List<String>? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The channel url to set as the search scope.

Link copied to clipboard

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

Link copied to clipboard

The keyword to search for.

Link copied to clipboard
var limit: Int

the maximum number of BaseMessages per queried page. Defaults to 20.

Link copied to clipboard

The start message timestamp set as the search range. Default is 0.

Link copied to clipboard

The end message timestamp set as the search range. Default is Long.MAX_VALUE.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Target fields of the query to set as the search scope.