@ray-js/api 1.7.78 → 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 +15 -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
@@ -6,6 +6,21 @@ const factory = createFactory('HealthKit');
6
6
  /**
7
7
  * @public
8
8
  * @since @ray-js/ray 1.6.17
9
+ * @example 基础调用
10
+ * ```tsx
11
+ * import { health } from '@ray-js/ray';
12
+ *
13
+ * const { getHealthConnectStatus } = health;
14
+ *
15
+ * getHealthConnectStatus({
16
+ * success: (status) => {
17
+ * console.log('Health Connect status:', status);
18
+ * },
19
+ * fail: (error) => {
20
+ * console.log('getHealthConnectStatus fail', error.errorMsg);
21
+ * },
22
+ * });
23
+ * ```
9
24
  */
10
25
  export const getHealthConnectStatus = factory('getHealthConnectStatus', {
11
26
  namespace: 'health'
@@ -13,6 +28,15 @@ export const getHealthConnectStatus = factory('getHealthConnectStatus', {
13
28
  /**
14
29
  * @public
15
30
  * @since @ray-js/ray 1.6.17
31
+ * @example 基础调用
32
+ * ```tsx
33
+ * import { health } from '@ray-js/ray';
34
+ *
35
+ * const { getHealthConnectStatusSync } = health;
36
+ *
37
+ * const result = getHealthConnectStatusSync();
38
+ * console.log('Health Connect status:', result);
39
+ * ```
16
40
  */
17
41
  export const getHealthConnectStatusSync = factory('getHealthConnectStatusSync', {
18
42
  namespace: 'health'
@@ -20,6 +44,23 @@ export const getHealthConnectStatusSync = factory('getHealthConnectStatusSync',
20
44
  /**
21
45
  * @public
22
46
  * @since @ray-js/ray 1.6.17
47
+ * @example 基础调用
48
+ * ```tsx
49
+ * import { health } from '@ray-js/ray';
50
+ *
51
+ * const { insertRecords } = health;
52
+ *
53
+ * const records = JSON.stringify([{ type: 'steps', value: 1000 }]);
54
+ * insertRecords({
55
+ * request: records,
56
+ * success: (result) => {
57
+ * console.log('insertRecords success', result);
58
+ * },
59
+ * fail: (error) => {
60
+ * console.log('insertRecords fail', error.errorMsg);
61
+ * },
62
+ * });
63
+ * ```
23
64
  */
24
65
  export const insertRecords = factory('insertRecords', {
25
66
  namespace: 'health'
@@ -27,6 +68,16 @@ export const insertRecords = factory('insertRecords', {
27
68
  /**
28
69
  * @public
29
70
  * @since @ray-js/ray 1.6.17
71
+ * @example 基础调用
72
+ * ```tsx
73
+ * import { health } from '@ray-js/ray';
74
+ *
75
+ * const { insertRecordsSync } = health;
76
+ *
77
+ * const records = JSON.stringify([{ type: 'steps', value: 1000 }]);
78
+ * const result = insertRecordsSync({ request: records });
79
+ * console.log('insertRecordsSync result', result);
80
+ * ```
30
81
  */
31
82
  export const insertRecordsSync = factory('insertRecordsSync', {
32
83
  namespace: 'health'
@@ -34,6 +85,23 @@ export const insertRecordsSync = factory('insertRecordsSync', {
34
85
  /**
35
86
  * @public
36
87
  * @since @ray-js/ray 1.6.17
88
+ * @example 基础调用
89
+ * ```tsx
90
+ * import { health } from '@ray-js/ray';
91
+ *
92
+ * const { authStatusPermissions } = health;
93
+ *
94
+ * authStatusPermissions({
95
+ * readPermissions: ['1', '2'],
96
+ * writePermissions: ['1', '2'],
97
+ * success: (result) => {
98
+ * console.log('authStatusPermissions value:', result.value);
99
+ * },
100
+ * fail: (error) => {
101
+ * console.log('authStatusPermissions fail', error.errorMsg);
102
+ * },
103
+ * });
104
+ * ```
37
105
  */
38
106
  export const authStatusPermissions = factory('authStatusPermissions', {
39
107
  namespace: 'health'
@@ -41,6 +109,18 @@ export const authStatusPermissions = factory('authStatusPermissions', {
41
109
  /**
42
110
  * @public
43
111
  * @since @ray-js/ray 1.6.17
112
+ * @example 基础调用
113
+ * ```tsx
114
+ * import { health } from '@ray-js/ray';
115
+ *
116
+ * const { authStatusPermissionsSync } = health;
117
+ *
118
+ * const result = authStatusPermissionsSync({
119
+ * readPermissions: ['1', '2'],
120
+ * writePermissions: ['1', '2'],
121
+ * });
122
+ * console.log('authStatusPermissionsSync value:', result.value);
123
+ * ```
44
124
  */
45
125
  export const authStatusPermissionsSync = factory('authStatusPermissionsSync', {
46
126
  namespace: 'health'
@@ -48,6 +128,22 @@ export const authStatusPermissionsSync = factory('authStatusPermissionsSync', {
48
128
  /**
49
129
  * @public
50
130
  * @since @ray-js/ray 1.6.17
131
+ * @example 基础调用
132
+ * ```tsx
133
+ * import { health } from '@ray-js/ray';
134
+ *
135
+ * const { getSaveQuantityPermission } = health;
136
+ *
137
+ * getSaveQuantityPermission({
138
+ * writePermission: 1,
139
+ * success: (result) => {
140
+ * console.log('getSaveQuantityPermission value:', result.value);
141
+ * },
142
+ * fail: (error) => {
143
+ * console.log('getSaveQuantityPermission fail', error.errorMsg);
144
+ * },
145
+ * });
146
+ * ```
51
147
  */
52
148
  export const getSaveQuantityPermission = factory('getSaveQuantityPermission', {
53
149
  namespace: 'health'
@@ -55,6 +151,17 @@ export const getSaveQuantityPermission = factory('getSaveQuantityPermission', {
55
151
  /**
56
152
  * @public
57
153
  * @since @ray-js/ray 1.6.17
154
+ * @example 基础调用
155
+ * ```tsx
156
+ * import { health } from '@ray-js/ray';
157
+ *
158
+ * const { getSaveQuantityPermissionSync } = health;
159
+ *
160
+ * const result = getSaveQuantityPermissionSync({
161
+ * writePermission: 1,
162
+ * });
163
+ * console.log('getSaveQuantityPermissionSync value:', result.value);
164
+ * ```
58
165
  */
59
166
  export const getSaveQuantityPermissionSync = factory('getSaveQuantityPermissionSync', {
60
167
  namespace: 'health'
@@ -62,6 +169,22 @@ export const getSaveQuantityPermissionSync = factory('getSaveQuantityPermissionS
62
169
  /**
63
170
  * @public
64
171
  * @since @ray-js/ray 1.6.17
172
+ * @example 基础调用
173
+ * ```tsx
174
+ * import { health } from '@ray-js/ray';
175
+ *
176
+ * const { authQuantityWritePermissions } = health;
177
+ *
178
+ * authQuantityWritePermissions({
179
+ * permissions: ['1', '2'],
180
+ * success: () => {
181
+ * console.log('authQuantityWritePermissions success');
182
+ * },
183
+ * fail: (error) => {
184
+ * console.log('authQuantityWritePermissions fail', error.errorMsg);
185
+ * },
186
+ * });
187
+ * ```
65
188
  */
66
189
  export const authQuantityWritePermissions = factory('authQuantityWritePermissions', {
67
190
  namespace: 'health'
@@ -69,6 +192,16 @@ export const authQuantityWritePermissions = factory('authQuantityWritePermission
69
192
  /**
70
193
  * @public
71
194
  * @since @ray-js/ray 1.6.17
195
+ * @example 基础调用
196
+ * ```tsx
197
+ * import { health } from '@ray-js/ray';
198
+ *
199
+ * const { authQuantityWritePermissionsSync } = health;
200
+ *
201
+ * authQuantityWritePermissionsSync({
202
+ * permissions: ['1', '2'],
203
+ * });
204
+ * ```
72
205
  */
73
206
  export const authQuantityWritePermissionsSync = factory('authQuantityWritePermissionsSync', {
74
207
  namespace: 'health'
@@ -76,6 +209,22 @@ export const authQuantityWritePermissionsSync = factory('authQuantityWritePermis
76
209
  /**
77
210
  * @public
78
211
  * @since @ray-js/ray 1.6.17
212
+ * @example 基础调用
213
+ * ```tsx
214
+ * import { health } from '@ray-js/ray';
215
+ *
216
+ * const { authCategoryWritePermissions } = health;
217
+ *
218
+ * authCategoryWritePermissions({
219
+ * permissions: ['1', '2'],
220
+ * success: () => {
221
+ * console.log('authCategoryWritePermissions success');
222
+ * },
223
+ * fail: (error) => {
224
+ * console.log('authCategoryWritePermissions fail', error.errorMsg);
225
+ * },
226
+ * });
227
+ * ```
79
228
  */
80
229
  export const authCategoryWritePermissions = factory('authCategoryWritePermissions', {
81
230
  namespace: 'health'
@@ -83,6 +232,16 @@ export const authCategoryWritePermissions = factory('authCategoryWritePermission
83
232
  /**
84
233
  * @public
85
234
  * @since @ray-js/ray 1.6.17
235
+ * @example 基础调用
236
+ * ```tsx
237
+ * import { health } from '@ray-js/ray';
238
+ *
239
+ * const { authCategoryWritePermissionsSync } = health;
240
+ *
241
+ * authCategoryWritePermissionsSync({
242
+ * permissions: ['1', '2'],
243
+ * });
244
+ * ```
86
245
  */
87
246
  export const authCategoryWritePermissionsSync = factory('authCategoryWritePermissionsSync', {
88
247
  namespace: 'health'
@@ -90,6 +249,22 @@ export const authCategoryWritePermissionsSync = factory('authCategoryWritePermis
90
249
  /**
91
250
  * @public
92
251
  * @since @ray-js/ray 1.6.17
252
+ * @example 基础调用
253
+ * ```tsx
254
+ * import { health } from '@ray-js/ray';
255
+ *
256
+ * const { authQuantityReadPermissions } = health;
257
+ *
258
+ * authQuantityReadPermissions({
259
+ * permissions: ['1', '2'],
260
+ * success: () => {
261
+ * console.log('authQuantityReadPermissions success');
262
+ * },
263
+ * fail: (error) => {
264
+ * console.log('authQuantityReadPermissions fail', error.errorMsg);
265
+ * },
266
+ * });
267
+ * ```
93
268
  */
94
269
  export const authQuantityReadPermissions = factory('authQuantityReadPermissions', {
95
270
  namespace: 'health'
@@ -97,6 +272,16 @@ export const authQuantityReadPermissions = factory('authQuantityReadPermissions'
97
272
  /**
98
273
  * @public
99
274
  * @since @ray-js/ray 1.6.17
275
+ * @example 基础调用
276
+ * ```tsx
277
+ * import { health } from '@ray-js/ray';
278
+ *
279
+ * const { authQuantityReadPermissionsSync } = health;
280
+ *
281
+ * authQuantityReadPermissionsSync({
282
+ * permissions: ['1', '2'],
283
+ * });
284
+ * ```
100
285
  */
101
286
  export const authQuantityReadPermissionsSync = factory('authQuantityReadPermissionsSync', {
102
287
  namespace: 'health'
@@ -104,6 +289,22 @@ export const authQuantityReadPermissionsSync = factory('authQuantityReadPermissi
104
289
  /**
105
290
  * @public
106
291
  * @since @ray-js/ray 1.6.17
292
+ * @example 基础调用
293
+ * ```tsx
294
+ * import { health } from '@ray-js/ray';
295
+ *
296
+ * const { authCategoryReadPermissions } = health;
297
+ *
298
+ * authCategoryReadPermissions({
299
+ * permissions: ['1', '2'],
300
+ * success: () => {
301
+ * console.log('authCategoryReadPermissions success');
302
+ * },
303
+ * fail: (error) => {
304
+ * console.log('authCategoryReadPermissions fail', error.errorMsg);
305
+ * },
306
+ * });
307
+ * ```
107
308
  */
108
309
  export const authCategoryReadPermissions = factory('authCategoryReadPermissions', {
109
310
  namespace: 'health'
@@ -111,6 +312,16 @@ export const authCategoryReadPermissions = factory('authCategoryReadPermissions'
111
312
  /**
112
313
  * @public
113
314
  * @since @ray-js/ray 1.6.17
315
+ * @example 基础调用
316
+ * ```tsx
317
+ * import { health } from '@ray-js/ray';
318
+ *
319
+ * const { authCategoryReadPermissionsSync } = health;
320
+ *
321
+ * authCategoryReadPermissionsSync({
322
+ * permissions: ['1', '2'],
323
+ * });
324
+ * ```
114
325
  */
115
326
  export const authCategoryReadPermissionsSync = factory('authCategoryReadPermissionsSync', {
116
327
  namespace: 'health'
@@ -118,6 +329,22 @@ export const authCategoryReadPermissionsSync = factory('authCategoryReadPermissi
118
329
  /**
119
330
  * @public
120
331
  * @since @ray-js/ray 1.6.17
332
+ * @example 基础调用
333
+ * ```tsx
334
+ * import { health } from '@ray-js/ray';
335
+ *
336
+ * const { authCharacteristicReadPermissions } = health;
337
+ *
338
+ * authCharacteristicReadPermissions({
339
+ * permissions: ['1', '2'],
340
+ * success: () => {
341
+ * console.log('authCharacteristicReadPermissions success');
342
+ * },
343
+ * fail: (error) => {
344
+ * console.log('authCharacteristicReadPermissions fail', error.errorMsg);
345
+ * },
346
+ * });
347
+ * ```
121
348
  */
122
349
  export const authCharacteristicReadPermissions = factory('authCharacteristicReadPermissions', {
123
350
  namespace: 'health'
@@ -125,6 +352,16 @@ export const authCharacteristicReadPermissions = factory('authCharacteristicRead
125
352
  /**
126
353
  * @public
127
354
  * @since @ray-js/ray 1.6.17
355
+ * @example 基础调用
356
+ * ```tsx
357
+ * import { health } from '@ray-js/ray';
358
+ *
359
+ * const { authCharacteristicReadPermissionsSync } = health;
360
+ *
361
+ * authCharacteristicReadPermissionsSync({
362
+ * permissions: ['1', '2'],
363
+ * });
364
+ * ```
128
365
  */
129
366
  export const authCharacteristicReadPermissionsSync = factory('authCharacteristicReadPermissionsSync', {
130
367
  namespace: 'health'
@@ -132,6 +369,22 @@ export const authCharacteristicReadPermissionsSync = factory('authCharacteristic
132
369
  /**
133
370
  * @public
134
371
  * @since @ray-js/ray 1.6.17
372
+ * @example 基础调用
373
+ * ```tsx
374
+ * import { health } from '@ray-js/ray';
375
+ *
376
+ * const { authQuantityRWPermissions } = health;
377
+ *
378
+ * authQuantityRWPermissions({
379
+ * permissions: ['1', '2'],
380
+ * success: () => {
381
+ * console.log('authQuantityRWPermissions success');
382
+ * },
383
+ * fail: (error) => {
384
+ * console.log('authQuantityRWPermissions fail', error.errorMsg);
385
+ * },
386
+ * });
387
+ * ```
135
388
  */
136
389
  export const authQuantityRWPermissions = factory('authQuantityRWPermissions', {
137
390
  namespace: 'health'
@@ -139,6 +392,16 @@ export const authQuantityRWPermissions = factory('authQuantityRWPermissions', {
139
392
  /**
140
393
  * @public
141
394
  * @since @ray-js/ray 1.6.17
395
+ * @example 基础调用
396
+ * ```tsx
397
+ * import { health } from '@ray-js/ray';
398
+ *
399
+ * const { authQuantityRWPermissionsSync } = health;
400
+ *
401
+ * authQuantityRWPermissionsSync({
402
+ * permissions: ['1', '2'],
403
+ * });
404
+ * ```
142
405
  */
143
406
  export const authQuantityRWPermissionsSync = factory('authQuantityRWPermissionsSync', {
144
407
  namespace: 'health'
@@ -146,6 +409,22 @@ export const authQuantityRWPermissionsSync = factory('authQuantityRWPermissionsS
146
409
  /**
147
410
  * @public
148
411
  * @since @ray-js/ray 1.6.17
412
+ * @example 基础调用
413
+ * ```tsx
414
+ * import { health } from '@ray-js/ray';
415
+ *
416
+ * const { authCategoryRWPermissions } = health;
417
+ *
418
+ * authCategoryRWPermissions({
419
+ * permissions: ['1', '2'],
420
+ * success: () => {
421
+ * console.log('authCategoryRWPermissions success');
422
+ * },
423
+ * fail: (error) => {
424
+ * console.log('authCategoryRWPermissions fail', error.errorMsg);
425
+ * },
426
+ * });
427
+ * ```
149
428
  */
150
429
  export const authCategoryRWPermissions = factory('authCategoryRWPermissions', {
151
430
  namespace: 'health'
@@ -153,6 +432,16 @@ export const authCategoryRWPermissions = factory('authCategoryRWPermissions', {
153
432
  /**
154
433
  * @public
155
434
  * @since @ray-js/ray 1.6.17
435
+ * @example 基础调用
436
+ * ```tsx
437
+ * import { health } from '@ray-js/ray';
438
+ *
439
+ * const { authCategoryRWPermissionsSync } = health;
440
+ *
441
+ * authCategoryRWPermissionsSync({
442
+ * permissions: ['1', '2'],
443
+ * });
444
+ * ```
156
445
  */
157
446
  export const authCategoryRWPermissionsSync = factory('authCategoryRWPermissionsSync', {
158
447
  namespace: 'health'
@@ -160,6 +449,26 @@ export const authCategoryRWPermissionsSync = factory('authCategoryRWPermissionsS
160
449
  /**
161
450
  * @public
162
451
  * @since @ray-js/ray 1.6.17
452
+ * @example 基础调用
453
+ * ```tsx
454
+ * import { health } from '@ray-js/ray';
455
+ *
456
+ * const { saveQuantityData } = health;
457
+ *
458
+ * saveQuantityData({
459
+ * type: 1,
460
+ * value: 65,
461
+ * unitType: 'kg',
462
+ * startTime: 1700000000,
463
+ * endTime: 1700000060,
464
+ * success: () => {
465
+ * console.log('saveQuantityData success');
466
+ * },
467
+ * fail: (error) => {
468
+ * console.log('saveQuantityData fail', error.errorMsg);
469
+ * },
470
+ * });
471
+ * ```
163
472
  */
164
473
  export const saveQuantityData = factory('saveQuantityData', {
165
474
  namespace: 'health'
@@ -167,6 +476,20 @@ export const saveQuantityData = factory('saveQuantityData', {
167
476
  /**
168
477
  * @public
169
478
  * @since @ray-js/ray 1.6.17
479
+ * @example 基础调用
480
+ * ```tsx
481
+ * import { health } from '@ray-js/ray';
482
+ *
483
+ * const { saveQuantityDataSync } = health;
484
+ *
485
+ * saveQuantityDataSync({
486
+ * type: 1,
487
+ * value: 65,
488
+ * unitType: 'kg',
489
+ * startTime: 1700000000,
490
+ * endTime: 1700000060,
491
+ * });
492
+ * ```
170
493
  */
171
494
  export const saveQuantityDataSync = factory('saveQuantityDataSync', {
172
495
  namespace: 'health'
@@ -174,6 +497,24 @@ export const saveQuantityDataSync = factory('saveQuantityDataSync', {
174
497
  /**
175
498
  * @public
176
499
  * @since @ray-js/ray 1.6.17
500
+ * @example 基础调用
501
+ * ```tsx
502
+ * import { health } from '@ray-js/ray';
503
+ *
504
+ * const { saveQuantityNoTimeWithData } = health;
505
+ *
506
+ * saveQuantityNoTimeWithData({
507
+ * type: 1,
508
+ * value: 65,
509
+ * unitType: 'kg',
510
+ * success: () => {
511
+ * console.log('saveQuantityNoTimeWithData success');
512
+ * },
513
+ * fail: (error) => {
514
+ * console.log('saveQuantityNoTimeWithData fail', error.errorMsg);
515
+ * },
516
+ * });
517
+ * ```
177
518
  */
178
519
  export const saveQuantityNoTimeWithData = factory('saveQuantityNoTimeWithData', {
179
520
  namespace: 'health'
@@ -181,6 +522,18 @@ export const saveQuantityNoTimeWithData = factory('saveQuantityNoTimeWithData',
181
522
  /**
182
523
  * @public
183
524
  * @since @ray-js/ray 1.6.17
525
+ * @example 基础调用
526
+ * ```tsx
527
+ * import { health } from '@ray-js/ray';
528
+ *
529
+ * const { saveQuantityNoTimeWithDataSync } = health;
530
+ *
531
+ * saveQuantityNoTimeWithDataSync({
532
+ * type: 1,
533
+ * value: 65,
534
+ * unitType: 'kg',
535
+ * });
536
+ * ```
184
537
  */
185
538
  export const saveQuantityNoTimeWithDataSync = factory('saveQuantityNoTimeWithDataSync', {
186
539
  namespace: 'health'
@@ -188,6 +541,25 @@ export const saveQuantityNoTimeWithDataSync = factory('saveQuantityNoTimeWithDat
188
541
  /**
189
542
  * @public
190
543
  * @since @ray-js/ray 1.6.17
544
+ * @example 基础调用
545
+ * ```tsx
546
+ * import { health } from '@ray-js/ray';
547
+ *
548
+ * const { saveBloodPressureData } = health;
549
+ *
550
+ * saveBloodPressureData({
551
+ * systolic: 120,
552
+ * diastolic: 80,
553
+ * startTime: 1700000000,
554
+ * endTime: 1700000060,
555
+ * success: () => {
556
+ * console.log('saveBloodPressureData success');
557
+ * },
558
+ * fail: (error) => {
559
+ * console.log('saveBloodPressureData fail', error.errorMsg);
560
+ * },
561
+ * });
562
+ * ```
191
563
  */
192
564
  export const saveBloodPressureData = factory('saveBloodPressureData', {
193
565
  namespace: 'health'
@@ -195,6 +567,19 @@ export const saveBloodPressureData = factory('saveBloodPressureData', {
195
567
  /**
196
568
  * @public
197
569
  * @since @ray-js/ray 1.6.17
570
+ * @example 基础调用
571
+ * ```tsx
572
+ * import { health } from '@ray-js/ray';
573
+ *
574
+ * const { saveBloodPressureDataSync } = health;
575
+ *
576
+ * saveBloodPressureDataSync({
577
+ * systolic: 120,
578
+ * diastolic: 80,
579
+ * startTime: 1700000000,
580
+ * endTime: 1700000060,
581
+ * });
582
+ * ```
198
583
  */
199
584
  export const saveBloodPressureDataSync = factory('saveBloodPressureDataSync', {
200
585
  namespace: 'health'
@@ -202,6 +587,25 @@ export const saveBloodPressureDataSync = factory('saveBloodPressureDataSync', {
202
587
  /**
203
588
  * @public
204
589
  * @since @ray-js/ray 1.6.17
590
+ * @example 基础调用
591
+ * ```tsx
592
+ * import { health } from '@ray-js/ray';
593
+ *
594
+ * const { readQuantityDataWithType } = health;
595
+ *
596
+ * readQuantityDataWithType({
597
+ * type: 1,
598
+ * unitType: 'count',
599
+ * startTime: 1700000000,
600
+ * endTime: 1700086400,
601
+ * success: (result) => {
602
+ * console.log('readQuantityDataWithType success', result.value);
603
+ * },
604
+ * fail: (error) => {
605
+ * console.log('readQuantityDataWithType fail', error.errorMsg);
606
+ * },
607
+ * });
608
+ * ```
205
609
  */
206
610
  export const readQuantityDataWithType = factory('readQuantityDataWithType', {
207
611
  namespace: 'health'
@@ -209,6 +613,20 @@ export const readQuantityDataWithType = factory('readQuantityDataWithType', {
209
613
  /**
210
614
  * @public
211
615
  * @since @ray-js/ray 1.6.17
616
+ * @example 基础调用
617
+ * ```tsx
618
+ * import { health } from '@ray-js/ray';
619
+ *
620
+ * const { readQuantityDataWithTypeSync } = health;
621
+ *
622
+ * const result = readQuantityDataWithTypeSync({
623
+ * type: 1,
624
+ * unitType: 'count',
625
+ * startTime: 1700000000,
626
+ * endTime: 1700086400,
627
+ * });
628
+ * console.log('readQuantityDataWithTypeSync result', result.value);
629
+ * ```
212
630
  */
213
631
  export const readQuantityDataWithTypeSync = factory('readQuantityDataWithTypeSync', {
214
632
  namespace: 'health'
@@ -216,6 +634,24 @@ export const readQuantityDataWithTypeSync = factory('readQuantityDataWithTypeSyn
216
634
  /**
217
635
  * @public
218
636
  * @since @ray-js/ray 1.6.17
637
+ * @example 基础调用
638
+ * ```tsx
639
+ * import { health } from '@ray-js/ray';
640
+ *
641
+ * const { deleteQuantityDataType } = health;
642
+ *
643
+ * deleteQuantityDataType({
644
+ * type: 1,
645
+ * startTime: 1700000000,
646
+ * endTime: 1700086400,
647
+ * success: () => {
648
+ * console.log('deleteQuantityDataType success');
649
+ * },
650
+ * fail: (error) => {
651
+ * console.log('deleteQuantityDataType fail', error.errorMsg);
652
+ * },
653
+ * });
654
+ * ```
219
655
  */
220
656
  export const deleteQuantityDataType = factory('deleteQuantityDataType', {
221
657
  namespace: 'health'
@@ -223,6 +659,18 @@ export const deleteQuantityDataType = factory('deleteQuantityDataType', {
223
659
  /**
224
660
  * @public
225
661
  * @since @ray-js/ray 1.6.17
662
+ * @example 基础调用
663
+ * ```tsx
664
+ * import { health } from '@ray-js/ray';
665
+ *
666
+ * const { deleteQuantityDataTypeSync } = health;
667
+ *
668
+ * deleteQuantityDataTypeSync({
669
+ * type: 1,
670
+ * startTime: 1700000000,
671
+ * endTime: 1700086400,
672
+ * });
673
+ * ```
226
674
  */
227
675
  export const deleteQuantityDataTypeSync = factory('deleteQuantityDataTypeSync', {
228
676
  namespace: 'health'
@@ -230,6 +678,22 @@ export const deleteQuantityDataTypeSync = factory('deleteQuantityDataTypeSync',
230
678
  /**
231
679
  * @public
232
680
  * @since @ray-js/ray 1.6.17
681
+ * @example 基础调用
682
+ * ```tsx
683
+ * import { health } from '@ray-js/ray';
684
+ *
685
+ * const { readCharacteristicDataWithType } = health;
686
+ *
687
+ * readCharacteristicDataWithType({
688
+ * type: 1,
689
+ * success: (result) => {
690
+ * console.log('readCharacteristicDataWithType success', result.value);
691
+ * },
692
+ * fail: (error) => {
693
+ * console.log('readCharacteristicDataWithType fail', error.errorMsg);
694
+ * },
695
+ * });
696
+ * ```
233
697
  */
234
698
  export const readCharacteristicDataWithType = factory('readCharacteristicDataWithType', {
235
699
  namespace: 'health'
@@ -237,6 +701,17 @@ export const readCharacteristicDataWithType = factory('readCharacteristicDataWit
237
701
  /**
238
702
  * @public
239
703
  * @since @ray-js/ray 1.6.17
704
+ * @example 基础调用
705
+ * ```tsx
706
+ * import { health } from '@ray-js/ray';
707
+ *
708
+ * const { readCharacteristicDataWithTypeSync } = health;
709
+ *
710
+ * const result = readCharacteristicDataWithTypeSync({
711
+ * type: 1,
712
+ * });
713
+ * console.log('readCharacteristicDataWithTypeSync result', result.value);
714
+ * ```
240
715
  */
241
716
  export const readCharacteristicDataWithTypeSync = factory('readCharacteristicDataWithTypeSync', {
242
717
  namespace: 'health'
@@ -244,6 +719,25 @@ export const readCharacteristicDataWithTypeSync = factory('readCharacteristicDat
244
719
  /**
245
720
  * @public
246
721
  * @since @ray-js/ray 1.6.17
722
+ * @example 基础调用
723
+ * ```tsx
724
+ * import { health } from '@ray-js/ray';
725
+ *
726
+ * const { saveCategoryData } = health;
727
+ *
728
+ * saveCategoryData({
729
+ * type: 1,
730
+ * value: 1,
731
+ * startTime: 1700000000,
732
+ * endTime: 1700000060,
733
+ * success: () => {
734
+ * console.log('saveCategoryData success');
735
+ * },
736
+ * fail: (error) => {
737
+ * console.log('saveCategoryData fail', error.errorMsg);
738
+ * },
739
+ * });
740
+ * ```
247
741
  */
248
742
  export const saveCategoryData = factory('saveCategoryData', {
249
743
  namespace: 'health'
@@ -251,6 +745,19 @@ export const saveCategoryData = factory('saveCategoryData', {
251
745
  /**
252
746
  * @public
253
747
  * @since @ray-js/ray 1.6.17
748
+ * @example 基础调用
749
+ * ```tsx
750
+ * import { health } from '@ray-js/ray';
751
+ *
752
+ * const { saveCategoryDataSync } = health;
753
+ *
754
+ * saveCategoryDataSync({
755
+ * type: 1,
756
+ * value: 1,
757
+ * startTime: 1700000000,
758
+ * endTime: 1700000060,
759
+ * });
760
+ * ```
254
761
  */
255
762
  export const saveCategoryDataSync = factory('saveCategoryDataSync', {
256
763
  namespace: 'health'
@@ -258,6 +765,23 @@ export const saveCategoryDataSync = factory('saveCategoryDataSync', {
258
765
  /**
259
766
  * @public
260
767
  * @since @ray-js/ray 1.6.17
768
+ * @example 基础调用
769
+ * ```tsx
770
+ * import { health } from '@ray-js/ray';
771
+ *
772
+ * const { saveCategoryNoTimeWithData } = health;
773
+ *
774
+ * saveCategoryNoTimeWithData({
775
+ * type: 1,
776
+ * value: 1,
777
+ * success: () => {
778
+ * console.log('saveCategoryNoTimeWithData success');
779
+ * },
780
+ * fail: (error) => {
781
+ * console.log('saveCategoryNoTimeWithData fail', error.errorMsg);
782
+ * },
783
+ * });
784
+ * ```
261
785
  */
262
786
  export const saveCategoryNoTimeWithData = factory('saveCategoryNoTimeWithData', {
263
787
  namespace: 'health'
@@ -265,6 +789,17 @@ export const saveCategoryNoTimeWithData = factory('saveCategoryNoTimeWithData',
265
789
  /**
266
790
  * @public
267
791
  * @since @ray-js/ray 1.6.17
792
+ * @example 基础调用
793
+ * ```tsx
794
+ * import { health } from '@ray-js/ray';
795
+ *
796
+ * const { saveCategoryNoTimeWithDataSync } = health;
797
+ *
798
+ * saveCategoryNoTimeWithDataSync({
799
+ * type: 1,
800
+ * value: 1,
801
+ * });
802
+ * ```
268
803
  */
269
804
  export const saveCategoryNoTimeWithDataSync = factory('saveCategoryNoTimeWithDataSync', {
270
805
  namespace: 'health'
@@ -272,6 +807,24 @@ export const saveCategoryNoTimeWithDataSync = factory('saveCategoryNoTimeWithDat
272
807
  /**
273
808
  * @public
274
809
  * @since @ray-js/ray 1.6.17
810
+ * @example 基础调用
811
+ * ```tsx
812
+ * import { health } from '@ray-js/ray';
813
+ *
814
+ * const { readCategoryDataWithType } = health;
815
+ *
816
+ * readCategoryDataWithType({
817
+ * type: 1,
818
+ * startTime: 1700000000,
819
+ * endTime: 1700086400,
820
+ * success: (result) => {
821
+ * console.log('readCategoryDataWithType success', result.value);
822
+ * },
823
+ * fail: (error) => {
824
+ * console.log('readCategoryDataWithType fail', error.errorMsg);
825
+ * },
826
+ * });
827
+ * ```
275
828
  */
276
829
  export const readCategoryDataWithType = factory('readCategoryDataWithType', {
277
830
  namespace: 'health'
@@ -279,6 +832,19 @@ export const readCategoryDataWithType = factory('readCategoryDataWithType', {
279
832
  /**
280
833
  * @public
281
834
  * @since @ray-js/ray 1.6.17
835
+ * @example 基础调用
836
+ * ```tsx
837
+ * import { health } from '@ray-js/ray';
838
+ *
839
+ * const { readCategoryDataWithTypeSync } = health;
840
+ *
841
+ * const result = readCategoryDataWithTypeSync({
842
+ * type: 1,
843
+ * startTime: 1700000000,
844
+ * endTime: 1700086400,
845
+ * });
846
+ * console.log('readCategoryDataWithTypeSync result', result.value);
847
+ * ```
282
848
  */
283
849
  export const readCategoryDataWithTypeSync = factory('readCategoryDataWithTypeSync', {
284
850
  namespace: 'health'
@@ -286,6 +852,27 @@ export const readCategoryDataWithTypeSync = factory('readCategoryDataWithTypeSyn
286
852
  /**
287
853
  * @public
288
854
  * @since @ray-js/ray 1.7.4
855
+ * @example 基础调用
856
+ * ```tsx
857
+ * import { health } from '@ray-js/ray';
858
+ *
859
+ * const { queryBodyFatScaleAlgorithm } = health;
860
+ *
861
+ * queryBodyFatScaleAlgorithm({
862
+ * sex: 1,
863
+ * weight: 70,
864
+ * imp: 500,
865
+ * height: 175,
866
+ * birthday: 946684800000,
867
+ * time: 1700000000000,
868
+ * success: (result) => {
869
+ * console.log('queryBodyFatScaleAlgorithm success', result.bmi, result.fat);
870
+ * },
871
+ * fail: (error) => {
872
+ * console.log('queryBodyFatScaleAlgorithm fail', error.errorMsg);
873
+ * },
874
+ * });
875
+ * ```
289
876
  */
290
877
  export const queryBodyFatScaleAlgorithm = factory('queryBodyFatScaleAlgorithm', {
291
878
  namespace: 'health'
@@ -293,6 +880,22 @@ export const queryBodyFatScaleAlgorithm = factory('queryBodyFatScaleAlgorithm',
293
880
  /**
294
881
  * @public
295
882
  * @since @ray-js/ray 1.7.4
883
+ * @example 基础调用
884
+ * ```tsx
885
+ * import { health } from '@ray-js/ray';
886
+ *
887
+ * const { queryBodyFatScaleAlgorithmSync } = health;
888
+ *
889
+ * const result = queryBodyFatScaleAlgorithmSync({
890
+ * sex: 1,
891
+ * weight: 70,
892
+ * imp: 500,
893
+ * height: 175,
894
+ * birthday: 946684800000,
895
+ * time: 1700000000000,
896
+ * });
897
+ * console.log('queryBodyFatScaleAlgorithmSync result', result.bmi, result.fat);
898
+ * ```
296
899
  */
297
900
  export const queryBodyFatScaleAlgorithmSync = factory('queryBodyFatScaleAlgorithmSync', {
298
901
  namespace: 'health'