GroupChannelListQuery class - sendbird_chat library

Constructors

GroupChannelListQuery({Chat? chat})

Properties

channelNameContainsFilter ↔ String?: 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".
read / write
channelUrlsFilter ↔ List<String>: 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.
read / write
chat → Chat: finalinherited
customTypesFilter ↔ List<String>: List of custom type filter. GroupChannel list containing only and exactly the passed custom types will be returned.
read / write
customTypeStartsWithFilter ↔ String?: A filter to return channels that start with the specified customType.
read / write
hashCode → int: The hash code for this object.
read-onlyinherited
hasNext ↔ bool: Whether there is a next page.
read / writeinherited
hiddenChannelFilter ↔ HiddenChannelFilter: Hidden channel filter. Refer to HiddenChannelFilter.
read / write
includeChatNotification ↔ bool: Whether to include chat notification GroupChannel. @since 4.0.1
read / write
includeEmpty ↔ bool: Checks whether query result includes empty channels. (channels without messages). This flag is true by default.
read / write
includeFrozen ↔ bool: Checks whether query result includes frozen channels. This flag is true by default.
read / write
includeMetaData ↔ bool: Checks whether to include channel metadata on fetch. This flag is true by default.
read / write
isLoading ↔ bool: Whether the current query is in communication progress with server.
read / writeinherited
limit ↔ int: The maximum number of items per queried page.
read / writeinherited
metaDataKey ↔ String?: The metadataKey set with either metaDataValues or metaDataValueStartsWith.
read / write
metaDataOrderKeyFilter ↔ String?: 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.metadataValueAlphabetical
read / write
metaDataValues ↔ List<String>?: Works exclusively with metaDataValueStartsWith.
read / write
metaDataValueStartsWith ↔ String?: Works exclusively with metaDataValues.
read / write
myMemberStateFilter ↔ MyMemberStateFilter: A filter to return channels with the current User state matching to MyMemberStateFilter.
read / write
nicknameContainsFilter ↔ String?: 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.
read / write
order ↔ GroupChannelListQueryOrder: Result order of channels. Refer to GroupChannelListQueryOrder. GroupChannelListQueryOrder.metadataValueAlphabetical works with metaDataOrderKeyFilter.
read / write
publicChannelFilter ↔ PublicChannelFilter: Public channel filter. Refer to PublicChannelFilter.
read / write
queryType ↔ GroupChannelListQueryType: GroupChannelListQueryType of User IDs filter. Refer to setUserIdsIncludeFilter
read / write
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
searchFields ↔ List<GroupChannelListQuerySearchField>: Search fields. Refer to setSearchFilter and GroupChannelListQuerySearchField.
read / write
searchQuery ↔ String?: Query string. Refer to setSearchFilter.
read / write
superChannelFilter ↔ SuperChannelFilter: Super channel filter. Refer to SuperChannelFilter.
read / write
token ↔ String?: read / writeinherited
unreadChannelFilter ↔ UnreadChannelFilter: Unread channel filter. Refer to UnreadChannelFilter.
read / write
userIdsExactFilter ↔ List<String>: User IDs exact filter.GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.
read / write
userIdsIncludeFilter ↔ List<String>: User IDs include filter.
read / write

Methods

next() → Future<List<GroupChannel>>: Gets the list of next items.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
setChannelUrlsFilter(List<String> channelUrls) → void: 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.
setMetaData(String key, List<String> values) → void: Works exclusively with setMetaDataValueStartsWith.
setMetaDataValueStartsWith(String key, String startWith) → void: Works exclusively with setMetaData.
setNicknameContainsFilter(String nickname) → void: 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.
setSearchFilter(List<GroupChannelListQuerySearchField> searchFields, String searchQuery) → void: Sets Search filter. GroupChannels will be included in the result if its data in specified GroupChannelListQuerySearchFields contains specified query string. Refer to GroupChannelListQuerySearchField. If you set multiple GroupChannelListQuerySearchFields, the result will be union of each result. searchFields that you want to search. searchQuery string you want to search with.
setUserIdsExactFilter(List<String> userIds) → void: User IDs exact filter.GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.
setUserIdsIncludeFilter(List<String> userIds, GroupChannelListQueryType type) → void: Sets User IDs filter. GroupChannel list containing the passed User IDs and other members will be returned. This does not cooperate with other filters.
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited