The GroupChannelListQuery class is a query class for getting the list of group channels. More...

Public Member Functions
void	LoadNextPage (SbGroupChannelListHandler inCompletionHandler)
	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. More...

bool	BelongsTo (SbGroupChannel inGroupChannel)
	Verify that the given channel information matches the current query filter. More...

Properties
IReadOnlyList< SbGroupChannelListQuerySearchField >	SearchFields `[get]`
	Search fields. Refer to SbGroupChannelListQueryParams.SetSearchFilter and SearchField. More...

IReadOnlyList< string >	ChannelUrlsFilter `[get]`
	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. More...

IReadOnlyList< string >	UserIdsExactFilter `[get]`
	User IDs exact filter.GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters. More...

IReadOnlyList< string >	UserIdsIncludeFilter `[get]`
	User IDs include filter. It will return null if User IDs include filter hasn't been set before. This does not cooperate with other filters. More...

SbGroupChannelListQueryType	QueryType `[get]`
	Sets query type for includeMemberList. More...

string	NicknameContainsFilter `[get]`
	Searches for GroupChannels with members whose nicknames contain the specified value. 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. More...

string	NicknameExactMatchFilter `[get]`
	Searches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters. More...

string	NicknameStartsWithFilter `[get]`
	Searches for GroupChannels with members whose nicknames starts with the specified value. 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. More...

SbChannelHiddenStateFilter	ChannelHiddenStateFilter `[get]`
	Sets to filter channels by the hidden state. More...

SbGroupChannelListOrder	Order `[get]`
	Result order of channels. Refer to GroupChannelListQueryOrder. SbGroupChannelListOrder.ChannelMetaDataValueAlphabetical works with metaDataOrderKeyFilter. More...

SbGroupChannelPublicChannelFilter	PublicChannelFilter `[get]`
	Public channel filter. Refer to SbGroupChannelPublicChannelFilter. More...

SbGroupChannelSuperChannelFilter	SuperChannelFilter `[get]`
	Super channel filter. Refer to SbGroupChannelSuperChannelFilter. More...

SbMyMemberStateFilter	MyMemberStateFilter `[get]`
	A filter to return channels with the current User state matching to SbMyMemberStateFilter. More...

SbUnreadChannelFilter	UnreadChannelFilter `[get]`
	Unread channel filter. Refer to SbUnreadChannelFilter. More...

bool	IncludeChatNotification `[get]`
	Whether to include chat notification GroupChannel. More...

bool	IncludeEmptyChannel `[get]`
	Checks whether query result includes empty channels. (channels without messages). More...

bool	IncludeFrozenChannel `[get]`
	Checks whether query result includes frozen channels. More...

bool	IncludeMemberList `[get]`
	Determines channel object of the list includes members list. More...

string	ChannelNameContainsFilter `[get]`
	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. More...

IReadOnlyList< string >	CustomTypesFilter `[get]`
	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. More...

string	CustomTypeStartsWithFilter `[get]`
	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. More...

bool	IncludeMetaData `[get]`
	Whether to include channel metadata on fetch. More...

string	MetaDataKeyFilter `[get]`
	The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter. More...

string	MetaDataOrderKeyFilter `[get]`
	Meta data order key filter. It will return null if meta data order key filter hasn't been set before. More...

string	MetaDataValueStartsWithFilter `[get]`
	Works exclusively with MetaDataValuesFilter. More...

IReadOnlyList< string >	MetaDataValuesFilter `[get]`
	Works exclusively with MetaDataValueStartsWithFilter. More...

string	SearchQuery `[get]`
	Query string. More...

int	Limit `[get]`
	The maximum number of GroupChannels per page. More...

bool	HasNext `[get]`
	Whether there is a next page. More...

bool	IsLoading `[get]`
	Whether the current query is in communication progress with server. More...

Detailed Description

The GroupChannelListQuery class is a query class for getting the list of group channels.

Since: 4.0.0

Member Function Documentation

◆ BelongsTo()

bool BelongsTo ( SbGroupChannel inGroupChannel )

Verify that the given channel information matches the current query filter.

Parameters

inGroupChannel

Returns

Since: 4.0.0

◆ LoadNextPage()

void LoadNextPage ( SbGroupChannelListHandler inCompletionHandler )

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

inCompletionHandler

Since: 4.0.0

Property Documentation

◆ ChannelHiddenStateFilter

SbChannelHiddenStateFilter ChannelHiddenStateFilter

get

Sets to filter channels by the hidden state.

