You can search for specific private or public group channels by using several types of search filters within GroupChannelListQuery
and PublicGroupChannelListQuery
classes.
A PublicGroupChannelListQuery
instance provides several types of search filters such as ChannelNameContainsFilter
and ChannelUrlsFilter
. You can use these filters to search for specific public group channels.
The sample code below shows the query instance, which returns a list of the current user's group channels that partially match the specified keyword in ChannelNameContainsFilter
in the channels' name.
The following shows the query instance, which returns a list of the current user's group channels that partially match the keyword specified in ChannelUrlsFilter
in the channel URLs.
The following table shows all supported parameters that can be used as filters for PublicGroupChannelListQuery
to search for specific channels you want to retrieve. You can use any of the parameters with the sample code above.
Parameter name | Type | Description |
---|---|---|
string | Specifies group channels with one or more specified custom types you want to retrieve. | |
string | Specifies group channels with a custom type that starts with the specified value you want to retrieve. | |
string | Specifies group channels that contain the specified value in their names you want to retrieve. | |
string | Specifies group channels with one or more specified channel URLs you want to retrieve. | |
enum | Specifies either super group channels or group channels you want to retrieve. Acceptable values are | |
enum | Specifies group channels with specified membership you want to retrieve. Acceptable values are | |
string | Specifies group channels with metadata containing an item with the specified value as its key. This filter is effective only when the metadata are sorted in alphabetical order you want to retrieve. |
A GroupChannelListQuery
instance provides several types of search filters such as ChannelNameContainsFilter
and ChannelUrlsFilter
. You can use these filters to search for specific private group channels.
The sample code below shows the query instance, which returns a list of the current user's group channels that partially match the specified keyword in ChannelNameContainsFilter
in the channels' name.
The following shows the query instance, which returns a list of the current user's group channels that partially match the specified keyword in the ChannelUrlsFilter
in the channels' URL.
The following table shows all supported parameters that can be used as filters for GroupChannelListQuery
to search for specific channels you want to retrieve. You can use any of the parameters with the sample code above.
Parameter name | Type | Description |
---|---|---|
string | Specifies group channels with one or more specified custom types you want to retrieve. | |
string | Specifies group channels with a custom type that starts with the specified value you want to retrieve. | |
string | Specifies group channels that contain the specified value in their names you want to retrieve. | |
string | Specifies group channels with one or more specified channel URLs you want to retrieve. | |
enum | Specifies either super group channels or group channels you want to retrieve. Acceptable values are | |
enum | Specifies either public or private group channels you want to retrieve. Acceptable values are | |
enum | Specifies group channels with one or more unread messages you want to retrieve. Acceptable values are | |
enum | Specifies group channels with the specified state and operating behavior you want to retrieve. Acceptable values are | |
enum | Specifies group channels' invitation status such as invitation accept status and invitation sent status you want to retrieve. Acceptable values are | |
string | Specifies group channels with members whose nicknames contain the specified value you want to retrieve. | |
string | Specifies group channels with metadata containing an item with the specified value as its key. This filter is effective only when the metadata are sorted in alphabetical order you want to retrieve. |
You can retrieve a list of Supergroup channels through the GroupChannelListQuery
's superChannelFilter
property. A Supergroup channel is determined by the isSuper
property. If the property has a value of true
, the channel is a Supergroup channel.