stream-chat-android-client/io.getstream.chat.android.client.api.models/QueryThreadsRequest

QueryThreadsRequest

data class QueryThreadsRequest @JvmOverloads constructor(val filter: FilterObject? = null, val sort: QuerySorter<Thread> = DefaultSort, val watch: Boolean = true, val limit: Int = 10, val memberLimit: Int = 100, val next: String? = null, val participantLimit: Int = 100, val prev: String? = null, val replyLimit: Int = 2, val user: User? = null, val userId: String? = null)

Query threads request.

Constructors

QueryThreadsRequest

constructor(filter: FilterObject? = null, sort: QuerySorter<Thread> = DefaultSort, watch: Boolean = true, limit: Int = 10, memberLimit: Int = 100, next: String? = null, participantLimit: Int = 100, prev: String? = null, replyLimit: Int = 2, user: User? = null, userId: String? = null)

Types

object Companion

Properties

val filter: FilterObject? = null

The filter object for the query. Supported fields:

val limit: Int = 10

The number of threads to return. Defaults to 10.

val memberLimit: Int = 100

The number of members to request per thread. Defaults to 100.

val next: String? = null

The next pagination token. This token can be used to fetch the next page of threads.

participantLimit

val participantLimit: Int = 100

The number of thread participants to request per thread. Defaults to 100.

val prev: String? = null

The previous pagination token. This token can be used to fetch the previous page of threads.

val replyLimit: Int = 2

The number of latest replies to fetch per thread. Defaults to 2.

val sort: QuerySorter<Thread>

The sort object for the query. Supported fields:

val ~~user~~: User? = null

The user for which the threads are queried. Defaults to null. This property is deprecated and is not used.

val ~~userId~~: String? = null

The user ID for which the threads are queried. Defaults to null. This property is deprecated and is not used.

val watch: Boolean = true

If true, all the channels corresponding to threads returned in response will be watched. Defaults to true.