getUsers(params?: GetUsersParams)
Requires:
@ray-js/lock-sdk≥1.0.0
Description
Query the user list with pagination/keywords.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No | Query parameters (page: page number, pageSize: items per page, keyword: search keyword) |
Return Value
Type: Promise<getUsersResult>
User list result
getUsersResult
| Property | Type | Description |
|---|---|---|
| User list | ||
hasMore | boolean | Whether more data is available |
Referenced Types
interface
UserInfo| Property | Type | Description |
|---|---|---|
userId | string | Cloud user ID |
lockUserId | number | Lock‑side user ID |
avatarUrl | string | Avatar URL |
backHomeNotifyAttr | number | Home arrival notification attribute flags |
effectiveFlag | number | Effective state flag |
nickName | string | Nickname |
offlineUnlock | boolean | Whether offline unlocking is supported |
| Effective time range and repeat rules | ||
| Details grouped by unlock method type | ||
userContact | string | User contact (account) |
userType | UserType | User type |
isFamilyUser | boolean | Whether the user is a household member |
type
WeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 activeenum
UserType| Value | Actual Value | Description |
|---|---|---|
UserType.ADMIN | 10 | Administrator |
UserType.MEMBER | 20 | Member |
UserType.UNKNOW | 30 | Anonymous |
UserType.SHARE | 40 | Shared member |
UserType.OWNER | 50 | Home owner |
Valid Values
Week
| Value | Description | Since |
|---|---|---|
0 | - | - |
1 | - | - |
UserInfo.unlockDetails.type
| Value | Description | Since |
|---|---|---|
finger | - | - |
face | - | - |
password | - | - |
card | - | - |
fingerVein | - | - |
hand | - | - |
eye | - | - |
UserType
| Value | Description | Since |
|---|---|---|
10 | Administrator | - |
20 | Member | - |
30 | Anonymous | - |
40 | Shared member | - |
50 | Home owner | - |