GroupChannelListQuery

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.

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.

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

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

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.

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.

Whether there is a next page.

Hidden channel filter. Refer to HiddenChannelFilter.

Whether to include chat notification GroupChannel.

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

Checks whether query result includes frozen channels.

Whether to include channel metadata on fetch.

Whether the current query is in communication progress with server.

The maximum number of GroupChannels per page.

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

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

Works exclusively with metaDataValueStartsWith.

Works exclusively with metaDataValues.

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

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.

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

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.

Result order of channels. Refer to GroupChannelListQueryOrder. GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL works with metaDataOrderKeyFilter.

Public channel filter. Refer to PublicChannelFilter.

Search fields. Refer to GroupChannelListQueryParams.setSearchFilter and SearchField.

Query string. Refer to GroupChannelListQueryParams.setSearchFilter.

Super channel filter. Refer to SuperChannelFilter.

Unread channel filter. Refer to UnreadChannelFilter.

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

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.

QueryType of User IDs filter. Refer to GroupChannelListQueryParams.setUserIdsIncludeFilter

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

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.

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