createTempOffline(params: CreateOfflineParams)

版本要求:
@ray-js/lock-sdk≥1.0.0

描述

创建离线类临时密码。

参数

参数类型必填说明
是离线创建参数

返回值

类型:Promise<OfflineTempResult>
离线临时密码创建结果
OfflineTempResult
属性类型说明
type"once" | "multiple"类型:一次性或多次
namestring名称 / Name
passwordstring明文密码(已按设备解析)
unlockBindingIdstring密码 ID
pwdIdstring云端密码 ID
生效配置

错误码

错误码错误信息
1031密码名称过长(超过 20 字符)
1010生效时间大于过期时间
1067云端:该周期离线密码已耗尽(OFFLINE_PWD_EXAUST_IN_PERIOD)

引用对象

interfaceEffectiveConfig
属性类型必填描述
effectiveDatenumber是生效日(秒级时间戳)
expiredDatenumber是失效日(秒级时间戳)
repeat"none" | "week"否重复策略:无或按周
weeksWeek否周重复位图
effectiveTimenumber否每日生效开始时间,单位:分钟
expiredTimenumber否每日失效结束时间,单位:分钟
typeWeek周重复位图:下标 0–6 对应周日–周六,0 不生效 1 生效
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

合法值

EffectiveConfig.repeat
值说明最低版本
none--
week--
Week
值说明最低版本
0--
1--
return.type
值说明最低版本
once--
multiple--

示例代码

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