getUserInfo(params: GetUserInfoParams)
Requires:
@ray-js/lock-sdk≥1.0.0
Description
Get details of a single user.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Yes | Query parameters (userId: user ID) |
Return Value
Type: Promise<UserInfo>
User details
UserInfo
| Property | Type | Description |
|---|---|---|
userId | string | Cloud user ID |
lockUserId | number | Lock-side user ID |
avatarUrl | string | Avatar URL |
backHomeNotifyAttr | number | Return-home notification bit flags |
effectiveFlag | number | Active status flag |
nickName | string | Nickname |
offlineUnlock | boolean | Whether offline unlocking is supported |
| Effective period and repeat rules | ||
| Details grouped by unlock method type | ||
userContact | string | User contact info (account) |
userType | UserType | User type |
isFamilyUser | boolean | Whether the user is a home member |
Referenced Types
type
WeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 activeinterface
UnlockMethodBaseInfo| Property | Type | Description |
|---|---|---|
unlockId | number | Unlock method hardware/instance ID |
unlockName | string | Unlock method name |
isBound | boolean | Whether bound to a cloud user |
id | number | Cloud-assigned unlock method record ID |
photoUnlock | boolean | Whether an image-based unlock method |
isSpecial | boolean | Whether a special unlock method (notifications and other extensions) |
enum
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 | - | - |
return.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 | - |