getCurrentUser(isForce?: boolean)

Requires:
@ray-js/lock-sdk≥1.0.0

Description

Get the current user

Parameters

ParameterTypeRequiredDescription
isForcebooleanNoWhether to force a refresh

Return Value

Type: Promise<CurrentUser>
User snapshot
CurrentUser
PropertyTypeDescription
userIdstringCloud user ID
lockUserIdnumberLock-side user ID
userTypeUserTypeUser type (admin/regular, etc.)
allOpenDpsstringEncoded string of the DP set that supports remote unlocking
allOpenTypenumber[]List of supported unlock method type IDs
productAttributenumberProduct attribute bits
phasenumberUser status: 0 Frozen, 1 Normal, 5 Expired, 6 Not effective, 7 Deleted
adminbooleanIs admin
offlineUnlockbooleanWhether offline unlocking is allowed
permanentbooleanWhether the user is permanently valid
expireTimenumberExpiration time (s)
effectiveTimenumberActivation time (s)
expireDaynumberAbsolute expiration day count

Referenced Types

enumUserType
ValueActual ValueDescription
UserType.ADMIN10Administrator
UserType.MEMBER20Member
UserType.UNKNOW30Anonymous
UserType.SHARE40Shared member
UserType.OWNER50Home owner

Valid Values

UserType
ValueDescriptionSince
10Administrator-
20Member-
30Anonymous-
40Shared member-
50Home owner-

Examples

import { getCurrentUser } from '@ray-js/lock-sdk';
const user = await getCurrentUser();