getFitUsers

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

方法签名
getFitUsers()

描述

获取配件下的成员(用户)列表。

参数

无

返回值

类型:Promise<FitUserItem[]>
成员列表
FitUserItem
属性类型说明
userIdstring云端用户编号
lockUserIdnumber锁端用户 id
avatarUrlstring头像地址
nickNamestring昵称
userTypeUserType成员类型:10 管理员 / 20 普通成员 / 30 没有名字的成员 / 50 家庭拥有者。
userContactstring联系方式(手机号/邮箱等),属于敏感信息,业务侧请按需脱敏展示
userTimeSetstring开门时效设置(透传字符串)。
phasenumber状态:1 正常,3 冻结。

引用对象

enumUserType
枚举值实际值描述
UserType.ADMIN10管理员
UserType.MEMBER20普通成员
UserType.UNKNOW30匿名
UserType.SHARE40分享成员
UserType.OWNER50家庭拥有者

合法值

UserType
值说明最低版本
10管理员-
20普通成员-
30匿名-
40分享成员-
50家庭拥有者-

示例代码

import { getFitUsers } from '@ray-js/lock-sdk';
const users = await getFitUsers();
console.log(users[0]?.nickName);