MessageSearchQueryParams

data class MessageSearchQueryParams @JvmOverloads constructor(keyword: String, reverse: Boolean, exactMatch: Boolean, limit: Int, messageTimestampFrom: Long, messageTimestampTo: Long, channelUrl: String?, channelCustomType: String?, order: MessageSearchQuery.Order, advancedQuery: Boolean, targetFields: List<String>?)

Params for creating a MessageSearchQuery object.

Since

3.0.116

See also

Constructors

Link copied to clipboard
fun MessageSearchQueryParams(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
var advancedQuery: Boolean = false

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

Link copied to clipboard
var channelCustomType: String? = null

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

Link copied to clipboard
var channelUrl: String?

The channel url to set as the search scope.

Link copied to clipboard
var exactMatch: Boolean = false

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

Link copied to clipboard
val keyword: String

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
var messageTimestampFrom: Long = 0

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

Link copied to clipboard
var messageTimestampTo: Long

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

Link copied to clipboard
var order: MessageSearchQuery.Order

The MessageSearchQuery.Order of the search.

Link copied to clipboard
var reverse: Boolean = false

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

Link copied to clipboard
var targetFields: List<String>? = null

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