Public Types
enum	ChannelListOrder { CHRONOLOGICAL, LATEST_LAST_MESSAGE, CHANNEL_NAME_ALPHABETICAL, METADATA_VALUE_ALPHABETICAL }

enum	QueryType { AND, OR }

enum	SuperChannelFilter { ALL, SUPER_CHANNEL_ONLY, NONSUPER_CHANNEL_ONLY }

enum	PublicChannelFilter { ALL, PUBLIC, PRIVATE }

enum	UnreadChannelFilter { ALL, UNREAD_MESSAGE }

enum	SearchField { MEMBER_NICKNAME, CHANNEL_NAME }

enum	MemberStateFilter { ALL, INVITED, INVITED_BY_FRIEND, INVITED_BY_NON_FRIEND, JOINED }

enum	HiddenChannelFilter { UNHIDDEN, HIDDEN, HIDDEN_ALLOW_AUTO_UNHIDE, HIDDEN_PREVENT_AUTO_UNHIDE }

Public Member Functions
void	SetSearchFilter (List< SearchField > searchFields, string query)

void	SetIncludeEmpty (bool includeEmpty)

void	SetLimit (int limit)

void	SetOrder (ChannelListOrder order)

void	SetNicknameContainsFilter (string nickname)

void	SetUserIdsIncludeFilter (List< string > userIds, QueryType queryType)

void	SetUserIdsExactFilter (List< string > userIds)

void	SetCustomTypeFilter (string customType)

void	SetCustomTypesFilter (List< string > customTypesFilter)

bool	HasNext ()

bool	IsLoading ()

void	Next (GroupChannelListQueryResultHandler handler)

MemberStateFilter	GetMemberStateFilter ()

void	SetMemberStateFilter (MemberStateFilter memberStateFilter)

SuperChannelFilter	GetSuperChannelFilter ()

void	SetSuperChannelFilter (SuperChannelFilter superChannelFilter)

PublicChannelFilter	GetPublicChannelFilter ()

void	SetPublicChannelFilter (PublicChannelFilter publicChannelFilter)

UnreadChannelFilter	GetUnreadChannelFilter ()

void	SetUnreadChannelFilter (UnreadChannelFilter unreadChannelFilter)

HiddenChannelFilter	GetHiddenChannelFilter ()

void	SetHiddenChannelFilter (HiddenChannelFilter hiddenChannelFilter)

delegate void	GroupChannelListQueryResultHandler (List< GroupChannel > queryResult, SendBirdException e)

Properties
int	Limit `[get, set]`

bool	IncludeEmpty `[get, set]`

ChannelListOrder	Order `[get, set]`

string	MetaDataOrderKeyFilter `[get, set]`

List< string >	CustomTypesFilter `[get, set]`

string	CustomTypeStartsWithFilter `[get, set]`

string	SearchQuery `[get]`

List< string >	ChannelUrlsFilter `[get, set]`

string	ChannelNameContainsFilter `[get, set]`

Detailed Description

A class representing query to retrieve GroupChannel list for the current User.

Currently, 1 kind of GroupChannel list can be queried.

The list of GroupChannels the current User is a member of.

The query can be get by calling GroupChannel#CreateMyGroupChannelListQuery().

Member Enumeration Documentation

◆ ChannelListOrder

enum SendBird.GroupChannelListQuery.ChannelListOrder

strong

The query result order type. CHRONOLOGICAL query returns the result as by event time ascending order. LATEST_LAST_MESSAGE query returns the result as by event time descending order.

◆ HiddenChannelFilter

enum SendBird.GroupChannelListQuery.HiddenChannelFilter

strong

The hidden channel filter. Refer to setHiddenChannelFilter(HiddenChannelFilter).

2020.5

◆ MemberStateFilter

enum SendBird.GroupChannelListQuery.MemberStateFilter

strong

The member state filter. Refer to GroupChannel#getChannelCount(GroupChannelListQuery.MemberStateFilter, GroupChannel.GroupChannelChannelCountHandler) and setMemberStateFilter(MemberStateFilter).

Since: 3.0.15

◆ PublicChannelFilter

enum SendBird.GroupChannelListQuery.PublicChannelFilter

strong

