SendBird.UserListQuery Class Reference

Inheritance diagram for SendBird.UserListQuery:

Public Types
enum	QueryType {   ALL_USER, FILTERED_USER, BLOCKED_USER, PARTICIPANT,   MUTED_USER, BANNED_USER }

Public Member Functions
bool	HasNext ()
bool	IsLoading ()
void	SetMetaDataFilter (string metaDataKey, List< string > metaDataValues)
void	Next (UserListQueryResultHandler handler)
delegate void	UserListQueryResultHandler (List< User > queryResult, SendBirdException e)

Public Attributes
Dictionary< string, List< string > >	mMetaDataFilter

Properties
int	Limit [get, set]

Detailed Description

A class representing query to retrieve lists related to User.

Currently, 5 kinds of User list can be queried.

• The list of all Users of your application.

  The query can be get by calling SendBirdClient#CreateUserListQuery().

• The list of Users of the specified User IDs.

  The query can be get by calling SendBirdClient#CreateUserListQuery(List<string>).

• The list of blocked Users blocked by currently logged-in User.

  The query can be get by calling SendBirdClient#CreateBlockedUserListQuery().

• The list of participants (who are online) in an open channel.

  The query can be get by calling OpenChannel#CreateParticipantListQuery().

• The list of forced to be muted Users (including online and offline) from an open channel.

  The query can be get by calling OpenChannel#CreateMutedUserListQuery().

• The list of banned Users (including online and offline) from an open channel.

  The query can be get by calling OpenChannel#CreateBannedUserListQuery().

Member Function Documentation

HasNext()

bool SendBird.UserListQuery.HasNext ( )

inline

Checks if there is a next page.

Returns

true if there is a next page.

IsLoading()

bool SendBird.UserListQuery.IsLoading ( )

inline

Checks if the current query is in communication progress with server.

Returns

true if the current query is not finished.

Next()

void SendBird.UserListQuery.Next ( UserListQueryResultHandler  handler )

inline

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 (not null) is returned to handler.

Parameters

handler

A callback handler to get the queried result.

SetMetaDataFilter()

void SendBird.UserListQuery.SetMetaDataFilter ( string  metaDataKey, List< string >  metaDataValues  )

inline

Sets User meta data filter. User list containing only and exactly the passed User meta data will be returned.

Parameters

metaDataKey	User meta data key.
metaDataValues	User meta data values.

Deprecated:

As of 3.0.22, replaced by ApplicationUserListQuery#setMetaDataFilter(String, List)}.

UserListQueryResultHandler()

delegate void SendBird.UserListQuery.UserListQueryResultHandler	(	List< User >	queryResult,
		SendBirdException	e
	)

UserListQueryResult handler. This handler callback for next(UserListQueryResultHandler).

Property Documentation

Limit

int SendBird.UserListQuery.Limit

getset

Sets the maximum number of Users per queried page.

Parameters

limit

The maximum number of Users per page.

---

The documentation for this class was generated from the following file:

• SendBird/src/UserListQuery.cs