getUserInfo - 获取用户详细信息。 – 涂鸦小程序

getUserInfo(params: GetUserInfoParams)

版本要求:

@ray-js/lock-sdk≥1.0.0

描述

获取单个用户详情。

参数

参数	类型	必填	说明
		是	查询参数（userId 用户 id）

返回值

类型：Promise<UserInfo>

用户详情

UserInfo

属性	类型	说明
`userId`	string	云端用户 id
`lockUserId`	number	锁端用户 id
`avatarUrl`	string	头像 URL
`backHomeNotifyAttr`	number	回家通知相关属性位
`effectiveFlag`	number	生效状态标记
`nickName`	string	昵称
`offlineUnlock`	boolean	是否支持离线开锁
		生效时间段与重复规则
		按开锁方式类型分组的明细
`userContact`	string	用户联系方式（账号）
`userType`	UserType	用户类型
`isFamilyUser`	boolean	是否为家庭体系成员

引用对象

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

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

interfaceUnlockMethodBaseInfo

属性	类型	描述
`unlockId`	number	开锁方式硬件/实例 id
`unlockName`	string	开锁方式名称
`isBound`	boolean	是否已与云端用户绑定
`id`	number	云端分配的开锁方式记录 id
`photoUnlock`	boolean	是否图片类开锁方式
`isSpecial`	boolean	是否特殊开锁方式（通知等扩展）

enumUserType

枚举值	实际值	描述
`UserType.ADMIN`	`10`	管理员
`UserType.MEMBER`	`20`	普通成员
`UserType.UNKNOW`	`30`	匿名
`UserType.SHARE`	`40`	分享成员
`UserType.OWNER`	`50`	家庭拥有者

合法值

`Week`

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

`return.unlockDetails.type`

值	说明	最低版本
`finger`	-	-
`face`	-	-
`password`	-	-
`card`	-	-
`fingerVein`	-	-
`hand`	-	-
`eye`	-	-

`UserType`

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

示例代码

import { getUserInfo } from '@ray-js/lock-sdk';
const info = await getUserInfo({ userId: 'user_001' });