The public channel filter. Refer to setPublicChannelFilter(PublicChannelFilter).

Since: 3.0.23

◆ QueryType

enum SendBird.GroupChannelListQuery.QueryType

strong

The query type for currently supported only with SetUserIdsIncludeFilter(List, QueryType). If QueryType is AND and userIdsList contains A and B, the channels which have members A AND B will be returned. If the type is OR, the channels which have members A OR B will be returned.

◆ SearchField

enum SendBird.GroupChannelListQuery.SearchField

strong

Fields of GroupChannel that are used in search filter. Refer to setSearchFilter(List, String)}.

Since: 3.0.23

◆ SuperChannelFilter

enum SendBird.GroupChannelListQuery.SuperChannelFilter

strong

The super channel filter. Refer to setSuperChannelFilter(SuperChannelFilter).

Since: 3.0.23

◆ UnreadChannelFilter

enum SendBird.GroupChannelListQuery.UnreadChannelFilter

strong

The unread channel filter. Refer to setUnreadChannelFilter(UnreadChannelFilter).

Since: 3.0.23

Member Function Documentation

◆ GetHiddenChannelFilter()

HiddenChannelFilter SendBird.GroupChannelListQuery.GetHiddenChannelFilter ( )

inline

Returns hidden channel filter.

Returns: hidden channel filter HiddenChannelFilter.

Since: 3.0.23

◆ GetMemberStateFilter()

MemberStateFilter SendBird.GroupChannelListQuery.GetMemberStateFilter ( )

inline

Returns a filter to return channels with the current User state matching to MemberStateFilter.

Returns: Returns MemberStateFilter

Since: 3.0.15

◆ GetPublicChannelFilter()

PublicChannelFilter SendBird.GroupChannelListQuery.GetPublicChannelFilter ( )

inline

Returns public channel filter.

Returns: public channel filter PublicChannelFilter.

Since: 3.0.23

◆ GetSuperChannelFilter()

SuperChannelFilter SendBird.GroupChannelListQuery.GetSuperChannelFilter ( )

inline

Returns super channel filter.

Returns: super channel filter SuperChannelFilter.

Since: 3.0.23

◆ GetUnreadChannelFilter()

UnreadChannelFilter SendBird.GroupChannelListQuery.GetUnreadChannelFilter ( )

inline

Returns unread channel filter.

Returns: unread channel filter UnreadChannelFilter.

Since: 3.0.18

◆ GroupChannelListQueryResultHandler()

delegate void SendBird.GroupChannelListQuery.GroupChannelListQueryResultHandler	(	List< GroupChannel >	queryResult,
		SendBirdException	e
	)

GroupChannelListQuery handler. This handler provides callback for next(GroupChannelListQueryResultHandler).

◆ HasNext()

bool SendBird.GroupChannelListQuery.HasNext ( )

inline

Checks if there is a next page.

Returns: true if there is a next page.

◆ IsLoading()

bool SendBird.GroupChannelListQuery.IsLoading ( )

inline

Checks if the current query is in communication progress with server.

Returns: true if the current query is not finished.

◆ Next()

void SendBird.GroupChannelListQuery.Next ( GroupChannelListQueryResultHandler handler )

inline

Gets the list of GroupChannels. The queried result is passed to handler as list. If this method is repeatedly called after each next() is finished, it retrieves the following pages of the GroupChannel list. If there is no more pages to be read, an empty List (not null) is returned to handler.

Parameters

handler A callback handler to get the queried result.

◆ SetCustomTypeFilter()

void SendBird.GroupChannelListQuery.SetCustomTypeFilter ( string customType )

inline

Sets a filter to return only channels with the specified Custom Type.

Parameters

customType The Custom Type of the channels to return.

Since: 3.0.27

Deprecated:: As of 3.0.47, replaced by setCustomTypesFilter(List).

◆ SetCustomTypesFilter()

void SendBird.GroupChannelListQuery.SetCustomTypesFilter ( List< string > customTypesFilter )

inline

Sets GroupChannel CustomTypes filter. GroupChannel list containing the passed GroupChannel CustomTypes will be returned.

Parameters

customTypesFilter GroupChannel CustomTypes to search channels based on CustomTypes.

