Appearance
电子钥匙
说明:主要对电子钥匙进行一些基础操作,例如冻结电子钥匙、解冻电子钥匙、删除电子钥匙、发送电子钥匙、删除密码等。
冻结电子钥匙
- 调用方法
javascript
import { KeyFreeze } from 'star-cloud-web'
KeyFreeze(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户uid |
| keyId | Number | Y | 500 | 电子钥匙ID |
- 返回
返回结果遵循 Result 方法的统一返回结构。
解冻电子钥匙
- 调用方法
javascript
import { KeyUnfreeze } from 'star-cloud-web'
KeyUnfreeze(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户uid |
| keyId | Number | Y | 500 | 电子钥匙ID |
- 返回
返回结果遵循 Result 方法的统一返回结构。
删除电子钥匙
- 调用方法
javascript
import { KeyDelete } from 'star-cloud-web'
KeyDelete(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户uid |
| keyId | Number | Y | 500 | 电子钥匙ID |
- 返回
返回结果遵循 Result 方法的统一返回结构。
发送电子钥匙
- 调用方法
javascript
import { KeySend } from 'star-cloud-web'
KeySend(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户uid |
| receiverUsername | String | Y | "user@example.com" | 接收方用户账号,在云平台注册后返回获取的云平台username |
| receiverUsernameType | Number | Y | 1 | 账号类型:1-手机号 2-邮箱号 |
| keyName | String | Y | "我的钥匙" | 钥匙名称 |
| lockId | Number | Y | 500 | 锁ID |
| keyType | Number | Y | 1 | 钥匙类型(见常量列表) |
| startDate | Number | N | 1609459200000 | 开始时间:限时、循环钥匙必传,时间戳(毫秒) |
| endDate | Number | N | 1609545600000 | 结束时间:限时、循环钥匙必传,时间戳(毫秒) |
| weekDays | Number | N | 127 | 循环周期:循环钥匙必填 |
| keyRight | Number | N | 0 | 是否授权管理员,默认0:0-普通钥匙 1-授权管理员 |
| remoteEnable | Number | N | 0 | 是否支持远程开锁:0-默认关闭 1-是 2-否 |
| isCameraEnable | Number | N | 0 | 是否打开摄像头:0-默认关闭 1-是 2-否 |
| faceAuthentication | Number | N | 0 | 是否实名认证:0-默认关闭 1-是 2-否 |
| isOnlyManageSelf | Number | N | 0 | 是否仅管理自己创建的用户(keyRight为1时生效):0-否 1-是 |
| customInfo | String | N | "自定义内容" | 自定义内容(字符串) |
| remarks | String | N | "备注信息" | 备注 |
- 返回
返回结果遵循 Result 方法的统一返回结构,data 中包含:
| 名称 | 类型 | 描述 |
|---|---|---|
| keyId | Number | 电子钥匙ID |
| receiverUid | Number | 接收方用户uid |
删除密码
- 调用方法
javascript
import { deletePassword } from 'star-cloud-web'
deletePassword(params)- 参数说明
| 名称 | 类型 | 是否必需 | 示例 | 描述 |
|---|---|---|---|---|
| uid | Number | Y | 123 | 用户uid |
| keyboardPwdId | Number | Y | 100 | 密码ID |
- 返回
返回结果遵循 Result 方法的统一返回结构。
