getCurrentUser(isForce?: boolean)
Requires:
@ray-js/lock-sdk≥1.0.0
Description
Get the current user
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
isForce | boolean | No | Whether to force a refresh |
Return Value
Type: Promise<CurrentUser>
User snapshot
CurrentUser
| Property | Type | Description |
|---|---|---|
userId | string | Cloud user ID |
lockUserId | number | Lock-side user ID |
userType | UserType | User type (admin/regular, etc.) |
allOpenDps | string | Encoded string of the DP set that supports remote unlocking |
allOpenType | number[] | List of supported unlock method type IDs |
productAttribute | number | Product attribute bits |
phase | number | User status: 0 Frozen, 1 Normal, 5 Expired, 6 Not effective, 7 Deleted |
admin | boolean | Is admin |
offlineUnlock | boolean | Whether offline unlocking is allowed |
permanent | boolean | Whether the user is permanently valid |
expireTime | number | Expiration time (s) |
effectiveTime | number | Activation time (s) |
expireDay | number | Absolute expiration day count |
Referenced Types
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
UserType
| Value | Description | Since |
|---|---|---|
10 | Administrator | - |
20 | Member | - |
30 | Anonymous | - |
40 | Shared member | - |
50 | Home owner | - |