addSharedUser

版本要求:

@ray-js/lock-sdk≥1.2.0

方法签名

addSharedUser(params: )

描述

添加分享用户（蓝牙门锁）。

参数

参数	类型	必填	说明
		是	国家码、账号、名称与时效等

返回值

类型：Promise<AddSharedUserResult>

添加结果

AddSharedUserResult

属性	类型	说明
`id`	string	记录 ID
`name`	string	名称
`userExist`	boolean	是否有对应的 App 账号

错误码

错误码	错误信息
`1031`	名称长度超过 20
`1032`	effectiveType 为限时但未传入 effective
`1033`	未配置有效期起始日期
`1034`	未配置有效期结束日期
`1010`	生效时间不能大于失效时间
`1035`	周重复时未配置 weeks
`1083`	名称包含不支持的表情符号
`1084`	分享账号不正确
`1085`	虚拟钥匙不可用（或其它分享前置校验失败）
`1086`	设备不存在
`1038`	分享用户名称重复

引用对象

typeWeek周重复位图：下标 0–6 对应周日–周六，0 不生效 1 生效

export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

合法值

`AddSharedUserParams.effectiveType`

值	说明	最低版本
`once`	-	-
`permanent`	-	-
`limit`	-	-

`EffectiveConfig.repeat`

值	说明	最低版本
`none`	-	-
`week`	-	-

`Week`

值	说明	最低版本
`0`	-	-
`1`	-	-

示例代码

import { addSharedUser } from '@ray-js/lock-sdk';
await addSharedUser({
  countryCode: '86',
  account: '13800138000',
  name: '张三',
  effectiveType: 'once',
});