SendbirdChat/com.sendbird.android.user.query/ApplicationUserListQuery

ApplicationUserListQuery

class ApplicationUserListQuery

A class representing query to retrieve lists related to User.

Since

3.0.81

Properties

var hasNext: Boolean

Whether there is a next page.

@get:Synchronized

var isLoading: Boolean

Whether the current query is in communication progress with server.

The maximum number of Users per queried page.

val metaDataFilter: Pair<String, List<String>>?

User meta data key/value filter. User list containing only and exactly the passed User meta data will be returned.

nicknameStartsWithFilter

val nicknameStartsWithFilter: String?

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

val userIdsFilter: List<String>?

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

Functions

fun next(handler: UsersHandler?)

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.