getTempEffectiveList()

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

Description

Get the list of active temporary passwords.

Parameters

None

Return Value

Type: Promise<EffectivePasswrodItem[]>
Current list of active temporary passwords
EffectivePasswrodItem
PropertyTypeDescription
status"effective" | "toBeEffective" | "frozen" | "freezing" | "synchronizing" | "toBeDeleted"Password status
unlockBindingIdstringPassword ID
Validity settings
namestringPassword name
type"custom" | "once" | "limit" | "clear" | "clearOne"Password type
snnumberPassword SN
hasClearPwdbooleanWhether the current password is marked for clearing
Target info for clearing a single password

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.status
ValueDescriptionSince
effective--
toBeEffective--
frozen--
freezing--
synchronizing--
toBeDeleted--
EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--
return.type
ValueDescriptionSince
custom--
once--
limit--
clear--
clearOne--

Examples

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