new UserListQuery(userIdsopt)
- Deprecated:
- since version v3.0.86, please use
ApplicationUserListQueryinstead Query class used to retrieve all users. Initialize usingsendbird.createUserListQuery()
- since version v3.0.86, please use
- See:
Instantiates query class
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
userIds |
Array.<string> |
<optional> |
[]
|
Members
hasNext :boolean
Type:
- boolean
isLoading :boolean
Type:
- boolean
limit :number
- Default Value:
- 20
Type:
- number
metaDataKey :string
- Default Value:
- ""
Type:
- string
metaDataValues :Array.<string>
- Default Value:
- []
Type:
- Array.<string>
Methods
next(callbackopt) → {Promise|undefined}
Executes the query
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
userListQueryCallback |
<optional> |
Returns:
- Type
- Promise | undefined