createTempCustom(params: CreateCustomParams)

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

描述

创建自定义临时密码。

参数

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

返回值

类型:Promise<TempPasswordResult>
创建结果
TempPasswordResult
属性类型说明
type"custom" | "once" | "limit" | "clear" | "clearOne" | "dynamic"密码类型或 dynamic(动态码)
namestring展示名称
passwordstring密码明文或展示串
unlockBindingIdstring云端绑定关系 id
生效时间配置

错误码

错误码错误信息
1052同一设备上一次操作尚未完成
1030密码格式不合法
1031密码名称过长(超过 20 字符)
1032缺少生效时间配置
1033缺少生效日期
1034缺少过期日期
1010生效时间大于过期时间
1035周重复模式下未传入 weeks
1043云端未返回序号(近场通道)
1001设备不在线(近场通道)
1002操作超时(近场通道)
1041设备上报创建失败:密码重复(近场通道)
1042设备上报创建失败(近场通道)
1037云端:密码已存在(USER_PWD_ALREADY_EXIST)
1038云端:密码名称重复(LOCK_PWD_NAME_REPEAT)
1039云端:时间参数不正确(START_END_DATE_NOT_RIGHT)

引用对象

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
值说明最低版本
custom--
once--
limit--
clear--
clearOne--

示例代码

import { createTempCustom } from '@ray-js/lock-sdk';
await createTempCustom({ password: '123456', effectiveTime: 1700000000, invalidTime: 1700086400 });