@ray-js/api 1.7.69 → 1.7.71

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 (154) hide show
  1. package/@types/AIKit.d.ts +5509 -610
  2. package/@types/AIStreamKit.d.ts +2641 -0
  3. package/@types/AVideoKit.d.ts +1827 -0
  4. package/@types/BaseKit.d.ts +8682 -1893
  5. package/@types/BizKit.d.ts +6639 -1038
  6. package/@types/CategoryCommonBizKit.d.ts +1459 -0
  7. package/@types/CommunityKit.d.ts +154 -0
  8. package/@types/DeviceKit.d.ts +18475 -5662
  9. package/@types/GroupCITestKit.d.ts +651 -0
  10. package/@types/HealthKit.d.ts +2290 -357
  11. package/@types/HomeKit.d.ts +4068 -182
  12. package/@types/IPCKit.d.ts +4327 -1227
  13. package/@types/LightKit.d.ts +125 -0
  14. package/@types/MapKit.d.ts +1560 -204
  15. package/@types/MediaKit.d.ts +136 -16
  16. package/@types/MediaPlayerKit.d.ts +47 -0
  17. package/@types/MiniKit.d.ts +2976 -628
  18. package/@types/OutdoorKit.d.ts +1337 -24
  19. package/@types/P2PKit.d.ts +622 -103
  20. package/@types/PayKit.d.ts +115 -0
  21. package/@types/PlayNetKit.d.ts +3454 -1309
  22. package/@types/SweeperKit.d.ts +154 -0
  23. package/@types/ThirdAuthKit.d.ts +324 -0
  24. package/@types/ThirdPartyDeviceKit.d.ts +410 -0
  25. package/@types/WearKit.d.ts +10177 -375
  26. package/@types/gateway.d.ts +349 -61
  27. package/@types/health.d.ts +486 -304
  28. package/lib/AIKit-1.6.0.d.ts +265 -41
  29. package/lib/AIKit-1.6.0.js +374 -120
  30. package/lib/BaseKit-3.17.7.d.ts +704 -0
  31. package/lib/BaseKit-3.17.7.js +720 -1
  32. package/lib/BizKit-4.10.4.d.ts +336 -0
  33. package/lib/BizKit-4.10.4.js +342 -5
  34. package/lib/DeviceKit-4.13.1.d.ts +996 -0
  35. package/lib/DeviceKit-4.13.1.js +1247 -249
  36. package/lib/HealthKit-6.5.0.d.ts +210 -44
  37. package/lib/HealthKit-6.5.0.js +295 -128
  38. package/lib/HomeKit-3.1.4.d.ts +20 -6
  39. package/lib/HomeKit-3.1.4.js +29 -14
  40. package/lib/IPCKit-6.4.5.d.ts +375 -77
  41. package/lib/IPCKit-6.4.5.js +525 -228
  42. package/lib/MapKit-3.4.13.d.ts +70 -16
  43. package/lib/MapKit-3.4.13.js +98 -47
  44. package/lib/MediaKit-3.4.1.d.ts +5 -3
  45. package/lib/MediaKit-3.4.1.js +7 -6
  46. package/lib/MiniKit-3.14.1.d.ts +300 -0
  47. package/lib/MiniKit-3.14.1.js +302 -0
  48. package/lib/OutdoorKit-1.0.4.d.ts +55 -13
  49. package/lib/OutdoorKit-1.0.4.js +78 -35
  50. package/lib/P2PKit-2.0.3.d.ts +125 -27
  51. package/lib/P2PKit-2.0.3.js +175 -78
  52. package/lib/PlayNetKit-1.3.30.d.ts +290 -60
  53. package/lib/PlayNetKit-1.3.30.js +407 -176
  54. package/lib/WearKit-1.1.6.d.ts +125 -27
  55. package/lib/WearKit-1.1.6.js +176 -77
  56. package/lib/all-kits.d.ts +10 -10
  57. package/lib/all-kits.js +10 -10
  58. package/lib/cloud/core.d.ts +31 -1
  59. package/lib/cloud/core.js +31 -1
  60. package/lib/cloud/device.d.ts +155 -24
  61. package/lib/cloud/device.js +153 -22
  62. package/lib/cloud/gateway.d.ts +254 -0
  63. package/lib/cloud/gateway.js +269 -9
  64. package/lib/cloud/health.d.ts +1 -0
  65. package/lib/cloud/health.js +121 -0
  66. package/lib/cloud/interface.d.ts +222 -44
  67. package/lib/cloud/interface.js +15 -2
  68. package/lib/cloud/laser-clean/deleteCleaningRecord/index.d.ts +27 -0
  69. package/lib/cloud/laser-clean/deleteCleaningRecord/index.js +28 -0
  70. package/lib/cloud/laser-clean/deleteCleaningRecord/type.d.ts +7 -0
  71. package/lib/cloud/laser-clean/deleteCleaningRecord/type.js +1 -0
  72. package/lib/cloud/laser-clean/deleteGyroCleanRecord/index.d.ts +27 -0
  73. package/lib/cloud/laser-clean/deleteGyroCleanRecord/index.js +28 -0
  74. package/lib/cloud/laser-clean/deleteGyroCleanRecord/type.d.ts +7 -0
  75. package/lib/cloud/laser-clean/deleteGyroCleanRecord/type.js +1 -0
  76. package/lib/cloud/laser-clean/deleteMultipleMapFiles/index.d.ts +27 -0
  77. package/lib/cloud/laser-clean/deleteMultipleMapFiles/index.js +28 -0
  78. package/lib/cloud/laser-clean/deleteMultipleMapFiles/type.d.ts +7 -0
  79. package/lib/cloud/laser-clean/deleteMultipleMapFiles/type.js +1 -0
  80. package/lib/cloud/laser-clean/getCleaningRecords/index.d.ts +30 -0
  81. package/lib/cloud/laser-clean/getCleaningRecords/index.js +31 -0
  82. package/lib/cloud/laser-clean/getCleaningRecords/type.d.ts +39 -0
  83. package/lib/cloud/laser-clean/getCleaningRecords/type.js +1 -0
  84. package/lib/cloud/laser-clean/getGyroCleanRecordDetail/index.d.ts +29 -0
  85. package/lib/cloud/laser-clean/getGyroCleanRecordDetail/index.js +30 -0
  86. package/lib/cloud/laser-clean/getGyroCleanRecordDetail/type.d.ts +30 -0
  87. package/lib/cloud/laser-clean/getGyroCleanRecordDetail/type.js +1 -0
  88. package/lib/cloud/laser-clean/getGyroCleanRecords/index.d.ts +29 -0
  89. package/lib/cloud/laser-clean/getGyroCleanRecords/index.js +30 -0
  90. package/lib/cloud/laser-clean/getGyroCleanRecords/type.d.ts +35 -0
  91. package/lib/cloud/laser-clean/getGyroCleanRecords/type.js +1 -0
  92. package/lib/cloud/laser-clean/getGyroLatestCleanMap/index.d.ts +28 -0
  93. package/lib/cloud/laser-clean/getGyroLatestCleanMap/index.js +29 -0
  94. package/lib/cloud/laser-clean/getGyroLatestCleanMap/type.d.ts +28 -0
  95. package/lib/cloud/laser-clean/getGyroLatestCleanMap/type.js +1 -0
  96. package/lib/cloud/laser-clean/getMultipleMapFiles/index.d.ts +24 -0
  97. package/lib/cloud/laser-clean/getMultipleMapFiles/index.js +25 -0
  98. package/lib/cloud/laser-clean/getMultipleMapFiles/type.d.ts +29 -0
  99. package/lib/cloud/laser-clean/getMultipleMapFiles/type.js +1 -0
  100. package/lib/cloud/laser-clean/getSweeperStorageConfig/index.d.ts +24 -0
  101. package/lib/cloud/laser-clean/getSweeperStorageConfig/index.js +25 -0
  102. package/lib/cloud/laser-clean/getSweeperStorageConfig/type.d.ts +26 -0
  103. package/lib/cloud/laser-clean/getSweeperStorageConfig/type.js +1 -0
  104. package/lib/cloud/laser-clean/getVoiceList/index.d.ts +28 -0
  105. package/lib/cloud/laser-clean/getVoiceList/index.js +29 -0
  106. package/lib/cloud/laser-clean/getVoiceList/type.d.ts +48 -0
  107. package/lib/cloud/laser-clean/getVoiceList/type.js +1 -0
  108. package/lib/cloud/laser-clean/index.d.ts +1 -1
  109. package/lib/cloud/laser-clean/index.js +1 -1
  110. package/lib/cloud/laser-clean/map.d.ts +5 -7
  111. package/lib/cloud/laser-clean/map.js +5 -9
  112. package/lib/cloud/laser-clean/record.d.ts +5 -6
  113. package/lib/cloud/laser-clean/record.js +5 -7
  114. package/lib/cloud/laser-clean/renameHistoryMap/index.d.ts +28 -0
  115. package/lib/cloud/laser-clean/renameHistoryMap/index.js +29 -0
  116. package/lib/cloud/laser-clean/renameHistoryMap/type.d.ts +9 -0
  117. package/lib/cloud/laser-clean/renameHistoryMap/type.js +1 -0
  118. package/lib/cloud/laser-clean/voice.d.ts +1 -3
  119. package/lib/cloud/laser-clean/voice.js +1 -4
  120. package/lib/cloud/linkage.d.ts +271 -53
  121. package/lib/cloud/linkage.js +256 -51
  122. package/lib/cloud/remoteGroup.d.ts +37 -0
  123. package/lib/cloud/remoteGroup.js +37 -0
  124. package/lib/cloud/timer.d.ts +104 -26
  125. package/lib/cloud/timer.js +104 -26
  126. package/lib/getApp/index.thing.d.ts +47 -1
  127. package/lib/getApp/index.thing.js +40 -2
  128. package/lib/getBoundingClientRect/index.thing.d.ts +101 -1
  129. package/lib/getBoundingClientRect/index.thing.js +59 -0
  130. package/lib/getCurrentPages/index.thing.d.ts +40 -15
  131. package/lib/getCurrentPages/index.thing.js +36 -15
  132. package/lib/getCustomConfig/index.d.ts +5 -2
  133. package/lib/getCustomConfig/index.thing.d.ts +68 -2
  134. package/lib/getCustomConfig/index.thing.js +62 -0
  135. package/lib/getCustomConfig/index.wechat.d.ts +5 -2
  136. package/lib/getCustomConfig/type.d.ts +26 -15
  137. package/lib/getElementById/index.thing.d.ts +42 -1
  138. package/lib/getElementById/index.thing.js +40 -0
  139. package/lib/index.d.ts +3 -0
  140. package/lib/index.js +4 -2
  141. package/lib/nativeRouters/common.d.ts +8 -0
  142. package/lib/nativeRouters/device.d.ts +137 -5
  143. package/lib/nativeRouters/device.js +138 -6
  144. package/lib/nativeRouters/gw.d.ts +58 -8
  145. package/lib/nativeRouters/gw.js +57 -8
  146. package/lib/nativeRouters/outdoors.d.ts +16 -3
  147. package/lib/nativeRouters/outdoors.js +16 -3
  148. package/lib/nativeRouters/remoteGroup.d.ts +23 -0
  149. package/lib/nativeRouters/remoteGroup.js +23 -0
  150. package/lib/nativeRouters/root.d.ts +19 -0
  151. package/lib/nativeRouters/root.js +17 -0
  152. package/lib/openGroupCreate/index.d.ts +45 -0
  153. package/lib/openGroupCreate/index.js +32 -0
  154. package/package.json +5 -5
