@ray-js/api 1.7.79 → 1.7.80

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.
Files changed (56) hide show
  1. package/@types/AIKit.d.ts +1140 -1009
  2. package/@types/AVideoKit.d.ts +26 -101
  3. package/@types/BaseKit.d.ts +234 -210
  4. package/@types/BizKit.d.ts +271 -296
  5. package/@types/DeviceKit.d.ts +57 -88
  6. package/@types/GroupCITestKit.d.ts +1 -3
  7. package/@types/HealthKit.d.ts +273 -230
  8. package/@types/HomeKit.d.ts +1062 -891
  9. package/@types/IPCKit.d.ts +23 -50
  10. package/@types/LightKit.d.ts +2 -2
  11. package/@types/MapKit.d.ts +592 -381
  12. package/@types/MediaPlayerKit.d.ts +4 -28
  13. package/@types/MiniKit.d.ts +198 -375
  14. package/@types/P2PKit.d.ts +139 -205
  15. package/@types/PayKit.d.ts +10 -79
  16. package/@types/SweeperKit.d.ts +10 -10
  17. package/@types/ThirdAuthKit.d.ts +28 -252
  18. package/@types/WearKit.d.ts +630 -1593
  19. package/@types/api-extend.d.ts +0 -63
  20. package/lib/AIKit-1.6.0.d.ts +732 -35
  21. package/lib/AIKit-1.6.0.js +732 -51
  22. package/lib/BaseKit-3.17.7.d.ts +0 -214
  23. package/lib/BaseKit-3.17.7.js +1 -227
  24. package/lib/DeviceKit-4.13.1.d.ts +3666 -0
  25. package/lib/DeviceKit-4.13.1.js +3666 -0
  26. package/lib/HealthKit-6.5.0.d.ts +603 -0
  27. package/lib/HealthKit-6.5.0.js +603 -0
  28. package/lib/HomeKit-3.1.4.d.ts +4 -0
  29. package/lib/HomeKit-3.1.4.js +4 -0
  30. package/lib/IPCKit-6.4.5.d.ts +0 -1
  31. package/lib/IPCKit-6.4.5.js +0 -1
  32. package/lib/MapKit-3.4.13.d.ts +251 -0
  33. package/lib/MapKit-3.4.13.js +251 -0
  34. package/lib/MediaKit-3.4.1.d.ts +16 -0
  35. package/lib/MediaKit-3.4.1.js +16 -0
  36. package/lib/PlayNetKit-1.3.30.d.ts +930 -0
  37. package/lib/PlayNetKit-1.3.30.js +930 -0
  38. package/lib/cloud/alarm.d.ts +38 -5
  39. package/lib/cloud/alarm.js +38 -5
  40. package/lib/cloud/device.d.ts +42 -6
  41. package/lib/cloud/device.js +42 -6
  42. package/lib/cloud/gateway.d.ts +16 -0
  43. package/lib/cloud/gateway.js +16 -0
  44. package/lib/cloud/health.d.ts +1 -0
  45. package/lib/cloud/health.js +272 -0
  46. package/lib/cloud/interface.d.ts +161 -0
  47. package/lib/cloud/interface.js +18 -0
  48. package/lib/cloud/statistic.d.ts +112 -26
  49. package/lib/cloud/statistic.js +112 -26
  50. package/lib/cloud/timer.d.ts +2 -4
  51. package/lib/nativeRouters/outdoors.d.ts +2 -0
  52. package/lib/nativeRouters/outdoors.js +2 -0
  53. package/lib/nativeRouters/remoteGroup.d.ts +2 -0
  54. package/lib/nativeRouters/remoteGroup.js +2 -0
  55. package/lib/panel/publishDps.js +1 -1
  56. package/package.json +5 -5
@@ -2,290 +2,1220 @@
2
2
  /**
3
3
  * @public
4
4
  * @since @ray-js/ray 1.6.31
5
+ * @example 基础调用
6
+ * ```tsx
7
+ * import { playnet } from '@ray-js/ray';
8
+ *
9
+ * const { analysisMatterQRCode } = playnet;
10
+ *
11
+ * analysisMatterQRCode({
12
+ * qrCodeStr: 'MT:YNJV40800006IB5A010',
13
+ * success: (result) => {
14
+ * console.log('analysisMatterQRCode success', result);
15
+ * },
16
+ * fail: (error) => {
17
+ * console.log('analysisMatterQRCode fail', error.errorMsg);
18
+ * },
19
+ * });
20
+ * ```
5
21
  */
6
22
  export declare const analysisMatterQRCode: typeof ty.playnet.analysisMatterQRCode;
7
23
  /**
8
24
  * @public
9
25
  * @since @ray-js/ray 1.6.31
26
+ * @example 基础调用
27
+ * ```tsx
28
+ * import { playnet } from '@ray-js/ray';
29
+ *
30
+ * const { autoConnectToAp } = playnet;
31
+ *
32
+ * autoConnectToAp({
33
+ * ssidPrefix: 'SmartLife-',
34
+ * ssid: 'SmartLife-XXXX',
35
+ * pwd: '',
36
+ * success: () => {
37
+ * console.log('autoConnectToAp success');
38
+ * },
39
+ * fail: (error) => {
40
+ * console.log('autoConnectToAp fail', error.errorMsg);
41
+ * },
42
+ * });
43
+ * ```
10
44
  */
11
45
  export declare const autoConnectToAp: typeof ty.playnet.autoConnectToAp;
12
46
  /**
13
47
  * @public
14
48
  * @since @ray-js/ray 1.6.31
49
+ * @example 基础调用
50
+ * ```tsx
51
+ * import { playnet } from '@ray-js/ray';
52
+ *
53
+ * const { autoConnectToApWithSSIDPrefix } = playnet;
54
+ *
55
+ * autoConnectToApWithSSIDPrefix({
56
+ * ssidPrefix: 'SmartLife-',
57
+ * ssid: 'SmartLife-XXXX',
58
+ * pwd: '',
59
+ * success: () => {
60
+ * console.log('autoConnectToApWithSSIDPrefix success');
61
+ * },
62
+ * fail: (error) => {
63
+ * console.log('autoConnectToApWithSSIDPrefix fail', error.errorMsg);
64
+ * },
65
+ * });
66
+ * ```
15
67
  */
