GroupChannelListQuery class

A query object to retrieve list of my group channel.

Inheritance

• Object
• QueryBase
• GroupChannelListQuery

Annotations

• @JsonSerializable()

Constructors

GroupChannelListQuery()

Properties

channelHiddenStateFilter ↔ ChannelHiddenStateFilter

Sets to filter channels by the hidden state. The default value is unhiddenOnly

getter/setter pair

channelNameContains ↔ String?

Sets a filter to return only channels that contains the specified group channel name

getter/setter pair

channelUrls ↔ List<String>

Sets filter channel urls.

getter/setter pair

customTypes ↔ List<String>

Sets the custom type filter.

getter/setter pair

customTypeStartWith ↔ String?

Sets to filter channels by custom type that starts with

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasNext ↔ bool

True if query has next items to be queried

getter/setter pair, inherited

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 pair, inherited

loading ↔ bool

True if query is loading

getter/setter pair, inherited

memberStateFilter ↔ MemberStateFilter

Sets the member state filter

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 a key for ordering by value in the metadata. This is valid when the order is channelMetaDataValueAlphabetical only

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

nicknameContains ↔ String?

Sets the filter with nickname.

getter/setter pair

order ↔ GroupChannelListOrder

Order of the query result

getter/setter pair

publicChannelFilter ↔ PublicChannelFilter

Sets to filter public channel. Default is all

getter/setter pair

queryType ↔ GroupChannelListQueryType

Sets query type user Id filter, it only will work when includeMemberList is true

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchFields ↔ List<GroupChannelListQuerySearchField>

getter/setter pair

searchQuery ↔ String?

getter/setter pair

superChannelFilter ↔ SuperChannelFilter

Sets to filter super channel. Default is all

getter/setter pair

token ↔ String?

token for next query

getter/setter pair, inherited

unreadChannelFilter ↔ UnreadChannelFilter

Sets to filter channels by the unread messages. The default value is all

getter/setter pair

userIdsExactlyIn ↔ List<String>

Sets the filter with user IDs

getter/setter pair

userIdsIncludeIn ↔ List<String>

Sets the filter with user IDs

getter/setter pair

Methods

loadNext() → Future<List<GroupChannel>>

Load next items asynchronously

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent 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