A class representing query to retrieve GroupChannel list for the current User.
The query can be get by calling sendbirdChat.groupChannel.createMyGroupChannelListQuery().
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.
ReadonlycreatedAfter
createdAfter:number
Description
Restricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.
ReadonlycreatedBefore
createdBefore:number
Description
Restricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.
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.
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.
Whether to include chat notification GroupChannel. (default: false)
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)
Readonlylimit
limit:number = DEFAULT_LIST_QUERY_LIMIT
Description
The maximum number of data per queried page.
ReadonlymetadataKey
metadataKey:null | string = null
Description
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
A filter to return channels with the current User state matching to MyMemberStateFilter.
ReadonlynicknameContainsFilter
nicknameContainsFilter:null | string = null
Description
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.
ReadonlynicknameExactMatchFilter
nicknameExactMatchFilter:null | string = null
Description
Searches for GroupChannels with members whose nicknames match the specified value.
This does not cooperate with other filters.
ReadonlynicknameStartsWithFilter
nicknameStartsWithFilter:null | string = null
Description
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.
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.
serialize
serialize(): object
Returns object
Description
Serializes the GroupChannelListQuery instance.
This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.
Description
A class representing query to retrieve GroupChannel list for the current User. The query can be get by calling sendbirdChat.groupChannel.createMyGroupChannelListQuery().