16
68
  export declare const autoConnectToApWithSSIDPrefix: typeof ty.playnet.autoConnectToApWithSSIDPrefix;
17
69
  /**
18
70
  * @public
19
71
  * @since @ray-js/ray 1.6.31
72
+ * @example 基础调用
73
+ * ```tsx
74
+ * import { playnet } from '@ray-js/ray';
75
+ *
76
+ * const { checkBleWifiDeviceReset } = playnet;
77
+ *
78
+ * checkBleWifiDeviceReset({
79
+ * link: 'https://example.com/short',
80
+ * packet: {
81
+ * id: 'example',
82
+ * name: 'example',
83
+ * providerName: 'example',
84
+ * data: 'example',
85
+ * configType: 'example',
86
+ * productId: 'example',
87
+ * uuid: 'example',
88
+ * mac: 'example',
89
+ * address: 'example',
90
+ * deviceType: 0,
91
+ * isbind: false,
92
+ * flag: 0,
93
+ * isShare: false,
94
+ * rssi: 0,
95
+ * pidHexString: 'example',
96
+ * },
97
+ * success: (result) => {
98
+ * console.log('checkBleWifiDeviceReset success', result);
99
+ * },
100
+ * fail: (error) => {
101
+ * console.log('checkBleWifiDeviceReset fail', error.errorMsg);
102
+ * },
103
+ * });
104
+ * ```
20
105
  */
21
106
  export declare const checkBleWifiDeviceReset: typeof ty.playnet.checkBleWifiDeviceReset;
22
107
  /**
23
108
  * @public
24
109
  * @since @ray-js/ray 1.6.31
110
+ * @example 基础调用
111
+ * ```tsx
112
+ * import { playnet } from '@ray-js/ray';
113
+ *
114
+ * const { connectMatterDevice } = playnet;
115
+ *
116
+ * connectMatterDevice({
117
+ * spaceId: 0,
118
+ * timeout: 60,
119
+ * success: (result) => {
120
+ * console.log('connectMatterDevice success', result);
121
+ * },
122
+ * fail: (error) => {
123
+ * console.log('connectMatterDevice fail', error.errorMsg);
124
+ * },
125
+ * });
126
+ * ```
25
127
  */
26
128
  export declare const connectMatterDevice: typeof ty.playnet.connectMatterDevice;
27
129
  /**
28
130
  * @public
29
131
  * @since @ray-js/ray 1.6.31
132
+ * @example 基础调用
133
+ * ```tsx
134
+ * import { playnet } from '@ray-js/ray';
135
+ *
136
+ * const { connectWifi } = playnet;
137
+ *
138
+ * connectWifi({
139
+ * ssidPrefix: 'SmartLife-',
140
+ * ssid: 'SmartLife-XXXX',
141
+ * pwd: '',
142
+ * success: () => {
143
+ * console.log('connectWifi success');
144
+ * },
145
+ * fail: (error) => {
146
+ * console.log('connectWifi fail', error.errorMsg);
147
+ * },
148
+ * });
149
+ * ```
30
150
  */
31
151
  export declare const connectWifi: typeof ty.playnet.connectWifi;
32
152
  /**
33
153
  * @public
34
154
  * @since @ray-js/ray 1.6.31
155
+ * @example 基础调用
156
+ * ```tsx
157
+ * import { playnet } from '@ray-js/ray';
158
+ *
159
+ * const { continueMatterCommission } = playnet;
160
+ *
161
+ * continueMatterCommission({
162
+ * activeModel: 'MATTER',
163
+ * relationId: 0,
164
+ * spaceId: 0,
165
+ * success: () => {
166
+ * console.log('continueMatterCommission success');
167
+ * },
168
+ * fail: (error) => {
169
+ * console.log('continueMatterCommission fail', error.errorMsg);
170
+ * },
171
+ * });
172
+ * ```
35
173
  */
36
174
  export declare const continueMatterCommission: typeof ty.playnet.continueMatterCommission;
37
175
  /**
38
176
  * @public
39
177
  * @since @ray-js/ray 1.6.31
178
+ * @example 基础调用
179
+ * ```tsx
180
+ * import { playnet } from '@ray-js/ray';
181
+ *
182
+ * const { getCurrentWifiSSID } = playnet;
183
+ *
184
+ * getCurrentWifiSSID({
185
+ * success: (result) => {
186
+ * console.log('getCurrentWifiSSID success', result);
187
+ * },
188
+ * fail: (error) => {
189
+ * console.log('getCurrentWifiSSID fail', error.errorMsg);
190
+ * },
191
+ * });
192
+ * ```
40
193
  */
41
194
  export declare const getCurrentWifiSSID: typeof ty.playnet.getCurrentWifiSSID;
42
195
  /**
43
196
  * @public
44
197
  * @since @ray-js/ray 1.6.31
198
+ * @example 基础调用
199
+ * ```tsx
200
+ * import { playnet } from '@ray-js/ray';
201
+ *
202
+ * const { getDeviceSecurityConfigs } = playnet;
203
+ *
204
+ * getDeviceSecurityConfigs({
205
+ * success: (result) => {
206
+ * console.log('getDeviceSecurityConfigs success', result);
207
+ * },
208
+ * fail: (error) => {
209
+ * console.log('getDeviceSecurityConfigs fail', error.errorMsg);
210
+ * },
211
+ * });
212
+ * ```
45
213
  */
46
214
  export declare const getDeviceSecurityConfigs: typeof ty.playnet.getDeviceSecurityConfigs;
47
215
  /**
48
216
  * @public
49
217
  * @since @ray-js/ray 1.6.31
218
+ * @example 基础调用
219
+ * ```tsx
220
+ * import { playnet } from '@ray-js/ray';
221
+ *
222
+ * const { getPairConfigToken } = playnet;
223
+ *
224
+ * getPairConfigToken({
225
+ * gid: 0,
226
+ * success: (result) => {
227
+ * console.log('getPairConfigToken success', result);
228
+ * },
229
+ * fail: (error) => {
230
+ * console.log('getPairConfigToken fail', error.errorMsg);
231
+ * },
232
+ * });
233
+ * ```
50
234
  */
