js-apis-geolocation.md 54.3 KB
Newer Older
Z
zengyawen 已提交
1
# 位置服务
Z
zengyawen 已提交
2

3
位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。
Z
zengyawen 已提交
4

zyjhandsome's avatar
zyjhandsome 已提交
5
> **说明:**
Z
zengyawen 已提交
6
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
7
> 从API Version 9开始,该接口不再维护,推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

## 申请权限

应用在使用系统能力前,需要检查是否已经获取用户授权访问设备位置信息。如未获得授权,可以向用户申请需要的位置权限,申请方式请参考下文。

系统提供的定位权限有:
- ohos.permission.LOCATION

- ohos.permission.APPROXIMATELY_LOCATION

- ohos.permission.LOCATION_IN_BACKGROUND

访问设备的位置信息,必须申请权限,并且获得用户授权。

API9之前的版本,申请ohos.permission.LOCATION即可。

API9及之后的版本,需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION;无法单独申请ohos.permission.LOCATION。

| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 |
| -------- | -------- | -------- | -------- |
| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置,精准度在米级别。 |
| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置,精确度为5公里。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置,精准度在米级别。 |

如果应用在后台运行时也需要访问设备位置,除需要将应用声明为允许后台运行外,还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限,这样应用在切入后台之后,系统可以继续上报位置信息。

开发者可以在应用配置文件中声明所需要的权限,具体可参考[授权申请指导](../../security/accesstoken-guidelines.md)

Z
zengyawen 已提交
37 38 39

## 导入模块

L
liu-binjun 已提交
40
```ts
Z
zengyawen 已提交
41 42 43
import geolocation from '@ohos.geolocation';
```

44
## geolocation.on('locationChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
45

L
liu-binjun 已提交
46
on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void
Z
zengyawen 已提交
47

L
liu-binjun 已提交
48
开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报,
Z
zengyawen 已提交
49

50 51 52
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。

L
liu-binjun 已提交
53 54 55 56
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

57
**参数:**
L
liu-binjun 已提交
58

59
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
60
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
61
  | type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
