@ray-js/api 1.7.70 → 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,48 +1,253 @@
1
1
  /**
2
2
  * MapKit
3
3
  *
4
- * @version 3.4.13
4
+ * @version 7.8.2
5
5
  */
6
6
  declare namespace ty.map {
7
7
  /**
8
- * 更新地理围栏
9
- *权限: [scope.location]
8
+ * 是否开启地理围栏功能,与 NG 配置是否开启有关
9
+ * @public
10
+ * @since MapKit 3.9.1
11
+ * @platform iOS Android
10
12
  */
11
- export function updateGeofence(params: {
12
- /** 注册的地理围栏 */
13
- registerGeoFence: GeofenceInfo[]
14
- /** 取消的地理围栏 */
15
- unregisterGeoFence: GeofenceInfo[]
13
+ export function isSupport(params?: {
14
+ /**
15
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
16
+ * @since MapKit 3.9.1
17
+ */
18
+ businessType?: string
19
+ /**
20
+ * 该业务类型的附加数据
21
+ * @since MapKit 3.9.1
22
+ */
23
+ businessData?: Record<string, any>
24
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
16
25
  complete?: () => void
26
+ /** 接口调用成功的回调函数 */
17
27
  success?: (params: {
18
- /** 更新成功 */
19
- success?: boolean
28
+ /**
29
+ * 是否支持地理围栏
30
+ * @since MapKit 3.9.1
31
+ * @defaultValue false
32
+ */
33
+ isSupport?: boolean
20
34
  }) => void
35
+ /** 接口调用失败的回调函数 */
21
36
  fail?: (params: {
37
+ /** 错误信息 */
22
38
  errorMsg: string
39
+ /** 错误码 */
23
40
  errorCode: string | number
41
+ /** 错误扩展 */
24
42
  innerError: {
43
+ /** 错误扩展码 */
25
44
  errorCode: string | number
45
+ /** 错误扩展信息 */
26
46
  errorMsg: string
27
47
  }
28
48
  }) => void
29
49
  }): void
30
50
 
31
51
  /**
32
- * 地理围栏是否达到上限
33
- *权限: [scope.location]
52
+ * 地理围栏是否达到上限,不同手机系统限制数量不一样
53
+ * @public
54
+ * @since MapKit 3.9.1
55
+ * @platform iOS Android
34
56
  */
35
- export function isGeofenceReachLimit(params?: {
57
+ export function isReachLimit(params?: {
58
+ /**
59
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
60
+ * @since MapKit 3.9.1
61
+ */
62
+ businessType?: string
63
+ /**
64
+ * 该业务类型的附加数据
65
+ * @since MapKit 3.9.1
66
+ */
67
+ businessData?: Record<string, any>
68
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
36
69
  complete?: () => void
70
+ /** 接口调用成功的回调函数 */
37
71
  success?: (params: {
38
- /** 地理围栏是否达到上限 */
72
+ /**
73
+ * 地理围栏是否达到上限
74
+ * @since MapKit 3.9.1
75
+ * @defaultValue false
76
+ */
39
77
  reachLimit?: boolean
40
78
  }) => void
79
+ /** 接口调用失败的回调函数 */
80
+ fail?: (params: {
81
+ /** 错误信息 */
82
+ errorMsg: string
83
+ /** 错误码 */
84
+ errorCode: string | number
85
+ /** 错误扩展 */
86
+ innerError: {
87
+ /** 错误扩展码 */
88
+ errorCode: string | number
89
+ /** 错误扩展信息 */
90
+ errorMsg: string
91
+ }
92
+ }) => void
93
+ }): void
94
+
95
+ /**
96
+ * 打开地理围栏地图页面,获取地理围栏信息(新建或者编辑地理围栏)
97
+ * 权限: [scope.userLocationBackground] 没有权限时本方法会引导申请权限
98
+ * @public
99
+ * @since MapKit 3.9.1
100
+ * @platform iOS Android
101
+ */
102
+ export function openMap(params: {
103
+ /**
104
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
105
+ * @since MapKit 3.9.1
106
+ */
107
+ businessInfo?: GeofenceBusinessInfo
108
+ /**
109
+ * 地理围栏信息
110
+ * @since MapKit 3.9.1
111
+ */
112
+ info: GeofenceInfo
113
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
114
+ complete?: () => void
115
+ /** 接口调用成功的回调函数 */
116
+ success?: (params: {
117
+ /**
118
+ * 取消保存地理围栏
119
+ * @since MapKit 3.9.1
120
+ * @defaultValue false
121
+ */
122
+ isCancel?: boolean
123
+ /**
124
+ * 地理围栏信息
125
+ * @since MapKit 3.9.1
126
+ */
127
+ geofenceInfo: GeofenceInfo
128
+ }) => void
129
+ /** 接口调用失败的回调函数 */
130
+ fail?: (params: {
131
+ /** 错误信息 */
132
+ errorMsg: string
133
+ /** 错误码 */
134
+ errorCode: string | number
135
+ /** 错误扩展 */
136
+ innerError: {
137
+ /** 错误扩展码 */
138
+ errorCode: string | number
139
+ /** 错误扩展信息 */
140
+ errorMsg: string
141
+ }
142
+ }) => void
143
+ }): void
144
+
145
+ /**
146
+ * 注册地理围栏。当编辑地理围栏时,需要先 unregister 旧的地理围栏,再 register 新的地理围栏
147
+ * @public
148
+ * @since MapKit 3.9.1
149
+ * @platform iOS Android
150
+ */
151
+ export function register(params: {
152
+ /**
153
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
154
+ * @since MapKit 3.9.1
155
+ */
156
+ businessInfo?: GeofenceBusinessInfo
157
+ /**
158
+ * 地理围栏信息
159
+ * @since MapKit 3.9.1
160
+ */
161
+ info: GeofenceInfo
162
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
163
+ complete?: () => void
164
+ /** 接口调用成功的回调函数 */
165
+ success?: (params: null) => void
166
+ /** 接口调用失败的回调函数 */
167
+ fail?: (params: {
168
+ /** 错误信息 */
169
+ errorMsg: string
170
+ /** 错误码 */
171
+ errorCode: string | number
172
+ /** 错误扩展 */
173
+ innerError: {
174
+ /** 错误扩展码 */
175
+ errorCode: string | number
176
+ /** 错误扩展信息 */
177
+ errorMsg: string
178
+ }
179
+ }) => void
180
+ }): void
181
+
182
+ /**
183
+ * 取消地理围栏
184
+ * @public
185
+ * @since MapKit 3.9.1
186
+ * @platform iOS Android
187
+ */
188
+ export function unregister(params: {
189
+ /**
190
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
191
+ * @since MapKit 3.9.1
192
+ */
193
+ businessInfo?: GeofenceBusinessInfo
194
+ /**
195
+ * 地理围栏信息
196
+ * @since MapKit 3.9.1
197
+ */
198
+ info: GeofenceInfo
199
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
200
+ complete?: () => void
201
+ /** 接口调用成功的回调函数 */
202
+ success?: (params: null) => void
203
+ /** 接口调用失败的回调函数 */
204
+ fail?: (params: {
205
+ /** 错误信息 */
206
+ errorMsg: string
207
+ /** 错误码 */
208
+ errorCode: string | number
209
+ /** 错误扩展 */
210
+ innerError: {
211
+ /** 错误扩展码 */
212
+ errorCode: string | number
213
+ /** 错误扩展信息 */
214
+ errorMsg: string
215
+ }
216
+ }) => void
217
+ }): void
218
+
219
+ /**
220
+ * 更新地理围栏状态
221
+ * @public
222
+ * @since MapKit 3.9.8
223
+ * @platform iOS Android
224
+ */
225
+ export function changeGeofenceStatus(params: {
226
+ /**
227
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
228
+ * @since MapKit 3.9.8
229
+ */
230
+ businessInfo?: GeofenceBusinessInfo
231
+ /**
232
+ * 地理围栏信息
233
+ * @since MapKit 3.9.8
234
+ */
235
+ info: GeofenceInfo
236
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
237
+ complete?: () => void
238
+ /** 接口调用成功的回调函数 */
239
+ success?: (params: null) => void
240
+ /** 接口调用失败的回调函数 */
41
241
  fail?: (params: {
242
+ /** 错误信息 */
42
243
  errorMsg: string
244
+ /** 错误码 */
43
245
  errorCode: string | number
246
+ /** 错误扩展 */
44
247
  innerError: {
248
+ /** 错误扩展码 */
45
249
  errorCode: string | number
250
+ /** 错误扩展信息 */
46
251
  errorMsg: string
47
252
  }
48
253
  }) => void
@@ -50,32 +255,146 @@ declare namespace ty.map {
50
255
 
51
256
  /**
52
257
  * 取消地理围栏
53
- *权限: [scope.location]
258
+ * 权限: [scope.location]
259
+ * @public
260
+ * @since MapKit 3.0.1
261
+ * @platform iOS Android
262
+ * @deprecated unregister
54
263
  */
55
264
  export function unregisterGeofence(params?: {
56
- /** 地理围栏名称 */
265
+ /**
266
+ * 地理围栏名称
267
+ * @since MapKit 3.9.1
268
+ */
57
269
  geoTitle?: string
58
- /** 经度 */
270
+ /**
271
+ * 经度
272
+ * @since MapKit 3.9.1
273
+ * @defaultValue 0.0
274
+ */
59
275
  longitude?: number
60
- /** 纬度 */
276
+ /**
277
+ * 纬度
278
+ * @since MapKit 3.9.1
279
+ * @defaultValue 0.0
280
+ */
61
281
  latitude?: number
62
- /** 半径 */
282
+ /**
283
+ * 半径
284
+ * @since MapKit 3.9.1
285
+ * @defaultValue 0
286
+ */
63
287
  radius?: number
64
- /** id */
288
+ /**
289
+ * id
290
+ * @since MapKit 3.9.1
291
+ */
65
292
  geofenceId?: string
66
293
  /**
67
294
  * 半径
68
295
  * 0:进度地理围栏
69
296
  * 1:离开地理围栏
297
+ * @since MapKit 3.9.1
298
+ * @defaultValue 0
70
299
  */
71
300
  type?: number
301
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
72
302
  complete?: () => void
303
+ /** 接口调用成功的回调函数 */
73
304
  success?: (params: null) => void
305
+ /** 接口调用失败的回调函数 */
306
+ fail?: (params: {
307
+ /** 错误信息 */
308
+ errorMsg: string
309
+ /** 错误码 */
310
+ errorCode: string | number
311
+ /** 错误扩展 */
312
+ innerError: {
313
+ /** 错误扩展码 */
314
+ errorCode: string | number
315
+ /** 错误扩展信息 */
316
+ errorMsg: string
317
+ }
318
+ }) => void
319
+ }): void
320
+
321
+ /**
322
+ * 地理围栏是否达到上限
323
+ * 权限: [scope.location]
324
+ * @public
325
+ * @since MapKit 3.0.1
326
+ * @platform iOS Android
327
+ * @deprecated isReachLimit
328
+ */
329
+ export function isGeofenceReachLimit(params?: {
330
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
331
+ complete?: () => void
332
+ /** 接口调用成功的回调函数 */
333
+ success?: (params: {
334
+ /**
335
+ * 地理围栏是否达到上限
336
+ * @since MapKit 3.0.5
337
+ * @defaultValue false
338
+ */
339
+ reachLimit?: boolean
340
+ }) => void
341
+ /** 接口调用失败的回调函数 */
342
+ fail?: (params: {
343
+ /** 错误信息 */
344
+ errorMsg: string
345
+ /** 错误码 */
346
+ errorCode: string | number
347
+ /** 错误扩展 */
348
+ innerError: {
349
+ /** 错误扩展码 */
350
+ errorCode: string | number
351
+ /** 错误扩展信息 */
352
+ errorMsg: string
353
+ }
354
+ }) => void
355
+ }): void
356
+
357
+ /**
358
+ * 更新地理围栏
359
+ * 权限: [scope.location]
360
+ * @public
361
+ * @since MapKit 3.0.1
362
+ * @platform iOS Android
363
+ * @deprecated register
364
+ */
365
+ export function updateGeofence(params: {
366
+ /**
367
+ * 注册的地理围栏
368
+ * @since MapKit 3.0.1
369
+ */
370
+ registerGeoFence: GeofenceInfo[]
371
+ /**
372
+ * 取消的地理围栏
373
+ * @since MapKit 3.0.1
374
+ */
375
+ unregisterGeoFence: GeofenceInfo[]
376
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
377
+ complete?: () => void
378
+ /** 接口调用成功的回调函数 */
379
+ success?: (params: {
380
+ /**
381
+ * 更新成功
382
+ * @since MapKit 3.0.5
383
+ * @defaultValue false
384
+ */
385
+ success?: boolean
386
+ }) => void
387
+ /** 接口调用失败的回调函数 */
74
388
  fail?: (params: {
389
+ /** 错误信息 */
75
390
  errorMsg: string
391
+ /** 错误码 */
76
392
  errorCode: string | number
393
+ /** 错误扩展 */
77
394
  innerError: {
395
+ /** 错误扩展码 */
78
396
  errorCode: string | number
397
+ /** 错误扩展信息 */
79
398
  errorMsg: string
80
399
  }
81
400
  }) => void
@@ -83,32 +402,64 @@ declare namespace ty.map {
83
402
 
84
403
  /**
85
404
  * 注册地理围栏
86
- *权限: [scope.location]
405
+ * 权限: [scope.location]
406
+ * @public
407
+ * @since MapKit 3.0.1
408
+ * @platform iOS Android
409
+ * @deprecated register
87
410
  */
88
411
  export function registerGeofence(params?: {
89
- /** 地理围栏名称 */
412
+ /**
413
+ * 地理围栏名称
414
+ * @since MapKit 3.9.1
415
+ */
90
416
  geoTitle?: string
91
- /** 经度 */
417
+ /**
418
+ * 经度
419
+ * @since MapKit 3.9.1
420
+ * @defaultValue 0.0
421
+ */
92
422
  longitude?: number
93
- /** 纬度 */
423
+ /**
424
+ * 纬度
425
+ * @since MapKit 3.9.1
426
+ * @defaultValue 0.0
427
+ */
94
428
  latitude?: number
95
- /** 半径 */
429
+ /**
430
+ * 半径
431
+ * @since MapKit 3.9.1
432
+ * @defaultValue 0
433
+ */
96
434
  radius?: number
97
- /** id */
435
+ /**
436
+ * id
437
+ * @since MapKit 3.9.1
438
+ */
98
439
  geofenceId?: string
99
440
  /**
100
441
  * 半径
101
442
  * 0:进度地理围栏
102
443
  * 1:离开地理围栏
444
+ * @since MapKit 3.9.1
445
+ * @defaultValue 0
103
446
  */
104
447
  type?: number
448
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
105
449
  complete?: () => void
450
+ /** 接口调用成功的回调函数 */
106
451
  success?: (params: null) => void
452
+ /** 接口调用失败的回调函数 */
107
453
  fail?: (params: {
454
+ /** 错误信息 */
108
455
  errorMsg: string
456
+ /** 错误码 */
109
457
  errorCode: string | number
458
+ /** 错误扩展 */
110
459
  innerError: {
460
+ /** 错误扩展码 */
111
461
  errorCode: string | number
462
+ /** 错误扩展信息 */
112
463
  errorMsg: string
113
464
  }
114
465
  }) => void
@@ -116,299 +467,691 @@ declare namespace ty.map {
116
467
 
117
468
  /**
118
469
  * 打开地理围栏地图页面,获取地理围栏信息(新建或者编辑地理围栏)
119
- *权限: [scope.location]
470
+ * 权限: [scope.location]
471
+ * @public
472
+ * @since MapKit 3.0.1
473
+ * @platform iOS Android
474
+ * @deprecated openMap
120
475
  */
121
476
  export function openGeofenceMap(params?: {
122
- /** 地理围栏名称 */
477
+ /**
478
+ * 地理围栏名称
479
+ * @since MapKit 3.9.1
480
+ */
123
481
  geoTitle?: string
124
- /** 经度 */
482
+ /**
483
+ * 经度
484
+ * @since MapKit 3.9.1
485
+ * @defaultValue 0.0
486
+ */
125
487
  longitude?: number
126
- /** 纬度 */
488
+ /**
489
+ * 纬度
490
+ * @since MapKit 3.9.1
491
+ * @defaultValue 0.0
492
+ */
127
493
  latitude?: number
128
- /** 半径 */
494
+ /**
495
+ * 半径
496
+ * @since MapKit 3.9.1
497
+ * @defaultValue 0
498
+ */
129
499
  radius?: number
130
- /** id */
500
+ /**
501
+ * id
502
+ * @since MapKit 3.9.1
503
+ */
131
504
  geofenceId?: string
132
505
  /**
133
506
  * 半径
134
507
  * 0:进度地理围栏
135
508
  * 1:离开地理围栏
509
+ * @since MapKit 3.9.1
510
+ * @defaultValue 0
136
511
  */
137
512
  type?: number
513
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
138
514
  complete?: () => void
515
+ /** 接口调用成功的回调函数 */
139
516
  success?: (params: null) => void
517
+ /** 接口调用失败的回调函数 */
140
518
  fail?: (params: {
519
+ /** 错误信息 */
141
520
  errorMsg: string
521
+ /** 错误码 */
142
522
  errorCode: string | number
523
+ /** 错误扩展 */
143
524
  innerError: {
525
+ /** 错误扩展码 */
144
526
  errorCode: string | number
527
+ /** 错误扩展信息 */
145
528
  errorMsg: string
146
529
  }
147
530
  }) => void
148
531
  }): void
149
532
 
150
533
  /**
151
- * 获取当前的地理位置、速度
534
+ * 获取当前地理位置和速度
535
+ * @public
536
+ * @since MapKit 1.0.6
537
+ * @platform iOS Android
152
538
  */
153
539
  export function getLocation(params: {
154
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标 */
540
+ /**
541
+ * wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标
542
+ * @since MapKit 1.0.6
543
+ */
155
544
  type: string
156
- /** 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 */
545
+ /**
546
+ * 传入true会返回高度信息。由于获取高度需要较高精度,会减慢接口响应速度。
547
+ * @since MapKit 1.0.6
548
+ */
157
549
  altitude: boolean
158
- /** 开启高精度定位 */
550
+ /**
551
+ * 开启高精度定位
552
+ * @since MapKit 1.0.6
553
+ */
159
554
  isHighAccuracy: boolean
160
- /** 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 */
555
+ /**
556
+ * 高精度定位超时时间(ms)。指定时间内返回最高精度,该值3000ms以上高精度定位才有效果。
557
+ * @since MapKit 1.0.6
558
+ */
161
559
  highAccuracyExpireTime: number
560
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
162
561
  complete?: () => void
562
+ /** 接口调用成功的回调函数 */
163
563
  success?: (params: {
164
- /** 纬度,范围为 -90~90,负数表示南纬 */
564
+ /**
565
+ * 纬度,范围 -90~90,负数表示南纬
566
+ * @since MapKit 3.0.5
567
+ */
165
568
  latitude: number
166
- /** 经度,范围为 -180~180,负数表示西经 */
569
+ /**
570
+ * 经度,范围 -180~180,负数表示西经
571
+ * @since MapKit 3.0.5
572
+ */
167
573
  longitude: number
168
- /** 速度,单位 m/s */
574
+ /**
575
+ * 速度,单位 m/s
576
+ * @since MapKit 3.0.5
577
+ */
169
578
  speed: number
170
- /** 位置的精确度 */
579
+ /**
580
+ * 定位精度
581
+ * @since MapKit 3.0.5
582
+ */
171
583
  accuracy: number
172
- /** 高度,单位 m */
584
+ /**
585
+ * 海拔,单位 m
586
+ * @since MapKit 3.0.5
587
+ */
173
588
  altitude: number
174
- /** 垂直精度,单位 m(Android 无法获取,返回 0) */
589
+ /**
590
+ * 垂直精度,单位 m(Android无法获取,返回0)
591
+ * @since MapKit 3.0.5
592
+ */
175
593
  verticalAccuracy: number
176
- /** 水平精度,单位 m */
594
+ /**
595
+ * 水平精度,单位 m
596
+ * @since MapKit 3.0.5
597
+ */
177
598
  horizontalAccuracy: number
178
- /** 城市名称street */
599
+ /**
600
+ * 城市名称
601
+ * @since MapKit 3.0.5
602
+ */
179
603
  cityName: string
180
- /** 街道名称 */
604
+ /**
605
+ * 街道名称
606
+ * @since MapKit 3.0.5
607
+ */
181
608
  streetName: string
182
- /** 位置名称 */
609
+ /**
610
+ * 位置名称,历史上iOS返回Array类型,建议使用formatAddress字段
611
+ * @since MapKit 3.0.5
612
+ */
183
613
  address: string
184
- /** 国家码 */
614
+ /**
615
+ * 格式化地址
616
+ * @since MapKit 3.6.0
617
+ */
618
+ formatAddress: string
619
+ /**
620
+ * 国家代码
621
+ * @since MapKit 3.1.0
622
+ */
185
623
  countryCode: string
186
- /** 邮编 */
624
+ /**
625
+ * 邮政编码
626
+ * @since MapKit 3.1.0
627
+ */
187
628
  postalCode: string
188
- /** 国家名 */
629
+ /**
630
+ * 国家名称
631
+ * @since MapKit 3.1.1
632
+ */
189
633
  countryName: string
190
- /** 省名 */
634
+ /**
635
+ * 省份名称
636
+ * @since MapKit 3.1.1
637
+ */
191
638
  province: string
192
- /** 区名, 次级区域名 */
639
+ /**
640
+ * 区县名称,二级区域名称
641
+ * @since MapKit 3.1.1
642
+ */
193
643
  district: string
194
644
  }) => void
645
+ /** 接口调用失败的回调函数 */
195
646
  fail?: (params: {
647
+ /** 错误信息 */
196
648
  errorMsg: string
649
+ /** 错误码 */
197
650
  errorCode: string | number
651
+ /** 错误扩展 */
198
652
  innerError: {
653
+ /** 错误扩展码 */
199
654
  errorCode: string | number
655
+ /** 错误扩展信息 */
200
656
  errorMsg: string
201
657
  }
202
658
  }) => void
203
659
  }): void
204
660
 
205
661
  /**
206
- * 打开地图选择位置。
662
+ * 打开地图选择位置
663
+ * @public
664
+ * @since MapKit 1.0.6
665
+ * @platform iOS Android
207
666
  */
208
667
  export function chooseLocation(params?: {
209
- /** 目标地纬度 */
668
+ /**
669
+ * 目标纬度
670
+ * @since MapKit 1.0.6
671
+ */
210
672
  latitude?: number
211
- /** 目标地经度 */
673
+ /**
674
+ * 目标经度
675
+ * @since MapKit 1.0.6
676
+ */
212
677
  longitude?: number
678
+ /**
679
+ * 标题
680
+ * @since MapKit 7.4.0
681
+ */
682
+ title?: string
683
+ /**
684
+ * 详细描述文本
685
+ * @since MapKit 7.4.0
686
+ */
687
+ detailText?: string
688
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
213
689
  complete?: () => void
690
+ /** 接口调用成功的回调函数 */
214
691
  success?: (params: {
215
- /** 位置名称 */
692
+ /**
693
+ * 位置名称
694
+ * @since MapKit 3.0.5
695
+ */
216
696
  name: string
217
- /** 详细地址 */
697
+ /**
698
+ * 详细地址
699
+ * @since MapKit 3.0.5
700
+ */
218
701
  address: string
219
- /** 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 */
702
+ /**
703
+ * 纬度,浮点数,范围 -90~90,负数表示南纬。使用gcj02坐标系。
704
+ * @since MapKit 3.0.5
705
+ */
220
706
  latitude: number
221
- /** 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 */
707
+ /**
708
+ * 经度,浮点数,范围 -180~180,负数表示西经。使用gcj02坐标系。
709
+ * @since MapKit 3.0.5
710
+ */
222
711
  longitude: number
223
712
  }) => void
713
+ /** 接口调用失败的回调函数 */
224
714
  fail?: (params: {
715
+ /** 错误信息 */
225
716
  errorMsg: string
717
+ /** 错误码 */
226
718
  errorCode: string | number
719
+ /** 错误扩展 */
227
720
  innerError: {
721
+ /** 错误扩展码 */
228
722
  errorCode: string | number
723
+ /** 错误扩展信息 */
229
724
  errorMsg: string
230
725
  }
231
726
  }) => void
232
727
  }): void
233
728
 
234
729
  /**
235
- * 获取可跳转第三方地图的地图类型
730
+ * 获取可打开的第三方地图类型
731
+ * @public
732
+ * @since MapKit 2.1.0
733
+ * @platform iOS Android
236
734
  */
237
735
  export function getMapList(params?: {
736
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
238
737
  complete?: () => void
738
+ /** 接口调用成功的回调函数 */
239
739
  success?: (params: {
240
- /** 可跳转的地图厂商,目前支持:BMK:百度地图 MA:高德地图 TENCENT:腾讯地图 Google:Google地图 */
740
+ /**
741
+ * 支持的地图厂商,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
742
+ * @since MapKit 3.0.5
743
+ */
241
744
  maps: string[]
242
745
  }) => void
746
+ /** 接口调用失败的回调函数 */
243
747
  fail?: (params: {
748
+ /** 错误信息 */
244
749
  errorMsg: string
750
+ /** 错误码 */
245
751
  errorCode: string | number
752
+ /** 错误扩展 */
246
753
  innerError: {
754
+ /** 错误扩展码 */
247
755
  errorCode: string | number
756
+ /** 错误扩展信息 */
248
757
  errorMsg: string
249
758
  }
250
759
  }) => void
251
760
  }): void
252
761
 
253
762
  /**
254
- * 使用三方地图查看位置
763
+ * 使用第三方地图查看位置
764
+ * @public
765
+ * @since MapKit 2.1.0
766
+ * @platform iOS Android
255
767
  */
256
768
  export function openMapAppLocation(params: {
257
- /** 纬度,范围为 -90~90,负数表示南纬 */
769
+ /**
770
+ * 纬度,范围 -90~90,负数表示南纬
771
+ * @since MapKit 2.1.0
772
+ */
258
773
  latitude: number
259
- /** 经度,范围为 -180~180,负数表示西经 */
774
+ /**
775
+ * 经度,范围 -180~180,负数表示西经
776
+ * @since MapKit 2.1.0
777
+ */
260
778
  longitude: number
261
- /** 位置名 */
779
+ /**
780
+ * 位置名称
781
+ * @since MapKit 2.1.0
782
+ */
262
783
  name: string
263
- /** 地址的详细说明 */
784
+ /**
785
+ * 地址详细描述
786
+ * @since MapKit 2.1.0
787
+ */
264
788
  address: string
265
- /** 地图类型,目前支持:BMK:百度地图 MA:高德地图 TENCENT:腾讯地图 Google:Google地图 */
789
+ /**
790
+ * 地图类型,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
791
+ * @since MapKit 2.1.0
792
+ */
793
+ mapType: string
794
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
795
+ complete?: () => void
796
+ /** 接口调用成功的回调函数 */
797
+ success?: (params: null) => void
798
+ /** 接口调用失败的回调函数 */
799
+ fail?: (params: {
800
+ /** 错误信息 */
801
+ errorMsg: string
802
+ /** 错误码 */
803
+ errorCode: string | number
804
+ /** 错误扩展 */
805
+ innerError: {
806
+ /** 错误扩展码 */
807
+ errorCode: string | number
808
+ /** 错误扩展信息 */
809
+ errorMsg: string
810
+ }
811
+ }) => void
812
+ }): void
813
+
814
+ /**
815
+ * 使用第三方地图应用打开地图并导航到指定位置
816
+ * @public
817
+ * @since MapKit 7.4.0
818
+ * @platform iOS Android
819
+ */
820
+ export function openMapNavigation(params: {
821
+ /**
822
+ * 起始位置
823
+ * @since MapKit 7.4.0
824
+ */
825
+ startLocation: LocationInfo
826
+ /**
827
+ * 终点位置
828
+ * @since MapKit 7.4.0
829
+ */
830
+ endLocation: LocationInfo
831
+ /**
832
+ * 导航模式
833
+ * @since MapKit 7.5.8
834
+ */
835
+ navigationMode: string
836
+ /**
837
+ * 地图类型,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
838
+ * @since MapKit 7.4.0
839
+ */
266
840
  mapType: string
841
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
267
842
  complete?: () => void
843
+ /** 接口调用成功的回调函数 */
268
844
  success?: (params: null) => void
845
+ /** 接口调用失败的回调函数 */
269
846
  fail?: (params: {
847
+ /** 错误信息 */
270
848
  errorMsg: string
849
+ /** 错误码 */
271
850
  errorCode: string | number
851
+ /** 错误扩展 */
272
852
  innerError: {
853
+ /** 错误扩展码 */
273
854
  errorCode: string | number
855
+ /** 错误扩展信息 */
274
856
  errorMsg: string
275
857
  }
276
858
  }) => void
277
859
  }): void
278
860
 
279
861
  /**
280
- * 根据经纬度或者地址
862
+ * 转换经纬度或地址
863
+ * @public
864
+ * @since MapKit 3.2.2
865
+ * @platform iOS Android
281
866
  */
282
867
  export function transformLocation(params: {
283
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标 */
868
+ /**
869
+ * wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标
870
+ * @since MapKit 3.2.2
871
+ */
284
872
  type: string
285
- /** 纬度,范围为 -90~90,负数表示南纬 */
873
+ /**
874
+ * 纬度,范围 -90~90,负数表示南纬
875
+ * @since MapKit 3.2.2
876
+ */
286
877
  latitude: number
287
- /** 经度,范围为 -180~180,负数表示西经 */
878
+ /**
879
+ * 经度,范围 -180~180,负数表示西经
880
+ * @since MapKit 3.2.2
881
+ */
288
882
  longitude: number
883
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
289
884
  complete?: () => void
885
+ /** 接口调用成功的回调函数 */
290
886
  success?: (params: {
291
- /** 纬度,范围为 -90~90,负数表示南纬 */
887
+ /**
888
+ * 纬度,范围 -90~90,负数表示南纬
889
+ * @since MapKit 3.2.2
890
+ */
292
891
  latitude: number
293
- /** 经度,范围为 -180~180,负数表示西经 */
892
+ /**
893
+ * 经度,范围 -180~180,负数表示西经
894
+ * @since MapKit 3.2.2
895
+ */
294
896
  longitude: number
295
- /** 城市名称street */
897
+ /**
898
+ * 城市名称
899
+ * @since MapKit 3.2.2
900
+ */
296
901
  cityName: string
297
- /** 街道名称 */
902
+ /**
903
+ * 街道名称
904
+ * @since MapKit 3.2.2
905
+ */
298
906
  streetName: string
299
- /** 位置名称 */
907
+ /**
908
+ * 位置名称,历史上iOS返回Array类型,建议使用formatAddress字段
909
+ * @since MapKit 3.2.2
910
+ */
300
911
  address: string
301
- /** 国家码 */
912
+ /**
913
+ * 格式化地址
914
+ * @since MapKit 3.6.0
915
+ */
916
+ formatAddress: string
917
+ /**
918
+ * 国家代码
919
+ * @since MapKit 3.2.2
920
+ */
302
921
  countryCode: string
303
- /** 邮编 */
922
+ /**
923
+ * 邮政编码
924
+ * @since MapKit 3.2.2
925
+ */
304
926
  postalCode: string
305
- /** 国家名 */
927
+ /**
928
+ * 国家名称
929
+ * @since MapKit 3.2.2
930
+ */
306
931
  countryName: string
307
- /** 省名 */
932
+ /**
933
+ * 省份名称
934
+ * @since MapKit 3.2.2
935
+ */
308
936
  province: string
309
- /** 区名, 次级区域名 */
937
+ /**
938
+ * 区县名称,二级区域名称
939
+ * @since MapKit 3.2.2
940
+ */
310
941
  district: string
311
942
  }) => void
943
+ /** 接口调用失败的回调函数 */
312
944
  fail?: (params: {
945
+ /** 错误信息 */
313
946
  errorMsg: string
947
+ /** 错误码 */
314
948
  errorCode: string | number
949
+ /** 错误扩展 */
315
950
  innerError: {
951
+ /** 错误扩展码 */
316
952
  errorCode: string | number
953
+ /** 错误扩展信息 */
317
954
  errorMsg: string
318
955
  }
319
956
  }) => void
320
957
  }): void
321
958
 
322
959
  /**
323
- * 将经纬度转换为具体的地址
960
+ * 将经纬度转换为具体地址
961
+ * @public
962
+ * @since MapKit 3.4.13
963
+ * @platform iOS Android
324
964
  */
325
965
  export function reverseGeocodeLocation(params: {
326
- /** 经度 */
966
+ /**
967
+ * 经度
968
+ * @since MapKit 3.4.13
969
+ */
327
970
  longitude: number
328
- /** 纬度 */
971
+ /**
972
+ * 纬度
973
+ * @since MapKit 3.4.13
974
+ */
329
975
  latitude: number
330
- /** 请求的经纬度类型,wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标,默认为 wgs84 */
976
+ /**
977
+ * 请求坐标类型,wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标,默认为wgs84
978
+ * @since MapKit 3.4.13
979
+ * @defaultValue "wgs84"
980
+ */
331
981
  requestType?: string
332
- /** 响应的经纬度类型,wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标,默认为 wgs84 */
982
+ /**
983
+ * 响应坐标类型,wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标,默认为wgs84
984
+ * @since MapKit 3.4.13
985
+ * @defaultValue "wgs84"
986
+ */
333
987
  responseType?: string
988
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
334
989
  complete?: () => void
990
+ /** 接口调用成功的回调函数 */
335
991
  success?: (params: {
336
- /** 纬度,范围为 -90~90,负数表示南纬 */
992
+ /**
993
+ * 纬度,范围 -90~90,负数表示南纬
994
+ * @since MapKit 3.4.13
995
+ */
337
996
  latitude: number
338
- /** 经度,范围为 -180~180,负数表示西经 */
997
+ /**
998
+ * 经度,范围 -180~180,负数表示西经
999
+ * @since MapKit 3.4.13
1000
+ */
339
1001
  longitude: number
340
- /** 城市名称street */
1002
+ /**
1003
+ * 城市名称
1004
+ * @since MapKit 3.4.13
1005
+ */
341
1006
  cityName: string
342
- /** 街道名称 */
1007
+ /**
1008
+ * 街道名称
1009
+ * @since MapKit 3.4.13
1010
+ */
343
1011
  streetName: string
344
- /** 位置名称 */
1012
+ /**
1013
+ * 位置名称,历史上iOS返回Array类型,建议使用formatAddress字段
1014
+ * @since MapKit 3.4.13
1015
+ */
345
1016
  address: string
346
- /** 国家码 */
1017
+ /**
1018
+ * 格式化地址
1019
+ * @since MapKit 3.6.0
1020
+ */
1021
+ formatAddress: string
1022
+ /**
1023
+ * 国家代码
1024
+ * @since MapKit 3.4.13
1025
+ */
347
1026
  countryCode: string
348
- /** 邮编 */
1027
+ /**
1028
+ * 邮政编码
1029
+ * @since MapKit 3.4.13
1030
+ */
349
1031
  postalCode: string
350
- /** 国家名 */
1032
+ /**
1033
+ * 国家名称
1034
+ * @since MapKit 3.4.13
1035
+ */
351
1036
  countryName: string
352
- /** 省名 */
1037
+ /**
1038
+ * 省份名称
1039
+ * @since MapKit 3.4.13
1040
+ */
353
1041
  province: string
354
- /** 区名, 次级区域名 */
1042
+ /**
1043
+ * 区县名称,二级区域名称
1044
+ * @since MapKit 3.4.13
1045
+ */
355
1046
  district: string
356
1047
  }) => void
1048
+ /** 接口调用失败的回调函数 */
357
1049
  fail?: (params: {
1050
+ /** 错误信息 */
358
1051
  errorMsg: string
1052
+ /** 错误码 */
359
1053
  errorCode: string | number
1054
+ /** 错误扩展 */
360
1055
  innerError: {
1056
+ /** 错误扩展码 */
361
1057
  errorCode: string | number
1058
+ /** 错误扩展信息 */
362
1059
  errorMsg: string
363
1060
  }
364
1061
  }) => void
365
1062
  }): void
366
1063
 
367
1064
  /**
368
- * 将WGS84坐标系转为GCJ02坐标系
1065
+ * 将WGS84坐标系转换为GCJ02坐标系
1066
+ * @public
1067
+ * @since MapKit 3.4.13
1068
+ * @platform iOS Android
369
1069
  */
370
1070
  export function coordinateWGS84ToGCJ02(params: {
371
- /** 经度 */
1071
+ /**
1072
+ * 经度
1073
+ * @since MapKit 3.4.13
1074
+ */
372
1075
  longitude: number
373
- /** 纬度 */
1076
+ /**
1077
+ * 纬度
1078
+ * @since MapKit 3.4.13
1079
+ */
374
1080
  latitude: number
1081
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
375
1082
  complete?: () => void
1083
+ /** 接口调用成功的回调函数 */
376
1084
  success?: (params: {
377
- /** 经度 */
1085
+ /**
1086
+ * 经度
1087
+ * @since MapKit 3.4.13
1088
+ */
378
1089
  longitude: number
379
- /** 纬度 */
1090
+ /**
1091
+ * 纬度
1092
+ * @since MapKit 3.4.13
1093
+ */
380
1094
  latitude: number
381
1095
  }) => void
1096
+ /** 接口调用失败的回调函数 */
382
1097
  fail?: (params: {
1098
+ /** 错误信息 */
383
1099
  errorMsg: string
1100
+ /** 错误码 */
384
1101
  errorCode: string | number
1102
+ /** 错误扩展 */
385
1103
  innerError: {
1104
+ /** 错误扩展码 */
386
1105
  errorCode: string | number
1106
+ /** 错误扩展信息 */
387
1107
  errorMsg: string
388
1108
  }
389
1109
  }) => void
390
1110
  }): void
391
1111
 
392
1112
  /**
393
- * 将GCJ02坐标系转为WGS84坐标系
1113
+ * 将GCJ02坐标系转换为WGS84坐标系
1114
+ * @public
1115
+ * @since MapKit 3.4.13
1116
+ * @platform iOS Android
394
1117
  */
395
1118
  export function coordinateGCJ02ToWGS84(params: {
396
- /** 经度 */
1119
+ /**
1120
+ * 经度
1121
+ * @since MapKit 3.4.13
1122
+ */
397
1123
  longitude: number
398
- /** 纬度 */
1124
+ /**
1125
+ * 纬度
1126
+ * @since MapKit 3.4.13
1127
+ */
399
1128
  latitude: number
1129
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
400
1130
  complete?: () => void
1131
+ /** 接口调用成功的回调函数 */
401
1132
  success?: (params: {
402
- /** 经度 */
1133
+ /**
1134
+ * 经度
1135
+ * @since MapKit 3.4.13
1136
+ */
403
1137
  longitude: number
404
- /** 纬度 */
1138
+ /**
1139
+ * 纬度
1140
+ * @since MapKit 3.4.13
1141
+ */
405
1142
  latitude: number
406
1143
  }) => void
1144
+ /** 接口调用失败的回调函数 */
407
1145
  fail?: (params: {
1146
+ /** 错误信息 */
408
1147
  errorMsg: string
1148
+ /** 错误码 */
409
1149
  errorCode: string | number
1150
+ /** 错误扩展 */
410
1151
  innerError: {
1152
+ /** 错误扩展码 */
411
1153
  errorCode: string | number
1154
+ /** 错误扩展信息 */
412
1155
  errorMsg: string
413
1156
  }
414
1157
  }) => void
@@ -416,195 +1159,808 @@ declare namespace ty.map {
416
1159
 
417
1160
  /**
418
1161
  * 获取当前地图类型
419
- *huawei: 华为地图
420
- *google: 谷歌地图
421
- *amap: 高德地图
422
- *apple: 苹果地图
1162
+ * huawei: 华为地图
1163
+ * google: 谷歌地图
1164
+ * amap: 高德地图
1165
+ * apple: 苹果地图
1166
+ * @public
1167
+ * @since MapKit 3.4.13
1168
+ * @platform iOS Android
423
1169
  */
424
1170
  export function getMapType(params?: {
1171
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
425
1172
  complete?: () => void
1173
+ /** 接口调用成功的回调函数 */
426
1174
  success?: (params: {
427
- /** 地图类型 */
1175
+ /**
1176
+ * 地图类型
1177
+ * @since MapKit 3.4.13
1178
+ */
428
1179
  type: string
429
1180
  }) => void
1181
+ /** 接口调用失败的回调函数 */
430
1182
  fail?: (params: {
1183
+ /** 错误信息 */
431
1184
  errorMsg: string
1185
+ /** 错误码 */
432
1186
  errorCode: string | number
1187
+ /** 错误扩展 */
433
1188
  innerError: {
1189
+ /** 错误扩展码 */
434
1190
  errorCode: string | number
1191
+ /** 错误扩展信息 */
435
1192
  errorMsg: string
436
1193
  }
437
1194
  }) => void
438
1195
  }): void
439
1196
 
440
- export type GeofenceInfo = {
441
- /** 地理围栏名称 */
442
- geoTitle?: string
443
- /** 经度 */
444
- longitude?: number
445
- /** 纬度 */
446
- latitude?: number
447
- /** 半径 */
448
- radius?: number
449
- /** id */
450
- geofenceId?: string
1197
+ /**
1198
+ * 搜索地址(列表)
1199
+ * @public
1200
+ * @since MapKit 3.4.16
1201
+ * @platform iOS Android
1202
+ */
1203
+ export function searchAddressList(params: {
451
1204
  /**
452
- * 半径
453
- * 0:进度地理围栏
454
- * 1:离开地理围栏
1205
+ * 地图能力(Android only)
1206
+ * 0-高德
1207
+ * 1-Google
1208
+ * 2-mapbox
1209
+ * @since MapKit 3.4.16
1210
+ */
1211
+ type: number
1212
+ /**
1213
+ * 模糊搜索关键词 The search string that you want completions for.
1214
+ * @since MapKit 3.4.16
1215
+ */
1216
+ keyword: string
1217
+ /**
1218
+ * 当前城市名字-仅高德搜索需要
1219
+ * 传入""代表在全国进行检索,否则按照传入的city进行范围检索
1220
+ * @since MapKit 3.4.16
1221
+ * @defaultValue ""
1222
+ */
1223
+ city?: string
1224
+ /**
1225
+ * 限制搜索范围的国家代码-仅Google、MapBox地址搜索需要
1226
+ * ISO 3166-1 Alpha-2 国家/地区代码(不区分大小写)
1227
+ * 例如:中国CN、香港HK、台湾TW
1228
+ * @since MapKit 3.4.16
1229
+ */
1230
+ countryCode: string
1231
+ /**
1232
+ * 搜索中心点经纬度、搜索范围(IOS ONLY)设置
1233
+ * @since MapKit 3.4.16
1234
+ */
1235
+ region: CoordinateRegion
1236
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1237
+ complete?: () => void
1238
+ /** 接口调用成功的回调函数 */
1239
+ success?: (params: AddressInfo[]) => void
1240
+ /** 接口调用失败的回调函数 */
1241
+ fail?: (params: {
1242
+ /** 错误信息 */
1243
+ errorMsg: string
1244
+ /** 错误码 */
1245
+ errorCode: string | number
1246
+ /** 错误扩展 */
1247
+ innerError: {
1248
+ /** 错误扩展码 */
1249
+ errorCode: string | number
1250
+ /** 错误扩展信息 */
1251
+ errorMsg: string
1252
+ }
1253
+ }) => void
1254
+ }): void
1255
+
1256
+ /**
1257
+ * 获取地址详细信息
1258
+ * @public
1259
+ * @since MapKit 3.4.16
1260
+ * @platform iOS Android
1261
+ */
1262
+ export function getAddressInfo(params: {
1263
+ /**
1264
+ * 地址 POI ID
1265
+ * @since MapKit 3.4.16
1266
+ */
1267
+ poiID: string
1268
+ /**
1269
+ * 地址名称
1270
+ * @since MapKit 3.4.16
1271
+ */
1272
+ name: string
1273
+ /**
1274
+ * 详细的地址信息
1275
+ * @since MapKit 3.4.16
1276
+ */
1277
+ address: string
1278
+ /**
1279
+ * 当前地址经纬度坐标
1280
+ * @since MapKit 3.4.16
1281
+ */
1282
+ coordinate2D: LocationCoordinate2D
1283
+ /** 接口调用结束的回调函数(调用成功、失败都会执行) */
1284
+ complete?: () => void
1285
+ /** 接口调用成功的回调函数 */
1286
+ success?: (params: {
1287
+ /**
1288
+ * 地址 POI ID
1289
+ * @since MapKit 3.4.16
1290
+ */
1291
+ poiID: string
1292
+ /**
1293
+ * 地址名称
1294
+ * @since MapKit 3.4.16
1295
+ */
1296
+ name: string
1297
+ /**
1298
+ * 详细的地址信息
1299
+ * @since MapKit 3.4.16
1300
+ */
1301
+ address: string
1302
+ /**
1303
+ * 当前地址经纬度坐标
1304
+ * @since MapKit 3.4.16
1305
+ */
1306
+ coordinate2D: LocationCoordinate2D
1307
+ }) => void
1308
+ /** 接口调用失败的回调函数 */
1309
+ fail?: (params: {
1310
+ /** 错误信息 */
1311
+ errorMsg: string
1312
+ /** 错误码 */
1313
+ errorCode: string | number
1314
+ /** 错误扩展 */
1315
+ innerError: {
1316
+ /** 错误扩展码 */
1317
+ errorCode: string | number
1318
+ /** 错误扩展信息 */
1319
+ errorMsg: string
1320
+ }
1321
+ }) => void
1322
+ }): void
1323
+
1324
+ /** @since MapKit 2.2.1 */
1325
+ export interface DiffLayerMap {
1326
+ /**
1327
+ * 当前组件类型
1328
+ * @since MapKit 2.2.1
1329
+ * @defaultValue 0
1330
+ */
1331
+ type?: number
1332
+ }
1333
+
1334
+ /** @since MapKit 3.9.1 */
1335
+ export interface GeofenceBusinessInfo {
1336
+ /**
1337
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
1338
+ * @since MapKit 3.9.1
1339
+ */
1340
+ businessType?: string
1341
+ /**
1342
+ * 该业务类型的附加数据
1343
+ * @since MapKit 3.9.1
1344
+ */
1345
+ businessData?: Record<string, any>
1346
+ }
1347
+
1348
+ /** @since MapKit 3.9.1 */
1349
+ export interface IsGeofenceSupportResponse {
1350
+ /**
1351
+ * 是否支持地理围栏
1352
+ * @since MapKit 3.9.1
1353
+ * @defaultValue false
1354
+ */
1355
+ isSupport?: boolean
1356
+ }
1357
+
1358
+ /** @since MapKit 3.0.1 */
1359
+ export interface IsGeofenceReachLimitResponse {
1360
+ /**
1361
+ * 地理围栏是否达到上限
1362
+ * @since MapKit 3.0.1
1363
+ * @defaultValue false
455
1364
  */
456
- type?: number
457
- }
458
-
459
- export type UpdateGeofenceParams = {
460
- /** 注册的地理围栏 */
461
- registerGeoFence: GeofenceInfo[]
462
- /** 取消的地理围栏 */
463
- unregisterGeoFence: GeofenceInfo[]
464
- }
465
-
466
- export type UpdateGeofenceResponse = {
467
- /** 更新成功 */
468
- success?: boolean
469
- }
470
-
471
- export type IsGeofenceReachLimitResponse = {
472
- /** 地理围栏是否达到上限 */
473
1365
  reachLimit?: boolean
474
1366
  }
475
1367
 
476
- export type LocationBean = {
477
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标 */
1368
+ /** @since MapKit 3.0.1 */
1369
+ export interface GeofenceInfo {
1370
+ /**
1371
+ * 地理围栏名称
1372
+ * @since MapKit 3.9.1
1373
+ */
1374
+ geoTitle?: string
1375
+ /**
1376
+ * 经度
1377
+ * @since MapKit 3.9.1
1378
+ * @defaultValue 0.0
1379
+ */
1380
+ longitude?: number
1381
+ /**
1382
+ * 纬度
1383
+ * @since MapKit 3.9.1
1384
+ * @defaultValue 0.0
1385
+ */
1386
+ latitude?: number
1387
+ /**
1388
+ * 半径
1389
+ * @since MapKit 3.9.1
1390
+ * @defaultValue 0
1391
+ */
1392
+ radius?: number
1393
+ /**
1394
+ * id
1395
+ * @since MapKit 3.9.1
1396
+ */
1397
+ geofenceId?: string
1398
+ /**
1399
+ * 半径
1400
+ * 0:进度地理围栏
1401
+ * 1:离开地理围栏
1402
+ * @since MapKit 3.9.1
1403
+ * @defaultValue 0
1404
+ */
1405
+ type?: number
1406
+ }
1407
+
1408
+ /** @since MapKit 3.9.1 */
1409
+ export interface Geofence {
1410
+ /**
1411
+ * 区分不同的地理围栏业务。空数据时默认为场景类型地理围栏 GeofenceBusinessType.Scene。
1412
+ * @since MapKit 3.9.1
1413
+ */
1414
+ businessInfo?: GeofenceBusinessInfo
1415
+ /**
1416
+ * 地理围栏信息
1417
+ * @since MapKit 3.9.1
1418
+ */
1419
+ info: GeofenceInfo
1420
+ }
1421
+
1422
+ /** @since MapKit 3.9.1 */
1423
+ export interface OpenMapResponse {
1424
+ /**
1425
+ * 取消保存地理围栏
1426
+ * @since MapKit 3.9.1
1427
+ * @defaultValue false
1428
+ */
1429
+ isCancel?: boolean
1430
+ /**
1431
+ * 地理围栏信息
1432
+ * @since MapKit 3.9.1
1433
+ */
1434
+ geofenceInfo: GeofenceInfo
1435
+ }
1436
+
1437
+ /** @since MapKit 3.0.1 */
1438
+ export interface UpdateGeofenceParams {
1439
+ /**
1440
+ * 注册的地理围栏
1441
+ * @since MapKit 3.0.1
1442
+ */
1443
+ registerGeoFence: GeofenceInfo[]
1444
+ /**
1445
+ * 取消的地理围栏
1446
+ * @since MapKit 3.0.1
1447
+ */
1448
+ unregisterGeoFence: GeofenceInfo[]
1449
+ }
1450
+
1451
+ /** @since MapKit 3.0.1 */
1452
+ export interface UpdateGeofenceResponse {
1453
+ /**
1454
+ * 更新成功
1455
+ * @since MapKit 3.0.1
1456
+ * @defaultValue false
1457
+ */
1458
+ success?: boolean
1459
+ }
1460
+
1461
+ /** @since MapKit 3.0.1 */
1462
+ export interface SupportGeofenceResponse {
1463
+ /**
1464
+ * 是否支持地理围栏
1465
+ * @since MapKit 3.0.1
1466
+ * @defaultValue false
1467
+ */
1468
+ isSupport?: boolean
1469
+ }
1470
+
1471
+ /** @since MapKit 3.9.8 */
1472
+ export enum GeofenceBusinessType {
1473
+ /**
1474
+ * 场景类型地理围栏
1475
+ * @since MapKit 3.9.8
1476
+ */
1477
+ Scene = "scene",
1478
+
1479
+ /**
1480
+ * 门锁场景地理围栏
1481
+ * @since MapKit 3.9.8
1482
+ */
1483
+ BleLockScene = "bleLockScene",
1484
+ }
1485
+
1486
+ /** @since MapKit 1.0.6 */
1487
+ export interface LocationBean {
1488
+ /**
1489
+ * wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标
1490
+ * @since MapKit 1.0.6
1491
+ */
478
1492
  type: string
479
- /** 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 */
1493
+ /**
1494
+ * 传入true会返回高度信息。由于获取高度需要较高精度,会减慢接口响应速度。
1495
+ * @since MapKit 1.0.6
1496
+ */
480
1497
  altitude: boolean
481
- /** 开启高精度定位 */
1498
+ /**
1499
+ * 开启高精度定位
1500
+ * @since MapKit 1.0.6
1501
+ */
482
1502
  isHighAccuracy: boolean
483
- /** 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 */
1503
+ /**
1504
+ * 高精度定位超时时间(ms)。指定时间内返回最高精度,该值3000ms以上高精度定位才有效果。
1505
+ * @since MapKit 1.0.6
1506
+ */
484
1507
  highAccuracyExpireTime: number
485
1508
  }
486
1509
 
487
- export type LocationCB = {
488
- /** 纬度,范围为 -90~90,负数表示南纬 */
1510
+ /** @since MapKit 1.0.6 */
1511
+ export interface LocationCB {
1512
+ /**
1513
+ * 纬度,范围 -90~90,负数表示南纬
1514
+ * @since MapKit 1.0.6
1515
+ */
489
1516
  latitude: number
490
- /** 经度,范围为 -180~180,负数表示西经 */
1517
+ /**
1518
+ * 经度,范围 -180~180,负数表示西经
1519
+ * @since MapKit 1.0.6
1520
+ */
491
1521
  longitude: number
492
- /** 速度,单位 m/s */
1522
+ /**
1523
+ * 速度,单位 m/s
1524
+ * @since MapKit 1.0.6
1525
+ */
493
1526
  speed: number
494
- /** 位置的精确度 */
1527
+ /**
1528
+ * 定位精度
1529
+ * @since MapKit 1.0.6
1530
+ */
495
1531
  accuracy: number
496
- /** 高度,单位 m */
1532
+ /**
1533
+ * 海拔,单位 m
1534
+ * @since MapKit 1.0.6
1535
+ */
497
1536
  altitude: number
498
- /** 垂直精度,单位 m(Android 无法获取,返回 0) */
1537
+ /**
1538
+ * 垂直精度,单位 m(Android无法获取,返回0)
1539
+ * @since MapKit 1.0.6
1540
+ */
499
1541
  verticalAccuracy: number
500
- /** 水平精度,单位 m */
1542
+ /**
1543
+ * 水平精度,单位 m
1544
+ * @since MapKit 1.0.6
1545
+ */
501
1546
  horizontalAccuracy: number
502
- /** 城市名称street */
1547
+ /**
1548
+ * 城市名称
1549
+ * @since MapKit 3.0.4
1550
+ */
503
1551
  cityName: string
504
- /** 街道名称 */
1552
+ /**
1553
+ * 街道名称
1554
+ * @since MapKit 3.0.4
1555
+ */
505
1556
  streetName: string
506
- /** 位置名称 */
1557
+ /**
1558
+ * 位置名称,历史上iOS返回Array类型,建议使用formatAddress字段
1559
+ * @since MapKit 3.0.4
1560
+ */
507
1561
  address: string
508
- /** 国家码 */
1562
+ /**
1563
+ * 格式化地址
1564
+ * @since MapKit 3.6.0
1565
+ */
1566
+ formatAddress: string
1567
+ /**
1568
+ * 国家代码
1569
+ * @since MapKit 3.1.0
1570
+ */
509
1571
  countryCode: string
510
- /** 邮编 */
1572
+ /**
1573
+ * 邮政编码
1574
+ * @since MapKit 3.1.0
1575
+ */
511
1576
  postalCode: string
512
- /** 国家名 */
1577
+ /**
1578
+ * 国家名称
1579
+ * @since MapKit 3.1.1
1580
+ */
513
1581
  countryName: string
514
- /** 省名 */
1582
+ /**
1583
+ * 省份名称
1584
+ * @since MapKit 3.1.1
1585
+ */
515
1586
  province: string
516
- /** 区名, 次级区域名 */
1587
+ /**
1588
+ * 区县名称,二级区域名称
1589
+ * @since MapKit 3.1.1
1590
+ */
517
1591
  district: string
518
1592
  }
519
1593
 
520
- export type ChooseBean = {
521
- /** 目标地纬度 */
1594
+ /** @since MapKit 1.0.6 */
1595
+ export interface ChooseBean {
1596
+ /**
1597
+ * 目标纬度
1598
+ * @since MapKit 1.0.6
1599
+ */
522
1600
  latitude?: number
523
- /** 目标地经度 */
1601
+ /**
1602
+ * 目标经度
1603
+ * @since MapKit 1.0.6
1604
+ */
524
1605
  longitude?: number
1606
+ /**
1607
+ * 标题
1608
+ * @since MapKit 7.4.0
1609
+ */
1610
+ title?: string
1611
+ /**
1612
+ * 详细描述文本
1613
+ * @since MapKit 7.4.0
1614
+ */
1615
+ detailText?: string
525
1616
  }
526
1617
 
527
- export type ChooseCB = {
528
- /** 位置名称 */
1618
+ /** @since MapKit 1.0.6 */
1619
+ export interface ChooseCB {
1620
+ /**
1621
+ * 位置名称
1622
+ * @since MapKit 1.0.6
1623
+ */
529
1624
  name: string
530
- /** 详细地址 */
1625
+ /**
1626
+ * 详细地址
1627
+ * @since MapKit 1.0.6
1628
+ */
531
1629
  address: string
532
- /** 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 */
1630
+ /**
1631
+ * 纬度,浮点数,范围 -90~90,负数表示南纬。使用gcj02坐标系。
1632
+ * @since MapKit 1.0.6
1633
+ */
533
1634
  latitude: number
534
- /** 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 */
1635
+ /**
1636
+ * 经度,浮点数,范围 -180~180,负数表示西经。使用gcj02坐标系。
1637
+ * @since MapKit 1.0.6
1638
+ */
535
1639
  longitude: number
536
1640
  }
537
1641
 
538
- export type MapsBean = {
539
- /** 可跳转的地图厂商,目前支持:BMK:百度地图 MA:高德地图 TENCENT:腾讯地图 Google:Google地图 */
1642
+ /** @since MapKit 2.1.0 */
1643
+ export interface MapsBean {
1644
+ /**
1645
+ * 支持的地图厂商,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
1646
+ * @since MapKit 2.1.0
1647
+ */
540
1648
  maps: string[]
541
1649
  }
542
1650
 
543
- export type OpenMapAppBean = {
544
- /** 纬度,范围为 -90~90,负数表示南纬 */
1651
+ /** @since MapKit 2.1.0 */
1652
+ export interface OpenMapAppBean {
1653
+ /**
1654
+ * 纬度,范围 -90~90,负数表示南纬
1655
+ * @since MapKit 2.1.0
1656
+ */
545
1657
  latitude: number
546
- /** 经度,范围为 -180~180,负数表示西经 */
1658
+ /**
1659
+ * 经度,范围 -180~180,负数表示西经
1660
+ * @since MapKit 2.1.0
1661
+ */
547
1662
  longitude: number
548
- /** 位置名 */
1663
+ /**
1664
+ * 位置名称
1665
+ * @since MapKit 2.1.0
1666
+ */
549
1667
  name: string
550
- /** 地址的详细说明 */
1668
+ /**
1669
+ * 地址详细描述
1670
+ * @since MapKit 2.1.0
1671
+ */
551
1672
  address: string
552
- /** 地图类型,目前支持:BMK:百度地图 MA:高德地图 TENCENT:腾讯地图 Google:Google地图 */
1673
+ /**
1674
+ * 地图类型,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
1675
+ * @since MapKit 2.1.0
1676
+ */
553
1677
  mapType: string
554
1678
  }
555
1679
 
556
- export type TransformLocationReq = {
557
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标 */
1680
+ /**
1681
+ * 位置信息
1682
+ * @since MapKit 7.4.0
1683
+ */
1684
+ export interface LocationInfo {
1685
+ /**
1686
+ * 纬度,范围 -90~90,负数表示南纬
1687
+ * @since MapKit 7.4.0
1688
+ */
1689
+ latitude: number
1690
+ /**
1691
+ * 经度,范围 -180~180,负数表示西经
1692
+ * @since MapKit 7.4.0
1693
+ */
1694
+ longitude: number
1695
+ /**
1696
+ * 当前点位置名称
1697
+ * @since MapKit 7.4.0
1698
+ */
1699
+ addressName: string
1700
+ }
1701
+
1702
+ /**
1703
+ * 使用第三方地图应用打开地图并导航到指定位置
1704
+ * @since MapKit 7.4.0
1705
+ */
1706
+ export interface OpenMapNavigationBean {
1707
+ /**
1708
+ * 起始位置
1709
+ * @since MapKit 7.4.0
1710
+ */
1711
+ startLocation: LocationInfo
1712
+ /**
1713
+ * 终点位置
1714
+ * @since MapKit 7.4.0
1715
+ */
1716
+ endLocation: LocationInfo
1717
+ /**
1718
+ * 导航模式
1719
+ * @since MapKit 7.5.8
1720
+ */
1721
+ navigationMode: string
1722
+ /**
1723
+ * 地图类型,目前支持:BMK: 百度地图, MA: 高德地图, TENCENT: 腾讯地图, Google: 谷歌地图
1724
+ * @since MapKit 7.4.0
1725
+ */
1726
+ mapType: string
1727
+ }
1728
+
1729
+ /** @since MapKit 3.2.2 */
1730
+ export interface TransformLocationReq {
1731
+ /**
1732
+ * wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标
1733
+ * @since MapKit 3.2.2
1734
+ */
558
1735
  type: string
559
- /** 纬度,范围为 -90~90,负数表示南纬 */
1736
+ /**
1737
+ * 纬度,范围 -90~90,负数表示南纬
1738
+ * @since MapKit 3.2.2
1739
+ */
560
1740
  latitude: number
561
- /** 经度,范围为 -180~180,负数表示西经 */
1741
+ /**
1742
+ * 经度,范围 -180~180,负数表示西经
1743
+ * @since MapKit 3.2.2
1744
+ */
562
1745
  longitude: number
563
1746
  }
564
1747
 
565
- export type TransformLocationResp = {
566
- /** 纬度,范围为 -90~90,负数表示南纬 */
1748
+ /** @since MapKit 3.2.2 */
1749
+ export interface TransformLocationResp {
1750
+ /**
1751
+ * 纬度,范围 -90~90,负数表示南纬
1752
+ * @since MapKit 3.2.2
1753
+ */
567
1754
  latitude: number
568
- /** 经度,范围为 -180~180,负数表示西经 */
1755
+ /**
1756
+ * 经度,范围 -180~180,负数表示西经
1757
+ * @since MapKit 3.2.2
1758
+ */
569
1759
  longitude: number
570
- /** 城市名称street */
1760
+ /**
1761
+ * 城市名称
1762
+ * @since MapKit 3.2.2
1763
+ */
571
1764
  cityName: string
572
- /** 街道名称 */
1765
+ /**
1766
+ * 街道名称
1767
+ * @since MapKit 3.2.2
1768
+ */
573
1769
  streetName: string
574
- /** 位置名称 */
1770
+ /**
1771
+ * 位置名称,历史上iOS返回Array类型,建议使用formatAddress字段
1772
+ * @since MapKit 3.2.2
1773
+ */
575
1774
  address: string
576
- /** 国家码 */
1775
+ /**
1776
+ * 格式化地址
1777
+ * @since MapKit 3.6.0
1778
+ */
1779
+ formatAddress: string
1780
+ /**
1781
+ * 国家代码
1782
+ * @since MapKit 3.2.2
1783
+ */
577
1784
  countryCode: string
578
- /** 邮编 */
1785
+ /**
1786
+ * 邮政编码
1787
+ * @since MapKit 3.2.2
1788
+ */
579
1789
  postalCode: string
580
- /** 国家名 */
1790
+ /**
1791
+ * 国家名称
1792
+ * @since MapKit 3.2.2
1793
+ */
581
1794
  countryName: string
582
- /** 省名 */
1795
+ /**
1796
+ * 省份名称
1797
+ * @since MapKit 3.2.2
1798
+ */
583
1799
  province: string
584
- /** 区名, 次级区域名 */
1800
+ /**
1801
+ * 区县名称,二级区域名称
1802
+ * @since MapKit 3.2.2
1803
+ */
585
1804
  district: string
586
1805
  }
587
1806
 
588
- export type ReverseGeocodeLocationReq = {
589
- /** 经度 */
1807
+ /** @since MapKit 3.4.13 */
1808
+ export interface ReverseGeocodeLocationReq {
1809
+ /**
1810
+ * 经度
1811
+ * @since MapKit 3.4.13
1812
+ */
590
1813
  longitude: number
591
- /** 纬度 */
1814
+ /**
1815
+ * 纬度
1816
+ * @since MapKit 3.4.13
1817
+ */
592
1818
  latitude: number
593
- /** 请求的经纬度类型,wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标,默认为 wgs84 */
1819
+ /**
1820
+ * 请求坐标类型,wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标,默认为wgs84
1821
+ * @since MapKit 3.4.13
1822
+ * @defaultValue "wgs84"
1823
+ */
594
1824
  requestType?: string
595
- /** 响应的经纬度类型,wgs84 返回 gps 坐标,gcj02 返回可用于 openLocation 的坐标,默认为 wgs84 */
1825
+ /**
1826
+ * 响应坐标类型,wgs84返回GPS坐标,gcj02返回可用于openLocation的坐标,默认为wgs84
1827
+ * @since MapKit 3.4.13
1828
+ * @defaultValue "wgs84"
1829
+ */
596
1830
  responseType?: string
597
1831
  }
598
1832
 
599
- export type Coordinate = {
600
- /** 经度 */
1833
+ /** @since MapKit 3.4.13 */
1834
+ export interface Coordinate {
1835
+ /**
1836
+ * 经度
1837
+ * @since MapKit 3.4.13
1838
+ */
601
1839
  longitude: number
602
- /** 纬度 */
1840
+ /**
1841
+ * 纬度
1842
+ * @since MapKit 3.4.13
1843
+ */
603
1844
  latitude: number
604
1845
  }
605
1846
 
606
- export type MapTypeBean = {
607
- /** 地图类型 */
1847
+ /** @since MapKit 3.4.13 */
1848
+ export interface MapTypeBean {
1849
+ /**
1850
+ * 地图类型
1851
+ * @since MapKit 3.4.13
1852
+ */
608
1853
  type: string
609
1854
  }
1855
+
1856
+ /** @since MapKit 1.0.6 */
1857
+ export interface LocationError {
1858
+ /**
1859
+ * 定位错误码
1860
+ * @since MapKit 1.0.6
1861
+ */
1862
+ errCode: number
1863
+ }
1864
+
1865
+ /** @since MapKit 1.0.6 */
1866
+ export interface OpenBean {
1867
+ /**
1868
+ * 纬度,范围 -90~90,负数表示南纬
1869
+ * @since MapKit 1.0.6
1870
+ */
1871
+ latitude: number
1872
+ /**
1873
+ * 经度,范围 -180~180,负数表示西经
1874
+ * @since MapKit 1.0.6
1875
+ */
1876
+ longitude: number
1877
+ /**
1878
+ * 缩放级别,范围 5~18
1879
+ * @since MapKit 1.0.6
1880
+ * @defaultValue 18
1881
+ */
1882
+ scale?: number
1883
+ /**
1884
+ * 位置名称
1885
+ * @since MapKit 1.0.6
1886
+ */
1887
+ name?: string
1888
+ /**
1889
+ * 地址详细描述
1890
+ * @since MapKit 1.0.6
1891
+ */
1892
+ address?: string
1893
+ }
1894
+
1895
+ /** @since MapKit 3.4.16 */
1896
+ export interface CoordinateRegion {}
1897
+
1898
+ /**
1899
+ * 地图搜索-参数配置
1900
+ * @since MapKit 3.4.16
1901
+ */
1902
+ export interface AddressRequestParams {
1903
+ /**
1904
+ * 地图能力(Android only)
1905
+ * 0-高德
1906
+ * 1-Google
1907
+ * 2-mapbox
1908
+ * @since MapKit 3.4.16
1909
+ */
1910
+ type: number
1911
+ /**
1912
+ * 模糊搜索关键词 The search string that you want completions for.
1913
+ * @since MapKit 3.4.16
1914
+ */
1915
+ keyword: string
1916
+ /**
1917
+ * 当前城市名字-仅高德搜索需要
1918
+ * 传入""代表在全国进行检索,否则按照传入的city进行范围检索
1919
+ * @since MapKit 3.4.16
1920
+ * @defaultValue ""
1921
+ */
1922
+ city?: string
1923
+ /**
1924
+ * 限制搜索范围的国家代码-仅Google、MapBox地址搜索需要
1925
+ * ISO 3166-1 Alpha-2 国家/地区代码(不区分大小写)
1926
+ * 例如:中国CN、香港HK、台湾TW
1927
+ * @since MapKit 3.4.16
1928
+ */
1929
+ countryCode: string
1930
+ /**
1931
+ * 搜索中心点经纬度、搜索范围(IOS ONLY)设置
1932
+ * @since MapKit 3.4.16
1933
+ */
1934
+ region: CoordinateRegion
1935
+ }
1936
+
1937
+ /** @since MapKit 3.4.16 */
1938
+ export interface LocationCoordinate2D {}
1939
+
1940
+ /**
1941
+ * 地址信息
1942
+ * @since MapKit 3.4.16
1943
+ */
1944
+ export interface AddressInfo {
1945
+ /**
1946
+ * 地址 POI ID
1947
+ * @since MapKit 3.4.16
1948
+ */
1949
+ poiID: string
1950
+ /**
1951
+ * 地址名称
1952
+ * @since MapKit 3.4.16
1953
+ */
1954
+ name: string
1955
+ /**
1956
+ * 详细的地址信息
1957
+ * @since MapKit 3.4.16
1958
+ */
1959
+ address: string
1960
+ /**
1961
+ * 当前地址经纬度坐标
1962
+ * @since MapKit 3.4.16
1963
+ */
1964
+ coordinate2D: LocationCoordinate2D
1965
+ }
610
1966
  }