#include <SBDUserListQuery.h>

Public Member Functions
void	SetMetaDataFilter (const std::wstring &key, const std::vector< std::wstring > &values)

void	LoadNextPage (std::function< void(const std::vector< SBDUser > &users, SBDError *error)> completion_handler)

Public Attributes
SBDBaseChannel *	channel

SBDUserListQueryType	query_type

int64_t	limit

bool	has_next

bool	is_loading

Detailed Description

The SBDUserListQuery class is a query class for getting the list of all users, participants, blocked users, muted users and banned users. Each type of the query is created by the class or the instance that is related to it.

The query for the all users is created by [CreateAllUserListQuery()]() of SBDMain class.
The query for the users of the specified user IDs is created by [CreateUserListQuery()]() of SBDMain class.
The query for the blocked users is created by [CreateBlockedUserListQuery()]() of SBDMain class.
The query for the participants in the specified open channel is created by [CreateParticipantListQuery()]() of the SBDOpenChannel instance.
The query for the muted users is created by [CreateMutedUserListQuery()]() of the SBDOpenChannel instance.
The query for the banned users is created by [CreateBannedUserListQuery()]() of the SBDOpenChannel instance.

Member Function Documentation

◆ LoadNextPage()

void SBDUserListQuery::LoadNextPage ( std::function< void(const std::vector< SBDUser > &users, SBDError *error)> completion_handler )

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

Parameters

completion_handler The handler interface to execute. The users is the array of SBDUser instances.

◆ SetMetaDataFilter()

void SBDUserListQuery::SetMetaDataFilter	(	const std::wstring &	key,
		const std::vector< std::wstring > &	values
	)

Sets meta data filter.

Parameters

key	The key of the meta data to use for filter.
values	The values of the meta data to use for filter.

Member Data Documentation

◆ channel

SBDBaseChannel* SBDUserListQuery::channel

The channel instance related to query.

◆ has_next

bool SBDUserListQuery::has_next

Shows if there is a next page

◆ is_loading

bool SBDUserListQuery::is_loading

Shows if the query is loading.

◆ limit

int64_t SBDUserListQuery::limit

Sets the number of users per page.

◆ query_type

SBDUserListQueryType SBDUserListQuery::query_type

Query type. It is defined in SBDUserListQueryType.

Public Member Functions

Public Attributes