Since: 4.0.0

◆ ChannelNameContainsFilter

string ChannelNameContainsFilter

get

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.

Since: 4.0.0

◆ ChannelUrlsFilter

IReadOnlyList<string> ChannelUrlsFilter

get

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.

Since: 4.0.0

◆ CustomTypesFilter

IReadOnlyList<string> CustomTypesFilter

get

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.

Since: 4.0.0

◆ CustomTypeStartsWithFilter

string CustomTypeStartsWithFilter

get

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.

Since: 4.0.0

◆ HasNext

bool HasNext

get

Whether there is a next page.

Since: 4.0.0

◆ IncludeChatNotification

bool IncludeChatNotification

get

Whether to include chat notification GroupChannel.

Since: 4.0.0

◆ IncludeEmptyChannel

bool IncludeEmptyChannel

get

Checks whether query result includes empty channels. (channels without messages).

Since: 4.0.0

◆ IncludeFrozenChannel

bool IncludeFrozenChannel

get

Checks whether query result includes frozen channels.

Since: 4.0.0

◆ IncludeMemberList

bool IncludeMemberList

get

Determines channel object of the list includes members list.

Since: 4.0.0

◆ IncludeMetaData

bool IncludeMetaData

get

Whether to include channel metadata on fetch.

Since: 4.0.0

◆ IsLoading

bool IsLoading

get

Whether the current query is in communication progress with server.

Since: 4.0.0

◆ Limit

int Limit

get

The maximum number of GroupChannels per page.

Since: 4.0.0

◆ MetaDataKeyFilter

string MetaDataKeyFilter

get

The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter.

Since: 4.0.0

◆ MetaDataOrderKeyFilter

string MetaDataOrderKeyFilter

get

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

Since: 4.0.0

◆ MetaDataValuesFilter

IReadOnlyList<string> MetaDataValuesFilter

get

Works exclusively with MetaDataValueStartsWithFilter.

Since: 4.0.0

◆ MetaDataValueStartsWithFilter

string MetaDataValueStartsWithFilter

get

Works exclusively with MetaDataValuesFilter.

Since: 4.0.0

◆ MyMemberStateFilter

SbMyMemberStateFilter MyMemberStateFilter

get

A filter to return channels with the current User state matching to SbMyMemberStateFilter.

Since: 4.0.0

◆ NicknameContainsFilter

string NicknameContainsFilter

get

Searches for GroupChannels with members whose nicknames contain the specified value. 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.

Since: 4.0.0

◆ NicknameExactMatchFilter

string NicknameExactMatchFilter

get

Searches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.

Since: 4.0.0

◆ NicknameStartsWithFilter

string NicknameStartsWithFilter

get

Searches for GroupChannels with members whose nicknames starts with the specified value. 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.

Since: 4.0.0

◆ Order

SbGroupChannelListOrder Order

get

Result order of channels. Refer to GroupChannelListQueryOrder. SbGroupChannelListOrder.ChannelMetaDataValueAlphabetical works with metaDataOrderKeyFilter.

Since: 4.0.0

◆ PublicChannelFilter

SbGroupChannelPublicChannelFilter PublicChannelFilter

get

Public channel filter. Refer to SbGroupChannelPublicChannelFilter.

Since: 4.0.0

◆ QueryType

SbGroupChannelListQueryType QueryType

get

Sets query type for includeMemberList.

Since: 4.0.0

◆ SearchFields

IReadOnlyList<SbGroupChannelListQuerySearchField> SearchFields

get

Search fields. Refer to SbGroupChannelListQueryParams.SetSearchFilter and SearchField.

Since: 4.0.0

◆ SearchQuery

string SearchQuery

get

Query string.

Since: 4.0.0

◆ SuperChannelFilter

SbGroupChannelSuperChannelFilter SuperChannelFilter

get

Super channel filter. Refer to SbGroupChannelSuperChannelFilter.

Since: 4.0.0

◆ UnreadChannelFilter

SbUnreadChannelFilter UnreadChannelFilter

get

Unread channel filter. Refer to SbUnreadChannelFilter.

Since: 4.0.0

◆ UserIdsExactFilter

IReadOnlyList<string> UserIdsExactFilter

get

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

Since: 4.0.0

◆ UserIdsIncludeFilter

IReadOnlyList<string> UserIdsIncludeFilter

get

User IDs include filter. It will return null if User IDs include filter hasn't been set before. This does not cooperate with other filters.

Since: 4.0.0

Public Member Functions

Properties