Optional
channelOptional
channelList of channel URL filter. GroupChannel list of exactly matched channel URLs will be returned.
Optional
createdRestricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.
Optional
createdRestricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.
Optional
customList of custom type filter. GroupChannel list of exactly matched custom types will be returned.
Optional
customA filter to return channels that start with the specified customType.
Optional
hiddenHidden channel filter. Refer to HiddenChannelFilter.
Optional
includeWhether to include chat notification channels.
Optional
includeWhether to include the channels with no message. (default: true)
Optional
includeWhether to include frozen channels or not. (default: true)
Optional
includeWhether to include channel metadata. (default: true)
Optional
limitOptional
metadataThe metadataKey set with either metaDataValues
or metaDataValueStartsWith
.
Optional
metadataMeta data order key filter.
This filter will work only if order
is GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL.
Optional
metadataWorks exclusively with metaDataValueStartsWith
.
Optional
metadataWorks exclusively with metaDataValues
.
Optional
myA filter to return channels with the current user state matching to MyMemberStateFilter.
Optional
nicknameSearches 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.
Optional
nicknameSearches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.
Optional
nicknameSearches 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.
Optional
orderResult order of channels.
Refer to GroupChannelListQueryOrder.
GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL works only with metaDataOrderKeyFilter
.
Optional
publicPublic channel filter. Refer to PublicChannelFilter.
Optional
searchSearch fields. Refer to GroupChannelSearchFilter.
Optional
superSuper channel filter. Refer to SuperChannelFilter.
Optional
unreadUnread channel filter. Refer to UnreadChannelFilter.
Optional
userUser IDs exact filter. Refer to GroupChannelUserIdsFilter
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".