A class representing query to retrieve lists related to User. More...

Public Member Functions
void	LoadNextPage (SbUserListHandler inCompletionHandler)
	Gets the list of Users. 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 User list. If there is no more pages to be read, an empty List is returned to handler. More...

Properties
IReadOnlyList< string >	UserIdsFilter `[get]`
	Sets User IDs filter. User list containing the passed User IDs will be returned. More...

string	NicknameStartsWithFilter `[get]`
	A filter to return users whose nicknames start with the specified string. More...

string	MetaDataKeyFilter `[get]`
	The meta data key filter. This query will return users that has the meta data key and values. More...

IReadOnlyList< string >	MetaDataValuesFilter `[get]`
	The meta data values filter. This query will return users that has the meta data key and values. More...

int	Limit `[get]`
	The maximum number of Users per queried 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

A class representing query to retrieve lists related to User.

Since: 4.0.0

Member Function Documentation

◆ LoadNextPage()

void LoadNextPage ( SbUserListHandler inCompletionHandler )

Gets the list of Users. 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 User list. If there is no more pages to be read, an empty List is returned to handler.

Parameters

inCompletionHandler

Since: 4.0.0

Property Documentation

◆ HasNext

bool HasNext

get

Whether there is a next page.

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 Users per queried page.

Since: 4.0.0

◆ MetaDataKeyFilter

string MetaDataKeyFilter

get

The meta data key filter. This query will return users that has the meta data key and values.

Since: 4.0.0

◆ MetaDataValuesFilter

IReadOnlyList<string> MetaDataValuesFilter

get

The meta data values filter. This query will return users that has the meta data key and values.

Since: 4.0.0

◆ NicknameStartsWithFilter

string NicknameStartsWithFilter

get

A filter to return users whose nicknames start with the specified string.

Since: 4.0.0

◆ UserIdsFilter

IReadOnlyList<string> UserIdsFilter

get

Sets User IDs filter. User list containing the passed User IDs will be returned.

Since: 4.0.0

Public Member Functions

Properties