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.
ReadonlychannelUrlsFilter
channelUrlsFilter:null | string[] = null
Description
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.
ReadonlycustomTypeStartsWithFilter
customTypeStartsWithFilter:null | string = null
Description
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.
ReadonlycustomTypesFilter
customTypesFilter:null | string[] = null
Description
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.
ReadonlyincludeEmpty
includeEmpty:boolean = false
Description
Checks whether query result includes empty channels (channels without messages). (default: false)
ReadonlyincludeFrozen
includeFrozen:boolean = true
Description
Checks whether query result includes frozen channels. (default: true)
ReadonlyincludeMetaData
includeMetaData:boolean = true
Description
Whether to include channel metadata on fetch. (default: true)
The metadataKey set with either metaDataValues or metaDataValueStartsWith.
ReadonlymetadataOrderKeyFilter
metadataOrderKeyFilter:null | string = null
Description
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
Gets the list of public GroupChannels.
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.
Description
A class representing query to retrieve public GroupChannel list.