◆ SetHiddenChannelFilter()

void SendBird.GroupChannelListQuery.SetHiddenChannelFilter ( HiddenChannelFilter hiddenChannelFilter )

inline

Sets hidden channel filter.

Parameters

hiddenChannelFilter HiddenChannelFilter 2020.5

◆ SetIncludeEmpty()

void SendBird.GroupChannelListQuery.SetIncludeEmpty ( bool includeEmpty )

inline

Sets true/false to include empty channels (channels without messages). This flag is false by default.

Parameters

includeEmpty Flag to include empty channels.

Since: 3.0.15

◆ SetLimit()

void SendBird.GroupChannelListQuery.SetLimit ( int limit )

inline

Sets the maximum number of group channel members per queried page.

Parameters

limit The maximum number of group channel members per page.

Since: 3.0.15

◆ SetMemberStateFilter()

void SendBird.GroupChannelListQuery.SetMemberStateFilter ( MemberStateFilter memberStateFilter )

inline

Sets a filter to return channels with the current User state matching to MemberStateFilter. If set MemberStateFilter#INVITED, only the channels from which invitations has been sent to the current User (but not accepted yet) will be returned. If set MemberStateFilter#INVITED_BY_FRIEND, only the channels from which invitations by friend has been sent to the current User (but not accepted yet) will be returned. If set MemberStateFilter#INVITED_BY_NON_FRIEND, only the channels from which invitations by non friend has been sent to the current User (but not accepted yet) will be returned. If set MemberStateFilter#JOINED, only the channels the current User is already joined will be returned.

Parameters

memberStateFilter The member state of the current User of the channels to return.

Since: 3.0.15

◆ SetNicknameContainsFilter()

void SendBird.GroupChannelListQuery.SetNicknameContainsFilter ( string nickname )

inline

Sets nickname filter. GroupChannel list containing the passed nickname will be returned. If you pass nickname such as "abc", then the returned channel list will be containing member like "*abc*". This does not cooperate with other filters.

Parameters

nickname User nickname to search as the member of the channels.

◆ SetOrder()

void SendBird.GroupChannelListQuery.SetOrder ( ChannelListOrder order )

inline

Sets result order of channels. Order#METADATA_VALUE_ALPHABETICAL works with setMetaDataOrderKeyFilter(String).

Parameters

order Order#CHRONOLOGICAL or Order#LATEST_LAST_MESSAGE or Order#CHANNEL_NAME_ALPHABETICAL or Order#METADATA_VALUE_ALPHABETICAL.

Since: 3.0.15

◆ SetPublicChannelFilter()

void SendBird.GroupChannelListQuery.SetPublicChannelFilter ( PublicChannelFilter publicChannelFilter )

inline

Sets public channel filter.

Parameters

publicChannelFilter PublicChannelFilter

Since: 3.0.23

◆ SetSearchFilter()

void SendBird.GroupChannelListQuery.SetSearchFilter	(	List< SearchField >	searchFields,
		string	query
	)

inline

Sets 'Search' filter. GroupChannels will be included in the result if its data in specified SearchFields contains specified query string. Refer to SearchField. If you set multiple SearchFields, the result will be union of each result.

Parameters

searchFields	Target fields that you want to search. Refer to SearchField.
query	Query string you want to search with.

Since: 3.0.23

◆ SetSuperChannelFilter()

void SendBird.GroupChannelListQuery.SetSuperChannelFilter ( SuperChannelFilter superChannelFilter )

inline

Sets super channel filter.

Parameters

superChannelFilter SuperChannelFilter

Since: 3.0.23

◆ SetUnreadChannelFilter()

void SendBird.GroupChannelListQuery.SetUnreadChannelFilter ( UnreadChannelFilter unreadChannelFilter )

inline

Sets unread channel filter.

Parameters

unreadChannelFilter UnreadChannelFilter

Since: 3.0.23

◆ SetUserIdsExactFilter()

void SendBird.GroupChannelListQuery.SetUserIdsExactFilter ( List< string > userIds )

inline

Sets User IDs filter. GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.

Parameters

userIds User IDs to search as the member of the channels.

◆ SetUserIdsIncludeFilter()

