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

QueryChannelsRequest

data class QueryChannelsRequest @JvmOverloads constructor(val filter: FilterObject, var offset: Int = 0, var limit: Int, val querySort: QuerySorter<Channel> = QuerySortByField(), var messageLimit: Int? = null, var memberLimit: Int? = null, val predefinedFilter: String? = null, val filterValues: Map<String, Any>? = null, val sortValues: Map<String, Any>? = null) : ChannelRequest<QueryChannelsRequest>

Request body class for querying channels.

Constructors

QueryChannelsRequest

constructor(filter: FilterObject, offset: Int = 0, limit: Int, querySort: QuerySorter<Channel> = QuerySortByField(), messageLimit: Int? = null, memberLimit: Int? = null, predefinedFilter: String? = null, filterValues: Map<String, Any>? = null, sortValues: Map<String, Any>? = null)

constructor(predefinedFilter: String, limit: Int, filterValues: Map<String, Any>? = null, sortValues: Map<String, Any>? = null, offset: Int = 0, messageLimit: Int? = null, memberLimit: Int? = null)

Constructs a QueryChannelsRequest for a server-side predefined filter. filter and querySort are ignored by the backend in this mode and are defaulted to neutral values.

Properties

val filter: FilterObject

FilterObject conditions used by backend to filter queries response. If predefinedFilter is specified, this field is ignored.

val filterValues: Map<String, Any>?

Values to interpolate into the predefined filter template.

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. When null, the server-side default is used.

var messageLimit: Int?

Number of messages in the response. When null, the server-side default is used.

var offset: Int

Pagination offset.

predefinedFilter

val predefinedFilter: String?

ID of a server-side predefined filter to use instead of filter. When set, filter and querySort are ignored by the backend.

open override var presence: Boolean

val querySort: QuerySorter<Channel>

QuerySorter Sort specification for api queries. If predefinedFilter is specified, this field is ignored.

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

List of sort specifications.

val sortValues: Map<String, Any>?

Values to interpolate into the predefined sort template.

open override var state: Boolean

open override var watch: Boolean

Functions

open fun noPresence(): QueryChannelsRequest

open fun noState(): QueryChannelsRequest

open fun noWatch(): QueryChannelsRequest

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.

open fun withPresence(): QueryChannelsRequest

open fun withState(): QueryChannelsRequest

open fun withWatch(): QueryChannelsRequest