51
235
  export declare const getPairConfigToken: typeof ty.playnet.getPairConfigToken;
52
236
  /**
53
237
  * @public
54
238
  * @since @ray-js/ray 1.6.31
239
+ * @example 基础调用
240
+ * ```tsx
241
+ * import { playnet } from '@ray-js/ray';
242
+ *
243
+ * const { hasBlePermission } = playnet;
244
+ *
245
+ * hasBlePermission({
246
+ * success: (result) => {
247
+ * console.log('hasBlePermission success', result);
248
+ * },
249
+ * fail: (error) => {
250
+ * console.log('hasBlePermission fail', error.errorMsg);
251
+ * },
252
+ * });
253
+ * ```
55
254
  */
56
255
  export declare const hasBlePermission: typeof ty.playnet.hasBlePermission;
57
256
  /**
58
257
  * @public
59
258
  * @since @ray-js/ray 1.6.31
259
+ * @example 基础调用
260
+ * ```tsx
261
+ * import { playnet } from '@ray-js/ray';
262
+ *
263
+ * const { hasLocalNetworkPermission } = playnet;
264
+ *
265
+ * hasLocalNetworkPermission({
266
+ * success: (result) => {
267
+ * console.log('hasLocalNetworkPermission success', result);
268
+ * },
269
+ * fail: (error) => {
270
+ * console.log('hasLocalNetworkPermission fail', error.errorMsg);
271
+ * },
272
+ * });
273
+ * ```
60
274
  */
61
275
  export declare const hasLocalNetworkPermission: typeof ty.playnet.hasLocalNetworkPermission;
62
276
  /**
63
277
  * @public
64
278
  * @since @ray-js/ray 1.6.31
279
+ * @example 基础调用
280
+ * ```tsx
281
+ * import { playnet } from '@ray-js/ray';
282
+ *
283
+ * const { hasPermission } = playnet;
284
+ *
285
+ * hasPermission({
286
+ * permission: 'WIFI',
287
+ * success: (result) => {
288
+ * console.log('hasPermission success', result);
289
+ * },
290
+ * fail: (error) => {
291
+ * console.log('hasPermission fail', error.errorMsg);
292
+ * },
293
+ * });
294
+ * ```
65
295
  */
66
296
  export declare const hasPermission: typeof ty.playnet.hasPermission;
67
297
  /**
68
298
  * @public
69
299
  * @since @ray-js/ray 1.6.31
300
+ * @example 基础调用
301
+ * ```tsx
302
+ * import { playnet } from '@ray-js/ray';
303
+ *
304
+ * const { isExistInCurrentAccount } = playnet;
305
+ *
306
+ * isExistInCurrentAccount({
307
+ * uuid: 'example',
308
+ * mac: 'AA:BB:CC:DD:EE:FF',
309
+ * success: (result) => {
310
+ * console.log('isExistInCurrentAccount success', result);
311
+ * },
312
+ * fail: (error) => {
313
+ * console.log('isExistInCurrentAccount fail', error.errorMsg);
314
+ * },
315
+ * });
316
+ * ```
70
317
  */
71
318
  export declare const isExistInCurrentAccount: typeof ty.playnet.isExistInCurrentAccount;
72
319
  /**
73
320
  * @public
74
321
  * @since @ray-js/ray 1.6.31
322
+ * @example 基础调用
323
+ * ```tsx
324
+ * import { playnet } from '@ray-js/ray';
325
+ *
326
+ * const { isSystemPopupInAutoConnectAp } = playnet;
327
+ *
328
+ * isSystemPopupInAutoConnectAp({
329
+ * success: (result) => {
330
+ * console.log('isSystemPopupInAutoConnectAp success', result);
331
+ * },
332
+ * fail: (error) => {
333
+ * console.log('isSystemPopupInAutoConnectAp fail', error.errorMsg);
334
+ * },
335
+ * });
336
+ * ```
75
337
  */
76
338
  export declare const isSystemPopupInAutoConnectAp: typeof ty.playnet.isSystemPopupInAutoConnectAp;
77
339
  /**
78
340
  * @public
79
341
  * @since @ray-js/ray 1.6.31
342
+ * @example 基础调用
343
+ * ```tsx
344
+ * import { playnet } from '@ray-js/ray';
345
+ *
346
+ * const { offActivateIntermediateState } = playnet;
347
+ *
348
+ * offActivateIntermediateState((result) => {
349
+ * console.log('offActivateIntermediateState', result);
350
+ * });
351
+ * ```
80
352
  */
81
353
  export declare const offActivateIntermediateState: typeof ty.playnet.offActivateIntermediateState;
82
354
  /**
83
355
  * @public
84
356
  * @since @ray-js/ray 1.6.31
357
+ * @example 基础调用
358
+ * ```tsx
359
+ * import { playnet } from '@ray-js/ray';
360
+ *
361
+ * const { offBLEScanDevice } = playnet;
362
+ *
363
+ * offBLEScanDevice((result) => {
364
+ * console.log('offBLEScanDevice', result);
365
+ * });
366
+ * ```
85
367
  */
86
368
  export declare const offBLEScanDevice: typeof ty.playnet.offBLEScanDevice;
87
369
  /**
88
370
  * @public
89
371
  * @since @ray-js/ray 1.6.31
372
+ * @example 基础调用
373
+ * ```tsx
374
+ * import { playnet } from '@ray-js/ray';
375
+ *
376
+ * const { offBLEScanDeviceWithUUID } = playnet;
377
+ *
378
+ * offBLEScanDeviceWithUUID((result) => {
379
+ * console.log('offBLEScanDeviceWithUUID', result);
380
+ * });
381
+ * ```
90
382
  */
91
383
  export declare const offBLEScanDeviceWithUUID: typeof ty.playnet.offBLEScanDeviceWithUUID;
92
384
  /**
93
385
  * @public
94
386
  * @since @ray-js/ray 1.6.31
387
+ * @example 基础调用
388
+ * ```tsx
389
+ * import { playnet } from '@ray-js/ray';
390
+ *
391
+ * const { offBLEStateChange } = playnet;
392
+ *
393
+ * offBLEStateChange((result) => {
394
+ * console.log('offBLEStateChange', result);
395
+ * });
396
+ * ```
95
397
  */
