GroupChannelListQuery
The GroupChannelListQuery
class is a query class for getting the list of group channels.
The instance of this class is created by createMyGroupChannelListQuery()
in GroupChannel
class.
-
Boolean indicates there are more data to fetch
-
Indicates the query is currently loading or not
-
Specifies the number of results to return per call. (Default: 20)
-
-
-
Fetches next page
-
Copies this object
-
Gets comparator
-
Compares two channels
-
Validates the given channel object is belonged to this query object
-
Serializes this object into data
-
Deserializes and reconstructs the object
-
Determines channel list includes empty channel. Default is
true
-
Determines channel list includes frozen channel. Default is
true
Since
3.0.182 -
Determines channel object of the list includes members list.
-
Determines channel object of the list includes meta data property.
Since
3.0.216 -
Sets query type for
includeMemberList
. -
Sets the member state filter.
-
Sets
GroupChannel
URLs filter.GroupChannel
list containing only and exactly the passedGroupChannel
URLs will be returned. This does not cooperate with other filters. -
Sets to filter super channel. Default is
.all
-
Sets to filter public channel.Default is
.all
-
Sets to filter channels by custom type that starts with.
-
Sets the custom types filter. The custom types to search.
-
Sets the filter with nickname substring. Group channels whose members’ nicknames contain the filter are retruned by
loadNextPage:
. -
Sets the filter with nickname prefix. Group channels whose members’ nicknames start with the filter are retruned by
loadNextPage:
. -
Sets the filter with nickname. Group channels whose members’ nicknames match exactly with the filter are retruned by
loadNextPage:
. -
Sets the filter with user IDs. The group channels which have the members that contain user IDs are returned by
loadNextPage:
. -
Sets the filter with user IDs. The group channels which have the members that have user IDs are returned by
loadNextPage:
. The channels have theuserIds
members only. -
Sets a filter to return only channels that contains the specified group channel name. The channel name to search. The query will return the channels include
channelName
. -
Sets to filter channels by the unread messages. The default value is
.all
.Since
3.0.113 -
Sets a key for ordering by value in the metadata. This is valid when the
order
isGroupChannelListOrder.channelMetaDataValueAlphabetical
only.Since
3.0.118 -
Searches for group channels with metadata containing an item with the specified value as its key
Since
3.0.232 -
Searches for group channels with metadata containing an item with the key specified by the metaDataKey
Since
3.0.232 -
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
Since
3.0.232 -
Sets to filter channels by the hidden state. The default value is
ChannelHiddenStateFilter.unhiddenOnly
.Since
3.0.122 -
The query property of the query specified by
setSearchFilterQuery:fields:
Since
3.0.144 -
The fields properties of the query specified by
setSearchFilterQuery:fields:
Since
3.0.144 -
Sets the order of the list. The order is defined in
GroupChannelListOrder
. -
Since
4.6.0