SBDGroupChannelListQuery Class Reference

#include <SBDGroupChannelListQuery.h>

Public Member Functions
void	SetCustomTypeFilter (const std::wstring &custom_type)
void	SetMemberStateFilter (SBDMemberStateFilter member_state_filter)
void	SetChannelUrlsFilter (const std::vector< std::wstring > &channel_urls)
void	SetChannelNameContainsFilter (const std::wstring &channel_name)
void	SetNicknameContainsFilter (const std::wstring &nickname)
void	SetUsersIncludeFilter (const std::vector< SBDUser > &users, SBDGroupChannelListQueryType query_type)
void	SetUsersExactFilter (const std::vector< SBDUser > &users)
void	SetChannelPublicStateFilter (const SBDChannelPublicStateFilter channel_public_state_filter)
void	SetChannelHiddenStateFilter (const SBDChannelHiddenStateFilter channel_hidden_state_filter)
void	LoadNextPage (std::function< void(std::vector< SBDGroupChannel * > channels, SBDError *)> completion_handler)

Public Attributes
int64_t	limit
bool	include_empty_channel
bool	include_member_list
SBDGroupChannelListOrder	order
bool	has_next
SBDGroupChannelListQueryType	query_type
bool	is_loading
SBDChannelPublicStateFilter	channel_public_state_filter
SBDChannelHiddenStateFilter	channel_hidden_state_filter

Detailed Description

The SBDGroupChannelListQuery class is a query class for getting the list of group channels. The instance of this class is created by [CreateMyGroupChannelListQuery()]() in SBDGroupChannel class.

Member Function Documentation

LoadNextPage()

void SBDGroupChannelListQuery::LoadNextPage

(

std::function< void(std::vector< SBDGroupChannel * > channels, SBDError *)>

completion_handler

)

Gets the list of channels. If this method is repeatedly called, it will retrieve the following pages of the channel list.

Parameters

completion_handler

The handler block to execute. The channels is the array of SBDGroupChannel instances.

SetChannelHiddenStateFilter()

void SBDGroupChannelListQuery::SetChannelHiddenStateFilter

(

const SBDChannelHiddenStateFilter

channel_hidden_state_filter

)

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

Parameters

channel_hidden_state_filter

SetChannelNameContainsFilter()

void SBDGroupChannelListQuery::SetChannelNameContainsFilter

(

const std::wstring &

channel_name

)

Sets a filter to return only channels that contains the specified group channel name.

Parameters

channel_name

The channel name to search. The query will return the channels include channel_name.

SetChannelPublicStateFilter()

void SBDGroupChannelListQuery::SetChannelPublicStateFilter

(

const SBDChannelPublicStateFilter

channel_public_state_filter

)

Sets to filter channels by the public state. The default value is SBDChannelPublicStateFilter::All.

Parameters

channel_public_state_filter

Since

3.0.3

SetChannelUrlsFilter()

void SBDGroupChannelListQuery::SetChannelUrlsFilter

(

const std::vector< std::wstring > &

channel_urls

)

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

Parameters

channel_urls

The channel urls to search.

SetCustomTypeFilter()

void SBDGroupChannelListQuery::SetCustomTypeFilter

(

const std::wstring &

custom_type

)

Sets the custom type filter.

Parameters

custom_type

The custom type to search.

SetMemberStateFilter()

void SBDGroupChannelListQuery::SetMemberStateFilter

(

SBDMemberStateFilter

member_state_filter

)

Sets the member state filter.

Parameters

member_state_filter

The member state to search.

SetNicknameContainsFilter()

void SBDGroupChannelListQuery::SetNicknameContainsFilter

(

const std::wstring &

nickname

)

Sets the filter with nickname. The group channels which have the member that has nickname are returned by loadNextPageWithCompletionHandler:(LIKE search).

Parameters

nickname

Nickname to search.

SetUsersExactFilter()

void SBDGroupChannelListQuery::SetUsersExactFilter

(

const std::vector< SBDUser > &

users

)

Sets the filter with users. The group channels which have the members that have users are returned by LoadNextPage(). The channels have the users members only.

Parameters

users

Users to search.

SetUsersIncludeFilter()

void SBDGroupChannelListQuery::SetUsersIncludeFilter	(	const std::vector< SBDUser > &	users,
		SBDGroupChannelListQueryType	query_type
	)

Sets the filter with users. The group channels which have the members that contain users are returned by LoadNextPage(). If you pass SBDGroupChannelListQueryType::And to query_type and A, B to users, the channels whose members containing A and B will be returned. If SBDGroupChannelListQueryType::Or is set, the members of the queried channels will be A or B.

Parameters

users	Users to search.
query_type	Logical condition applied to filter.

Member Data Documentation

channel_hidden_state_filter

SBDChannelHiddenStateFilter SBDGroupChannelListQuery::channel_hidden_state_filter

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

channel_public_state_filter

SBDChannelPublicStateFilter SBDGroupChannelListQuery::channel_public_state_filter

Sets to filter channels by the public state. The default value is SBDChannelPublicStateFilter::All.

Since

3.0.3

has_next

bool SBDGroupChannelListQuery::has_next

Shows if there is a next page

include_empty_channel

bool SBDGroupChannelListQuery::include_empty_channel

If the value is true, the channel list includes empty channel.

include_member_list

bool SBDGroupChannelListQuery::include_member_list

If the value is true, the channel object of the list includes members list.

is_loading

bool SBDGroupChannelListQuery::is_loading

Shows if the query is loading.

limit

int64_t SBDGroupChannelListQuery::limit

Sets the number of channels per page.

order

SBDGroupChannelListOrder SBDGroupChannelListQuery::order

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

query_type

SBDGroupChannelListQueryType SBDGroupChannelListQuery::query_type

Sets query type for include_member_list.