@ray-js/api 1.5.35 → 1.5.37-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cloud/index.d.ts +1 -0
- package/lib/cloud/index.js +4 -1
- package/lib/getCdnUrl/index.thing.js +13 -8
- package/package.json +5 -5
- package/lib/cloud/doorlock/README.md +0 -62
- package/lib/cloud/doorlock/auth.md +0 -323
- package/lib/cloud/doorlock/device.md +0 -265
- package/lib/cloud/doorlock/log.md +0 -153
- package/lib/cloud/doorlock/member-opmode.md +0 -279
- package/lib/cloud/doorlock/member.md +0 -276
- package/lib/cloud/doorlock/offline-pwd.md +0 -155
- package/lib/cloud/doorlock/temp-pwd.md +0 -362
- package/lib/cloud/doorlock/unlock-method.md +0 -121
- package/lib/cloud/doorlock/unlock.md +0 -222
@@ -1,265 +0,0 @@
|
|
1
|
-
## setDeviceProperties
|
2
|
-
|
3
|
-
设置设备属性。
|
4
|
-
|
5
|
-
### 引入
|
6
|
-
|
7
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
8
|
-
|
9
|
-
```js
|
10
|
-
import { setDeviceProperties } from '@ray-js/ray'
|
11
|
-
```
|
12
|
-
|
13
|
-
### 参数
|
14
|
-
|
15
|
-
**SetDevicePropertiesParams**
|
16
|
-
|
17
|
-
| 属性 | 类型 | 必填 | 说明 |
|
18
|
-
| ------- | -------- | ---- | -------------------------------------------------- |
|
19
|
-
| devId | `string` | 是 | 设备 ID |
|
20
|
-
| propKvs | `string` | 是 | JSON 字符串,例如:`{"LOST_ALERTER_HELPER": true}` |
|
21
|
-
|
22
|
-
### 返回
|
23
|
-
|
24
|
-
**SetDevicePropertiesResponse**
|
25
|
-
|
26
|
-
`boolean`,表示设置是否成功。
|
27
|
-
|
28
|
-
### 函数定义示例
|
29
|
-
|
30
|
-
```typescript
|
31
|
-
/**
|
32
|
-
* 设置设备属性
|
33
|
-
*/
|
34
|
-
export function setDeviceProperties(
|
35
|
-
params: SetDevicePropertiesParams
|
36
|
-
): Promise<SetDevicePropertiesResponse>
|
37
|
-
```
|
38
|
-
|
39
|
-
## getDeviceProperties
|
40
|
-
|
41
|
-
查看设置的设备属性。
|
42
|
-
|
43
|
-
### 引入
|
44
|
-
|
45
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
46
|
-
|
47
|
-
```js
|
48
|
-
import { getDeviceProperties } from '@ray-js/ray'
|
49
|
-
```
|
50
|
-
|
51
|
-
### 参数
|
52
|
-
|
53
|
-
**GetDevicePropertiesParams**
|
54
|
-
|
55
|
-
| 属性 | 类型 | 必填 | 说明 |
|
56
|
-
| ----- | -------- | ---- | ------------------------------------------------------------- |
|
57
|
-
| devId | `string` | 是 | 设备 ID |
|
58
|
-
| props | `string` | 是 | 属性代码字符串,多个代码用逗号隔开,如:"LOST_ALERTER_HELPER" |
|
59
|
-
|
60
|
-
### 返回
|
61
|
-
|
62
|
-
**GetDevicePropertiesResponse**
|
63
|
-
|
64
|
-
`Record<string, string>`,返回参数键值对,key 为属性代码,值为对应状态字符串。
|
65
|
-
|
66
|
-
### 函数定义示例
|
67
|
-
|
68
|
-
```typescript
|
69
|
-
/**
|
70
|
-
* 查看设置的设备属性
|
71
|
-
*/
|
72
|
-
export function getDeviceProperties(
|
73
|
-
params: GetDevicePropertiesParams
|
74
|
-
): Promise<GetDevicePropertiesResponse>
|
75
|
-
```
|
76
|
-
|
77
|
-
## getMemberList
|
78
|
-
|
79
|
-
获取家庭成员基础信息列表。
|
80
|
-
|
81
|
-
### 引入
|
82
|
-
|
83
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
84
|
-
|
85
|
-
```js
|
86
|
-
import { getMemberList } from '@ray-js/ray'
|
87
|
-
```
|
88
|
-
|
89
|
-
### 参数
|
90
|
-
|
91
|
-
**MemberListParams**
|
92
|
-
|
93
|
-
| 属性 | 类型 | 必填 | 说明 |
|
94
|
-
| ----- | -------- | ---- | -------- |
|
95
|
-
| devId | `string` | 是 | 门锁编号 |
|
96
|
-
|
97
|
-
### 返回
|
98
|
-
|
99
|
-
**MemberListResponse**
|
100
|
-
|
101
|
-
`Array<MemberListResponseItem>`,包含家庭成员基础信息列表项。
|
102
|
-
|
103
|
-
### 函数定义示例
|
104
|
-
|
105
|
-
```typescript
|
106
|
-
/**
|
107
|
-
* 获取家庭成员基础信息列表
|
108
|
-
*/
|
109
|
-
export function getMemberList(params: MemberListParams): Promise<MemberListResponse>
|
110
|
-
```
|
111
|
-
|
112
|
-
## syncUnlockMode
|
113
|
-
|
114
|
-
解锁方式同步。
|
115
|
-
|
116
|
-
### 引入
|
117
|
-
|
118
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
119
|
-
|
120
|
-
```js
|
121
|
-
import { syncUnlockMode } from '@ray-js/ray'
|
122
|
-
```
|
123
|
-
|
124
|
-
### 参数
|
125
|
-
|
126
|
-
**UnlockSyncParams**
|
127
|
-
|
128
|
-
| 属性 | 类型 | 必填 | 说明 |
|
129
|
-
| ----- | --------------- | ---- | --------------------- |
|
130
|
-
| devId | `string` | 是 | 门锁编号 |
|
131
|
-
| dpIds | `Array<string>` | 是 | 需要同步的解锁方式 dp |
|
132
|
-
|
133
|
-
### 返回
|
134
|
-
|
135
|
-
**UnlockSyncResponse**
|
136
|
-
|
137
|
-
| 属性 | 类型 | 说明 |
|
138
|
-
| ----------- | -------- | ---------------------- |
|
139
|
-
| ins | `string` | 同步指令(仅协议部分) |
|
140
|
-
| distributed | `number` | 是否需要下发 |
|
141
|
-
| dpId | `number` | dp 点 |
|
142
|
-
|
143
|
-
### 函数定义示例
|
144
|
-
|
145
|
-
```typescript
|
146
|
-
/**
|
147
|
-
* 解锁方式同步
|
148
|
-
*/
|
149
|
-
export function syncUnlockMode(params: UnlockSyncParams): Promise<UnlockSyncResponse>
|
150
|
-
```
|
151
|
-
|
152
|
-
## queryDateFormat
|
153
|
-
|
154
|
-
查询时间对应的格式。
|
155
|
-
|
156
|
-
### 引入
|
157
|
-
|
158
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
159
|
-
|
160
|
-
```js
|
161
|
-
import { queryDateFormat } from '@ray-js/ray'
|
162
|
-
```
|
163
|
-
|
164
|
-
### 参数
|
165
|
-
|
166
|
-
**QueryDateFormatParams**
|
167
|
-
|
168
|
-
| 属性 | 类型 | 必填 | 说明 |
|
169
|
-
| ----- | -------- | ---- | ------- |
|
170
|
-
| devId | `string` | 是 | 设备 ID |
|
171
|
-
| uiId | `string` | 是 | 面板 ID |
|
172
|
-
|
173
|
-
### 返回
|
174
|
-
|
175
|
-
**QueryDateFormatResponse**
|
176
|
-
|
177
|
-
`string`,日期格式化格式。
|
178
|
-
|
179
|
-
### 函数定义示例
|
180
|
-
|
181
|
-
```typescript
|
182
|
-
/**
|
183
|
-
* 查询时间对应的格式
|
184
|
-
*/
|
185
|
-
export function queryDateFormat(params: QueryDateFormatParams): Promise<QueryDateFormatResponse>
|
186
|
-
```
|
187
|
-
|
188
|
-
## queryDeviceActiveDate
|
189
|
-
|
190
|
-
用户获取设备自身的激活时间(配网时间)。
|
191
|
-
|
192
|
-
### 引入
|
193
|
-
|
194
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
195
|
-
|
196
|
-
```js
|
197
|
-
import { queryDeviceActiveDate } from '@ray-js/ray'
|
198
|
-
```
|
199
|
-
|
200
|
-
### 参数
|
201
|
-
|
202
|
-
**QueryActiveDateParams**
|
203
|
-
|
204
|
-
| 属性 | 类型 | 必填 | 说明 |
|
205
|
-
| ----- | -------- | ---- | ------- |
|
206
|
-
| devId | `string` | 是 | 设备 ID |
|
207
|
-
|
208
|
-
### 返回
|
209
|
-
|
210
|
-
**QueryActiveDateResponse**
|
211
|
-
|
212
|
-
`string`,64 dp password_offline_time 最新数据。
|
213
|
-
|
214
|
-
### 函数定义示例
|
215
|
-
|
216
|
-
```typescript
|
217
|
-
/**
|
218
|
-
* 用户获取设备自身的激活时间(配网时间)
|
219
|
-
*/
|
220
|
-
export function queryDeviceActiveDate(
|
221
|
-
params: QueryActiveDateParams
|
222
|
-
): Promise<QueryActiveDateResponse>
|
223
|
-
```
|
224
|
-
|
225
|
-
## queryDeviceTrackDetails
|
226
|
-
|
227
|
-
获取设备位置。
|
228
|
-
|
229
|
-
### 引入
|
230
|
-
|
231
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
232
|
-
|
233
|
-
```js
|
234
|
-
import { queryDeviceTrackDetails } from '@ray-js/ray'
|
235
|
-
```
|
236
|
-
|
237
|
-
### 参数
|
238
|
-
|
239
|
-
**QueryTrackDetailsParams**
|
240
|
-
|
241
|
-
| 属性 | 类型 | 必填 | 说明 |
|
242
|
-
| --------- | -------- | ---- | -------- |
|
243
|
-
| devId | `string` | 是 | 设备 ID |
|
244
|
-
| startTime | `number` | 是 | 开始时间 |
|
245
|
-
| stopTime | `number` | 是 | 结束时间 |
|
246
|
-
|
247
|
-
### 返回
|
248
|
-
|
249
|
-
**QueryTrackDetailsResponse**
|
250
|
-
|
251
|
-
| 属性 | 类型 | 说明 |
|
252
|
-
| ---- | -------- | ---- |
|
253
|
-
| lat | `number` | 纬度 |
|
254
|
-
| lng | `number` | 经度 |
|
255
|
-
|
256
|
-
### 函数定义示例
|
257
|
-
|
258
|
-
```typescript
|
259
|
-
/**
|
260
|
-
* 获取设备位置
|
261
|
-
*/
|
262
|
-
export function queryDeviceTrackDetails(
|
263
|
-
params: QueryTrackDetailsParams
|
264
|
-
): Promise<QueryTrackDetailsResponse>
|
265
|
-
```
|
@@ -1,153 +0,0 @@
|
|
1
|
-
## getLatestLog
|
2
|
-
|
3
|
-
查询最近一条日志记录。
|
4
|
-
|
5
|
-
### 引入
|
6
|
-
|
7
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
8
|
-
|
9
|
-
```js
|
10
|
-
import { getLatestLog } from '@ray-js/ray'
|
11
|
-
```
|
12
|
-
|
13
|
-
### 参数
|
14
|
-
|
15
|
-
**LatestLogParams**
|
16
|
-
|
17
|
-
| 属性 | 类型 | 必填 | 说明 |
|
18
|
-
| ----- | -------- | ---- | ------- |
|
19
|
-
| devId | `string` | 是 | 设备 ID |
|
20
|
-
|
21
|
-
### 返回
|
22
|
-
|
23
|
-
**LatestLogResponse**
|
24
|
-
|
25
|
-
结构包含日志记录的各种详细信息。
|
26
|
-
|
27
|
-
### 函数定义示例
|
28
|
-
|
29
|
-
```typescript
|
30
|
-
/**
|
31
|
-
* 查询最近一条日志记录
|
32
|
-
*/
|
33
|
-
export function getLatestLog(params: LatestLogParams): Promise<LatestLogResponse>
|
34
|
-
```
|
35
|
-
|
36
|
-
## queryLogRecord
|
37
|
-
|
38
|
-
查询日志记录。
|
39
|
-
|
40
|
-
### 引入
|
41
|
-
|
42
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
43
|
-
|
44
|
-
```js
|
45
|
-
import { queryLogRecord } from '@ray-js/ray'
|
46
|
-
```
|
47
|
-
|
48
|
-
### 参数
|
49
|
-
|
50
|
-
**QueryLogRecordParams**
|
51
|
-
|
52
|
-
| 属性 | 类型 | 必填 | 说明 |
|
53
|
-
| ------------------- | ---------- | ---- | ---------------------------- |
|
54
|
-
| devId | `string` | 是 | 设备 ID |
|
55
|
-
| logCategories | `string[]` | 否 | 日志大类 |
|
56
|
-
| userIds | `string[]` | 否 | 用户 ID 列表 |
|
57
|
-
| onlyShowMediaRecord | `boolean` | 是 | 是否仅显示带图片或视频的记录 |
|
58
|
-
| startTime | `number` | 否 | 开始时间 |
|
59
|
-
| endTime | `number` | 否 | 结束时间 |
|
60
|
-
| lastRowKey | `string` | 否 | 上一页的数据 key |
|
61
|
-
| limit | `number` | 是 | 每页数据个数 |
|
62
|
-
|
63
|
-
### 返回
|
64
|
-
|
65
|
-
**QueryLogRecordResponse**
|
66
|
-
|
67
|
-
`Array<LogRecord>`,包含日志记录的数组。
|
68
|
-
|
69
|
-
### 函数定义示例
|
70
|
-
|
71
|
-
```typescript
|
72
|
-
/**
|
73
|
-
* 查询日志记录
|
74
|
-
*/
|
75
|
-
export function queryLogRecord(params: QueryLogRecordParams): Promise<QueryLogRecordResponse>
|
76
|
-
```
|
77
|
-
|
78
|
-
## uploadLogRecord
|
79
|
-
|
80
|
-
上报操作日志记录。
|
81
|
-
|
82
|
-
### 引入
|
83
|
-
|
84
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
85
|
-
|
86
|
-
```js
|
87
|
-
import { uploadLogRecord } from '@ray-js/ray'
|
88
|
-
```
|
89
|
-
|
90
|
-
### 参数
|
91
|
-
|
92
|
-
**UploadLogRecordParams**
|
93
|
-
|
94
|
-
| 属性 | 类型 | 必填 | 说明 |
|
95
|
-
| ------- | ---------- | ---- | -------- |
|
96
|
-
| devId | `string` | 是 | 设备 ID |
|
97
|
-
| logType | `string` | 是 | 日志类型 |
|
98
|
-
| data | `string[]` | 是 | 业务参数 |
|
99
|
-
|
100
|
-
### 返回
|
101
|
-
|
102
|
-
**UploadLogRecordResult**
|
103
|
-
|
104
|
-
`boolean`,表示操作是否成功。
|
105
|
-
|
106
|
-
### 函数定义示例
|
107
|
-
|
108
|
-
```typescript
|
109
|
-
/**
|
110
|
-
* 上报操作日志记录
|
111
|
-
*/
|
112
|
-
export function uploadLogRecord(params: UploadLogRecordParams): Promise<UploadLogRecordResult>
|
113
|
-
```
|
114
|
-
|
115
|
-
## queryAlbumRecord
|
116
|
-
|
117
|
-
分页获取可以查看的相册列表。
|
118
|
-
|
119
|
-
### 引入
|
120
|
-
|
121
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
122
|
-
|
123
|
-
```js
|
124
|
-
import { queryAlbumRecord } from '@ray-js/ray'
|
125
|
-
```
|
126
|
-
|
127
|
-
### 参数
|
128
|
-
|
129
|
-
**QueryAlbumRecordParams**
|
130
|
-
|
131
|
-
| 属性 | 类型 | 必填 | 说明 |
|
132
|
-
| ------ | -------- | ---- | ------------ |
|
133
|
-
| devId | `string` | 是 | 设备 ID |
|
134
|
-
| offset | `number` | 是 | 起始页 |
|
135
|
-
| limit | `number` | 是 | 每页数据个数 |
|
136
|
-
|
137
|
-
### 返回
|
138
|
-
|
139
|
-
**QueryAlbumRecordResponse**
|
140
|
-
|
141
|
-
| 属性 | 类型 | 说明 |
|
142
|
-
| ---------- | -------- | ------------ |
|
143
|
-
| eventTypes | `string` | 事件类型 |
|
144
|
-
| albumList | `any[]` | 相册信息数组 |
|
145
|
-
|
146
|
-
### 函数定义示例
|
147
|
-
|
148
|
-
```typescript
|
149
|
-
/**
|
150
|
-
* 分页获取可以查看的相册列表
|
151
|
-
*/
|
152
|
-
export function queryAlbumRecord(params: QueryAlbumRecordParams): Promise<QueryAlbumRecordResponse>
|
153
|
-
```
|
@@ -1,279 +0,0 @@
|
|
1
|
-
## validatePasswordForMember
|
2
|
-
|
3
|
-
校验成员密码是否存在(包括临时密码)。
|
4
|
-
|
5
|
-
### 引入
|
6
|
-
|
7
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
8
|
-
|
9
|
-
```js
|
10
|
-
import { validatePasswordForMember } from '@ray-js/ray'
|
11
|
-
```
|
12
|
-
|
13
|
-
### 参数
|
14
|
-
|
15
|
-
**ValidatePwdMemberParams**
|
16
|
-
|
17
|
-
| 属性 | 类型 | 必填 | 说明 |
|
18
|
-
| -------- | -------- | ---- | ----------- |
|
19
|
-
| devId | `string` | 是 | 设备 ID |
|
20
|
-
| opModeId | `number` | 否 | 操作模式 ID |
|
21
|
-
| password | `string` | 是 | 密码 |
|
22
|
-
|
23
|
-
### 返回
|
24
|
-
|
25
|
-
**ValidatePwdMemberResult**
|
26
|
-
|
27
|
-
| 属性 | 类型 | 说明 |
|
28
|
-
| --------- | --------- | ---------------- |
|
29
|
-
| valid | `boolean` | 是否有效 |
|
30
|
-
| errorCode | `string` | 错误代码(可选) |
|
31
|
-
| errorMsg | `string` | 错误信息(可选) |
|
32
|
-
|
33
|
-
### 函数定义示例
|
34
|
-
|
35
|
-
```typescript
|
36
|
-
/**
|
37
|
-
* 校验成员密码是否存在(包括临时密码)
|
38
|
-
*/
|
39
|
-
export function validatePasswordForMember(
|
40
|
-
params: ValidatePwdMemberParams
|
41
|
-
): Promise<ValidatePwdMemberResult>
|
42
|
-
```
|
43
|
-
|
44
|
-
## addMemberUnlockMethod
|
45
|
-
|
46
|
-
添加解锁方式。
|
47
|
-
|
48
|
-
### 引入
|
49
|
-
|
50
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
51
|
-
|
52
|
-
```js
|
53
|
-
import { addMemberUnlockMethod } from '@ray-js/ray'
|
54
|
-
```
|
55
|
-
|
56
|
-
### 参数
|
57
|
-
|
58
|
-
**AddMemberUnlockMethodParams**
|
59
|
-
|
60
|
-
| 属性 | 类型 | 必填 | 说明 |
|
61
|
-
| ------------ | ------------ | ---- | ------------ |
|
62
|
-
| devId | `string` | 是 | 设备 ID |
|
63
|
-
| userId | `string` | 是 | 用户 ID |
|
64
|
-
| unlockId | `number` | 是 | 解锁 ID |
|
65
|
-
| unlockName | `string` | 否 | 解锁名称 |
|
66
|
-
| unlockAttr | `number` | 是 | 解锁属性 |
|
67
|
-
| notifyInfo | `NotifyInfo` | 否 | 通知信息 |
|
68
|
-
| unlockDetail | `string` | 否 | 解锁详细信息 |
|
69
|
-
|
70
|
-
### 返回
|
71
|
-
|
72
|
-
**AddMemberUnlockMethodResult**
|
73
|
-
|
74
|
-
| 属性 | 类型 | 说明 |
|
75
|
-
| ---------- | -------- | ----------- |
|
76
|
-
| opModeId | `string` | 操作模式 ID |
|
77
|
-
| unlockName | `string` | 解锁名称 |
|
78
|
-
|
79
|
-
### 函数定义示例
|
80
|
-
|
81
|
-
```typescript
|
82
|
-
/**
|
83
|
-
* 添加解锁方式
|
84
|
-
*/
|
85
|
-
export function addMemberUnlockMethod(
|
86
|
-
params: AddMemberUnlockMethodParams
|
87
|
-
): Promise<AddMemberUnlockMethodResult>
|
88
|
-
```
|
89
|
-
|
90
|
-
## removeMemberUnlockMethod
|
91
|
-
|
92
|
-
删除解锁方式。
|
93
|
-
|
94
|
-
### 引入
|
95
|
-
|
96
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
97
|
-
|
98
|
-
```js
|
99
|
-
import { removeMemberUnlockMethod } from '@ray-js/ray'
|
100
|
-
```
|
101
|
-
|
102
|
-
### 参数
|
103
|
-
|
104
|
-
**RemoveMemberUnlockMethodParams**
|
105
|
-
|
106
|
-
| 属性 | 类型 | 必填 | 说明 |
|
107
|
-
| -------- | -------- | ---- | ----------- |
|
108
|
-
| devId | `string` | 是 | 设备 ID |
|
109
|
-
| opmodeId | `number` | 是 | 操作模式 ID |
|
110
|
-
|
111
|
-
### 返回
|
112
|
-
|
113
|
-
**RemoveMemberUnlockMethodResult**
|
114
|
-
|
115
|
-
`boolean`,表示操作是否成功。
|
116
|
-
|
117
|
-
### 函数定义示例
|
118
|
-
|
119
|
-
```typescript
|
120
|
-
/**
|
121
|
-
* 删除解锁方式
|
122
|
-
*/
|
123
|
-
export function removeMemberUnlockMethod(
|
124
|
-
params: RemoveMemberUnlockMethodParams
|
125
|
-
): Promise<RemoveMemberUnlockMethodResult>
|
126
|
-
```
|
127
|
-
|
128
|
-
## sendSpecialUnlockVerifyCode
|
129
|
-
|
130
|
-
发送设置特殊解锁方式的验证码。
|
131
|
-
|
132
|
-
### 引入
|
133
|
-
|
134
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
135
|
-
|
136
|
-
```js
|
137
|
-
import { sendSpecialUnlockVerifyCode } from '@ray-js/ray'
|
138
|
-
```
|
139
|
-
|
140
|
-
### 参数
|
141
|
-
|
142
|
-
**SendSpecialUnlockVerifyCodeParams**
|
143
|
-
|
144
|
-
| 属性 | 类型 | 必填 | 说明 |
|
145
|
-
| ------- | -------- | ---- | -------- |
|
146
|
-
| account | `string` | 是 | 用户账号 |
|
147
|
-
|
148
|
-
### 返回
|
149
|
-
|
150
|
-
**SendSpecialUnlockVerifyCodeResult**
|
151
|
-
|
152
|
-
`boolean`,表示操作是否成功。
|
153
|
-
|
154
|
-
### 函数定义示例
|
155
|
-
|
156
|
-
```typescript
|
157
|
-
/**
|
158
|
-
* 发送设置特殊解锁方式的验证码
|
159
|
-
*/
|
160
|
-
export function sendSpecialUnlockVerifyCode(
|
161
|
-
params: SendSpecialUnlockVerifyCodeParams
|
162
|
-
): Promise<SendSpecialUnlockVerifyCodeResult>
|
163
|
-
```
|
164
|
-
|
165
|
-
## updateMemberUnlockMode
|
166
|
-
|
167
|
-
更新成员的解锁方式。
|
168
|
-
|
169
|
-
### 引入
|
170
|
-
|
171
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
172
|
-
|
173
|
-
```js
|
174
|
-
import { updateMemberUnlockMode } from '@ray-js/ray'
|
175
|
-
```
|
176
|
-
|
177
|
-
### 参数
|
178
|
-
|
179
|
-
**UpdateMemberUnlockModeParams**
|
180
|
-
|
181
|
-
| 属性 | 类型 | 必填 | 说明 |
|
182
|
-
| ------------ | ------------ | ---- | ------------ |
|
183
|
-
| devId | `string` | 是 | 设备 ID |
|
184
|
-
| opModeId | `number` | 是 | 操作模式 ID |
|
185
|
-
| unlockName | `string` | 否 | 解锁名称 |
|
186
|
-
| unlockAttr | `number` | 是 | 解锁属性 |
|
187
|
-
| unlockDetail | `string` | 是 | 解锁详细信息 |
|
188
|
-
| notifyInfo | `NotifyInfo` | 否 | 通知信息 |
|
189
|
-
|
190
|
-
### 返回
|
191
|
-
|
192
|
-
**UpdateMemberUnlockModeResult**
|
193
|
-
|
194
|
-
`boolean`,表示操作是否成功。
|
195
|
-
|
196
|
-
### 函数定义示例
|
197
|
-
|
198
|
-
```typescript
|
199
|
-
/**
|
200
|
-
* 更新成员的解锁方式
|
201
|
-
*/
|
202
|
-
export function updateMemberUnlockMode(
|
203
|
-
params: UpdateMemberUnlockModeParams
|
204
|
-
): Promise<UpdateMemberUnlockModeResult>
|
205
|
-
```
|
206
|
-
|
207
|
-
## getUnlockMethodDetail
|
208
|
-
|
209
|
-
查询某个解锁方式的详情。
|
210
|
-
|
211
|
-
### 引入
|
212
|
-
|
213
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
214
|
-
|
215
|
-
```js
|
216
|
-
import { getUnlockMethodDetail } from '@ray-js/ray'
|
217
|
-
```
|
218
|
-
|
219
|
-
### 参数
|
220
|
-
|
221
|
-
**UnlockMethodDetailParams**
|
222
|
-
|
223
|
-
| 属性 | 类型 | 必填 | 说明 |
|
224
|
-
| -------- | -------- | ---- | ----------- |
|
225
|
-
| devId | `string` | 是 | 设备 ID |
|
226
|
-
| opModeId | `number` | 是 | 操作模式 ID |
|
227
|
-
|
228
|
-
### 返回
|
229
|
-
|
230
|
-
**UnlockMethodDetailResult**
|
231
|
-
|
232
|
-
结构包含解锁方式的详细信息。
|
233
|
-
|
234
|
-
### 函数定义示例
|
235
|
-
|
236
|
-
```typescript
|
237
|
-
/**
|
238
|
-
* 查询某个解锁方式的详情
|
239
|
-
*/
|
240
|
-
export function getUnlockMethodDetail(
|
241
|
-
params: UnlockMethodDetailParams
|
242
|
-
): Promise<UnlockMethodDetailResult>
|
243
|
-
```
|
244
|
-
|
245
|
-
## getCreatePasswordSN
|
246
|
-
|
247
|
-
获取创建密码时的序号。
|
248
|
-
|
249
|
-
### 引入
|
250
|
-
|
251
|
-
> @ray-js/ray^1.5.0 以上版本可使用
|
252
|
-
|
253
|
-
```js
|
254
|
-
import { getCreatePasswordSN } from '@ray-js/ray'
|
255
|
-
```
|
256
|
-
|
257
|
-
### 参数
|
258
|
-
|
259
|
-
**GetPasswordSNParams**
|
260
|
-
|
261
|
-
| 属性 | 类型 | 必填 | 说明 |
|
262
|
-
| ----- | -------- | ---- | --------- |
|
263
|
-
| devId | `string` | 是 | 设备 ID |
|
264
|
-
| dpId | `number` | 是 | 数据点 ID |
|
265
|
-
|
266
|
-
### 返回
|
267
|
-
|
268
|
-
**GetPasswordSNResult**
|
269
|
-
|
270
|
-
`number`,表示创建密码时的序号。
|
271
|
-
|
272
|
-
### 函数定义示例
|
273
|
-
|
274
|
-
```typescript
|
275
|
-
/**
|
276
|
-
* 获取创建密码时的序号
|
277
|
-
*/
|
278
|
-
export function getCreatePasswordSN(params: GetPasswordSNParams): Promise<GetPasswordSNResult>
|
279
|
-
```
|