GroupChannelListQuery

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

Currently, 1 kind of GroupChannel list can be queried.

The query can be get by calling GroupChannel.createMyGroupChannelListQuery.

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. If you pass name such as "abc", then the returned channel list will be containing name like "abc". It will return null if channel name filter hasn't been set before.

Link copied to clipboard

List of channel URL filter. It will return null if channel URL filter hasn't been set before. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A filter to return channels that start with the specified Custom Type. It will return null if custom type starts with filter hasn't been set before.

Link copied to clipboard

Whether there is a next page.

Link copied to clipboard

Hidden channel filter. Refer to HiddenChannelFilter.

Link copied to clipboard

Whether to include chat notification GroupChannel.

Link copied to clipboard

Checks whether query result includes empty channels. (channels without messages).

Link copied to clipboard

Checks whether query result includes frozen channels.

Link copied to clipboard

Whether to include channel metadata on fetch.

Link copied to clipboard

Whether 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

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

Link copied to clipboard

Meta data order key filter. It will return null if meta data order key filter hasn't been set before. This filter will work only if order is GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL

Link copied to clipboard

Works exclusively with metaDataValueStartsWith.

Link copied to clipboard

Works exclusively with metaDataValues.

Link copied to clipboard

A filter to return channels with the current User state matching to MyMemberStateFilter.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames contain the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc". This does not cooperate with other filters.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames starts with the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc*". This does not cooperate with other filters.

Link copied to clipboard

Public channel filter. Refer to PublicChannelFilter.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Super channel filter. Refer to SuperChannelFilter.

Link copied to clipboard

Unread channel filter. Refer to UnreadChannelFilter.

Link copied to clipboard

User IDs exact filter.GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.

Link copied to clipboard

User IDs include filter. It will return null if User IDs include filter hasn't been set before. This does not cooperate with other filters.

Functions

Link copied to clipboard

Verify that the given channel information matches the current query filter.

Link copied to clipboard

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

Link copied to clipboard

Serializes the GroupChannelListQuery instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.

Link copied to clipboard
open override fun toString(): String