Appearance
扩展功能操作(ic卡、指纹、人脸、遥控、掌静脉)
说明:主要对扩展功能进行操作,例如注册、修改、删除扩展功能(ic卡、指纹、人脸、遥控、掌静脉),以及获取相关列表等。
注册、修改、删除、删除全部
- 调用方法
javascript
const result = await plugin.registerExtendedProducts(params)- 参数说明
通用参数
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| type | String | Y | "card" | 功能类型:['card','fingerprint','face','remote','palmVein'] 其中一个 |
| keyId | String | Y | "key123" | 钥匙 ID |
| uid | String | Y | "123" | 用户uid |
| userCountLimit | Number | Y | 65535 | 使用次数限制,0xFFFF 表示不限次数 |
| operate | Number | Y | 0 | 操作类型:0: 注册, 1: 修改, 2: 删除, 3: 删除全部 |
| isAdmin | Number | Y | 0 | 是否管理员:1 表示是,0 表示否 |
| isForce | Number | Y | 0 | 是否胁迫:1 表示是,0 表示否 |
| isRound | Number | Y | 0 | 是否循环:1 表示是,0 表示否 |
| weekDay | Array<Number> | Y | [1,2,4] | 循环周期,默认传入空数组[],0-6 置位分别代表周日-周六;例如:循环星期一、星期二、星期四,对应为:[1,2,4] |
| startDate | Number | Y | 1609459200000 | 生效日期,时间戳,永久则填0 |
| endDate | Number | Y | 1609545600000 | 失效日期,时间戳,永久则填0 |
| startTime | String | Y | "00:00" | 生效时间,例如:'00:00' |
| endTime | String | Y | "23:59" | 失效时间,例如:'23:59' |
IC卡相关参数(type 为 'card' 时需要)
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| cardId | Number | N | 100 | 卡片Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| cardNumber | Number | N | 1 | 卡片序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| cardName | String | N | "我的卡片" | 卡片名称 |
| cardType | Number | N | 1 | 卡片类型:1:永久,2:期限,4:循环 |
| cardUserNo | Number | N | 1 | 卡UserNo(选填) |
指纹相关参数(type 为 'fingerprint' 时需要)
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| fingerprintId | Number | N | 100 | 指纹Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| fingerprintNumber | Number | N | 1 | 指纹序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| fingerprintName | String | N | "我的指纹" | 指纹名称 |
| fingerprintType | Number | N | 1 | 指纹类型:1:永久,2:期限,4:循环 |
| fingerprintUserNo | Number | N | 1 | 指纹UserNo(选填) |
| deleteType | Number | N | 1 | 删除方式:1:通过APP走蓝牙删除,必需先通过APP蓝牙删除后再调用该接口;2:通过网关或WiFi锁删除,如果是WiFi锁或有连接网关,则可以传2,直接调用该接口从锁里删除指纹 |
人脸相关参数(type 为 'face' 时需要)
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| faceId | Number | N | 100 | 人脸Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| faceNumber | Number | N | 1 | 人脸序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| faceName | String | N | "我的人脸" | 人脸名称 |
| faceType | Number | N | 1 | 人脸类型:1:永久,2:期限,4:循环 |
| faceUserNo | Number | N | 1 | 人脸UserNo(选填) |
掌静脉相关参数(type 为 'palmVein' 时需要)
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| palmVeinId | Number | N | 100 | 掌静脉Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| palmVeinNumber | Number | N | 1 | 掌静脉序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| palmVeinName | String | N | "我的掌静脉" | 掌静脉名称 |
| palmVeinType | Number | N | 1 | 掌静脉类型:1:永久,2:期限,4:循环 |
| palmVeinUserNo | Number | N | 1 | 掌静脉UserNo(选填) |
遥控相关参数(type 为 'remote' 时需要)
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| remoteId | Number | N | 100 | 遥控Id,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| remoteNumber | Number | N | 1 | 遥控序号,添加后由监听事件返回,注册时没有则传入0,收到监听返回值后在进行赋值,用于修改、删除功能 |
| remoteName | String | N | "我的遥控" | 遥控名称 |
| remoteType | Number | N | 1 | 遥控类型:1:永久,2:期限,4:循环 |
| remoteUserNo | Number | N | 1 | 遥控UserNo(选填) |
- 返回
返回结果遵循 Result 方法的统一返回结构。
注意:收到锁版提示后,将卡片放置读卡器
取消操作
- 调用方法
javascript
const result = await plugin.registerExtendedProductsCancel(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| type | String | Y | "card" | 功能类型:['card','fingerprint','face','remote','palmVein'] |
| keyId | String | Y | "key123" | 钥匙 ID |
| uid | String | Y | "123" | 用户uid |
- 返回
返回结果遵循 Result 方法的统一返回结构。
获取IC卡列表
- 调用方法
javascript
const result = await plugin.getIcCardList(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | String | Y | "500" | 锁id |
| pageNo | String | N | "1" | 页码 |
| pageSize | String | N | "10" | 每页显示数 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
json
{
"list": [],
"pageNo": 1,
"pageSize": 10,
"pages": 0,
"total": 0
}获取指纹列表
- 调用方法
javascript
const result = await plugin.getFingerprintList(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | String | Y | "500" | 锁id |
| pageNo | String | N | "1" | 页码 |
| pageSize | String | N | "10" | 每页显示数 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
json
{
"list": [],
"pageNo": 1,
"pageSize": 10,
"pages": 0,
"total": 0
}获取人脸列表
- 调用方法
javascript
const result = await plugin.getFaceList(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | String | Y | "500" | 锁id |
| pageNo | String | N | "1" | 页码 |
| pageSize | String | N | "10" | 每页显示数 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
json
{
"list": [],
"pageNo": 1,
"pageSize": 10,
"pages": 0,
"total": 0
}获取掌静脉列表
- 调用方法
javascript
const result = await plugin.getPalmVeinList(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | String | Y | "500" | 锁id |
| pageNo | String | N | "1" | 页码 |
| pageSize | String | N | "10" | 每页显示数 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
json
{
"list": [],
"pageNo": 1,
"pageSize": 10,
"pages": 0,
"total": 0
}获取遥控列表
- 调用方法
javascript
const result = await plugin.getRemoteList(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| lockId | String | Y | "500" | 锁id |
| pageNo | String | N | "1" | 页码 |
| pageSize | String | N | "10" | 每页显示数 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
json
{
"list": [],
"pageNo": 1,
"pageSize": 10,
"pages": 0,
"total": 0
}