Params for creating a GroupChannelListQuery object. More...

Public Member Functions
void	SetUserIdsIncludeFilter (List< string > inUserIds, SbGroupChannelListQueryType inQueryType)
	Sets User IDs filter. GroupChannel list containing the passed User IDs and other members will be returned. This does not cooperate with other filters. More...

void	SetSearchFilter (string inQuery, List< SbGroupChannelListQuerySearchField > inSearchFields)
	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 SbGroupChannelListQuerySearchField, the result will be union of each result. More...

void	SetMetaDataValuesFilter (string inMetaDataKey, List< string > inMetaDataValues)
	Sets GroupChannel meta data filter. GroupChannel list containing only and exactly the passed GroupChannel meta data will be returned. If this is set, it will reset the filter set from MetaDataValueStartsWith. More...

void	SetMetaDataValueStartsWithFilter (string inMetaDataKey, string inMetaDataValueStartsWith)
	Sets GroupChannel meta data filter. GroupChannel list containing passed GroupChannel meta data key with values that starts with the passed on value will be returned. If this is set, it will reset the filter set from MetaDataValues. More...

Properties
SbChannelHiddenStateFilter	ChannelHiddenStateFilter `[get, set]`
	Sets to filter channels by the hidden state. The default value is SbChannelHiddenStateFilter.UnhiddenOnly. More...

SbGroupChannelListOrder	Order `[get, set]`
	Sets the order of the list. The order is defined in SbGroupChannelListOrder. More...

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

SbGroupChannelPublicChannelFilter	PublicChannelFilter `[get, set]`
	Sets to filter public channel.Default is All More...

SbGroupChannelSuperChannelFilter	SuperChannelFilter `[get, set]`
	Sets to filter super channel. Default is All More...

SbMyMemberStateFilter	MyMemberStateFilter `[get, set]`
	Sets the member state filter. More...

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

bool	IncludeEmptyChannel `[get, set]`
	Determines channel list includes empty channel. Default is true More...

bool	IncludeFrozenChannel `[get, set]`
	Determines channel list includes frozen channel. Default is true More...

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

bool	IncludeChatNotification `[get, set]`

int	Limit `[get, set]`
	The maximum number of items per queried page. More...

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

List< string >	ChannelUrlsFilter `[get, set]`
	Sets GroupChannel URLs filter. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned. This does not cooperate with other filters. More...

List< string >	CustomTypesFilter `[get, set]`
	Sets the custom types filter. The custom types to search. More...

string	CustomTypeStartsWithFilter `[get, set]`
	Sets to filter channels by custom type that starts with. More...

bool	IncludeMetaData `[get, set]`
	Checks whether to include channel metadata on fetch. This flag is true by default. More...

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

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

string	MetaDataOrderKeyFilter `[get, set]`
	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 MetaDataValues. More...

string	NicknameContainsFilter `[get, set]`
	Sets the filter with nickname. More...

string	NicknameExactMatchFilter `[get, set]`
	Sets the filter with nickname. More...

string	NicknameStartsWithFilter `[get, set]`
	Sets the filter with nickname prefix. More...

string	SearchQuery `[get]`
	The query property of the query specified. More...

List< SbGroupChannelListQuerySearchField >	SearchFields `[get]`
	The fields properties of the query specified. More...

List< string >	UserIdsExactFilter `[get, set]`
	Sets the filter with user IDs. More...

List< string >	UserIdsIncludeFilter `[get]`
	Sets the filter with user IDs. More...

Detailed Description

Params for creating a GroupChannelListQuery object.

Since: 4.0.0

Member Function Documentation

◆ SetMetaDataValuesFilter()

void SetMetaDataValuesFilter	(	string	inMetaDataKey,
		List< string >	inMetaDataValues
	)

Sets GroupChannel meta data filter. GroupChannel list containing only and exactly the passed GroupChannel meta data will be returned. If this is set, it will reset the filter set from MetaDataValueStartsWith.

Parameters

inMetaDataKey
inMetaDataValues

Since: 4.0.0

◆ SetMetaDataValueStartsWithFilter()

void SetMetaDataValueStartsWithFilter	(	string	inMetaDataKey,
		string	inMetaDataValueStartsWith
	)

Sets GroupChannel meta data filter. GroupChannel list containing passed GroupChannel meta data key with values that starts with the passed on value will be returned. If this is set, it will reset the filter set from MetaDataValues.

Parameters

inMetaDataKey
inMetaDataValueStartsWith

Since: 4.0.0

◆ SetSearchFilter()

void SetSearchFilter	(	string	inQuery,
		List< SbGroupChannelListQuerySearchField >	inSearchFields
	)

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 SbGroupChannelListQuerySearchField, the result will be union of each result.

Parameters

inQuery
inSearchFields

Since: 4.0.0

◆ SetUserIdsIncludeFilter()

void SetUserIdsIncludeFilter	(	List< string >	inUserIds,
		SbGroupChannelListQueryType	inQueryType
	)

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

inUserIds
inQueryType

Since: 4.0.0

Property Documentation

◆ ChannelHiddenStateFilter

