createTempOffline

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

Method signature
createTempOffline(params: )

Description

Create an offline temporary password.

Parameters

ParameterTypeRequiredDescription
YesOffline creation parameters

Return Value

Type: Promise<OfflineTempResult>
Offline temporary password creation result
OfflineTempResult
PropertyTypeDescription
type"once" | "multiple"Type: one-time or multiple-use
namestringName
passwordstringPlaintext password (already parsed per device)
unlockBindingIdstringPassword ID
pwdIdstringCloud password ID
Activation settings

Error Code

Error CodeError Message
1031Password name too long (exceeds 20 characters)
1010Start time is later than expiry time
1067Cloud: Offline passwords for the period exhausted (OFFLINE_PWD_EXAUST_IN_PERIOD)

Referenced Types

interfaceEffectiveConfig
PropertyTypeRequiredDescription
effectiveDatenumberYesEffective date (seconds-level timestamp)
expiredDatenumberYesExpiration date (seconds-level timestamp)
repeat"none" | "week"NoRepeat policy: none or weekly
weeksWeekNoWeekly repeat bitmap
effectiveTimenumberNoDaily start time (minutes)
expiredTimenumberNoDaily 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

EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--
return.type
ValueDescriptionSince
once--
multiple--

Examples

import { createTempOffline } from '@ray-js/lock-sdk';
const result = createTempOffline({ type: 'once' });