getFitUnlockMethodList

版本要求:

@ray-js/lock-sdk≥1.2.0

方法签名

getFitUnlockMethodList(params: )

描述

获取配件下指定类型的开锁方式列表。

参数

参数	类型	必填	说明
		是	列表查询入参（type 必填、lockDevId 可选）

返回值

类型：Promise<FitUnlockMethodItem[]>

解析后的开锁方式列表（已剥离 passWord 等敏感字段）

FitUnlockMethodItem

属性	类型	说明
`id`	number	云端开锁方式记录 id（来自 `unlockBindingId`）
`unlockId`	number	锁端开锁实例 id
`unlockName`	string	开锁方式名称
`photoUnlock`	boolean	是否图片类开锁方式
`isSpecial`	boolean	是否特殊开锁方式（配件版不支持，固定 false）
`type`	"finger" \| "face" \| "password" \| "card" \| "fingerVein" \| "hand" \| "eye"	开锁方式类型，与入参一致
`userName`	string	密码所属用户名
`lockUserId`	number	用户的锁端用户 id
`userType`	number	用户类型
	[]	可解锁的门锁设备列表

错误码

错误码	错误信息
`1014`	当前设备不支持该 type 或缺少对应 DP id

引用对象

interfaceFitUnlockMethodDevice

属性	类型	描述
`devId`	string	门锁设备 id
`devName`	string	门锁设备名称

合法值

`GetFitUnlockMethodListParams.type`

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

`return.type`

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

示例代码

import { getFitUnlockMethodList } from '@ray-js/lock-sdk';
const list = await getFitUnlockMethodList({ type: 'password' });
const lockOnly = await getFitUnlockMethodList({
  type: 'password',
  lockDevId: 'lock_xxx',
});