L
liu-binjun 已提交
62
  | request |  [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 |
Z
zengyawen 已提交
63
  | callback | Callback&lt;[Location](#location)&gt; | 是 | 接收位置变化状态变化监听。 |
zyjhandsome's avatar
zyjhandsome 已提交
64

Z
zengyawen 已提交
65

L
liu-binjun 已提交
66

L
liu-binjun 已提交
67
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
68

L
liu-binjun 已提交
69 70
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
71 72 73 74 75 76 77 78
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
  geolocation.on('locationChange', requestInfo, locationChange);
  ```


79
## geolocation.off('locationChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
80

L
liu-binjun 已提交
81
off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
Z
zengyawen 已提交
82 83 84

关闭位置变化订阅,并删除对应的定位请求。

85 86 87
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。

L
liu-binjun 已提交
88 89 90 91
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

92
**参数:**
L
liu-binjun 已提交
93

94
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
95
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
96
  | type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
97
  | callback | Callback&lt;[Location](#location)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
Z
zengyawen 已提交
98

L
liu-binjun 已提交
99

L
liu-binjun 已提交
100
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
101

L
liu-binjun 已提交
102 103
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
104 105 106 107 108 109 110 111 112
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
  geolocation.on('locationChange', requestInfo, locationChange);
  geolocation.off('locationChange', locationChange);
  ```


113
## geolocation.on('locationServiceState')<sup>(deprecated) </sup>
Z
zengyawen 已提交
114

L
liu-binjun 已提交
115
on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
Z
zengyawen 已提交
116 117 118

订阅位置服务状态变化。

119 120 121
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationenabledchange)替代。

L
liu-binjun 已提交
122 123 124 125
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

126
**参数:**
L
liu-binjun 已提交
127

128
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
129
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
130 131
  | type | string | 是 | 设置事件类型。type为“locationServiceState”,表示位置服务状态。 |
  | callback | Callback&lt;boolean&gt; | 是 | 接收位置服务状态变化监听。 |
Z
zengyawen 已提交
132

L
liu-binjun 已提交
133

L
liu-binjun 已提交
134
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
135

L
liu-binjun 已提交
136 137
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
138
  var locationServiceState = (state) => {
L
liu-binjun 已提交
139
      console.log('locationServiceState: ' + JSON.stringify(state));
Z
zengyawen 已提交
140 141 142 143 144
  }
  geolocation.on('locationServiceState', locationServiceState);
  ```


145
## geolocation.off('locationServiceState')<sup>(deprecated) </sup>
Z
zengyawen 已提交
146

L
liu-binjun 已提交
147
off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
Z
zengyawen 已提交
148 149 150

取消订阅位置服务状态变化。

151 152 153
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationenabledchange)替代。

L
liu-binjun 已提交
154 155 156 157
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
158 159
**参数**

160
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
161
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
162
  | type | string | 是 | 设置事件类型。type为“locationServiceState”,表示位置服务状态。 |
163
  | callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
Z
zengyawen 已提交
164

L
liu-binjun 已提交
165

L
liu-binjun 已提交
166
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
167

L
liu-binjun 已提交
168 169
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
170
  var locationServiceState = (state) => {
L
liu-binjun 已提交
171
      console.log('locationServiceState: state: ' + JSON.stringify(state));
Z
zengyawen 已提交
172 173 174 175 176 177
  }
  geolocation.on('locationServiceState', locationServiceState);
  geolocation.off('locationServiceState', locationServiceState);
  ```


178
## geolocation.on('cachedGnssLocationsReporting')<sup>(deprecated) </sup>
Z
zengyawen 已提交
179

L
liu-binjun 已提交
180
on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
Z
zengyawen 已提交
181 182 183

订阅缓存GNSS定位结果上报事件。

184 185 186 187
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.on('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroncachedgnsslocationschange)替代。

L
liu-binjun 已提交
188 189 190 191
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
192 193
**参数**

194
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
195
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
196
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。 |
L
liu-binjun 已提交
197
  | request |  [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
198
  | callback | Callback&lt;Array&lt;[Location](#location)&gt;&gt; | 是 | 接收GNSS缓存位置上报。 |
Z
zengyawen 已提交
199

L
liu-binjun 已提交
200

L
liu-binjun 已提交
201
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
202

L
liu-binjun 已提交
203 204
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
205
  var cachedLocationsCb = (locations) => {
L
liu-binjun 已提交
206
      console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
Z
zengyawen 已提交
207 208 209 210 211 212
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
  geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
  ```


213
## geolocation.off('cachedGnssLocationsReporting')<sup>(deprecated) </sup>
Z
zengyawen 已提交
214

L
liu-binjun 已提交
215
off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
Z
zengyawen 已提交
216 217 218

取消订阅缓存GNSS定位结果上报事件。

219 220 221 222
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.off('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroffcachedgnsslocationschange)替代。

L
liu-binjun 已提交
223 224 225 226
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
227 228
**参数**

229
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
230
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
231
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。 |
232
  | callback | Callback&lt;Array&lt;[Location](#location)&gt;&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
Z
zengyawen 已提交
233

L
liu-binjun 已提交
234

L
liu-binjun 已提交
235
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
236

L
liu-binjun 已提交
237 238
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
239
  var cachedLocationsCb = (locations) => {
L
liu-binjun 已提交
240
      console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
Z
zengyawen 已提交
241 242 243 244 245 246 247
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
  geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
  geolocation.off('cachedGnssLocationsReporting');
  ```


248
## geolocation.on('gnssStatusChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
249

L
liu-binjun 已提交
250
on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void;
Z
zengyawen 已提交
251 252 253

订阅GNSS卫星状态信息上报事件。

254 255 256 257
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.on('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageronsatellitestatuschange)替代。

L
liu-binjun 已提交
258 259 260 261
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
262 263
**参数**

264
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
265
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
266
  | type | string | 是 | 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。 |
L
liu-binjun 已提交
267
  | callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 是 | 接收GNSS卫星状态信息上报。 |
Z
zengyawen 已提交
268

L
liu-binjun 已提交
269

L
liu-binjun 已提交
270
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
271

L
liu-binjun 已提交
272 273
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
274
  var gnssStatusCb = (satelliteStatusInfo) => {
L
liu-binjun 已提交
275
      console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
Z
zengyawen 已提交
276 277 278 279 280
  }
  geolocation.on('gnssStatusChange', gnssStatusCb);
  ```


281
## geolocation.off('gnssStatusChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
282

L
liu-binjun 已提交
283
off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void;
Z
zengyawen 已提交
284 285 286

取消订阅GNSS卫星状态信息上报事件。

287 288 289 290
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.off('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffsatellitestatuschange)替代。

L
liu-binjun 已提交
291 292 293 294
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
295 296
**参数**

297
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
298
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
299
  | type | string | 是 | 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。 |
300
  | callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
Z
zengyawen 已提交
301

L
liu-binjun 已提交
302
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
303

L
liu-binjun 已提交
304 305
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
306
  var gnssStatusCb = (satelliteStatusInfo) => {
L
liu-binjun 已提交
307
      console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
Z
zengyawen 已提交
308 309 310 311 312 313
  }
  geolocation.on('gnssStatusChange', gnssStatusCb);
  geolocation.off('gnssStatusChange', gnssStatusCb);
  ```


314
## geolocation.on('nmeaMessageChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
315

L
liu-binjun 已提交
316
on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
Z
zengyawen 已提交
317 318 319

订阅GNSS NMEA信息上报事件。

320 321 322 323
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.on('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageronnmeamessage)替代。

L
liu-binjun 已提交
324 325 326 327
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
328 329
**参数**

330
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
331
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
332 333
  | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”,表示订阅GNSS&nbsp;NMEA信息上报。 |
  | callback | Callback&lt;string&gt; | 是 | 接收GNSS&nbsp;NMEA信息上报。 |
Z
zengyawen 已提交
334

L
liu-binjun 已提交
335

L
liu-binjun 已提交
336
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
337

L
liu-binjun 已提交
338 339
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
340
  var nmeaCb = (str) => {
L
liu-binjun 已提交
341
      console.log('nmeaMessageChange: ' + JSON.stringify(str));
Z
zengyawen 已提交
342 343 344 345 346
  }
  geolocation.on('nmeaMessageChange', nmeaCb );
  ```


347
## geolocation.off('nmeaMessageChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
348

L
liu-binjun 已提交
349
off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
Z
zengyawen 已提交
350 351 352

取消订阅GNSS NMEA信息上报事件。

353 354 355 356
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.off('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageroffnmeamessage)替代。

L
liu-binjun 已提交
357 358 359 360
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Gnss

L
liu-binjun 已提交
361 362
**参数**

363
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
364
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
365
  | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”,表示订阅GNSS&nbsp;NMEA信息上报。 |
366
  | callback | Callback&lt;string&gt; | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |
Z
zengyawen 已提交
367

L
liu-binjun 已提交
368

L
liu-binjun 已提交
369
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
370

L
liu-binjun 已提交
371 372
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
373
  var nmeaCb = (str) => {
L
liu-binjun 已提交
374
      console.log('nmeaMessageChange: ' + JSON.stringify(str));
Z
zengyawen 已提交
375 376 377 378 379 380
  }
  geolocation.on('nmeaMessageChange', nmeaCb);
  geolocation.off('nmeaMessageChange', nmeaCb);
  ```


381
## geolocation.on('fenceStatusChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
382

L
liu-binjun 已提交
383
on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
Z
zengyawen 已提交
384 385 386

添加一个围栏,并订阅地理围栏事件。

387 388 389 390
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.on('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanagerongnssfencestatuschange)替代。

L
liu-binjun 已提交
391 392 393 394
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geofence

L
liu-binjun 已提交
395 396
**参数**

397
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
398
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
399
  | type | string | 是 | 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。 |
L
liu-binjun 已提交
400
  | request |  [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
Z
zengyawen 已提交
401
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
Z
zengyawen 已提交
402

L
liu-binjun 已提交
403

L
liu-binjun 已提交
404
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
405

L
liu-binjun 已提交
406
  ```ts
L
liu-binjun 已提交
407 408 409 410
  import geolocation from '@ohos.geolocation';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
Z
zengyawen 已提交
411 412
      wants: [
          {
L
liu-binjun 已提交
413
              bundleName: "com.example.myapplication",
414
              abilityName: "EntryAbility",
Z
zengyawen 已提交
415 416 417
              action: "action1",
          }
      ],
L
liu-binjun 已提交
418
      operationType: wantAgent.OperationType.START_ABILITY,
Z
zengyawen 已提交
419
      requestCode: 0,
L
liu-binjun 已提交
420
      wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
L
liu-binjun 已提交
421 422 423 424 425 426
  };
  
  wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
    geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
  });
Z
zengyawen 已提交
427 428 429
  ```


430
## geolocation.off('fenceStatusChange')<sup>(deprecated) </sup>
Z
zengyawen 已提交
431

L
liu-binjun 已提交
432
off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
Z
zengyawen 已提交
433 434 435

删除一个围栏,并取消订阅该围栏事件。

436 437 438 439
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.off('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffgnssfencestatuschange)替代。

L
liu-binjun 已提交
440 441 442 443
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geofence

L
liu-binjun 已提交
444 445
**参数**

446
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
447
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
448
  | type | string | 是 | 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。 |
L
liu-binjun 已提交
449
  | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
Z
zengyawen 已提交
450
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
Z
zengyawen 已提交
451

L
liu-binjun 已提交
452
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
453

L
liu-binjun 已提交
454
  ```ts
L
liu-binjun 已提交
455 456 457 458
  import geolocation from '@ohos.geolocation';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
Z
zengyawen 已提交
459 460
      wants: [
          {
L
liu-binjun 已提交
461
              bundleName: "com.example.myapplication",
462
              abilityName: "EntryAbility",
Z
zengyawen 已提交
463 464 465
              action: "action1",
          }
      ],
L
liu-binjun 已提交
466
      operationType: wantAgent.OperationType.START_ABILITY,
Z
zengyawen 已提交
467
      requestCode: 0,
L
liu-binjun 已提交
468 469 470 471 472 473 474 475 476 477 478
      wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  
  wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
    geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
    geolocation.off('fenceStatusChange', requestInfo, wantAgentObj);
  });
  ```


479
## geolocation.getCurrentLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
480

L
liu-binjun 已提交
481
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
Z
zengyawen 已提交
482

483
获取当前位置,使用callback回调异步返回结果。
484

485 486 487
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。

L
liu-binjun 已提交
488 489 490
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core
Z
zengyawen 已提交
491

L
liu-binjun 已提交
492 493
**参数**

494
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
495
  | -------- | -------- | -------- | -------- |
496
  | request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 |
Z
zengyawen 已提交
497
  | callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
Z
zengyawen 已提交
498

L
liu-binjun 已提交
499
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
500

L
liu-binjun 已提交
501 502
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
503 504
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
  var locationChange = (err, location) => {
L
liu-binjun 已提交
505 506 507 508 509 510
      if (err) {
          console.log('locationChanger: err=' + JSON.stringify(err));
      }
      if (location) {
          console.log('locationChanger: location=' + JSON.stringify(location));
      }
Z
zengyawen 已提交
511 512
  };
  geolocation.getCurrentLocation(requestInfo, locationChange);
513 514 515
  ```


516
## geolocation.getCurrentLocation<sup>(deprecated) </sup>
517 518 519 520 521 522

getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void


获取当前位置,使用callback回调异步返回结果。

523 524 525
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。

526 527 528 529 530 531 532 533 534 535 536
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |

**示例**
zyjhandsome's avatar
zyjhandsome 已提交
537

538 539 540 541 542 543 544 545 546 547
  ```ts
  import geolocation from '@ohos.geolocation';
  var locationChange = (err, location) => {
      if (err) {
          console.log('locationChanger: err=' + JSON.stringify(err));
      }
      if (location) {
          console.log('locationChanger: location=' + JSON.stringify(location));
      }
  };
Z
zengyawen 已提交
548 549 550 551
  geolocation.getCurrentLocation(locationChange);
  ```


552
## geolocation.getCurrentLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
553

L
liu-binjun 已提交
554
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
Z
zengyawen 已提交
555

556
获取当前位置,使用Promise方式异步返回结果。
557

558 559 560
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation-2)替代。

L
liu-binjun 已提交
561 562 563
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core
Z
zengyawen 已提交
564

L
liu-binjun 已提交
565 566
**参数**

567
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
568
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
569
  | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
Z
zengyawen 已提交
570

L
liu-binjun 已提交
571 572
**返回值**

573 574 575
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;[Location](#location)&gt; |[Location](#location)|NA| 返回位置信息。 |
Z
zengyawen 已提交
576

L
liu-binjun 已提交
577

L
liu-binjun 已提交
578
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
579

L
liu-binjun 已提交
580 581
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
582
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
L
liu-binjun 已提交
583
  geolocation.getCurrentLocation(requestInfo).then((result) => {
Z
zengyawen 已提交
584 585 586 587 588
      console.log('current location: ' + JSON.stringify(result));
  });
  ```


589
## geolocation.getLastLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
590

L
liu-binjun 已提交
591
getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
Z
zengyawen 已提交
592 593 594

获取上一次位置,使用callback回调异步返回结果。

595 596 597
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。

L
liu-binjun 已提交
598 599 600 601
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
602 603
**参数**

604
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
605
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
606
  | callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收上次位置的回调。 |
Z
zengyawen 已提交
607

L
liu-binjun 已提交
608

L
liu-binjun 已提交
609
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
610

L
liu-binjun 已提交
611 612
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
613
  geolocation.getLastLocation((err, data) => {
L
liu-binjun 已提交
614 615 616 617 618 619
      if (err) {
          console.log('getLastLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getLastLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
620 621 622 623
  });
  ```


624
## geolocation.getLastLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
625

L
liu-binjun 已提交
626
getLastLocation(): Promise&lt;Location&gt;
Z
zengyawen 已提交
627 628 629

获取上一次位置,使用Promise方式异步返回结果。

630 631 632
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。

L
liu-binjun 已提交
633 634 635 636
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
637 638
**返回值**

639 640 641
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;[Location](#location)&gt; | [Location](#location)|NA|返回上次位置信息。 |
Z
zengyawen 已提交
642

L
liu-binjun 已提交
643

L
liu-binjun 已提交
644
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
645

L
liu-binjun 已提交
646 647
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
648 649 650 651 652 653
  geolocation.getLastLocation().then((result) => {
      console.log('getLastLocation: result: ' + JSON.stringify(result));
  });
  ```


654
## geolocation.isLocationEnabled<sup>(deprecated) </sup>
Z
zengyawen 已提交
655

L
liu-binjun 已提交
656
isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
Z
zengyawen 已提交
657

658
判断位置服务是否已经打开,使用callback回调异步返回结果。
659

660 661 662
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。

L
liu-binjun 已提交
663 664 665
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core
Z
zengyawen 已提交
666

L
liu-binjun 已提交
667 668
**参数**

669
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
670
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
671
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
Z
zengyawen 已提交
672

L
liu-binjun 已提交
673
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
674

L
liu-binjun 已提交
675 676
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
677
  geolocation.isLocationEnabled((err, data) => {
L
liu-binjun 已提交
678 679 680 681 682 683
      if (err) {
          console.log('isLocationEnabled: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('isLocationEnabled: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
684 685 686 687
  });
  ```


688
## geolocation.isLocationEnabled<sup>(deprecated) </sup>
Z
zengyawen 已提交
689

L
liu-binjun 已提交
690
isLocationEnabled(): Promise&lt;boolean&gt;
Z
zengyawen 已提交
691 692 693

判断位置服务是否已经开启,使用Promise方式异步返回结果。

694 695 696
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。

L
liu-binjun 已提交
697 698 699 700
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
701 702
**返回值**

703 704 705
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;boolean&gt; | boolean|NA|返回位置服务是否可用的状态。 |
Z
zengyawen 已提交
706

L
liu-binjun 已提交
707
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
708

L
liu-binjun 已提交
709 710
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
711
  geolocation.isLocationEnabled().then((result) => {
L
liu-binjun 已提交
712
      console.log('promise, isLocationEnabled: ' + JSON.stringify(result));
Z
zengyawen 已提交
713 714 715 716
  });
  ```


717
## geolocation.requestEnableLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
718

L
liu-binjun 已提交
719
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
Z
zengyawen 已提交
720

721
请求打开位置服务,使用callback回调异步返回结果。
722

723 724 725
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。

L
liu-binjun 已提交
726 727 728
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core
Z
zengyawen 已提交
729

L
liu-binjun 已提交
730 731
**参数**

732
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
733
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
734
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
Z
zengyawen 已提交
735

L
liu-binjun 已提交
736
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
737

L
liu-binjun 已提交
738 739
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
740
  geolocation.requestEnableLocation((err, data) => {
L
liu-binjun 已提交
741 742 743 744 745 746
      if (err) {
          console.log('requestEnableLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('requestEnableLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
747 748 749 750
  });
  ```


751
## geolocation.requestEnableLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
752

L
liu-binjun 已提交
753
requestEnableLocation(): Promise&lt;boolean&gt;
Z
zengyawen 已提交
754 755 756

请求打开位置服务,使用Promise方式异步返回结果。

757 758 759
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。

L
liu-binjun 已提交
760 761 762 763
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
764 765
**返回值**

766 767 768
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;boolean&gt; | boolean|NA|返回位置服务是否可用。 |
Z
zengyawen 已提交
769

L
liu-binjun 已提交
770
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
771

L
liu-binjun 已提交
772 773
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
774
  geolocation.requestEnableLocation().then((result) => {
L
liu-binjun 已提交
775
      console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
Z
zengyawen 已提交
776 777 778 779
  });
  ```


780
## geolocation.isGeoServiceAvailable<sup>(deprecated) </sup>
Z
zengyawen 已提交
781

L
liu-binjun 已提交
782
isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void
Z
zengyawen 已提交
783 784 785

判断(逆)地理编码服务状态,使用callback回调异步返回结果。

786 787 788
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。

L
liu-binjun 已提交
789 790 791 792
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder

L
liu-binjun 已提交
793 794
**参数**

795
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
796
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
797
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收地理编码服务状态的回调。 |
Z
zengyawen 已提交
798

L
liu-binjun 已提交
799
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
800

L
liu-binjun 已提交
801 802
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
803
  geolocation.isGeoServiceAvailable((err, data) => {
L
liu-binjun 已提交
804 805 806 807 808 809
      if (err) {
          console.log('isGeoServiceAvailable: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('isGeoServiceAvailable: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
810 811 812 813
  });
  ```


814
## geolocation.isGeoServiceAvailable<sup>(deprecated) </sup>
Z
zengyawen 已提交
815

L
liu-binjun 已提交
816
isGeoServiceAvailable(): Promise&lt;boolean&gt;
Z
zengyawen 已提交
817 818 819

判断(逆)地理编码服务状态,使用Promise方式异步返回结果。

820 821 822
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。

L
liu-binjun 已提交
823 824 825 826
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder

L
liu-binjun 已提交
827 828
**返回值**

829 830 831
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;boolean&gt; |boolean|NA| 返回地理编码服务是否可用的状态。 |
Z
zengyawen 已提交
832

L
liu-binjun 已提交
833
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
834

L
liu-binjun 已提交
835 836
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
837
  geolocation.isGeoServiceAvailable().then((result) => {
L
liu-binjun 已提交
838
      console.log('promise, isGeoServiceAvailable: ' + JSON.stringify(result));
Z
zengyawen 已提交
839 840 841 842
  });
  ```


843
## geolocation.getAddressesFromLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
844

L
liu-binjun 已提交
845
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
Z
zengyawen 已提交
846 847 848

调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。

849 850 851
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation)替代。

L
liu-binjun 已提交
852 853 854 855
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder

L
liu-binjun 已提交
856 857
**参数**

858
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
859
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
860 861
  | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
  | callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 设置接收逆地理编码请求的回调参数。 |
Z
zengyawen 已提交
862

L
liu-binjun 已提交
863
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
864

L
liu-binjun 已提交
865 866
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
867 868
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
L
liu-binjun 已提交
869 870 871 872 873 874
      if (err) {
          console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
875 876 877 878
  });
  ```


879
## geolocation.getAddressesFromLocation<sup>(deprecated) </sup>
Z
zengyawen 已提交
880

L
liu-binjun 已提交
881
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;;
Z
zengyawen 已提交
882 883 884

调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。

885 886 887
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation-1)替代。

L
liu-binjun 已提交
888 889 890 891
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder

L
liu-binjun 已提交
892 893
**参数**

894
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
895
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
896
  | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
Z
zengyawen 已提交
897

L
liu-binjun 已提交
898 899
**返回值**

900 901 902
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt;|NA|返回地理描述信息。 |
Z
zengyawen 已提交
903

L
liu-binjun 已提交
904
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
905

L
liu-binjun 已提交
906 907
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
908 909 910 911 912 913 914
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
      console.log('getAddressesFromLocation: ' + JSON.stringify(data));
  });
  ```


915
## geolocation.getAddressesFromLocationName<sup>(deprecated) </sup>
Z
zengyawen 已提交
916

L
liu-binjun 已提交
917
getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
Z
zengyawen 已提交
918 919 920

调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。

921 922 923
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname)替代。

L
liu-binjun 已提交
924 925 926 927
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder

L
liu-binjun 已提交
928 929
**参数**

930
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
931
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
932 933
  | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
  | callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 设置接收地理编码请求的回调参数。 |
Z
zengyawen 已提交
934

L
liu-binjun 已提交
935
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
936

L
liu-binjun 已提交
937 938
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
939 940
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {
L
liu-binjun 已提交
941 942 943 944 945 946
      if (err) {
          console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
947 948 949 950
  });
  ```


951
## geolocation.getAddressesFromLocationName<sup>(deprecated) </sup>
Z
zengyawen 已提交
952

L
liu-binjun 已提交
953
getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
Z
zengyawen 已提交
954 955 956

调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。

957 958 959
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname-1)替代。

L
liu-binjun 已提交
960
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
961

L
liu-binjun 已提交
962
**系统能力**:SystemCapability.Location.Location.Geocoder
L
liu-binjun 已提交
963

L
liu-binjun 已提交
964 965
**参数**

966
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
967
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
968
  | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
Z
zengyawen 已提交
969

L
liu-binjun 已提交
970 971
**返回值**

972 973 974
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt;|NA|设置接收地理编码请求的回调参数。 |
Z
zengyawen 已提交
975

L
liu-binjun 已提交
976
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
977

L
liu-binjun 已提交
978 979
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
980 981 982 983 984 985 986
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => {
      console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
  });
  ```


987
## geolocation.getCachedGnssLocationsSize<sup>(deprecated) </sup>
Z
zengyawen 已提交
988

L
liu-binjun 已提交
989
getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
Z
zengyawen 已提交
990 991 992

获取GNSS芯片缓存位置的个数。

993 994 995 996
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize)替代。

L
liu-binjun 已提交
997
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
998

L
liu-binjun 已提交
999
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1000

L
liu-binjun 已提交
1001 1002
**参数**

1003
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1004
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1005
  | callback | AsyncCallback&lt;number&gt; | 是 | 用来接收GNSS芯片缓存位置个数的回调。 |
Z
zengyawen 已提交
1006

L
liu-binjun 已提交
1007
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1008

L
liu-binjun 已提交
1009 1010
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1011
  geolocation.getCachedGnssLocationsSize((err, size) => {
L
liu-binjun 已提交
1012 1013 1014 1015 1016 1017
      if (err) {
          console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
      }
      if (size) {
          console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
      }
Z
zengyawen 已提交
1018 1019 1020 1021
  });
  ```


1022
## geolocation.getCachedGnssLocationsSize<sup>(deprecated) </sup>
Z
zengyawen 已提交
1023

L
liu-binjun 已提交
1024
getCachedGnssLocationsSize(): Promise&lt;number&gt;;
Z
zengyawen 已提交
1025 1026 1027

获取GNSS芯片缓存位置的个数。

1028 1029 1030 1031
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize-1)替代。

L
liu-binjun 已提交
1032
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1033

L
liu-binjun 已提交
1034
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1035

L
liu-binjun 已提交
1036 1037
**返回值**

1038 1039 1040
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;number&gt; | number|NA|返回GNSS缓存位置的个数。 |
Z
zengyawen 已提交
1041

L
liu-binjun 已提交
1042
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1043

L
liu-binjun 已提交
1044 1045
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1046
  geolocation.getCachedGnssLocationsSize().then((result) => {
L
liu-binjun 已提交
1047
      console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
Z
zengyawen 已提交
1048 1049 1050 1051
  });
  ```


1052
## geolocation.flushCachedGnssLocations<sup>(deprecated) </sup>
Z
zengyawen 已提交
1053

L
liu-binjun 已提交
1054
flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
Z
zengyawen 已提交
1055 1056 1057

读取并清空GNSS芯片所有缓存位置。

1058 1059 1060 1061
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations)替代。

L
liu-binjun 已提交
1062
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1063

L
liu-binjun 已提交
1064
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1065

L
liu-binjun 已提交
1066 1067
**参数**

1068
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1069
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1070
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 |
Z
zengyawen 已提交
1071

L
liu-binjun 已提交
1072
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1073

L
liu-binjun 已提交
1074 1075
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1076
  geolocation.flushCachedGnssLocations((err, result) => {
L
liu-binjun 已提交
1077 1078 1079 1080 1081 1082
      if (err) {
          console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('flushCachedGnssLocations: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1083 1084 1085 1086
  });
  ```


1087
## geolocation.flushCachedGnssLocations<sup>(deprecated) </sup>
Z
zengyawen 已提交
1088

L
liu-binjun 已提交
1089
flushCachedGnssLocations(): Promise&lt;boolean&gt;;
Z
zengyawen 已提交
1090 1091 1092

读取并清空GNSS芯片所有缓存位置。

1093 1094 1095 1096
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations-1)替代。

L
liu-binjun 已提交
1097
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1098

L
liu-binjun 已提交
1099
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1100

L
liu-binjun 已提交
1101 1102
**返回值**

1103 1104 1105
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;boolean&gt; |boolean|NA| 清空所有GNSS缓存位置是否成功。 |
Z
zengyawen 已提交
1106

L
liu-binjun 已提交
1107
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1108

L
liu-binjun 已提交
1109 1110
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1111
  geolocation.flushCachedGnssLocations().then((result) => {
L
liu-binjun 已提交
1112
      console.log('promise, flushCachedGnssLocations: ' + JSON.stringify(result));
Z
zengyawen 已提交
1113 1114 1115 1116
  });
  ```


1117
## geolocation.sendCommand<sup>(deprecated) </sup>
Z
zengyawen 已提交
1118

L
liu-binjun 已提交
1119
sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): void;
Z
zengyawen 已提交
1120

1121
给位置服务子系统的各个部件发送扩展命令。
Z
zengyawen 已提交
1122

1123 1124 1125 1126
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。

L
liu-binjun 已提交
1127
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1128 1129 1130

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
1131 1132
**参数**

1133
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1134
  | -------- | -------- | -------- | -------- |
L
liu-binjun 已提交
1135
  | command |  [LocationCommand](#locationcommand) | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
Z
zengyawen 已提交
1136
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收命令发送的结果。 |
Z
zengyawen 已提交
1137

L
liu-binjun 已提交
1138
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1139

L
liu-binjun 已提交
1140 1141
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1142 1143
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geolocation.sendCommand(requestInfo, (err, result) => {
L
liu-binjun 已提交
1144 1145 1146 1147 1148 1149
      if (err) {
          console.log('sendCommand: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('sendCommand: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1150 1151 1152 1153
  });
  ```


1154
## geolocation.sendCommand<sup>(deprecated) </sup>
Z
zengyawen 已提交
1155

L
liu-binjun 已提交
1156
sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
Z
zengyawen 已提交
1157

1158
给位置服务子系统的各个部件发送扩展命令。
Z
zengyawen 已提交
1159

1160 1161 1162 1163
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。

L
liu-binjun 已提交
1164
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1165 1166 1167

**系统能力**:SystemCapability.Location.Location.Core

L
liu-binjun 已提交
1168 1169
**参数**

1170
  | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1171
  | -------- | -------- | -------- | -------- |
L
liu-binjun 已提交
1172
  | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
Z
zengyawen 已提交
1173

L
liu-binjun 已提交
1174 1175
**返回值**

1176 1177 1178
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise&lt;boolean&gt; |boolean|NA| 表示命令发送成功或失败。 |
Z
zengyawen 已提交
1179

L
liu-binjun 已提交
1180
**示例**
zyjhandsome's avatar
zyjhandsome 已提交
1181

L
liu-binjun 已提交
1182 1183
  ```ts
  import geolocation from '@ohos.geolocation';
Z
zengyawen 已提交
1184 1185
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geolocation.sendCommand(requestInfo).then((result) => {
L
liu-binjun 已提交
1186
      console.log('promise, sendCommand: ' + JSON.stringify(result));
Z
zengyawen 已提交
1187 1188 1189 1190
  });
  ```


1191
## LocationRequestPriority<sup>(deprecated) </sup>
L
liu-binjun 已提交
1192

1193
位置请求中位置信息优先级设置。
1194

1195 1196 1197
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。

L
liu-binjun 已提交
1198
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1199 1200 1201

**系统能力**:SystemCapability.Location.Location.Core

1202
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1203 1204 1205 1206 1207
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先,如果应用希望快速拿到1个位置,可以将优先级设置为该字段。 |
L
liu-binjun 已提交
1208

Z
zengyawen 已提交
1209

1210
## LocationRequestScenario<sup>(deprecated) </sup>
L
liu-binjun 已提交
1211 1212 1213

  位置请求中定位场景设置。

1214 1215 1216
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。

L
liu-binjun 已提交
1217
**需要权限**:ohos.permission.LOCATION
Z
zengyawen 已提交
1218

L
liu-binjun 已提交
1219
**系统能力**:SystemCapability.Location.Location.Core
Z
zengyawen 已提交
1220

1221
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1222 1223 1224 1225 1226 1227 1228
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。 |
Z
zengyawen 已提交
1229 1230


1231
## GeoLocationErrorCode<sup>(deprecated) </sup>
Z
zengyawen 已提交
1232

L
liu-binjun 已提交
1233
位置服务中的错误码信息。
L
liu-binjun 已提交
1234

1235 1236 1237
> **说明:**<br/>
> 从API version 9开始废弃。

L
liu-binjun 已提交
1238
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1239 1240 1241

**系统能力**:SystemCapability.Location.Location.Core

1242
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1243 1244 1245 1246 1247 1248 1249 1250
| -------- | -------- | -------- |
| INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 |
| REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 |
| GEOCODE_ERROR<sup>7+</sup> | 103 | 表示地理编码接口调用失败。 |
| LOCATOR_ERROR<sup>7+</sup> | 104 | 表示定位失败。 |
| LOCATION_SWITCH_ERROR<sup>7+</sup> | 105 | 表示定位开关。 |
| LAST_KNOWN_LOCATION_ERROR<sup>7+</sup> | 106 | 表示获取上次位置失败。 |
| LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位,没有在指定时间内返回位置。 |
L
liu-binjun 已提交
1251

Z
zengyawen 已提交
1252

1253
## ReverseGeoCodeRequest<sup>(deprecated) </sup>
L
liu-binjun 已提交
1254

L
liu-binjun 已提交
1255
逆地理编码请求接口。
Z
zengyawen 已提交
1256

1257 1258 1259
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest)替代。

L
liu-binjun 已提交
1260
**需要权限**:ohos.permission.LOCATION
Z
zengyawen 已提交
1261

L
liu-binjun 已提交
1262
**系统能力**:SystemCapability.Location.Location.Geocoder
Z
zengyawen 已提交
1263

1264
| 名称 | 类型 | 可读 | 可写 | 说明 |
1265
| -------- | -------- | -------- | -------- | -------- |
1266 1267 1268 1269
| locale | string | 是 | 是 | 指定位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| latitude | number | 是 | 是 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number | 是 | 是 | 表示经度信息,正值表示东经,负值表示西经。 |
| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
Z
zengyawen 已提交
1270 1271


1272
## GeoCodeRequest<sup>(deprecated) </sup>
Z
zengyawen 已提交
1273

L
liu-binjun 已提交
1274
地理编码请求接口。
L
liu-binjun 已提交
1275

1276 1277 1278
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoCodeRequest](js-apis-geoLocationManager.md#geocoderequest)替代。

L
liu-binjun 已提交
1279
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1280

L
liu-binjun 已提交
1281
**系统能力**:SystemCapability.Location.Location.Geocoder
L
liu-binjun 已提交
1282

1283
| 名称 | 类型 | 可读|可写 | 说明 |
1284
| -------- | -------- | -------- | -------- | -------- |
1285
| locale | string | 是 | 是 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
1286
| description | string | 是 | 是 | 表示位置信息描述,如“上海市浦东新区xx路xx号”。 |
1287 1288 1289 1290 1291
| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 是 | 是 | 表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。 |
| minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
L
liu-binjun 已提交
1292

Z
zengyawen 已提交
1293

1294
## GeoAddress<sup>(deprecated) </sup>
L
liu-binjun 已提交
1295 1296

地理编码类型。
Z
zengyawen 已提交
1297

1298 1299 1300
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoAddress](js-apis-geoLocationManager.md#geoaddress)替代。

L
liu-binjun 已提交
1301 1302 1303
**需要权限**:ohos.permission.LOCATION

**系统能力**:SystemCapability.Location.Location.Geocoder
Z
zengyawen 已提交
1304

1305
| 名称 | 类型 | 可读|可写 | 说明 |
1306
| -------- | -------- | -------- | -------- | -------- |
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
| latitude<sup>7+</sup> | number | 是 | 否 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude<sup>7+</sup> | number | 是 | 否 | 表示经度信息,正值表示东经,负值表是西经。 |
| locale<sup>7+</sup> | string | 是 | 否 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| placeName<sup>7+</sup> | string | 是 | 否 | 表示地区信息。 |
| countryCode<sup>7+</sup> | string | 是 | 否 | 表示国家码信息。 |
| countryName<sup>7+</sup> | string | 是 | 否 | 表示国家信息。 |
| administrativeArea<sup>7+</sup> | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea<sup>7+</sup> | string | 是 | 否 | 表示表示子区域信息。 |
| locality<sup>7+</sup> | string | 是 | 否 | 表示城市信息。 |
| subLocality<sup>7+</sup> | string | 是 | 否 | 表示子城市信息。 |
| roadName<sup>7+</sup> | string | 是 | 否 | 表示路名信息。 |
| subRoadName<sup>7+</sup> | string | 是 | 否 | 表示子路名信息。 |
| premises<sup>7+</sup> | string | 是 | 否 | 表示门牌号信息。 |
| postalCode<sup>7+</sup> | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber<sup>7+</sup> | string | 是 | 否| 表示联系方式信息。 |
| addressUrl<sup>7+</sup> | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize<sup>7+</sup> | number | 是 | 否 | 表示附加的描述信息数量。 |


1327
## LocationRequest<sup>(deprecated) </sup>
Z
zengyawen 已提交
1328

L
liu-binjun 已提交
1329
位置信息请求类型。
L
liu-binjun 已提交
1330

1331 1332 1333
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequest](js-apis-geoLocationManager.md#locationrequest)替代。

L
liu-binjun 已提交
1334
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1335 1336 1337

**系统能力**:SystemCapability.Location.Location.Core

1338
| 名称 | 类型 | 可读|可写 | 说明 |
1339
| -------- | -------- | -------- | -------- | -------- |
1340 1341 1342 1343 1344
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
L
liu-binjun 已提交
1345

Z
zengyawen 已提交
1346

1347
## CurrentLocationRequest<sup>(deprecated) </sup>
L
liu-binjun 已提交
1348

L
liu-binjun 已提交
1349
当前位置信息请求类型。
Z
zengyawen 已提交
1350

1351 1352 1353
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.CurrentLocationRequest](js-apis-geoLocationManager.md#currentlocationrequest)替代。

L
liu-binjun 已提交
1354
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1355

L
liu-binjun 已提交
1356
**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
1357

1358
| 名称 | 类型 | 可读|可写 | 说明 |
1359
| -------- | -------- | -------- | -------- | -------- |
1360 1361 1362 1363
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 是 | 是| 表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 是 | 是 | 表示超时时间,单位是毫秒,最小为1000毫秒。 |
L
liu-binjun 已提交
1364 1365


1366
## SatelliteStatusInfo<sup>(deprecated) </sup>
L
liu-binjun 已提交
1367

L
liu-binjun 已提交
1368
卫星状态信息。
L
liu-binjun 已提交
1369

1370 1371 1372 1373
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.SatelliteStatusInfo](js-apis-geoLocationManager.md#satellitestatusinfo)替代。

L
liu-binjun 已提交
1374
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1375

L
liu-binjun 已提交
1376
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1377

1378
| 名称 | 类型 | 可读|可写 | 说明 |
1379
| -------- | -------- | -------- | -------- | -------- |
1380 1381 1382 1383 1384 1385
| satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array&lt;number&gt; | 是 | 否 | 表示每个卫星的ID,数组类型。 |
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 否 | 表示载波噪声功率谱密度比,即cn0。 |
| altitudes | Array&lt;number&gt; | 是 | 否 | 表示高程信息。 |
| azimuths | Array&lt;number&gt; | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array&lt;number&gt; | 是 | 否 | 表示载波频率。 |
L
liu-binjun 已提交
1386 1387


1388
## CachedGnssLocationsRequest<sup>(deprecated) </sup>
L
liu-binjun 已提交
1389

L
liu-binjun 已提交
1390
请求订阅GNSS缓存位置上报功能接口的配置参数。
L
liu-binjun 已提交
1391

1392 1393 1394 1395
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.CachedGnssLocationsRequest](js-apis-geoLocationManager.md#cachedgnsslocationsrequest)替代。

L
liu-binjun 已提交
1396
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1397

L
liu-binjun 已提交
1398
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1399

1400
| 名称 | 类型 | 可读|可写 | 说明 |
1401
| -------- | -------- | -------- | -------- | -------- |
1402 1403
| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期,单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | 是  | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。 |
L
liu-binjun 已提交
1404 1405


1406
## Geofence<sup>(deprecated) </sup>
L
liu-binjun 已提交
1407

L
liu-binjun 已提交
1408
GNSS围栏的配置参数。目前只支持圆形围栏。
Z
zengyawen 已提交
1409

1410 1411 1412 1413
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.Geofence](js-apis-geoLocationManager.md#geofence)替代。

L
liu-binjun 已提交
1414
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1415

L
liu-binjun 已提交
1416
**系统能力**:SystemCapability.Location.Location.Geofence
L
liu-binjun 已提交
1417

1418
| 名称 | 类型 | 可读|可写 | 说明 |
1419
| -------- | -------- | -------- | -------- | -------- |
1420 1421 1422 1423
| latitude | number | 是 | 是  | 表示纬度。 |
| longitude | number | 是 | 是  | 表示经度。 |
| radius | number | 是 | 是  | 表示圆形围栏的半径。 |
| expiration | number | 是 | 是  | 围栏存活的时间,单位是毫秒。 |
Z
zengyawen 已提交
1424 1425


1426
## GeofenceRequest<sup>(deprecated) </sup>
Z
zengyawen 已提交
1427 1428 1429

请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。

1430 1431 1432 1433
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.GeofenceRequest](js-apis-geoLocationManager.md#geofencerequest)替代。

L
liu-binjun 已提交
1434
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1435

L
liu-binjun 已提交
1436
**系统能力**:SystemCapability.Location.Location.Geofence
L
liu-binjun 已提交
1437

1438
| 名称 | 类型 | 可读|可写 | 说明 |
1439
| -------- | -------- | -------- | -------- | -------- |
1440 1441 1442
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是  | 表示位置信息优先级。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是  | 表示定位场景。 |
| geofence | [Geofence](#geofence)| 是 | 是  | 表示围栏信息。 |
Z
zengyawen 已提交
1443 1444


1445
## LocationPrivacyType<sup>(deprecated) </sup>
Z
zengyawen 已提交
1446 1447 1448

定位服务隐私协议类型。

1449 1450 1451 1452
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。

L
liu-binjun 已提交
1453
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1454 1455 1456

**系统能力**:SystemCapability.Location.Location.Core

1457
| 名称 | 值 | 说明 |
Z
zengyawen 已提交
1458
| -------- | -------- | -------- |
Z
zengyawen 已提交
1459 1460 1461
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
Z
zengyawen 已提交
1462 1463


1464
## LocationCommand<sup>(deprecated) </sup>
Z
zengyawen 已提交
1465 1466 1467

扩展命令结构体。

1468 1469 1470 1471
> **说明:**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationCommand](js-apis-geoLocationManager.md#locationcommand)替代。

L
liu-binjun 已提交
1472
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1473 1474 1475

**系统能力**:SystemCapability.Location.Location.Core

1476
| 名称 | 类型 | 可读|可写 | 说明 |
1477
| -------- | -------- | -------- | -------- | -------- |
1478 1479
| scenario | [LocationRequestScenario](#locationrequestscenario)  | 是 | 是  | 表示定位场景。 |
| command | string | 是 | 是  | 扩展命令字符串。 |
Z
zengyawen 已提交
1480 1481


1482
## Location<sup>(deprecated) </sup>
Z
zengyawen 已提交
1483 1484 1485

位置信息类型。

1486 1487 1488
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.Location](js-apis-geoLocationManager.md#location)替代。

L
liu-binjun 已提交
1489
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1490 1491 1492

**系统能力**:SystemCapability.Location.Location.Core

1493
| 名称 | 类型 | 可读|可写 | 说明 |
1494
| -------- | -------- | -------- | -------- | -------- |
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
| latitude<sup>7+</sup> | number | 是 | 否 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude<sup>7+</sup> | number | 是 | 否 | 表示经度信息,正值表示东经,负值表是西经。 |
| altitude<sup>7+</sup> | number | 是 | 否 | 表示高度信息,单位米。 |
| accuracy<sup>7+</sup> | number | 是 | 否 | 表示精度信息,单位米。 |
| speed<sup>7+</sup> | number | 是 | 否 | 表示速度信息,单位米每秒。 |
| timeStamp<sup>7+</sup> | number | 是 | 否 | 表示位置时间戳,UTC格式。 |
| direction<sup>7+</sup> | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot<sup>7+</sup> | number | 是 | 否 | 表示位置时间戳,开机时间格式。 |
| additions<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize<sup>7+</sup> | number | 是 | 否 | 附加信息数量。 |