void SendBird.GroupChannelListQuery.SetUserIdsIncludeFilter	(	List< string >	userIds,
		QueryType	queryType
	)

inline

Sets User IDs filter. GroupChannel list containing the passed User IDs and other members will be returned. This does not cooperate with other filters.

Parameters

userIds	`User` IDs to search as the member of the channels.
queryType	The logical operation options. If passed QueryType#AND with `userIds = {A, B}`, the channels containing A AND B + other members will be returned. If QueryType#OR, the channels with A OR B + other members will be returned.

Property Documentation

◆ ChannelNameContainsFilter

string SendBird.GroupChannelListQuery.ChannelNameContainsFilter

getset

Returns channel name filter. It will return null if channel name filter hasn't been set before.

Returns: channel name filter.

Since: 3.0.23

◆ ChannelUrlsFilter

List<string> SendBird.GroupChannelListQuery.ChannelUrlsFilter

getset

Sets with given channel URLs. Sets GroupChannel URLs filter. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.

Parameters

channelUrls GroupChannel URLs.

Since: 3.0.23

◆ CustomTypesFilter

List<string> SendBird.GroupChannelListQuery.CustomTypesFilter

getset

Returns list of custom type filter. It will return null if custom types filter hasn't been set before.

Returns: list of custom type filter.

Since: 3.0.23

◆ CustomTypeStartsWithFilter

string SendBird.GroupChannelListQuery.CustomTypeStartsWithFilter

getset

Returns a filter to return channels that start with the specified Custom Type. It will return null if custom type starts with filter hasn't been set before.

Returns: The CustomType

Since: 3.0.23

◆ IncludeEmpty

bool SendBird.GroupChannelListQuery.IncludeEmpty

getset

Sets true/false to include empty channels (channels without messages). This flag is false by default.

Parameters

includeEmpty Flag to include empty channels.

◆ Limit

int SendBird.GroupChannelListQuery.Limit

getset

Sets the maximum number of GroupChannels per queried page.

Parameters

limit The maximum number of GroupChannels per page.

◆ MetaDataOrderKeyFilter

string SendBird.GroupChannelListQuery.MetaDataOrderKeyFilter

getset

Returns meta data order key filter. It will return null if meta data order key filter hasn't been set before.

Returns: Returns meta data order key filter.

Since: 3.0.23

◆ Order

ChannelListOrder SendBird.GroupChannelListQuery.Order

getset

Sets result order of channels.

Parameters

order Order#CHRONOLOGICAL or Order#LATEST_LAST_MESSAGE.

◆ SearchQuery

string SendBird.GroupChannelListQuery.SearchQuery

get

Returns query string. Refer to setSearchFilter(List, String).

Returns: String.

Since: 3.0.23

The documentation for this class was generated from the following file:

SendBird/src/GroupChannelListQuery.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ChannelListOrder

◆ HiddenChannelFilter

◆ MemberStateFilter

◆ PublicChannelFilter

◆ QueryType

◆ SearchField

◆ SuperChannelFilter

◆ UnreadChannelFilter

Member Function Documentation

◆ GetHiddenChannelFilter()

◆ GetMemberStateFilter()

◆ GetPublicChannelFilter()

◆ GetSuperChannelFilter()

◆ GetUnreadChannelFilter()

◆ GroupChannelListQueryResultHandler()

◆ HasNext()

◆ IsLoading()

◆ Next()

◆ SetCustomTypeFilter()

◆ SetCustomTypesFilter()

◆ SetHiddenChannelFilter()

◆ SetIncludeEmpty()

◆ SetLimit()

◆ SetMemberStateFilter()

◆ SetNicknameContainsFilter()

◆ SetOrder()

◆ SetPublicChannelFilter()

◆ SetSearchFilter()

◆ SetSuperChannelFilter()

◆ SetUnreadChannelFilter()

◆ SetUserIdsExactFilter()

◆ SetUserIdsIncludeFilter()

Property Documentation

◆ ChannelNameContainsFilter

◆ ChannelUrlsFilter

◆ CustomTypesFilter

◆ CustomTypeStartsWithFilter

◆ IncludeEmpty

◆ Limit

◆ MetaDataOrderKeyFilter

◆ Order

◆ SearchQuery