PublicGroupChannelListQuery

A class representing query to retrieve GroupChannel list for the current User.

Currently, 1 kind of public GroupChannel list can be queried.

Since

3.0.50

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A channel name filter. GroupChannel list containing the passed channel name will be returned.

Link copied to clipboard

The List of channel URL filter.

Link copied to clipboard

Restricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.

Link copied to clipboard

Restricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.

Link copied to clipboard

List of custom type filter. It will be null if custom types filter hasn't been set before. When set, public GroupChannel list containing only and exactly the passed custom types will be returned.

Link copied to clipboard

A filter to return channels that start with the specified Custom Type.

Link copied to clipboard
Link copied to clipboard

Checks whether query result includes empty channels.

Link copied to clipboard

Checks whether query result includes frozen channels.

Link copied to clipboard

Whether to include channel metadata on fetch. This flag is true by default

Link copied to clipboard

if the current query is in communication progress with server.

Link copied to clipboard
val limit: Int

The maximum number of GroupChannels per page.

Link copied to clipboard

Membership filter. Default is MembershipFilter.JOINED.

Link copied to clipboard

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

Link copied to clipboard

Meta data order key filter.

Link copied to clipboard

Works exclusively with metaDataValueStartsWith.

Link copied to clipboard

Works exclusively with metaDataValues.

Link copied to clipboard

Result order of channels. Refer to GroupChannelListQueryOrder.

Link copied to clipboard

super channel filter.

Functions

Link copied to clipboard

Gets the list of public GroupChannels. 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 public GroupChannel list. If there is no more pages to be read, an empty List (not null) is returned to handler.