96
398
  export declare const offBLEStateChange: typeof ty.playnet.offBLEStateChange;
97
399
  /**
98
400
  * @public
99
401
  * @since @ray-js/ray 1.6.31
402
+ * @example 基础调用
403
+ * ```tsx
404
+ * import { playnet } from '@ray-js/ray';
405
+ *
406
+ * const { offBlePermissionChange } = playnet;
407
+ *
408
+ * offBlePermissionChange((result) => {
409
+ * console.log('offBlePermissionChange', result);
410
+ * });
411
+ * ```
100
412
  */
101
413
  export declare const offBlePermissionChange: typeof ty.playnet.offBlePermissionChange;
102
414
  /**
103
415
  * @public
104
416
  * @since @ray-js/ray 1.6.31
417
+ * @example 基础调用
418
+ * ```tsx
419
+ * import { playnet } from '@ray-js/ray';
420
+ *
421
+ * const { offDeviceActivateResult } = playnet;
422
+ *
423
+ * offDeviceActivateResult((result) => {
424
+ * console.log('offDeviceActivateResult', result);
425
+ * });
426
+ * ```
105
427
  */
106
428
  export declare const offDeviceActivateResult: typeof ty.playnet.offDeviceActivateResult;
107
429
  /**
108
430
  * @public
109
431
  * @since @ray-js/ray 1.6.31
432
+ * @example 基础调用
433
+ * ```tsx
434
+ * import { playnet } from '@ray-js/ray';
435
+ *
436
+ * const { offReceiveActivatorState } = playnet;
437
+ *
438
+ * offReceiveActivatorState((result) => {
439
+ * console.log('offReceiveActivatorState', result);
440
+ * });
441
+ * ```
110
442
  */
111
443
  export declare const offReceiveActivatorState: typeof ty.playnet.offReceiveActivatorState;
112
444
  /**
113
445
  * @public
114
446
  * @since @ray-js/ray 1.6.31
447
+ * @example 基础调用
448
+ * ```tsx
449
+ * import { playnet } from '@ray-js/ray';
450
+ *
451
+ * const { offScanDeviceInfo } = playnet;
452
+ *
453
+ * offScanDeviceInfo((result) => {
454
+ * console.log('offScanDeviceInfo', result);
455
+ * });
456
+ * ```
115
457
  */
116
458
  export declare const offScanDeviceInfo: typeof ty.playnet.offScanDeviceInfo;
117
459
  /**
118
460
  * @public
119
461
  * @since @ray-js/ray 1.6.31
462
+ * @example 基础调用
463
+ * ```tsx
464
+ * import { playnet } from '@ray-js/ray';
465
+ *
466
+ * const { offWifiStateChange } = playnet;
467
+ *
468
+ * offWifiStateChange((result) => {
469
+ * console.log('offWifiStateChange', result);
470
+ * });
471
+ * ```
120
472
  */
121
473
  export declare const offWifiStateChange: typeof ty.playnet.offWifiStateChange;
122
474
  /**
123
475
  * @public
124
476
  * @since @ray-js/ray 1.6.31
477
+ * @example 基础调用
478
+ * ```tsx
479
+ * import { playnet } from '@ray-js/ray';
480
+ *
481
+ * const { offlocalNetWorkPermissionChange } = playnet;
482
+ *
483
+ * offlocalNetWorkPermissionChange((result) => {
484
+ * console.log('offlocalNetWorkPermissionChange', result);
485
+ * });
486
+ * ```
125
487
  */
126
488
  export declare const offlocalNetWorkPermissionChange: typeof ty.playnet.offlocalNetWorkPermissionChange;
127
489
  /**
128
490
  * @public
129
491
  * @since @ray-js/ray 1.6.31
492
+ * @example 基础调用
493
+ * ```tsx
494
+ * import { playnet } from '@ray-js/ray';
495
+ *
496
+ * const { onActivateIntermediateState } = playnet;
497
+ *
498
+ * onActivateIntermediateState((result) => {
499
+ * console.log('onActivateIntermediateState', result);
500
+ * });
501
+ * ```
130
502
  */
131
503
  export declare const onActivateIntermediateState: typeof ty.playnet.onActivateIntermediateState;
132
504
  /**
133
505
  * @public
134
506
  * @since @ray-js/ray 1.6.31
507
+ * @example 基础调用
508
+ * ```tsx
509
+ * import { playnet } from '@ray-js/ray';
510
+ *
511
+ * const { onBLEScanDevice } = playnet;
512
+ *
513
+ * onBLEScanDevice((result) => {
514
+ * console.log('onBLEScanDevice', result);
515
+ * });
516
+ * ```
135
517
  */
136
518
  export declare const onBLEScanDevice: typeof ty.playnet.onBLEScanDevice;
137
519
  /**
138
520
  * @public
139
521
  * @since @ray-js/ray 1.6.31
522
+ * @example 基础调用
523
+ * ```tsx
524
+ * import { playnet } from '@ray-js/ray';
525
+ *
526
+ * const { onBLEScanDeviceWithUUID } = playnet;
527
+ *
528
+ * onBLEScanDeviceWithUUID((result) => {
529
+ * console.log('onBLEScanDeviceWithUUID', result);
530
+ * });
531
+ * ```
140
532
  */
141
533
  export declare const onBLEScanDeviceWithUUID: typeof ty.playnet.onBLEScanDeviceWithUUID;
142
534
  /**
143
535
  * @public
144
536
  * @since @ray-js/ray 1.6.31
537
+ * @example 基础调用
538
+ * ```tsx
539
+ * import { playnet } from '@ray-js/ray';
540
+ *
541
+ * const { onBLEStateChange } = playnet;
542
+ *
543
+ * onBLEStateChange((result) => {
544
+ * console.log('onBLEStateChange', result);
545
+ * });
546
+ * ```
145
547
  */
146
548
  export declare const onBLEStateChange: typeof ty.playnet.onBLEStateChange;
