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

QueryChannelsRequest

data class QueryChannelsRequest(val filter: FilterObject, var offset: Int = 0, var limit: Int, val querySort: QuerySorter<Channel> = QuerySortByField(), var messageLimit: Int = 0, var memberLimit: Int = 1) : ChannelRequest<QueryChannelsRequest>

Request body class for querying channels.

Constructors

QueryChannelsRequest

constructor(filter: FilterObject, offset: Int = 0, limit: Int, querySort: QuerySorter<Channel> = QuerySortByField(), messageLimit: Int = 0, memberLimit: Int = 1)

Properties

val filter: FilterObject

FilterObject conditions used by backend to filter queries response.

val isFirstPage: Boolean

True if this request is querying the first page, otherwise False.

Number of channels to be returned by this query channels request.

var memberLimit: Int

Number of members in the response.

var messageLimit: Int

Number of messages in the response.

var offset: Int

Pagination offset.

open override var presence: Boolean

val querySort: QuerySorter<Channel>

QuerySorter Sort specification for api queries.

val sort: List<Map<String, Any>>

List of sort specifications.

open override var state: Boolean

open override var watch: Boolean

Functions

fun withLimit(limit: Int): QueryChannelsRequest

Sets the number of channels to be returned by this backend.

fun withMessages(limit: Int): QueryChannelsRequest

Sets the limit of number of messages to be returned by this backend.

fun withOffset(offset: Int): QueryChannelsRequest

Sets the offset to this request.

Inherited functions

open fun noPresence(): QueryChannelsRequest

open fun noState(): QueryChannelsRequest

open fun noWatch(): QueryChannelsRequest

open fun withPresence(): QueryChannelsRequest

open fun withState(): QueryChannelsRequest

open fun withWatch(): QueryChannelsRequest