@@ -1,23 +1,37 @@
1
1
  /**
2
2
  * OutdoorKit
3
3
  *
4
- * @version 1.0.4
4
+ * @version 6.4.2
5
5
  */
6
6
  declare namespace ty.outdoor {
7
7
  /**
8
8
  * 出行获取当前首页展示的设备ID
9
+ * @public
10
+ * @since OutdoorKit 1.0.0
11
+ * @platform iOS Android
9
12
  */
10
13
  export function currentDevice(params?: {
14
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
11
15
  complete?: () => void
16
+ /** 接口调用成功的回调函数 */
12
17
  success?: (params: {
13
- /** deviceID 设备ID */
18
+ /**
19
+ * deviceID 设备ID
20
+ * @since OutdoorKit 1.0.1
21
+ */
14
22
  deviceID: string
15
23
  }) => void
24
+ /** 接口调用失败的回调函数 */
16
25
  fail?: (params: {
26
+ /** 错误信息 */
17
27
  errorMsg: string
28
+ /** 错误码 */
18
29
  errorCode: string | number
30
+ /** 错误扩展 */
19
31
  innerError: {
32
+ /** 错误扩展码 */
20
33
  errorCode: string | number
34
+ /** 错误扩展信息 */
21
35
  errorMsg: string
22
36
  }
23
37
  }) => void
@@ -25,15 +39,124 @@ declare namespace ty.outdoor {
25
39
 
26
40
  /**
27
41
  * 切换设备,会弹出Native切换选择器
42
+ * @public
43
+ * @since OutdoorKit 1.0.4
44
+ * @platform iOS Android
28
45
  */
29
46
  export function switchDevice(params?: {
47
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
30
48
  complete?: () => void
49
+ /** 接口调用成功的回调函数 */
31
50
  success?: (params: boolean) => void
51
+ /** 接口调用失败的回调函数 */
32
52
  fail?: (params: {
53
+ /** 错误信息 */
33
54
  errorMsg: string
55
+ /** 错误码 */
34
56
  errorCode: string | number
57
+ /** 错误扩展 */
35
58
  innerError: {
59
+ /** 错误扩展码 */
36
60
  errorCode: string | number
61
+ /** 错误扩展信息 */
62
+ errorMsg: string
63
+ }
64
+ }) => void
65
+ }): void
66
+
67
+ /**
68
+ * 获取出行设备列表(不含分享的设备)
69
+ * @public
70
+ * @since OutdoorKit 1.1.0
71
+ * @platform iOS Android
72
+ */
73
+ export function getDeviceList(params?: {
74
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
75
+ complete?: () => void
76
+ /** 接口调用成功的回调函数 */
77
+ success?: (params: {
78
+ /**
79
+ * 设备ID列表
80
+ * @since OutdoorKit 1.1.0
81
+ */
82
+ devIDList: string[]
83
+ }) => void
84
+ /** 接口调用失败的回调函数 */
85
+ fail?: (params: {
86
+ /** 错误信息 */
87
+ errorMsg: string
88
+ /** 错误码 */
89
+ errorCode: string | number
90
+ /** 错误扩展 */
91
+ innerError: {
92
+ /** 错误扩展码 */
93
+ errorCode: string | number
94
+ /** 错误扩展信息 */
95
+ errorMsg: string
96
+ }
97
+ }) => void
98
+ }): void
99
+
100
+ /**
101
+ * 获取分享的设备列表
102
+ * @public
103
+ * @since OutdoorKit 1.1.0
104
+ * @platform iOS Android
105
+ */
106
+ export function getSharedDeviceList(params?: {
107
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
108
+ complete?: () => void
109
+ /** 接口调用成功的回调函数 */
110
+ success?: (params: {
111
+ /**
112
+ * 设备ID列表
113
+ * @since OutdoorKit 1.1.0
114
+ */
115
+ devIDList: string[]
116
+ }) => void
117
+ /** 接口调用失败的回调函数 */
118
+ fail?: (params: {
119
+ /** 错误信息 */
120
+ errorMsg: string
121
+ /** 错误码 */
122
+ errorCode: string | number
123
+ /** 错误扩展 */
124
+ innerError: {
125
+ /** 错误扩展码 */
126
+ errorCode: string | number
127
+ /** 错误扩展信息 */
128
+ errorMsg: string
129
+ }
130
+ }) => void
131
+ }): void
132
+
133
+ /**
134
+ * 指定设备ID
135
+ * @public
136
+ * @since OutdoorKit 1.1.0
137
+ * @platform iOS Android
138
+ */
139
+ export function specifyDevice(params: {
140
+ /**
141
+ * deviceID 设备ID
142
+ * @since OutdoorKit 1.1.0
143
+ */
144
+ deviceID: string
145
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
146
+ complete?: () => void
147
+ /** 接口调用成功的回调函数 */
148
+ success?: (params: boolean) => void
149
+ /** 接口调用失败的回调函数 */
150
+ fail?: (params: {
151
+ /** 错误信息 */
152
+ errorMsg: string
153
+ /** 错误码 */
154
+ errorCode: string | number
155
+ /** 错误扩展 */
156
+ innerError: {
157
+ /** 错误扩展码 */
158
+ errorCode: string | number
159
+ /** 错误扩展信息 */
37
160
  errorMsg: string
38
161
  }
39
162
  }) => void
@@ -41,18 +164,32 @@ declare namespace ty.outdoor {
41
164
 
42
165
  /**
43
166
  * 获取已绑定设备ID集合
167
+ * @public
168
+ * @since OutdoorKit 1.0.1
169
+ * @platform iOS Android
44
170
  */
45
171
  export function getBoundDeviceIdList(params?: {
172
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
46
173
  complete?: () => void
174
+ /** 接口调用成功的回调函数 */
47
175
  success?: (params: {
48
- /** 返回已绑定的设备ID集合 */
176
+ /**
177
+ * 返回已绑定的设备ID集合
178
+ * @since OutdoorKit 1.0.1
179
+ */
49
180
  devIdList: string[]
50
181
  }) => void
182
+ /** 接口调用失败的回调函数 */
51
183
  fail?: (params: {
184
+ /** 错误信息 */
52
185
  errorMsg: string
186
+ /** 错误码 */
53
187
  errorCode: string | number
188
+ /** 错误扩展 */
54
189
  innerError: {
190
+ /** 错误扩展码 */
55
191
  errorCode: string | number
192
+ /** 错误扩展信息 */
56
193
  errorMsg: string
57
194
  }
58
195
  }) => void
@@ -60,18 +197,32 @@ declare namespace ty.outdoor {
60
197
 
61
198
  /**
62
199
  * 获取可绑定设备ID集合
200
+ * @public
201
+ * @since OutdoorKit 1.0.1
202
+ * @platform iOS Android
63
203
  */
64
204
  export function getUnbindDeviceIdList(params?: {
205
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
65
206
  complete?: () => void
207
+ /** 接口调用成功的回调函数 */
66
208
  success?: (params: {
67
- /** 返回可绑定的设备ID集合 */
209
+ /**
210
+ * 返回可绑定的设备ID集合
211
+ * @since OutdoorKit 1.0.1
212
+ */
68
213
  devIdList: string[]
69
214
  }) => void
215
+ /** 接口调用失败的回调函数 */
70
216
  fail?: (params: {
217
+ /** 错误信息 */
71
218
  errorMsg: string
219
+ /** 错误码 */
72
220
  errorCode: string | number
221
+ /** 错误扩展 */
73
222
  innerError: {
223
+ /** 错误扩展码 */
74
224
  errorCode: string | number
225
+ /** 错误扩展信息 */
75
226
  errorMsg: string
76
227
  }
77
228
  }) => void
@@ -79,19 +230,36 @@ declare namespace ty.outdoor {
79
230
 
80
231
  /**
81
232
  * 从设备绑定
233
+ * @public
234
+ * @since OutdoorKit 1.0.1
235
+ * @platform iOS Android
82
236
  */
83
237
  export function bindSlaveDevice(params: {
84
- /** 从设备ID */
238
+ /**
239
+ * 从设备ID
240
+ * @since OutdoorKit 1.0.1
241
+ */
85
242
  slaveDevId: string
86
- /** 主设备ID */
243
+ /**
244
+ * 主设备ID
245
+ * @since OutdoorKit 1.0.1
246
+ */
87
247
  masterDevId: string
248
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
88
249
  complete?: () => void
250
+ /** 接口调用成功的回调函数 */
89
251
  success?: (params: boolean) => void
252
+ /** 接口调用失败的回调函数 */
90
253
  fail?: (params: {
254
+ /** 错误信息 */
91
255
  errorMsg: string
256
+ /** 错误码 */
92
257
  errorCode: string | number
258
+ /** 错误扩展 */
93
259
  innerError: {
260
+ /** 错误扩展码 */
94
261
  errorCode: string | number
262
+ /** 错误扩展信息 */
95
263
  errorMsg: string
96
264
  }
97
265
  }) => void
@@ -99,17 +267,31 @@ declare namespace ty.outdoor {
99
267
 
100
268
  /**
101
269
  * 从设备移除
270
+ * @public
271
+ * @since OutdoorKit 1.0.1
272
+ * @platform iOS Android
102
273
  */
103
274
  export function unbindDevice(params: {
104
- /** 从设备ID */
275
+ /**
276
+ * 从设备ID
277
+ * @since OutdoorKit 1.0.1
278
+ */
105
279
  devId: string
280
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
106
281
  complete?: () => void
282
+ /** 接口调用成功的回调函数 */
107
283
  success?: (params: boolean) => void
284
+ /** 接口调用失败的回调函数 */
108
285
  fail?: (params: {
286
+ /** 错误信息 */
109
287
  errorMsg: string
288
+ /** 错误码 */
110
289
  errorCode: string | number
290
+ /** 错误扩展 */
111
291
  innerError: {
292
+ /** 错误扩展码 */
112
293
  errorCode: string | number
294
+ /** 错误扩展信息 */
113
295
  errorMsg: string
114
296
  }
115
297
  }) => void
@@ -117,21 +299,41 @@ declare namespace ty.outdoor {
117
299
 
118
300
  /**
119
301
  * 小程序表盘设置
302
+ * @public
303
+ * @since OutdoorKit 1.0.1
304
+ * @platform iOS Android
120
305
  */
121
306
  export function saveDialViewTag(params: {
122
- /** 表盘左侧 */
307
+ /**
308
+ * 表盘左侧
309
+ * @since OutdoorKit 1.0.1
310
+ */
123
311
  leftViewTag: string
124
- /** 表盘中间数据 */
312
+ /**
313
+ * 表盘中间数据
314
+ * @since OutdoorKit 1.0.1
315
+ */
125
316
  centerViewTag: string
126
- /** 表盘右侧数据 */
317
+ /**
318
+ * 表盘右侧数据
319
+ * @since OutdoorKit 1.0.1
320
+ */
127
321
  rightViewTag: string
322
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
128
323
  complete?: () => void
324
+ /** 接口调用成功的回调函数 */
129
325
  success?: (params: boolean) => void
326
+ /** 接口调用失败的回调函数 */
130
327
  fail?: (params: {
328
+ /** 错误信息 */
131
329
  errorMsg: string
330
+ /** 错误码 */
132
331
  errorCode: string | number
332
+ /** 错误扩展 */
133
333
  innerError: {
334
+ /** 错误扩展码 */
134
335
  errorCode: string | number
336
+ /** 错误扩展信息 */
135
337
  errorMsg: string
136
338
  }
137
339
  }) => void
@@ -139,29 +341,61 @@ declare namespace ty.outdoor {
139
341
 
140
342
  /**
141
343
  * 保存骑行语音播报数据
344
+ * @public
345
+ * @since OutdoorKit 1.0.1
346
+ * @platform iOS Android
142
347
  */
143
348
  export function saveTTSData(params: {
144
- /** 骑行数据播报总开关 */
349
+ /**
350
+ * 骑行数据播报总开关
351
+ * @since OutdoorKit 1.0.1
352
+ */
145
353
  ttsMainSwitch: boolean
146
- /** 天气 */
354
+ /**
355
+ * 天气
356
+ * @since OutdoorKit 1.0.1
357
+ */
147
358
  weather: boolean
148
- /** 骑行数据播报总开关 */
359
+ /**
360
+ * 骑行数据播报总开关
361
+ * @since OutdoorKit 1.0.1
362
+ */
149
363
  abnormalWear: boolean
150
- /** 骑行里程 */
364
+ /**
365
+ * 骑行里程
366
+ * @since OutdoorKit 1.0.1
367
+ */
151
368
  cyclingMileage: boolean
152
- /** 低电量 */
369
+ /**
370
+ * 低电量
371
+ * @since OutdoorKit 1.0.1
372
+ */
153
373
  lowBattery: boolean
154
- /** 具体电量数值 */
374
+ /**
375
+ * 具体电量数值
376
+ * @since OutdoorKit 1.0.1
377
+ */
155
378
  electricThreshold: number
156
- /** 骑行里程 */
379
+ /**
380
+ * 骑行里程
381
+ * @since OutdoorKit 1.0.1
382
+ */
157
383
  callReminder: boolean
384
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
158
385
  complete?: () => void
386
+ /** 接口调用成功的回调函数 */
159
387
  success?: (params: boolean) => void
388
+ /** 接口调用失败的回调函数 */
160
389
  fail?: (params: {
390
+ /** 错误信息 */
161
391
  errorMsg: string
392
+ /** 错误码 */
162
393
  errorCode: string | number
394
+ /** 错误扩展 */
163
395
  innerError: {
396
+ /** 错误扩展码 */
164
397
  errorCode: string | number
398
+ /** 错误扩展信息 */
165
399
  errorMsg: string
166
400
  }
167
401
  }) => void
@@ -169,30 +403,62 @@ declare namespace ty.outdoor {
169
403
 
170
404
  /**
171
405
  * 获取骑行播报数据
406
+ * @public
407
+ * @since OutdoorKit 1.0.1
408
+ * @platform iOS Android
172
409
  */
173
410
  export function getTTSData(params?: {
411
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
174
412
  complete?: () => void
413
+ /** 接口调用成功的回调函数 */
175
414
  success?: (params: {
176
- /** 骑行数据播报总开关 */
415
+ /**
416
+ * 骑行数据播报总开关
417
+ * @since OutdoorKit 1.0.1
418
+ */
177
419
  ttsMainSwitch: boolean
178
- /** 天气 */
420
+ /**
421
+ * 天气
422
+ * @since OutdoorKit 1.0.1
423
+ */
179
424
  weather: boolean
180
- /** 骑行数据播报总开关 */
425
+ /**
426
+ * 骑行数据播报总开关
427
+ * @since OutdoorKit 1.0.1
428
+ */
181
429
  abnormalWear: boolean
182
- /** 骑行里程 */
430
+ /**
431
+ * 骑行里程
432
+ * @since OutdoorKit 1.0.1
433
+ */
183
434
  cyclingMileage: boolean
184
- /** 低电量 */
435
+ /**
436
+ * 低电量
437
+ * @since OutdoorKit 1.0.1
438
+ */
185
439
  lowBattery: boolean
186
- /** 具体电量数值 */
440
+ /**
441
+ * 具体电量数值
442
+ * @since OutdoorKit 1.0.1
443
+ */
187
444
  electricThreshold: number
188
- /** 骑行里程 */
445
+ /**
446
+ * 骑行里程
447
+ * @since OutdoorKit 1.0.1
448
+ */
189
449
  callReminder: boolean
190
450
  }) => void
451
+ /** 接口调用失败的回调函数 */
191
452
  fail?: (params: {
453
+ /** 错误信息 */
192
454
  errorMsg: string
455
+ /** 错误码 */
193
456
  errorCode: string | number
457
+ /** 错误扩展 */
194
458
  innerError: {
459
+ /** 错误扩展码 */
195
460
  errorCode: string | number
461
+ /** 错误扩展信息 */
196
462
  errorMsg: string
197
463
  }
198
464
  }) => void
@@ -200,15 +466,26 @@ declare namespace ty.outdoor {
200
466
 
201
467
  /**
202
468
  * 是否有通话权限
469
+ * @public
470
+ * @since OutdoorKit 1.0.1
471
+ * @platform iOS Android
203
472
  */
204
473
  export function isCallPhoneGranted(params?: {
474
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
205
475
  complete?: () => void
476
+ /** 接口调用成功的回调函数 */
206
477
  success?: (params: boolean) => void
478
+ /** 接口调用失败的回调函数 */
207
479
  fail?: (params: {
480
+ /** 错误信息 */
208
481
  errorMsg: string
482
+ /** 错误码 */
209
483
  errorCode: string | number
484
+ /** 错误扩展 */
210
485
  innerError: {
486
+ /** 错误扩展码 */
211
487
  errorCode: string | number
488
+ /** 错误扩展信息 */
212
489
  errorMsg: string
213
490
  }
214
491
  }) => void
@@ -216,17 +493,1053 @@ declare namespace ty.outdoor {
216
493
 
217
494
  /**
218
495
  * 申请通话权限
496
+ * @public
497
+ * @since OutdoorKit 1.0.1
498
+ * @platform iOS Android
219
499
  */
220
500
  export function requestCallPhonePermission(params?: {
501
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
221
502
  complete?: () => void
503
+ /** 接口调用成功的回调函数 */
222
504
  success?: (params: boolean) => void
505
+ /** 接口调用失败的回调函数 */
223
506
  fail?: (params: {
507
+ /** 错误信息 */
224
508
  errorMsg: string
509
+ /** 错误码 */
225
510
  errorCode: string | number
511
+ /** 错误扩展 */
226
512
  innerError: {
513
+ /** 错误扩展码 */
227
514
  errorCode: string | number
515
+ /** 错误扩展信息 */
228
516
  errorMsg: string
229
517
  }
230
518
  }) => void
231
519
  }): void
520
+
521
+ /**
522
+ * 是否为BLE+X设备
523
+ * @public
524
+ * @since OutdoorKit 1.1.0
525
+ * @platform iOS Android
526
+ */
527
+ export function isBLEXDevice(params: {
528
+ /**
529
+ * deviceID 设备ID
530
+ * @since OutdoorKit 1.1.0
531
+ */
532
+ deviceID: string
533
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
534
+ complete?: () => void
535
+ /** 接口调用成功的回调函数 */
536
+ success?: (params: boolean) => void
537
+ /** 接口调用失败的回调函数 */
538
+ fail?: (params: {
539
+ /** 错误信息 */
540
+ errorMsg: string
541
+ /** 错误码 */
542
+ errorCode: string | number
543
+ /** 错误扩展 */
544
+ innerError: {
545
+ /** 错误扩展码 */
546
+ errorCode: string | number
547
+ /** 错误扩展信息 */
548
+ errorMsg: string
549
+ }
550
+ }) => void
551
+ }): void
552
+
553
+ /**
554
+ * BLE+X是否已激活 前置条件:是BLE+X设备
555
+ * @public
556
+ * @since OutdoorKit 1.1.0
557
+ * @platform iOS Android
558
+ */
559
+ export function isBLEXDeviceActived(params: {
560
+ /**
561
+ * deviceID 设备ID
562
+ * @since OutdoorKit 1.1.0
563
+ */
564
+ deviceID: string
565
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
566
+ complete?: () => void
567
+ /** 接口调用成功的回调函数 */
568
+ success?: (params: boolean) => void
569
+ /** 接口调用失败的回调函数 */
570
+ fail?: (params: {
571
+ /** 错误信息 */
572
+ errorMsg: string
573
+ /** 错误码 */
574
+ errorCode: string | number
575
+ /** 错误扩展 */
576
+ innerError: {
577
+ /** 错误扩展码 */
578
+ errorCode: string | number
579
+ /** 错误扩展信息 */
580
+ errorMsg: string
581
+ }
582
+ }) => void
583
+ }): void
584
+
585
+ /**
586
+ * 获取 扩展模组关联事件配置
587
+ * @public
588
+ * @since OutdoorKit 1.1.0
589
+ * @platform iOS Android
590
+ */
591
+ export function getExtendedModuleExtConfig(params: {
592
+ /**
593
+ * deviceID 设备ID
594
+ * @since OutdoorKit 1.1.0
595
+ */
596
+ deviceID: string
597
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
598
+ complete?: () => void
599
+ /** 接口调用成功的回调函数 */
600
+ success?: (params: {
601
+ /**
602
+ * auto_active / manual_active
603
+ * @since OutdoorKit 1.1.0
604
+ */
605
+ activeType: string
606
+ /**
607
+ * disabled / hide
608
+ * @since OutdoorKit 1.1.0
609
+ */
610
+ interactionType: string
611
+ /**
612
+ * [dpID]
613
+ * @since OutdoorKit 1.1.0
614
+ */
615
+ assocaitedDps: number[]
616
+ }) => void
617
+ /** 接口调用失败的回调函数 */
618
+ fail?: (params: {
619
+ /** 错误信息 */
620
+ errorMsg: string
621
+ /** 错误码 */
622
+ errorCode: string | number
623
+ /** 错误扩展 */
624
+ innerError: {
625
+ /** 错误扩展码 */
626
+ errorCode: string | number
627
+ /** 错误扩展信息 */
628
+ errorMsg: string
629
+ }
630
+ }) => void
631
+ }): void
632
+
633
+ /**
634
+ * 获取设备增值服务能力
635
+ * @public
636
+ * @since OutdoorKit 1.1.0
637
+ * @platform iOS Android
638
+ */
639
+ export function getValueAddedServicesAbility(params: {
640
+ /**
641
+ * deviceID 设备ID
642
+ * @since OutdoorKit 1.1.0
643
+ */
644
+ deviceID: string
645
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
646
+ complete?: () => void
647
+ /** 接口调用成功的回调函数 */
648
+ success?: (params: {
649
+ /**
650
+ * 结果
651
+ * @since OutdoorKit 1.1.0
652
+ */
653
+ result: Record<any, any>
654
+ }) => void
655
+ /** 接口调用失败的回调函数 */
656
+ fail?: (params: {
657
+ /** 错误信息 */
658
+ errorMsg: string
659
+ /** 错误码 */
660
+ errorCode: string | number
661
+ /** 错误扩展 */
662
+ innerError: {
663
+ /** 错误扩展码 */
664
+ errorCode: string | number
665
+ /** 错误扩展信息 */
666
+ errorMsg: string
667
+ }
668
+ }) => void
669
+ }): void
670
+
671
+ /**
672
+ * 设置弹窗状态
673
+ * @public
674
+ * @since OutdoorKit 1.1.0
675
+ * @platform iOS Android
676
+ */
677
+ export function setValueAddedServicesPop(params: {
678
+ /**
679
+ * deviceID 设备ID
680
+ * @since OutdoorKit 1.1.0
681
+ */
682
+ deviceID: string
683
+ /**
684
+ * 是否已经弹窗过
685
+ * @since OutdoorKit 1.1.0
686
+ */
687
+ hadPopup: boolean
688
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
689
+ complete?: () => void
690
+ /** 接口调用成功的回调函数 */
691
+ success?: (params: boolean) => void
692
+ /** 接口调用失败的回调函数 */
693
+ fail?: (params: {
694
+ /** 错误信息 */
695
+ errorMsg: string
696
+ /** 错误码 */
697
+ errorCode: string | number
698
+ /** 错误扩展 */
699
+ innerError: {
700
+ /** 错误扩展码 */
701
+ errorCode: string | number
702
+ /** 错误扩展信息 */
703
+ errorMsg: string
704
+ }
705
+ }) => void
706
+ }): void
707
+
708
+ /**
709
+ * 获取感应解锁类型
710
+ * @public
711
+ * @since OutdoorKit 1.1.0
712
+ * @platform iOS Android
713
+ */
714
+ export function getInductiveUnlockType(params: {
715
+ /**
716
+ * 设备Mac地址
717
+ * @since OutdoorKit 1.1.0
718
+ */
719
+ deviceID: string
720
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
721
+ complete?: () => void
722
+ /** 接口调用成功的回调函数 */
723
+ success?: (params: {
724
+ /**
725
+ * 感应解锁类型 位移枚举转换 InductiveUnlockTypeBLEHID = 1 << 0, InductiveUnlockTypeBT = 1 << 1
726
+ * @since OutdoorKit 1.1.0
727
+ */
728
+ inductiveUnlockType: number
729
+ }) => void
730
+ /** 接口调用失败的回调函数 */
731
+ fail?: (params: {
732
+ /** 错误信息 */
733
+ errorMsg: string
734
+ /** 错误码 */
735
+ errorCode: string | number
736
+ /** 错误扩展 */
737
+ innerError: {
738
+ /** 错误扩展码 */
739
+ errorCode: string | number
740
+ /** 错误扩展信息 */
741
+ errorMsg: string
742
+ }
743
+ }) => void
744
+ }): void
745
+
746
+ /**
747
+ * 获取 HID 感应解锁 状态 true:开启 false:关闭
748
+ * @public
749
+ * @since OutdoorKit 1.1.0
750
+ * @platform iOS Android
751
+ */
752
+ export function getHIDInductiveUnlockStatus(params: {
753
+ /**
754
+ * 设备Mac地址
755
+ * @since OutdoorKit 1.1.0
756
+ */
757
+ deviceID: string
758
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
759
+ complete?: () => void
760
+ /** 接口调用成功的回调函数 */
761
+ success?: (params: boolean) => void
762
+ /** 接口调用失败的回调函数 */
763
+ fail?: (params: {
764
+ /** 错误信息 */
765
+ errorMsg: string
766
+ /** 错误码 */
767
+ errorCode: string | number
768
+ /** 错误扩展 */
769
+ innerError: {
770
+ /** 错误扩展码 */
771
+ errorCode: string | number
772
+ /** 错误扩展信息 */
773
+ errorMsg: string
774
+ }
775
+ }) => void
776
+ }): void
777
+
778
+ /**
779
+ * 获取 HID 感应解锁绑定状态 true:已绑定 false:未绑定
780
+ * @public
781
+ * @since OutdoorKit 1.1.0
782
+ * @platform iOS Android
783
+ */
784
+ export function getHIDInductiveUnlockBindStatus(params: {
785
+ /**
786
+ * 设备Mac地址
787
+ * @since OutdoorKit 1.1.0
788
+ */
789
+ deviceID: string
790
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
791
+ complete?: () => void
792
+ /** 接口调用成功的回调函数 */
793
+ success?: (params: boolean) => void
794
+ /** 接口调用失败的回调函数 */
795
+ fail?: (params: {
796
+ /** 错误信息 */
797
+ errorMsg: string
798
+ /** 错误码 */
799
+ errorCode: string | number
800
+ /** 错误扩展 */
801
+ innerError: {
802
+ /** 错误扩展码 */
803
+ errorCode: string | number
804
+ /** 错误扩展信息 */
805
+ errorMsg: string
806
+ }
807
+ }) => void
808
+ }): void
809
+
810
+ /**
811
+ * 开启 HID 感应解锁
812
+ * @public
813
+ * @since OutdoorKit 1.1.0
814
+ * @platform iOS Android
815
+ */
816
+ export function turnOnHIDInductiveUnlock(params: {
817
+ /**
818
+ * 设备Mac地址
819
+ * @since OutdoorKit 1.1.0
820
+ */
821
+ deviceID: string
822
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
823
+ complete?: () => void
824
+ /** 接口调用成功的回调函数 */
825
+ success?: (params: boolean) => void
826
+ /** 接口调用失败的回调函数 */
827
+ fail?: (params: {
828
+ /** 错误信息 */
829
+ errorMsg: string
830
+ /** 错误码 */
831
+ errorCode: string | number
832
+ /** 错误扩展 */
833
+ innerError: {
834
+ /** 错误扩展码 */
835
+ errorCode: string | number
836
+ /** 错误扩展信息 */
837
+ errorMsg: string
838
+ }
839
+ }) => void
840
+ }): void
841
+
842
+ /**
843
+ * 关闭 HID 感应解锁
844
+ * @public
845
+ * @since OutdoorKit 1.1.0
846
+ * @platform iOS Android
847
+ */
848
+ export function turnOffHIDInductiveUnlock(params: {
849
+ /**
850
+ * 设备Mac地址
851
+ * @since OutdoorKit 1.1.0
852
+ */
853
+ deviceID: string
854
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
855
+ complete?: () => void
856
+ /** 接口调用成功的回调函数 */
857
+ success?: (params: boolean) => void
858
+ /** 接口调用失败的回调函数 */
859
+ fail?: (params: {
860
+ /** 错误信息 */
861
+ errorMsg: string
862
+ /** 错误码 */
863
+ errorCode: string | number
864
+ /** 错误扩展 */
865
+ innerError: {
866
+ /** 错误扩展码 */
867
+ errorCode: string | number
868
+ /** 错误扩展信息 */
869
+ errorMsg: string
870
+ }
871
+ }) => void
872
+ }): void
873
+
874
+ /**
875
+ * HID 感应解锁 添加设防距离
876
+ * @public
877
+ * @since OutdoorKit 1.1.0
878
+ * @platform iOS Android
879
+ */
880
+ export function recordHIDInductiveUnlockFortifyDistance(params: {
881
+ /**
882
+ * 设备Mac地址
883
+ * @since OutdoorKit 1.1.0
884
+ */
885
+ deviceID: string
886
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
887
+ complete?: () => void
888
+ /** 接口调用成功的回调函数 */
889
+ success?: (params: boolean) => void
890
+ /** 接口调用失败的回调函数 */
891
+ fail?: (params: {
892
+ /** 错误信息 */
893
+ errorMsg: string
894
+ /** 错误码 */
895
+ errorCode: string | number
896
+ /** 错误扩展 */
897
+ innerError: {
898
+ /** 错误扩展码 */
899
+ errorCode: string | number
900
+ /** 错误扩展信息 */
901
+ errorMsg: string
902
+ }
903
+ }) => void
904
+ }): void
905
+
906
+ /**
907
+ * HID 感应解锁 添加解防距离
908
+ * @public
909
+ * @since OutdoorKit 1.1.0
910
+ * @platform iOS Android
911
+ */
912
+ export function recordHIDInductiveUnlockDisarmDistance(params: {
913
+ /**
914
+ * 设备Mac地址
915
+ * @since OutdoorKit 1.1.0
916
+ */
917
+ deviceID: string
918
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
919
+ complete?: () => void
920
+ /** 接口调用成功的回调函数 */
921
+ success?: (params: boolean) => void
922
+ /** 接口调用失败的回调函数 */
923
+ fail?: (params: {
924
+ /** 错误信息 */
925
+ errorMsg: string
926
+ /** 错误码 */
927
+ errorCode: string | number
928
+ /** 错误扩展 */
929
+ innerError: {
930
+ /** 错误扩展码 */
931
+ errorCode: string | number
932
+ /** 错误扩展信息 */
933
+ errorMsg: string
934
+ }
935
+ }) => void
936
+ }): void
937
+
938
+ /**
939
+ * 获取 BT 感应解锁 配对状态
940
+ * @public
941
+ * @since OutdoorKit 1.1.0
942
+ * @platform iOS Android
943
+ */
944
+ export function getBTInductiveUnlockPairedStatus(params: {
945
+ /**
946
+ * 设备Mac地址
947
+ * @since OutdoorKit 1.1.0
948
+ */
949
+ deviceID: string
950
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
951
+ complete?: () => void
952
+ /** 接口调用成功的回调函数 */
953
+ success?: (params: boolean) => void
954
+ /** 接口调用失败的回调函数 */
955
+ fail?: (params: {
956
+ /** 错误信息 */
957
+ errorMsg: string
958
+ /** 错误码 */
959
+ errorCode: string | number
960
+ /** 错误扩展 */
961
+ innerError: {
962
+ /** 错误扩展码 */
963
+ errorCode: string | number
964
+ /** 错误扩展信息 */
965
+ errorMsg: string
966
+ }
967
+ }) => void
968
+ }): void
969
+
970
+ /**
971
+ * 开启 BT 感应解锁
972
+ * @public
973
+ * @since OutdoorKit 1.1.0
974
+ * @platform iOS Android
975
+ */
976
+ export function turnOnBTInductiveUnlock(params: {
977
+ /**
978
+ * 设备Mac地址
979
+ * @since OutdoorKit 1.1.0
980
+ */
981
+ deviceID: string
982
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
983
+ complete?: () => void
984
+ /** 接口调用成功的回调函数 */
985
+ success?: (params: boolean) => void
986
+ /** 接口调用失败的回调函数 */
987
+ fail?: (params: {
988
+ /** 错误信息 */
989
+ errorMsg: string
990
+ /** 错误码 */
991
+ errorCode: string | number
992
+ /** 错误扩展 */
993
+ innerError: {
994
+ /** 错误扩展码 */
995
+ errorCode: string | number
996
+ /** 错误扩展信息 */
997
+ errorMsg: string
998
+ }
999
+ }) => void
1000
+ }): void
1001
+
1002
+ /**
1003
+ * 关闭 BT 感应解锁
1004
+ * @public
1005
+ * @since OutdoorKit 1.1.0
1006
+ * @platform iOS Android
1007
+ */
1008
+ export function turnOffBTInductiveUnlock(params: {
1009
+ /**
1010
+ * 设备Mac地址
1011
+ * @since OutdoorKit 1.1.0
1012
+ */
1013
+ deviceID: string
1014
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1015
+ complete?: () => void
1016
+ /** 接口调用成功的回调函数 */
1017
+ success?: (params: boolean) => void
1018
+ /** 接口调用失败的回调函数 */
1019
+ fail?: (params: {
1020
+ /** 错误信息 */
1021
+ errorMsg: string
1022
+ /** 错误码 */
1023
+ errorCode: string | number
1024
+ /** 错误扩展 */
1025
+ innerError: {
1026
+ /** 错误扩展码 */
1027
+ errorCode: string | number
1028
+ /** 错误扩展信息 */
1029
+ errorMsg: string
1030
+ }
1031
+ }) => void
1032
+ }): void
1033
+
1034
+ /**
1035
+ * 设置 BT 感应解锁距离 1、2、3
1036
+ * @public
1037
+ * @since OutdoorKit 1.1.0
1038
+ * @platform iOS Android
1039
+ */
1040
+ export function setBTInductiveUnlockDistance(params: {
1041
+ /**
1042
+ * 设备 ID
1043
+ * @since OutdoorKit 1.1.0
1044
+ */
1045
+ deviceID: string
1046
+ /**
1047
+ * 距离 1、2、3
1048
+ * @since OutdoorKit 1.1.0
1049
+ */
1050
+ distance: number
1051
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1052
+ complete?: () => void
1053
+ /** 接口调用成功的回调函数 */
1054
+ success?: (params: boolean) => void
1055
+ /** 接口调用失败的回调函数 */
1056
+ fail?: (params: {
1057
+ /** 错误信息 */
1058
+ errorMsg: string
1059
+ /** 错误码 */
1060
+ errorCode: string | number
1061
+ /** 错误扩展 */
1062
+ innerError: {
1063
+ /** 错误扩展码 */
1064
+ errorCode: string | number
1065
+ /** 错误扩展信息 */
1066
+ errorMsg: string
1067
+ }
1068
+ }) => void
1069
+ }): void
1070
+
1071
+ /**
1072
+ * 获取 BT 感应解锁距离
1073
+ * @public
1074
+ * @since OutdoorKit 1.1.0
1075
+ * @platform iOS Android
1076
+ */
1077
+ export function getBTInductiveUnlockDistance(params: {
1078
+ /**
1079
+ * 设备Mac地址
1080
+ * @since OutdoorKit 1.1.0
1081
+ */
1082
+ deviceID: string
1083
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1084
+ complete?: () => void
1085
+ /** 接口调用成功的回调函数 */
1086
+ success?: (params: {
1087
+ /**
1088
+ * 设备 ID
1089
+ * @since OutdoorKit 1.1.0
1090
+ */
1091
+ deviceID: string
1092
+ /**
1093
+ * 距离 1、2、3
1094
+ * @since OutdoorKit 1.1.0
1095
+ */
1096
+ distance: number
1097
+ }) => void
1098
+ /** 接口调用失败的回调函数 */
1099
+ fail?: (params: {
1100
+ /** 错误信息 */
1101
+ errorMsg: string
1102
+ /** 错误码 */
1103
+ errorCode: string | number
1104
+ /** 错误扩展 */
1105
+ innerError: {
1106
+ /** 错误扩展码 */
1107
+ errorCode: string | number
1108
+ /** 错误扩展信息 */
1109
+ errorMsg: string
1110
+ }
1111
+ }) => void
1112
+ }): void
1113
+
1114
+ /**
1115
+ * 设备绑定
1116
+ * @public
1117
+ * @since OutdoorKit 1.1.0
1118
+ * @platform iOS Android
1119
+ */
1120
+ export function createBond(params: {
1121
+ /**
1122
+ * 设备Mac地址
1123
+ * @since OutdoorKit 1.1.0
1124
+ */
1125
+ deviceMac: string
1126
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1127
+ complete?: () => void
1128
+ /** 接口调用成功的回调函数 */
1129
+ success?: (params: boolean) => void
1130
+ /** 接口调用失败的回调函数 */
1131
+ fail?: (params: {
1132
+ /** 错误信息 */
1133
+ errorMsg: string
1134
+ /** 错误码 */
1135
+ errorCode: string | number
1136
+ /** 错误扩展 */
1137
+ innerError: {
1138
+ /** 错误扩展码 */
1139
+ errorCode: string | number
1140
+ /** 错误扩展信息 */
1141
+ errorMsg: string
1142
+ }
1143
+ }) => void
1144
+ }): void
1145
+
1146
+ /**
1147
+ * 移除绑定
1148
+ * @public
1149
+ * @since OutdoorKit 1.1.0
1150
+ * @platform iOS Android
1151
+ */
1152
+ export function removeBond(params: {
1153
+ /**
1154
+ * 设备Mac地址
1155
+ * @since OutdoorKit 1.1.0
1156
+ */
1157
+ deviceMac: string
1158
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1159
+ complete?: () => void
1160
+ /** 接口调用成功的回调函数 */
1161
+ success?: (params: boolean) => void
1162
+ /** 接口调用失败的回调函数 */
1163
+ fail?: (params: {
1164
+ /** 错误信息 */
1165
+ errorMsg: string
1166
+ /** 错误码 */
1167
+ errorCode: string | number
1168
+ /** 错误扩展 */
1169
+ innerError: {
1170
+ /** 错误扩展码 */
1171
+ errorCode: string | number
1172
+ /** 错误扩展信息 */
1173
+ errorMsg: string
1174
+ }
1175
+ }) => void
1176
+ }): void
1177
+
1178
+ /**
1179
+ * 是否已绑定
1180
+ * @public
1181
+ * @since OutdoorKit 1.1.0
1182
+ * @platform iOS Android
1183
+ */
1184
+ export function isBond(params: {
1185
+ /**
1186
+ * 设备Mac地址
1187
+ * @since OutdoorKit 1.1.0
1188
+ */
1189
+ deviceMac: string
1190
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1191
+ complete?: () => void
1192
+ /** 接口调用成功的回调函数 */
1193
+ success?: (params: boolean) => void
1194
+ /** 接口调用失败的回调函数 */
1195
+ fail?: (params: {
1196
+ /** 错误信息 */
1197
+ errorMsg: string
1198
+ /** 错误码 */
1199
+ errorCode: string | number
1200
+ /** 错误扩展 */
1201
+ innerError: {
1202
+ /** 错误扩展码 */
1203
+ errorCode: string | number
1204
+ /** 错误扩展信息 */
1205
+ errorMsg: string
1206
+ }
1207
+ }) => void
1208
+ }): void
1209
+
1210
+ /**
1211
+ * 注册当前设备监听
1212
+ * @public
1213
+ * @since OutdoorKit 1.1.8
1214
+ * @platform iOS Android
1215
+ */
1216
+ export function onRegisterCurrentDeviceChange(
1217
+ listener: (params: {
1218
+ /**
1219
+ * deviceID 设备ID
1220
+ * @since OutdoorKit 1.0.0
1221
+ */
1222
+ deviceID: string
1223
+ }) => void
1224
+ ): void
1225
+
1226
+ /**
1227
+ * 取消当前设备监听
1228
+ * @public
1229
+ * @since OutdoorKit 1.1.8
1230
+ * @platform iOS Android
1231
+ */
1232
+ export function offRegisterCurrentDeviceChange(
1233
+ listener: (params: {
1234
+ /**
1235
+ * deviceID 设备ID
1236
+ * @since OutdoorKit 1.0.0
1237
+ */
1238
+ deviceID: string
1239
+ }) => void
1240
+ ): void
1241
+
1242
+ /**
1243
+ * 注册扩展模块插拔状态监听
1244
+ * @public
1245
+ * @since OutdoorKit 1.1.6
1246
+ * @platform iOS Android
1247
+ */
1248
+ export function onRegisterExtModuleStatus(
1249
+ listener: (params: {
1250
+ /**
1251
+ * 设备ID
1252
+ * @since OutdoorKit 1.1.1
1253
+ */
1254
+ devID: string
1255
+ /**
1256
+ * 状态 1:插入模组
1257
+ * @since OutdoorKit 1.1.1
1258
+ */
1259
+ status: number
1260
+ }) => void
1261
+ ): void
1262
+
1263
+ /**
1264
+ * 取消扩展模块插拔状态监听
1265
+ * @public
1266
+ * @since OutdoorKit 1.1.6
1267
+ * @platform iOS Android
1268
+ */
1269
+ export function offRegisterExtModuleStatus(
1270
+ listener: (params: {
1271
+ /**
1272
+ * 设备ID
1273
+ * @since OutdoorKit 1.1.1
1274
+ */
1275
+ devID: string
1276
+ /**
1277
+ * 状态 1:插入模组
1278
+ * @since OutdoorKit 1.1.1
1279
+ */
1280
+ status: number
1281
+ }) => void
1282
+ ): void
1283
+
1284
+ /**
1285
+ * 设备
1286
+ * @since OutdoorKit 1.0.0
1287
+ */
1288
+ export interface DeviceInfoBean {
1289
+ /**
1290
+ * deviceID 设备ID
1291
+ * @since OutdoorKit 1.0.0
1292
+ */
1293
+ deviceID: string
1294
+ }
1295
+
1296
+ /**
1297
+ * 设备ID 列表 Bean
1298
+ * @since OutdoorKit 1.1.0
1299
+ */
1300
+ export interface DeviceIDListBean {
1301
+ /**
1302
+ * 设备ID列表
1303
+ * @since OutdoorKit 1.1.0
1304
+ */
1305
+ devIDList: string[]
1306
+ }
1307
+
1308
+ /**
1309
+ * 已绑定设备ID实体
1310
+ * @since OutdoorKit 1.0.1
1311
+ */
1312
+ export interface BoundDeviceIdListBean {
1313
+ /**
1314
+ * 返回已绑定的设备ID集合
1315
+ * @since OutdoorKit 1.0.1
1316
+ */
1317
+ devIdList: string[]
1318
+ }
1319
+
1320
+ /**
1321
+ * 可绑定设备ID实体
1322
+ * @since OutdoorKit 1.0.1
1323
+ */
1324
+ export interface UnBindDeviceIdListBean {
1325
+ /**
1326
+ * 返回可绑定的设备ID集合
1327
+ * @since OutdoorKit 1.0.1
1328
+ */
1329
+ devIdList: string[]
1330
+ }
1331
+
1332
+ /**
1333
+ * 主从一体
1334
+ * @since OutdoorKit 1.0.1
1335
+ */
1336
+ export interface MasterSlaveDevParams {
1337
+ /**
1338
+ * 从设备ID
1339
+ * @since OutdoorKit 1.0.1
1340
+ */
1341
+ slaveDevId: string
1342
+ /**
1343
+ * 主设备ID
1344
+ * @since OutdoorKit 1.0.1
1345
+ */
1346
+ masterDevId: string
1347
+ }
1348
+
1349
+ /**
1350
+ * 从设备绑定
1351
+ * @since OutdoorKit 1.0.1
1352
+ */
1353
+ export interface SlaveDevParams {
1354
+ /**
1355
+ * 从设备ID
1356
+ * @since OutdoorKit 1.0.1
1357
+ */
1358
+ devId: string
1359
+ }
1360
+
1361
+ /**
1362
+ * 表盘数据设置
1363
+ * @since OutdoorKit 1.0.1
1364
+ */
1365
+ export interface DialViewTagParams {
1366
+ /**
1367
+ * 表盘左侧
1368
+ * @since OutdoorKit 1.0.1
1369
+ */
1370
+ leftViewTag: string
1371
+ /**
1372
+ * 表盘中间数据
1373
+ * @since OutdoorKit 1.0.1
1374
+ */
1375
+ centerViewTag: string
1376
+ /**
1377
+ * 表盘右侧数据
1378
+ * @since OutdoorKit 1.0.1
1379
+ */
1380
+ rightViewTag: string
1381
+ }
1382
+
1383
+ /**
1384
+ * 骑行语音数据集合
1385
+ * @since OutdoorKit 1.0.1
1386
+ */
1387
+ export interface OdTtsTagParams {
1388
+ /**
1389
+ * 骑行数据播报总开关
1390
+ * @since OutdoorKit 1.0.1
1391
+ */
1392
+ ttsMainSwitch: boolean
1393
+ /**
1394
+ * 天气
1395
+ * @since OutdoorKit 1.0.1
1396
+ */
1397
+ weather: boolean
1398
+ /**
1399
+ * 骑行数据播报总开关
1400
+ * @since OutdoorKit 1.0.1
1401
+ */
1402
+ abnormalWear: boolean
1403
+ /**
1404
+ * 骑行里程
1405
+ * @since OutdoorKit 1.0.1
1406
+ */
1407
+ cyclingMileage: boolean
1408
+ /**
1409
+ * 低电量
1410
+ * @since OutdoorKit 1.0.1
1411
+ */
1412
+ lowBattery: boolean
1413
+ /**
1414
+ * 具体电量数值
1415
+ * @since OutdoorKit 1.0.1
1416
+ */
1417
+ electricThreshold: number
1418
+ /**
1419
+ * 骑行里程
1420
+ * @since OutdoorKit 1.0.1
1421
+ */
1422
+ callReminder: boolean
1423
+ }
1424
+
1425
+ /**
1426
+ * 扩展模组关联事件配置,在 IoT 平台配置
1427
+ * @since OutdoorKit 1.1.0
1428
+ */
1429
+ export interface ExtendedModuleExtConfig {
1430
+ /**
1431
+ * auto_active / manual_active
1432
+ * @since OutdoorKit 1.1.0
1433
+ */
1434
+ activeType: string
1435
+ /**
1436
+ * disabled / hide
1437
+ * @since OutdoorKit 1.1.0
1438
+ */
1439
+ interactionType: string
1440
+ /**
1441
+ * [dpID]
1442
+ * @since OutdoorKit 1.1.0
1443
+ */
1444
+ assocaitedDps: number[]
1445
+ }
1446
+
1447
+ /**
1448
+ * 字典类型 一般用于透传
1449
+ * @since OutdoorKit 1.1.0
1450
+ */
1451
+ export interface MapResponse {
1452
+ /**
1453
+ * 结果
1454
+ * @since OutdoorKit 1.1.0
1455
+ */
1456
+ result: Record<any, any>
1457
+ }
1458
+
1459
+ /**
1460
+ * Value-Added Services 弹窗设置
1461
+ * @since OutdoorKit 1.1.0
1462
+ */
1463
+ export interface ValueAddedServicePopInfoBean {
1464
+ /**
1465
+ * deviceID 设备ID
1466
+ * @since OutdoorKit 1.1.0
1467
+ */
1468
+ deviceID: string
1469
+ /**
1470
+ * 是否已经弹窗过
1471
+ * @since OutdoorKit 1.1.0
1472
+ */
1473
+ hadPopup: boolean
1474
+ }
1475
+
1476
+ /**
1477
+ * BLE+X 扩展模块状态回调
1478
+ * @since OutdoorKit 1.1.1
1479
+ */
1480
+ export interface ExtendedModuleChangeCB {
1481
+ /**
1482
+ * 设备ID
1483
+ * @since OutdoorKit 1.1.1
1484
+ */
1485
+ devID: string
1486
+ /**
1487
+ * 状态 1:插入模组
1488
+ * @since OutdoorKit 1.1.1
1489
+ */
1490
+ status: number
1491
+ }
1492
+
1493
+ /**
1494
+ * 设备信息
1495
+ * @since OutdoorKit 1.1.0
1496
+ */
1497
+ export interface DeviceBean {
1498
+ /**
1499
+ * 设备Mac地址
1500
+ * @since OutdoorKit 1.1.0
1501
+ */
1502
+ deviceID: string
1503
+ }
1504
+
1505
+ /**
1506
+ * InductiveUnlock 感应解锁
1507
+ * @since OutdoorKit 1.1.0
1508
+ */
1509
+ export interface InductiveUnlockBean {
1510
+ /**
1511
+ * 感应解锁类型 位移枚举转换 InductiveUnlockTypeBLEHID = 1 << 0, InductiveUnlockTypeBT = 1 << 1
1512
+ * @since OutdoorKit 1.1.0
1513
+ */
1514
+ inductiveUnlockType: number
1515
+ }
1516
+
1517
+ /**
1518
+ * 感应解锁距离信息
1519
+ * @since OutdoorKit 1.1.0
1520
+ */
1521
+ export interface InductiveUnlockDistanceBean {
1522
+ /**
1523
+ * 设备 ID
1524
+ * @since OutdoorKit 1.1.0
1525
+ */
1526
+ deviceID: string
1527
+ /**
1528
+ * 距离 1、2、3
1529
+ * @since OutdoorKit 1.1.0
1530
+ */
1531
+ distance: number
1532
+ }
1533
+
1534
+ /**
1535
+ * 设备信息
1536
+ * @since OutdoorKit 1.1.0
1537
+ */
1538
+ export interface DeviceInfo {
1539
+ /**
1540
+ * 设备Mac地址
1541
+ * @since OutdoorKit 1.1.0
1542
+ */
1543
+ deviceMac: string
1544
+ }
232
1545
  }