147
549
  /**
148
550
  * @public
149
551
  * @since @ray-js/ray 1.6.31
552
+ * @example 基础调用
553
+ * ```tsx
554
+ * import { playnet } from '@ray-js/ray';
555
+ *
556
+ * const { onBlePermissionChange } = playnet;
557
+ *
558
+ * onBlePermissionChange((result) => {
559
+ * console.log('onBlePermissionChange', result);
560
+ * });
561
+ * ```
150
562
  */
151
563
  export declare const onBlePermissionChange: typeof ty.playnet.onBlePermissionChange;
152
564
  /**
153
565
  * @public
154
566
  * @since @ray-js/ray 1.6.31
567
+ * @example 基础调用
568
+ * ```tsx
569
+ * import { playnet } from '@ray-js/ray';
570
+ *
571
+ * const { onDeviceActivateResult } = playnet;
572
+ *
573
+ * onDeviceActivateResult((result) => {
574
+ * console.log('onDeviceActivateResult', result);
575
+ * });
576
+ * ```
155
577
  */
156
578
  export declare const onDeviceActivateResult: typeof ty.playnet.onDeviceActivateResult;
157
579
  /**
158
580
  * @public
159
581
  * @since @ray-js/ray 1.6.31
582
+ * @example 基础调用
583
+ * ```tsx
584
+ * import { playnet } from '@ray-js/ray';
585
+ *
586
+ * const { onReceiveActivatorState } = playnet;
587
+ *
588
+ * onReceiveActivatorState((result) => {
589
+ * console.log('onReceiveActivatorState', result);
590
+ * });
591
+ * ```
160
592
  */
161
593
  export declare const onReceiveActivatorState: typeof ty.playnet.onReceiveActivatorState;
162
594
  /**
163
595
  * @public
164
596
  * @since @ray-js/ray 1.6.31
597
+ * @example 基础调用
598
+ * ```tsx
599
+ * import { playnet } from '@ray-js/ray';
600
+ *
601
+ * const { onScanDeviceInfo } = playnet;
602
+ *
603
+ * onScanDeviceInfo((result) => {
604
+ * console.log('onScanDeviceInfo', result);
605
+ * });
606
+ * ```
165
607
  */
166
608
  export declare const onScanDeviceInfo: typeof ty.playnet.onScanDeviceInfo;
167
609
  /**
168
610
  * @public
169
611
  * @since @ray-js/ray 1.6.31
612
+ * @example 基础调用
613
+ * ```tsx
614
+ * import { playnet } from '@ray-js/ray';
615
+ *
616
+ * const { onWifiStateChange } = playnet;
617
+ *
618
+ * onWifiStateChange((result) => {
619
+ * console.log('onWifiStateChange', result);
620
+ * });
621
+ * ```
170
622
  */
171
623
  export declare const onWifiStateChange: typeof ty.playnet.onWifiStateChange;
172
624
  /**
173
625
  * @public
174
626
  * @since @ray-js/ray 1.6.31
627
+ * @example 基础调用
628
+ * ```tsx
629
+ * import { playnet } from '@ray-js/ray';
630
+ *
631
+ * const { onlocalNetWorkPermissionChange } = playnet;
632
+ *
633
+ * onlocalNetWorkPermissionChange((result) => {
634
+ * console.log('onlocalNetWorkPermissionChange', result);
635
+ * });
636
+ * ```
175
637
  */
176
638
  export declare const onlocalNetWorkPermissionChange: typeof ty.playnet.onlocalNetWorkPermissionChange;
177
639
  /**
178
640
  * @public
179
641
  * @since @ray-js/ray 1.6.31
642
+ * @example 基础调用
643
+ * ```tsx
644
+ * import { playnet } from '@ray-js/ray';
645
+ *
646
+ * const { queryDeviceConfigState } = playnet;
647
+ *
648
+ * queryDeviceConfigState({
649
+ * homeId: 0,
650
+ * pairType: 'AP',
651
+ * bleWifiPairParams: {
652
+ * id: 'example',
653
+ * name: 'example',
654
+ * providerName: 'example',
655
+ * data: 'example',
656
+ * configType: 'example',
657
+ * productId: 'example',
658
+ * uuid: 'example',
659
+ * mac: 'AA:BB:CC:DD:EE:FF',
660
+ * address: 'example',
661
+ * deviceType: 0,
662
+ * isbind: false,
663
+ * flag: 0,
664
+ * isShare: false,
665
+ * rssi: 0,
666
+ * pidHexString: 'example',
667
+ * },
668
+ * success: (result) => {
669
+ * console.log('queryDeviceConfigState success', result);
670
+ * },
671
+ * fail: (error) => {
672
+ * console.log('queryDeviceConfigState fail', error.errorMsg);
673
+ * },
674
+ * });
675
+ * ```
180
676
  */
181
677
  export declare const queryDeviceConfigState: typeof ty.playnet.queryDeviceConfigState;
182
678
  /**
183
679
  * @public
184
680
  * @since @ray-js/ray 1.6.31
681
+ * @example 基础调用
682
+ * ```tsx
683
+ * import { playnet } from '@ray-js/ray';
684
+ *
685
+ * const { queryWifiListByNormalChannel } = playnet;
686
+ *
687
+ * queryWifiListByNormalChannel({
688
+ * timeout: 30,
689
+ * size: 10,
690
+ * pairType: 'AP',
691
+ * uuid: 'example',
692
+ * success: (result) => {
693
+ * console.log('queryWifiListByNormalChannel success', result);
694
+ * },
695
+ * fail: (error) => {
696
+ * console.log('queryWifiListByNormalChannel fail', error.errorMsg);
697
+ * },
698
+ * });
699
+ * ```
185
700
  */
186
701
  export declare const queryWifiListByNormalChannel: typeof ty.playnet.queryWifiListByNormalChannel;
187
702
  /**
188
703
  * @public
189
704
  * @since @ray-js/ray 1.6.31
705
+ * @example 基础调用
706
+ * ```tsx
707
+ * import { playnet } from '@ray-js/ray';
708
+ *
709
+ * const { releaseP2PWifi } = playnet;
710
+ *
711
+ * releaseP2PWifi({
712
+ * success: () => {
713
+ * console.log('releaseP2PWifi success');
714
+ * },
715
+ * fail: (error) => {
716
+ * console.log('releaseP2PWifi fail', error.errorMsg);
717
+ * },
718
+ * });
719
+ * ```
190
720
  */
