getSharedUserList

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

方法签名
getSharedUserList()

描述

获取分享用户列表

参数

无

返回值

类型:Promise<SharedUserInfo[]>
分享用户列表
SharedUserInfo
属性类型说明
idstring记录 ID
namestring名称
effectiveType"once" | "permanent" | "limit"时效类型
生效时间配置
accountstring账号
countryCodestring国家码
lockUserIdnumber锁端用户 ID
userExistboolean是否有对应的 App 账号

引用对象

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

合法值

return.effectiveType
值说明最低版本
once--
permanent--
limit--
EffectiveConfig.repeat
值说明最低版本
none--
week--
Week
值说明最低版本
0--
1--

示例代码

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