SendbirdChat/com.sendbird.android.channel.query/OpenChannelListQuery

OpenChannelListQuery

class OpenChannelListQuery

A class representing query to retrieve OpenChannel list.

Currently, 1 kind of OpenChannel list can be queried. The list of OpenChannels the APP ID (refer to SendbirdChat.init has.

The query can be get by calling OpenChannel.createOpenChannelListQuery.

Properties

customTypeFilter

val customTypeFilter: String?

A filter to return only channels with the specified customType.

var hasNext: Boolean

Indicate whether if there is a next page.

val includeFrozen: Boolean

Indicate whether to include frozen channels or not.

includeMetadata

val includeMetadata: Boolean

Indicate whether to include channel metadata on fetch.

@get:Synchronized

var isLoading: Boolean

Indicate whether if the current query is in communication progress with server.

Indicate the maximum number of OpenChannels per queried page.

val nameKeyword: String?

Indicate search keyword for channel name.

val urlKeyword: String?

Indicate search keyword for channel URL.

Functions

fun next(handler: OpenChannelsCallbackHandler?)

Gets the list of OpenChannels. The queried result is passed to handler as List. If this method is repeatedly called after each next is finished, it retrieves the following pages of the OpenChannel list. If there is no more pages to be read, an empty List (not null) is returned to handler.