GroupChannelListQuery class
A class representing query to retrieve GroupChannel list for the current User. Currently, 1 kind of GroupChannel list can be queried. The list of GroupChannels the current User is a member of.
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".
getter/setter pair
-
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.getter/setter pair - chat → Chat
-
finalinherited
- createdAfter ↔ int?
-
Restricts the search scope to only retrieve group channels which have been created after the specified time, in milliseconds.
@since 4.1.2
getter/setter pair
- createdBefore ↔ int?
-
Restricts the search scope to only retrieve group channels which have been created before the specified time, in milliseconds.
@since 4.1.2
getter/setter pair
-
customTypesFilter
↔ List<
String> -
List of custom type filter. GroupChannel list containing only and exactly the passed custom types will be returned.
getter/setter pair
- customTypeStartsWithFilter ↔ String?
-
A filter to return channels that start with the specified customType.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNext ↔ bool
-
Whether there is a next page.
getter/setter pairinherited
-
Hidden channel filter. Refer to HiddenChannelFilter.
getter/setter pair
- includeChatNotification ↔ bool
-
Whether to include chat notification GroupChannel.
@since 4.0.3
getter/setter pair
- includeEmpty ↔ bool
-
Checks whether query result includes empty channels. (channels without messages).
This flag is true by default.
getter/setter pair
- includeFrozen ↔ bool
-
Checks whether query result includes frozen channels.
This flag is true by default.
getter/setter pair
- includeMetaData ↔ bool
-
Checks whether to include channel metadata on fetch.
This flag is true by default.
getter/setter pair
- isLoading ↔ bool
-
Whether the current query is in communication progress with server.
getter/setter pairinherited
- limit ↔ int
-
The maximum number of items per queried page.
getter/setter pairinherited
- metaDataKey ↔ String?
-
The metadataKey set with either metaDataValues or metaDataValueStartsWith.
getter/setter pair
- 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.metadataValueAlphabeticalgetter/setter pair -
metaDataValues
↔ List<
String> ? -
Works exclusively with metaDataValueStartsWith.
getter/setter pair
- metaDataValueStartsWith ↔ String?
-
Works exclusively with metaDataValues.
getter/setter pair
- myMemberStateFilter ↔ MyMemberStateFilter
-
A filter to return channels with the current User state matching to MyMemberStateFilter.
getter/setter pair
- 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.
getter/setter pair
- order ↔ GroupChannelListQueryOrder
-
Result order of channels. Refer to GroupChannelListQueryOrder.
GroupChannelListQueryOrder.metadataValueAlphabetical works with metaDataOrderKeyFilter.
getter/setter pair
- publicChannelFilter ↔ PublicChannelFilter
-
Public channel filter. Refer to PublicChannelFilter.
getter/setter pair
- queryType ↔ GroupChannelListQueryType
-
GroupChannelListQueryType of User IDs filter.
Refer to setUserIdsIncludeFilter
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchFields
↔ List<
GroupChannelListQuerySearchField> -
Search fields. Refer to setSearchFilter and GroupChannelListQuerySearchField.
getter/setter pair
- searchQuery ↔ String?
-
Query string. Refer to setSearchFilter.
getter/setter pair
- superChannelFilter ↔ SuperChannelFilter
-
Super channel filter. Refer to SuperChannelFilter.
getter/setter pair
- token ↔ String?
-
getter/setter pairinherited
- unreadChannelFilter ↔ UnreadChannelFilter
-
Unread channel filter. Refer to UnreadChannelFilter.
getter/setter pair
-
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.
getter/setter pair
-
userIdsIncludeFilter
↔ List<
String> -
User IDs include filter.
getter/setter pair
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