Readonly channelA 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.
Readonly channelList 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.
Readonly createdRestricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.
Readonly createdRestricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.
Readonly customA 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.
Readonly customList 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.
Readonly hiddenHidden channel filter.
Readonly includeWhether to include chat notification GroupChannel. (default: false)
Readonly includeChecks whether query result includes empty channels (channels without messages). (default: false)
Readonly includeChecks whether query result includes frozen channels. (default: true)
Readonly includeWhether to include channel metadata on fetch. (default: true)
Readonly limitThe maximum number of data per queried page.
Readonly metadataThe metadataKey set with either metaDataValues or metaDataValueStartsWith.
Readonly metadataMeta 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
Readonly metadataWorks exclusively with metaDataValues.
Readonly metadataWorks exclusively with metaDataValueStartsWith.
Readonly myA filter to return channels with the current User state matching to MyMemberStateFilter.
Readonly 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.
Readonly nicknameSearches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.
Readonly 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.
Readonly orderResult order of channels.
Readonly publicPublic channel filter.
Readonly searchSearch filter including fields and query string.
Readonly superSuper channel filter.
Readonly unreadUnread channel filter.
Readonly userUser IDs filter. GroupChannel list containing exactly or inclusively the passed User IDs will be returned. This does not cooperate with other filters.
Whether there is a next page.
Whether the current query is in communication progress with server.
Gets the list of 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.
Generated using TypeDoc
Description
A class representing query to retrieve GroupChannel list for the current User. The query can be get by calling sendbirdChat.groupChannel.createMyGroupChannelListQuery().