191
721
  export declare const releaseP2PWifi: typeof ty.playnet.releaseP2PWifi;
192
722
  /**
193
723
  * @public
194
724
  * @since @ray-js/ray 1.6.31
725
+ * @example 基础调用
726
+ * ```tsx
727
+ * import { playnet } from '@ray-js/ray';
728
+ *
729
+ * const { removeApConfigration } = playnet;
730
+ *
731
+ * removeApConfigration({
732
+ * ssidPrefix: 'SmartLife-',
733
+ * ssid: 'SmartLife-XXXX',
734
+ * pwd: '',
735
+ * success: () => {
736
+ * console.log('removeApConfigration success');
737
+ * },
738
+ * fail: (error) => {
739
+ * console.log('removeApConfigration fail', error.errorMsg);
740
+ * },
741
+ * });
742
+ * ```
195
743
  */
196
744
  export declare const removeApConfigration: typeof ty.playnet.removeApConfigration;
197
745
  /**
198
746
  * @public
199
747
  * @since @ray-js/ray 1.6.31
748
+ * @example 基础调用
749
+ * ```tsx
750
+ * import { playnet } from '@ray-js/ray';
751
+ *
752
+ * const { requestPermission } = playnet;
753
+ *
754
+ * requestPermission({
755
+ * permission: 'WIFI',
756
+ * success: () => {
757
+ * console.log('requestPermission success');
758
+ * },
759
+ * fail: (error) => {
760
+ * console.log('requestPermission fail', error.errorMsg);
761
+ * },
762
+ * });
763
+ * ```
200
764
  */
201
765
  export declare const requestPermission: typeof ty.playnet.requestPermission;
202
766
  /**
203
767
  * @public
204
768
  * @since @ray-js/ray 1.6.31
769
+ * @example 基础调用
770
+ * ```tsx
771
+ * import { playnet } from '@ray-js/ray';
772
+ *
773
+ * const { requestWifiList } = playnet;
774
+ *
775
+ * requestWifiList({
776
+ * success: (result) => {
777
+ * console.log('requestWifiList success', result);
778
+ * },
779
+ * fail: (error) => {
780
+ * console.log('requestWifiList fail', error.errorMsg);
781
+ * },
782
+ * });
783
+ * ```
205
784
  */
206
785
  export declare const requestWifiList: typeof ty.playnet.requestWifiList;
207
786
  /**
208
787
  * @public
209
788
  * @since @ray-js/ray 1.6.31
789
+ * @example 基础调用
790
+ * ```tsx
791
+ * import { playnet } from '@ray-js/ray';
792
+ *
793
+ * const { resetDevice } = playnet;
794
+ *
795
+ * resetDevice({
796
+ * uuid: 'example',
797
+ * pairType: 'WIFI_BLE',
798
+ * success: (result) => {
799
+ * console.log('resetDevice success', result);
800
+ * },
801
+ * fail: (error) => {
802
+ * console.log('resetDevice fail', error.errorMsg);
803
+ * },
804
+ * });
805
+ * ```
210
806
  */
211
807
  export declare const resetDevice: typeof ty.playnet.resetDevice;
212
808
  /**
213
809
  * @public
214
810
  * @since @ray-js/ray 1.6.31
811
+ * @example 基础调用
812
+ * ```tsx
813
+ * import { playnet } from '@ray-js/ray';
814
+ *
815
+ * const { resetDeviceActivatedStatus } = playnet;
816
+ *
817
+ * resetDeviceActivatedStatus({
818
+ * tokens: ['example_token'],
819
+ * scanDeviceBeans: [],
820
+ * success: () => {
821
+ * console.log('resetDeviceActivatedStatus success');
822
+ * },
823
+ * fail: (error) => {
824
+ * console.log('resetDeviceActivatedStatus fail', error.errorMsg);
825
+ * },
826
+ * });
827
+ * ```
215
828
  */
216
829
  export declare const resetDeviceActivatedStatus: typeof ty.playnet.resetDeviceActivatedStatus;
217
830
  /**
218
831
  * @public
219
832
  * @since @ray-js/ray 1.6.31
833
+ * @example 基础调用
834
+ * ```tsx
835
+ * import { playnet } from '@ray-js/ray';
836
+ *
837
+ * const { resumeActive } = playnet;
838
+ *
839
+ * resumeActive({
840
+ * success: () => {
841
+ * console.log('resumeActive success');
842
+ * },
843
+ * fail: (error) => {
844
+ * console.log('resumeActive fail', error.errorMsg);
845
+ * },
846
+ * });
847
+ * ```
220
848
  */
221
849
  export declare const resumeActive: typeof ty.playnet.resumeActive;
222
850
  /**
223
851
  * @public
224
852
  * @since @ray-js/ray 1.6.31
853
+ * @example 基础调用
854
+ * ```tsx
855
+ * import { playnet } from '@ray-js/ray';
856
+ *
857
+ * const { startActivator } = playnet;
858
+ *
859
+ * startActivator({
860
+ * pairType: 'AP',
861
+ * apActivatorParams: {
862
+ * ssid: 'MyWifi',
863
+ * pwd: 'password',
864
+ * token: 'example_token',
865
+ * timeout: 100,
866
+ * isRecovery: false,
867
+ * securityConfig: 'example',
868
+ * },
869
+ * bleWifiActivatorParams: {
870
+ * uuid: 'example',
871
+ * ssid: 'MyWifi',
872
+ * pwd: 'password',
873
+ * token: 'example_token',
874
+ * timeout: 100,
875
+ * isRecovery: false,
876
+ * phase1Timeout: 60000,
877
+ * },
878
+ * success: (result) => {
879
+ * console.log('startActivator success', result);
880
+ * },
881
+ * fail: (error) => {
882
+ * console.log('startActivator fail', error.errorMsg);
883
+ * },
884
+ * });
885
+ * ```
225
886
  */
226
887
  export declare const startActivator: typeof ty.playnet.startActivator;
