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] |
A class representing query to retrieve lists related to User.
Currently, 5 kinds of User
list can be queried.
The list of all User
s of your application.
The query can be get by calling SendBirdClient#CreateUserListQuery().
The list of User
s of the specified User
IDs.
The query can be get by calling SendBirdClient#CreateUserListQuery(List<string>).
The list of blocked User
s 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 User
s (including online and offline) from an open channel.
The query can be get by calling OpenChannel#CreateMutedUserListQuery().
The list of banned User
s (including online and offline) from an open channel.
The query can be get by calling OpenChannel#CreateBannedUserListQuery().
|
inline |
Checks if there is a next page.
true
if there is a next page.
|
inline |
Checks if the current query is in communication progress with server.
true
if the current query is not finished.
|
inline |
Gets the list of User
s. 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
.
handler | A callback handler to get the queried result. |
|
inline |
Sets User
meta data filter. User
list containing only and exactly the passed User
meta data will be returned.
delegate void SendBird.UserListQuery.UserListQueryResultHandler | ( | List< User > | queryResult, |
SendBirdException | e | ||
) |
UserListQueryResult handler. This handler callback for next(UserListQueryResultHandler).
|
getset |