GroupChannelListQuery class Null safety

A query object to retrieve list of my group channel.

Inheritance
Annotations

Constructors

GroupChannelListQuery()

Properties

channelHiddenStateFilter ↔ ChannelHiddenStateFilter
Sets to filter channels by the hidden state. The default value is unhiddenOnly
read / write
channelNameContains ↔ String?
Sets a filter to return only channels that contains the specified group channel name
read / write
channelUrls ↔ List<String>
Sets filter channel urls.
read / write
customTypes ↔ List<String>
Sets the custom type filter.
read / write
customTypeStartWith ↔ String?
Sets to filter channels by custom type that starts with
read / write
hashCode → int
The hash code for this object.
read-onlyinherited
hasNext ↔ bool
True if query has next items to be queried
read / writeinherited
includeEmptyChannel ↔ bool
Query result includes empty (message) channel if true. default value is true
read / write
includeFrozenChannel ↔ bool
Query result includes frozen channels if true. default value is true
read / write
includeMemberList ↔ bool
Query result of channel object contains member list if true. default value is true
read / write
includeMetaData ↔ bool
Query result of channel object contains meta data if true. deault value is true
read / write
limit ↔ int
number of item per executing loadNext
read / writeinherited
loading ↔ bool
True if query is loading
read / writeinherited
memberStateFilter ↔ MemberStateFilter
Sets the member state filter
read / write
metaDataKeyFilter ↔ String?
Searches for group channels with metadata containing an item with the specified value as its key
read / write
metaDataOrderKeyFilter ↔ String?
Sets a key for ordering by value in the metadata. This is valid when the order is channelMetaDataValueAlphabetical only
read / write
metaDataValuesFilter ↔ List<String>?
Searches for group channels with metadata containing an item with the key specified by the metaDataKey
read / write
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
read / write
nicknameContains ↔ String?
Sets the filter with nickname.
read / write
order ↔ GroupChannelListOrder
Order of the query result
read / write
publicChannelFilter ↔ PublicChannelFilter
Sets to filter public channel. Default is all
read / write
queryType ↔ GroupChannelListQueryType
Sets query type user Id filter, it only will work when includeMemberList is true
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
searchFields ↔ List<GroupChannelListQuerySearchField>
read / write
searchQuery ↔ String?
read / write
superChannelFilter ↔ SuperChannelFilter
Sets to filter super channel. Default is all
read / write
token ↔ String?
token for next query
read / writeinherited
unreadChannelFilter ↔ UnreadChannelFilter
Sets to filter channels by the unread messages. The default value is all
read / write
userIdsExactlyIn ↔ List<String>
Sets the filter with user IDs
read / write
userIdsIncludeIn ↔ List<String>
Sets the filter with user IDs
read / write

Methods

loadNext() → Future<List<GroupChannel>>
Load next items asynchronously
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
setChannelUrlsFilter(List<String> channelUrls) → void
setMetaDataFilterWithStartWith(String key, String startWith) → void
setMetaDataFilterWithValues(String key, List<String> values) → void
setNicknameContainsFilter(String nickname) → void
setSearchFilter(String searchQuery, List<GroupChannelListQuerySearchField> searchFields) → void
setUserIdsExactFilter(List<String> userIds) → void
setUserIdsIncludeFilter(List<String> userIds, GroupChannelListQueryType type) → void
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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