227
888
  /**
228
889
  * @public
229
890
  * @since @ray-js/ray 1.6.31
891
+ * @example 基础调用
892
+ * ```tsx
893
+ * import { playnet } from '@ray-js/ray';
894
+ *
895
+ * const { startActivatorNormal } = playnet;
896
+ *
897
+ * startActivatorNormal({
898
+ * pairType: 'AP',
899
+ * apParams: {
900
+ * homeId: 0,
901
+ * ssid: 'MyWifi',
902
+ * pwd: 'password',
903
+ * token: 'example_token',
904
+ * timeout: 100,
905
+ * isRecovery: false,
906
+ * securityConfig: 'example',
907
+ * },
908
+ * bleWifiParams: {
909
+ * homeId: 0,
910
+ * uuid: 'example',
911
+ * ssid: 'MyWifi',
912
+ * pwd: 'password',
913
+ * token: 'example_token',
914
+ * timeout: 100,
915
+ * isRecovery: false,
916
+ * phase1Timeout: 60000,
917
+ * bleWifiPacket: {
918
+ * id: 'example',
919
+ * name: 'example',
920
+ * providerName: 'example',
921
+ * data: 'example',
922
+ * configType: 'example',
923
+ * productId: 'example',
924
+ * uuid: 'example',
925
+ * mac: 'AA:BB:CC:DD:EE:FF',
926
+ * address: 'example',
927
+ * deviceType: 0,
928
+ * isbind: false,
929
+ * flag: 0,
930
+ * isShare: false,
931
+ * rssi: 0,
932
+ * pidHexString: 'example',
933
+ * },
934
+ * },
935
+ * success: (result) => {
936
+ * console.log('startActivatorNormal success', result);
937
+ * },
938
+ * fail: (error) => {
939
+ * console.log('startActivatorNormal fail', error.errorMsg);
940
+ * },
941
+ * });
942
+ * ```
230
943
  */
231
944
  export declare const startActivatorNormal: typeof ty.playnet.startActivatorNormal;
232
945
  /**
233
946
  * @public
234
947
  * @since @ray-js/ray 1.6.31
948
+ * @example 基础调用
949
+ * ```tsx
950
+ * import { playnet } from '@ray-js/ray';
951
+ *
952
+ * const { startBLEScanDevice } = playnet;
953
+ *
954
+ * startBLEScanDevice({
955
+ * timeout: 30,
956
+ * scanType: 'NORMAL',
957
+ * success: () => {
958
+ * console.log('startBLEScanDevice success');
959
+ * },
960
+ * fail: (error) => {
961
+ * console.log('startBLEScanDevice fail', error.errorMsg);
962
+ * },
963
+ * });
964
+ * ```
235
965
  */
236
966
  export declare const startBLEScanDevice: typeof ty.playnet.startBLEScanDevice;
237
967
  /**
238
968
  * @public
239
969
  * @since @ray-js/ray 1.6.31
970
+ * @example 基础调用
971
+ * ```tsx
972
+ * import { playnet } from '@ray-js/ray';
973
+ *
974
+ * const { startBLEScanDeviceWithUUID } = playnet;
975
+ *
976
+ * startBLEScanDeviceWithUUID({
977
+ * scanType: 'NORMAL',
978
+ * uuid: 'example',
979
+ * success: () => {
980
+ * console.log('startBLEScanDeviceWithUUID success');
981
+ * },
982
+ * fail: (error) => {
983
+ * console.log('startBLEScanDeviceWithUUID fail', error.errorMsg);
984
+ * },
985
+ * });
986
+ * ```
240
987
  */
241
988
  export declare const startBLEScanDeviceWithUUID: typeof ty.playnet.startBLEScanDeviceWithUUID;
242
989
  /**
243
990
  * @public
244
991
  * @since @ray-js/ray 1.6.31
992
+ * @example 基础调用
993
+ * ```tsx
994
+ * import { playnet } from '@ray-js/ray';
995
+ *
996
+ * const { startDeviceActivate } = playnet;
997
+ *
998
+ * startDeviceActivate({
999
+ * activeModel: 'EZ',
1000
+ * relationId: 0,
1001
+ * spaceId: 0,
1002
+ * success: () => {
1003
+ * console.log('startDeviceActivate success');
1004
+ * },
1005
+ * fail: (error) => {
1006
+ * console.log('startDeviceActivate fail', error.errorMsg);
1007
+ * },
1008
+ * });
1009
+ * ```
245
1010
  */
246
1011
  export declare const startDeviceActivate: typeof ty.playnet.startDeviceActivate;
247
1012
  /**
248
1013
  * @public
249
1014
  * @since @ray-js/ray 1.6.31
1015
+ * @example 基础调用
1016
+ * ```tsx
1017
+ * import { playnet } from '@ray-js/ray';
1018
+ *
1019
+ * const { startResetBleWifiDevice } = playnet;
1020
+ *
1021
+ * startResetBleWifiDevice({
1022
+ * packet: {
1023
+ * id: 'example',
1024
+ * name: 'example',
1025
+ * providerName: 'example',
1026
+ * data: 'example',
1027
+ * configType: 'example',
1028
+ * productId: 'example',
1029
+ * uuid: 'example',
1030
+ * mac: 'AA:BB:CC:DD:EE:FF',
1031
+ * address: 'example',
1032
+ * deviceType: 0,
1033
+ * isbind: false,
1034
+ * flag: 0,
1035
+ * isShare: false,
1036
+ * rssi: 0,
1037
+ * pidHexString: 'example',
1038
+ * },
1039
+ * encryptedAuthKey: 'example',
1040
+ * random: 'example',
1041
+ * success: (result) => {
1042
+ * console.log('startResetBleWifiDevice success', result);
1043
+ * },
1044
+ * fail: (error) => {
1045
+ * console.log('startResetBleWifiDevice fail', error.errorMsg);
1046
+ * },
1047
+ * });
1048
+ * ```
250
1049
  */
251
1050
  export declare const startResetBleWifiDevice: typeof ty.playnet.startResetBleWifiDevice;