SbChannelHiddenStateFilter ChannelHiddenStateFilter

getset

Sets to filter channels by the hidden state. The default value is SbChannelHiddenStateFilter.UnhiddenOnly.

Since: 4.0.0

◆ ChannelNameContainsFilter

string ChannelNameContainsFilter

getset

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

List<string> ChannelUrlsFilter

getset

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

Since: 4.0.0

◆ CustomTypesFilter

List<string> CustomTypesFilter

getset

Sets the custom types filter. The custom types to search.

Since: 4.0.0

◆ CustomTypeStartsWithFilter

string CustomTypeStartsWithFilter

getset

Sets to filter channels by custom type that starts with.

Since: 4.0.0

◆ IncludeChatNotification

bool IncludeChatNotification

getset

Since: 4.0.0

◆ IncludeEmptyChannel

bool IncludeEmptyChannel

getset

Determines channel list includes empty channel. Default is true

Since: 4.0.0

◆ IncludeFrozenChannel

bool IncludeFrozenChannel

getset

Determines channel list includes frozen channel. Default is true

Since: 4.0.0

◆ IncludeMemberList

bool IncludeMemberList

getset

Determines channel object of the list includes members list.

Since: 4.0.0

◆ IncludeMetaData

bool IncludeMetaData

getset

Checks whether to include channel metadata on fetch. This flag is true by default.

Since: 4.0.0

◆ Limit

int Limit

getset

The maximum number of items per queried page.

Since: 4.0.0

◆ MetaDataKeyFilter

string MetaDataKeyFilter

get

The metadataKey set with either metaDataValues or MetaDataValueStartsWithFilter.

Since: 4.0.0

◆ MetaDataOrderKeyFilter

string MetaDataOrderKeyFilter

getset

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

List<string> MetaDataValuesFilter

get

Works exclusively with MetaDataValueStartsWithFilter.

Since: 4.0.0

◆ MetaDataValueStartsWithFilter

string MetaDataValueStartsWithFilter

get

Works exclusively with MetaDataValues.

Since: 4.0.0

◆ MyMemberStateFilter

SbMyMemberStateFilter MyMemberStateFilter

getset

Sets the member state filter.

Since: 4.0.0

◆ NicknameContainsFilter

string NicknameContainsFilter

getset

Sets the filter with nickname.

Since: 4.0.0

◆ NicknameExactMatchFilter

string NicknameExactMatchFilter

getset

Sets the filter with nickname.

Since: 4.0.0

◆ NicknameStartsWithFilter

string NicknameStartsWithFilter

getset

Sets the filter with nickname prefix.

Since: 4.0.0

◆ Order

SbGroupChannelListOrder Order

getset

Sets the order of the list. The order is defined in SbGroupChannelListOrder.

Since: 4.0.0

◆ PublicChannelFilter

SbGroupChannelPublicChannelFilter PublicChannelFilter

getset

Sets to filter public channel.Default is All

Since: 4.0.0

◆ QueryType

SbGroupChannelListQueryType QueryType

getset

Sets query type for includeMemberList.

Since: 4.0.0

◆ SearchFields

List<SbGroupChannelListQuerySearchField> SearchFields

get

The fields properties of the query specified.

Since: 4.0.0

◆ SearchQuery

string SearchQuery

get

The query property of the query specified.

Since: 4.0.0

◆ SuperChannelFilter

SbGroupChannelSuperChannelFilter SuperChannelFilter

getset

Sets to filter super channel. Default is All

Since: 4.0.0

◆ UnreadChannelFilter

SbUnreadChannelFilter UnreadChannelFilter

getset

Unread channel filter. Refer to SbUnreadChannelFilter.

Since: 4.0.0

◆ UserIdsExactFilter

List<string> UserIdsExactFilter

getset

Sets the filter with user IDs.

Since: 4.0.0

◆ UserIdsIncludeFilter

List<string> UserIdsIncludeFilter

get

Sets the filter with user IDs.

Since: 4.0.0

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ SetMetaDataValuesFilter()

◆ SetMetaDataValueStartsWithFilter()

◆ SetSearchFilter()

◆ SetUserIdsIncludeFilter()

Property Documentation

◆ ChannelHiddenStateFilter

◆ ChannelNameContainsFilter

◆ ChannelUrlsFilter

◆ CustomTypesFilter

◆ CustomTypeStartsWithFilter

◆ IncludeChatNotification

◆ IncludeEmptyChannel

◆ IncludeFrozenChannel

◆ IncludeMemberList

◆ IncludeMetaData

◆ Limit

◆ MetaDataKeyFilter

◆ MetaDataOrderKeyFilter

◆ MetaDataValuesFilter

◆ MetaDataValueStartsWithFilter

◆ MyMemberStateFilter

◆ NicknameContainsFilter

◆ NicknameExactMatchFilter

◆ NicknameStartsWithFilter

◆ Order

◆ PublicChannelFilter

◆ QueryType

◆ SearchFields

◆ SearchQuery

◆ SuperChannelFilter

◆ UnreadChannelFilter

◆ UserIdsExactFilter

◆ UserIdsIncludeFilter