SendbirdChat/com.sendbird.android.params/ApplicationUserListQueryParams

ApplicationUserListQueryParams

data class ApplicationUserListQueryParams @JvmOverloads constructor(var userIdsFilter: List<String>? = null, var nicknameStartsWithFilter: String? = null, var metaDataFilter: Pair<String, List<String>>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ApplicationUserListQuery object.

Since

4.0.0

See also

Constructors

Link copied to clipboard
@JvmOverloads
constructor(userIdsFilter: List<String>? = null, nicknameStartsWithFilter: String? = null, metaDataFilter: Pair<String, List<String>>? = null, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

Link copied to clipboard
var limit: Int

The maximum number of items per queried page.

Link copied to clipboard
var 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.

Link copied to clipboard
var nicknameStartsWithFilter: String?

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

Link copied to clipboard
var userIdsFilter: List<String>?

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