252
1051
  /**
253
1052
  * @public
254
1053
  * @since @ray-js/ray 1.6.31
1054
+ * @example 基础调用
1055
+ * ```tsx
1056
+ * import { playnet } from '@ray-js/ray';
1057
+ *
1058
+ * const { startScanDevice } = playnet;
1059
+ *
1060
+ * startScanDevice({
1061
+ * scanType: ['EZ', 'AP'],
1062
+ * spaceId: 0,
1063
+ * success: () => {
1064
+ * console.log('startScanDevice success');
1065
+ * },
1066
+ * fail: (error) => {
1067
+ * console.log('startScanDevice fail', error.errorMsg);
1068
+ * },
1069
+ * });
1070
+ * ```
255
1071
  */
256
1072
  export declare const startScanDevice: typeof ty.playnet.startScanDevice;
257
1073
  /**
258
1074
  * @public
259
1075
  * @since @ray-js/ray 1.6.31
1076
+ * @example 基础调用
1077
+ * ```tsx
1078
+ * import { playnet } from '@ray-js/ray';
1079
+ *
1080
+ * const { startScanWifi } = playnet;
1081
+ *
1082
+ * startScanWifi({
1083
+ * success: (result) => {
1084
+ * console.log('startScanWifi success', result);
1085
+ * },
1086
+ * fail: (error) => {
1087
+ * console.log('startScanWifi fail', error.errorMsg);
1088
+ * },
1089
+ * });
1090
+ * ```
260
1091
  */
261
1092
  export declare const startScanWifi: typeof ty.playnet.startScanWifi;
262
1093
  /**
263
1094
  * @public
264
1095
  * @since @ray-js/ray 1.6.31
1096
+ * @example 基础调用
1097
+ * ```tsx
1098
+ * import { playnet } from '@ray-js/ray';
1099
+ *
1100
+ * const { stopActivator } = playnet;
1101
+ *
1102
+ * stopActivator({
1103
+ * uuid: 'example',
1104
+ * pairType: 'WIFI_BLE',
1105
+ * success: () => {
1106
+ * console.log('stopActivator success');
1107
+ * },
1108
+ * fail: (error) => {
1109
+ * console.log('stopActivator fail', error.errorMsg);
1110
+ * },
1111
+ * });
1112
+ * ```
265
1113
  */
266
1114
  export declare const stopActivator: typeof ty.playnet.stopActivator;
267
1115
  /**
268
1116
  * @public
269
1117
  * @since @ray-js/ray 1.6.31
1118
+ * @example 基础调用
1119
+ * ```tsx
1120
+ * import { playnet } from '@ray-js/ray';
1121
+ *
1122
+ * const { stopActivatorNormal } = playnet;
1123
+ *
1124
+ * stopActivatorNormal({
1125
+ * uuid: 'example',
1126
+ * pairType: 'WIFI_BLE',
1127
+ * success: () => {
1128
+ * console.log('stopActivatorNormal success');
1129
+ * },
1130
+ * fail: (error) => {
1131
+ * console.log('stopActivatorNormal fail', error.errorMsg);
1132
+ * },
1133
+ * });
1134
+ * ```
270
1135
  */
271
1136
  export declare const stopActivatorNormal: typeof ty.playnet.stopActivatorNormal;
272
1137
  /**
273
1138
  * @public
274
1139
  * @since @ray-js/ray 1.6.31
1140
+ * @example 基础调用
1141
+ * ```tsx
1142
+ * import { playnet } from '@ray-js/ray';
1143
+ *
1144
+ * const { stopBLEScan } = playnet;
1145
+ *
1146
+ * stopBLEScan({
1147
+ * success: () => {
1148
+ * console.log('stopBLEScan success');
1149
+ * },
1150
+ * fail: (error) => {
1151
+ * console.log('stopBLEScan fail', error.errorMsg);
1152
+ * },
1153
+ * });
1154
+ * ```
275
1155
  */
276
1156
  export declare const stopBLEScan: typeof ty.playnet.stopBLEScan;
277
1157
  /**
278
1158
  * @public
279
1159
  * @since @ray-js/ray 1.6.31
1160
+ * @example 基础调用
1161
+ * ```tsx
1162
+ * import { playnet } from '@ray-js/ray';
1163
+ *
1164
+ * const { stopBleScanWithUUID } = playnet;
1165
+ *
1166
+ * stopBleScanWithUUID({
1167
+ * success: () => {
1168
+ * console.log('stopBleScanWithUUID success');
1169
+ * },
1170
+ * fail: (error) => {
1171
+ * console.log('stopBleScanWithUUID fail', error.errorMsg);
1172
+ * },
1173
+ * });
1174
+ * ```
280
1175
  */
281
1176
  export declare const stopBleScanWithUUID: typeof ty.playnet.stopBleScanWithUUID;
282
1177
  /**
283
1178
  * @public
284
1179
  * @since @ray-js/ray 1.6.31
1180
+ * @example 基础调用
1181
+ * ```tsx
1182
+ * import { playnet } from '@ray-js/ray';
1183
+ *
1184
+ * const { stopDeviceActivate } = playnet;
1185
+ *
1186
+ * stopDeviceActivate({
1187
+ * activeModel: 'EZ',
1188
+ * relationId: 0,
1189
+ * spaceId: 0,
1190
+ * success: () => {
1191
+ * console.log('stopDeviceActivate success');
1192
+ * },
1193
+ * fail: (error) => {
1194
+ * console.log('stopDeviceActivate fail', error.errorMsg);
1195
+ * },
1196
+ * });
1197
+ * ```
285
1198
  */
286
1199
  export declare const stopDeviceActivate: typeof ty.playnet.stopDeviceActivate;
287
1200
  /**
288
1201
  * @public
289
1202
  * @since @ray-js/ray 1.6.31
1203
+ * @example 基础调用
1204
+ * ```tsx
1205
+ * import { playnet } from '@ray-js/ray';
1206
+ *
1207
+ * const { stopScanDevice } = playnet;
1208
+ *
1209
+ * stopScanDevice({
1210
+ * scanType: ['EZ', 'AP'],
1211
+ * spaceId: 0,
1212
+ * success: () => {
1213
+ * console.log('stopScanDevice success');
1214
+ * },
1215
+ * fail: (error) => {
1216
+ * console.log('stopScanDevice fail', error.errorMsg);
1217
+ * },
1218
+ * });
1219
+ * ```
290
1220
  */
291
1221
  export declare const stopScanDevice: typeof ty.playnet.stopScanDevice;