getTempOfflineEffectiveList

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

Method signature
getTempOfflineEffectiveList(pwdTypeCode: "once" | "multiple" | "clear_one" | "clear_all")

Description

Get the list of valid offline passwords

Parameters

ParameterTypeRequiredDescription
pwdTypeCode"once" | "multiple" | "clear_one" | "clear_all"YesOffline password type

Return Value

Type: Promise<EffectivePasswrodItem[]>
List
EffectivePasswrodItem
PropertyTypeDescription
effectivenumberWhether valid: 1 valid, 0 invalid
unlockBindingIdstringCloud unlock method record ID
effectiveTimenumberEffective time (Unix timestamp in seconds)
failReasonnumberInvalidation reason code; 0 indicates no reason
invalidTimenumberExpiration time (Unix timestamp in seconds)
namestringPassword name
phasenumberStatus: 1 Normal, 2 Pending confirmation, 3 Frozen, 10 Pending addition
[]Validity cycle details; when repeating weekly, each item describes a time period
opModeTypenumberUnlock method type
opModeSubTypenumberUnlock method subtype; in the temporary password scenario, carries semantics such as available uses
snnumberPassword index on the lock
Additional info for the clear code (only issued for clear-code type)
availTimenumberAvailable uses; omitted means unlimited
timeSetTypenumberValidity type: 0 single-use, 10 permanent, 20 start-end, 30 recurring
Sharing info (issued for virtual key/share records)

Valid Values

pwdTypeCode
ValueDescriptionSince
once--
multiple--
clear_one--
clear_all--

Examples

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