Public Types
enum	Order { CHRONOLOGICAL, CHANNEL_NAME_ALPHABETICAL, METADATA_VALUE_ALPHABETICAL }

enum	SuperChannelFilter { ALL, SUPER_CHANNEL_ONLY, NONSUPER_CHANNEL_ONLY }

enum	MembershipFilter { ALL, JOINED }

Public Member Functions
Order	GetOrder ()

void	SetOrder (Order order)

SuperChannelFilter	GetSuperChannelFilter ()

void	SetSuperChannelFilter (SuperChannelFilter superChannelFilter)

MembershipFilter	GetMembershipFilter ()

void	SetMembershipFilter (MembershipFilter membershipFilter)

void	Next (PublicGroupChannelListQueryResultHandler handler)

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

Properties
int	Limit `[get, set]`

bool	IncludeEmpty `[get, set]`

String	MetaDataOrderKeyFilter `[get, set]`

string	CustomTypeStartsWithFilter `[get, set]`

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

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

string	ChannelNameContainsFilter `[get, set]`

bool	HasNext `[get]`

bool	IsLoading `[get, set]`

bool	IsIncludeFrozen `[get, set]`

Member Enumeration Documentation

◆ MembershipFilter

enum SendBird.PublicGroupChannelListQuery.MembershipFilter

strong

The public channel membership filter. Refer to setMembershipFilter(MembershipFilter).

Since: 3.0.50

◆ Order

enum SendBird.PublicGroupChannelListQuery.Order

strong

The query result order type. CHRONOLOGICAL query returns the result as by event time ascending order. CHANNEL_NAME_ALPHABETICAL query returns the result as by channel name alphabetical order.

Since: 3.0.25

◆ SuperChannelFilter

enum SendBird.PublicGroupChannelListQuery.SuperChannelFilter

strong

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

Since: 3.0.50

Member Function Documentation

◆ GetMembershipFilter()

MembershipFilter SendBird.PublicGroupChannelListQuery.GetMembershipFilter ( )

inline

Returns membership filter.

Returns: membership filter MembershipFilter.

Since: 3.0.25

◆ GetOrder()

Order SendBird.PublicGroupChannelListQuery.GetOrder ( )

inline

Returns result order of channels. Refer to GroupChannelListQuery.Order.

Returns: Returns Order.

Since: 3.0.25

◆ GetSuperChannelFilter()

SuperChannelFilter SendBird.PublicGroupChannelListQuery.GetSuperChannelFilter ( )

inline

Returns super channel filter.

Returns: super channel filter SuperChannelFilter.

Since: 3.0.25

◆ Next()

void SendBird.PublicGroupChannelListQuery.Next ( PublicGroupChannelListQueryResultHandler handler )

inline

Gets the list of public 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 public 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.

Since: 3.0.25

◆ PublicGroupChannelListQueryResultHandler()

delegate void SendBird.PublicGroupChannelListQuery.PublicGroupChannelListQueryResultHandler	(	List< GroupChannel >	queryResult,
		SendBirdException	e
	)

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

Since: 3.0.25

◆ SetMembershipFilter()

void SendBird.PublicGroupChannelListQuery.SetMembershipFilter ( MembershipFilter membershipFilter )

inline

Sets membership filter. Default is MembershipFilter#JOINED.

Parameters

membershipFilter MembershipFilter

Since: 3.0.25

◆ SetOrder()

void SendBird.PublicGroupChannelListQuery.SetOrder ( Order order )

inline

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

Parameters

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

Since: 3.0.25

◆ SetSuperChannelFilter()

void SendBird.PublicGroupChannelListQuery.SetSuperChannelFilter ( SuperChannelFilter superChannelFilter )

inline

Sets super channel filter.

Parameters

superChannelFilter SuperChannelFilter

Since: 3.0.25

Property Documentation

◆ ChannelNameContainsFilter

string SendBird.PublicGroupChannelListQuery.ChannelNameContainsFilter

getset

Sets channel name filter. public 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*".

Parameters

channelName Name of channel to search.

Since: 3.0.25

◆ ChannelUrlsFilter

List<string> SendBird.PublicGroupChannelListQuery.ChannelUrlsFilter

getset

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

Parameters

channelUrls public GroupChannel URLs.

Since: 3.0.25

◆ CustomTypesFilter

List<string> SendBird.PublicGroupChannelListQuery.CustomTypesFilter

getset

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

Parameters

customTypes public GroupChannel custom types.

Since: 3.0.25

◆ CustomTypeStartsWithFilter

string SendBird.PublicGroupChannelListQuery.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.25

◆ HasNext

bool SendBird.PublicGroupChannelListQuery.HasNext

get

Checks if there is a next page.

Returns: true if there is a next page.

Since: 3.0.25

◆ IncludeEmpty

bool SendBird.PublicGroupChannelListQuery.IncludeEmpty

getset

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

Parameters

includeEmpty Flag to include empty channels.

Since: 3.0.25

◆ IsIncludeFrozen

bool SendBird.PublicGroupChannelListQuery.IsIncludeFrozen

getset

Sets true/false to include frozen channels or not. This flag is true by default.

Parameters

includeFrozen Flag to include frozen channels.

Since: 3.0.25

◆ IsLoading

bool SendBird.PublicGroupChannelListQuery.IsLoading

getset

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

Returns: true if the current query is not finished.

Since: 3.0.25

◆ Limit

int SendBird.PublicGroupChannelListQuery.Limit

getset

Returns the maximum number of GroupChannels per page.

Returns: the number of GroupChannels per page.

Since: 3.0.25

◆ MetaDataOrderKeyFilter

String SendBird.PublicGroupChannelListQuery.MetaDataOrderKeyFilter

getset

Sets meta data order key filter. This filter will work only if Order#METADATA_VALUE_ALPHABETICAL is set from setOrder(Order).

Parameters

metaDataOrderKey Meta data order key.

Since: 3.0.25

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

SendBird/src/PublicGroupChannelListQuery.cs

Public Types

Public Member Functions

Properties

Member Enumeration Documentation

◆ MembershipFilter

◆ Order

◆ SuperChannelFilter

Member Function Documentation

◆ GetMembershipFilter()

◆ GetOrder()

◆ GetSuperChannelFilter()

◆ Next()

◆ PublicGroupChannelListQueryResultHandler()

◆ SetMembershipFilter()

◆ SetOrder()

◆ SetSuperChannelFilter()

Property Documentation

◆ ChannelNameContainsFilter

◆ ChannelUrlsFilter

◆ CustomTypesFilter

◆ CustomTypeStartsWithFilter

◆ HasNext

◆ IncludeEmpty

◆ IsIncludeFrozen

◆ IsLoading

◆ Limit

◆ MetaDataOrderKeyFilter