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.
OptionalchannelUrlsFilter
channelUrlsFilter?:string[]
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.
OptionalcustomTypeStartsWithFilter
customTypeStartsWithFilter?:string
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.
OptionalcustomTypesFilter
customTypesFilter?:string[]
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.
OptionalincludeEmpty
includeEmpty?:boolean
Description
Checks whether query result includes empty channels (channels without messages). (default: false)
OptionalincludeFrozen
includeFrozen?:boolean
Description
Checks whether query result includes frozen channels. (default: true)
OptionalincludeMetaData
includeMetaData?:boolean
Description
Whether to include channel metadata on fetch. (default: true)
The metadataKey set with either metaDataValues or metaDataValueStartsWith.
OptionalmetadataOrderKeyFilter
metadataOrderKeyFilter?:string
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
Description
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.