PublicGroupChannelListQuery class - sendbird_chat_sdk library

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.
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. It will return null if custom types filter hasn't been set before.
getter/setter pair
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.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
hasNext ↔ bool: Whether there is a next page.
getter/setter pairinherited
includeEmpty ↔ bool: Checks whether query result includes empty channels. (channels without messages). This flag is false 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: Query result of channel object contains meta data if true default value is true
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
membershipFilter ↔ MembershipFilter: Membership filter. Default is MembershipFilter.joined.
getter/setter pair
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.metadataValueAlphabetical
getter/setter pair
metaDataValues ↔ List<String>?: Works exclusively with metaDataValueStartsWith.
getter/setter pair
metaDataValueStartsWith ↔ String?: Works exclusively with metaDataValues.
getter/setter pair
order ↔ GroupChannelListQueryOrder: Order of query result
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
superChannelFilter ↔ SuperChannelFilter: Super channel filter. Refer to SuperChannelFilter.
getter/setter pair
token ↔ String?: getter/setter pairinherited

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