PublicGroupChannelListQuery class

A class representing query to retrieve GroupChannel list for the current User. Currently, 1 kind of public GroupChannel list can be queried.

Inheritance

Constructors

PublicGroupChannelListQuery({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". It will return null if channel name filter hasn't been set before.
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. It will return null if custom types filter hasn't been set before.
read / write
customTypeStartsWithFilter String?
A filter to return channels that start with the specified customType. It will return null if custom type starts with filter hasn't been set before.
read / write
hashCode int
The hash code for this object.
read-onlyinherited
hasNext bool
Whether there is a next page.
read / writeinherited
includeEmpty bool
Checks whether query result includes empty channels. (channels without messages). This flag is false by default.
read / write
includeFrozen bool
Checks whether query result includes frozen channels. This flag is true by default.
read / write
includeMetaData bool
Query result of channel object contains meta data if true default value is true
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
membershipFilter MembershipFilter
Membership filter. Default is MembershipFilter.joined.
read / write
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
order GroupChannelListQueryOrder
Order of query result
read / write
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
superChannelFilter SuperChannelFilter
Super channel filter. Refer to SuperChannelFilter.
read / write
token String?
read / writeinherited

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
setMetaDataFilterWithStartWith(String key, String startWith) → void
setMetaDataFilterWithValues
setMetaDataFilterWithValues(String key, List<String> values) → void
setMetaDataFilterWithValues
toString() String
A string representation of this object.
inherited

Operators

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