com.sendbird.android

Class UserListQuery

java.lang.Object

com.sendbird.android.UserListQuery

Direct Known Subclasses:

ApplicationUserListQuery, BannedUserListQuery, BlockedUserListQuery, MutedUserListQuery

public class UserListQuery
extends java.lang.Object

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 SendBird.createUserListQuery().

• The list of Users of the specified User IDs.

  The query can be get by calling SendBird.createUserListQuery(List).

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

  The query can be get by calling SendBird.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().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserListQuery.UserListQueryResultHandler UserListQueryResult handler.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Checks if there is a next page.
boolean	isLoading() Checks if the current query is in communication progress with server.
void	next(UserListQuery.UserListQueryResultHandler handler) Gets the list of Users.
void	setLimit(int limit) Sets the maximum number of Users per queried page.
void	setMetaDataFilter(java.lang.String metaDataKey, java.util.List<java.lang.String> metaDataValues) Deprecated. As of 3.0.81, replaced by ApplicationUserListQuery.setMetaDataFilter(String, List)}.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLimit

public void setLimit(int limit)

Sets the maximum number of Users per queried page.

Parameters:

limit - The maximum number of Users per page.

hasNext

public boolean hasNext()

Checks if there is a next page.

Returns:

true if there is a next page.

isLoading

public boolean isLoading()

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

Returns:

true if the current query is not finished.

setMetaDataFilter

@Deprecated
public void setMetaDataFilter(java.lang.String metaDataKey,
                                          java.util.List<java.lang.String> metaDataValues)

Deprecated. As of 3.0.81, replaced by ApplicationUserListQuery.setMetaDataFilter(String, List)}.

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.

Since:

3.0.35

next

public void next(UserListQuery.UserListQueryResultHandler handler)

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. For QueryType#MUTED_USER or QueryType#BANNED_USER list, you can use users from the result user list as RestrictedUser to get more detailed information about the restrictions.

Parameters:

handler - A callback handler to get the queried result.

See Also:

RestrictedUser, RestrictionInfo, RestrictedUser#getRestrictionInfo()