PublicGroupChannelListQuery class

A query object to retrieve list of public group channel.

Inheritance
Annotations
  • @JsonSerializable()

Properties

channelNameContainsFilter String?
Filters by channel name contains certain text
getter/setter pair
channelUrls List<String>?
Filters for channel urls.
getter/setter pair
customTypesFilter List<String>?
Filters by custom types.
getter/setter pair
customTypeStartWithFilter String?
Filter by custom type that starts with
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
hasNext bool
True if query has next items to be queried
getter/setter pairinherited
includeEmptyChannel bool
Query result includes empty (message) channel if true default value is true
getter/setter pair
includeFrozenChannel bool
Query result includes frozen channels if true default value is true
getter/setter pair
includeMemberList bool
Query result of channel object contains member list if true default value is true
getter/setter pair
includeMetaData bool
Query result of channel object contains meta data if true deault value is true
getter/setter pair
limit int
number of item per executing loadNext
getter/setter pairinherited
loading bool
True if query is loading
getter/setter pairinherited
membershipFilter PublicGroupChannelMembershipFilter
Filters by current user's member state in public group channel
getter/setter pair
metaDataKeyFilter String?
Searches for group channels with metadata containing an item with the specified value as its key
getter/setter pair
metaDataOrderKeyFilter String?
Sets metadata's key for ordering its value
getter/setter pair
metaDataValuesFilter List<String>?
Searches for group channels with metadata containing an item with the key specified by the metaDataKey
getter/setter pair
metaDataValueStartWithFilter String?
Searches for group channels with metadata containing an item with the key specified by the metaDataKey and the values of that item start with the specified value
getter/setter pair
order PublicGroupChannelListOrder
Order of query result
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
superChannelFilter SuperChannelFilter
Filters channels for super group channel. Default is all
getter/setter pair
token String?
token for next query
getter/setter pairinherited

Methods

loadNext() Future<List<GroupChannel>>
Load next items asynchronously
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setMetaDataFilterWithStartWith(String key, String startWith) → void
setMetaDataFilterWithValues(String key, List<String> values) → void
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

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