getSharedUserList

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

Method signature
getSharedUserList()

Description

Get the shared user list

Parameters

None

Return Value

Type: Promise<SharedUserInfo[]>
Shared user list
SharedUserInfo
PropertyTypeDescription
idstringRecord ID
namestringName
effectiveType"once" | "permanent" | "limit"Validity type
Effective time configuration
accountstringAccount
countryCodestringCountry code
lockUserIdnumberLock-side user ID
userExistbooleanWhether a corresponding App account exists

Referenced Types

interfaceEffectiveConfig
PropertyTypeDescription
effectiveDatenumberEffective date (seconds-level timestamp)
expiredDatenumberExpiration date (seconds-level timestamp)
repeat"none" | "week"Repeat policy: none or weekly
weeksWeekWeekly repeat bitmap
effectiveTimenumberDaily start time (minutes)
expiredTimenumberDaily end time (minutes)
typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

Valid Values

return.effectiveType
ValueDescriptionSince
once--
permanent--
limit--
EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--

Examples

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