js-apis-geoLocationManager.md 74.4 KB
Newer Older
L
liu-binjun 已提交
1 2 3 4 5 6 7
# 位置服务

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

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

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
## 申请权限

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

系统提供的定位权限有:
- 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)

L
liu-binjun 已提交
36 37 38 39 40 41 42 43

## 导入模块

```ts
import geoLocationManager from '@ohos.geoLocationManager';
```


44 45 46 47 48 49
## geoLocationManager.on('locationChange')

on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void

开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报,

50
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
51 52 53 54 55 56 57 58 59 60 61

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
  | request |  [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 |
  | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 |

62 63 64 65 66 67 68 69 70
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.                                       |
71 72 73 74 75 76 77 78 79

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
80 81 82 83 84 85
  try {
      geoLocationManager.on('locationChange', requestInfo, locationChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
  
86 87 88 89 90 91 92 93 94
  ```


## geoLocationManager.off('locationChange')

off(type: 'locationChange', callback?: Callback<Location>): void

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

95
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
96 97 98 99 100 101 102 103 104 105

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
  | callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

106 107 108 109 110 111 112 113 114
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.                                       |
115 116 117 118 119 120 121 122 123

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
124 125 126 127 128 129
  try {
      geoLocationManager.on('locationChange', requestInfo, locationChange);
      geoLocationManager.off('locationChange', locationChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  ```


## geoLocationManager.on('locationEnabledChange')

on(type: 'locationEnabledChange', callback: Callback<boolean>): void

订阅位置服务状态变化。

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

**参数:**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“locationEnabledChange”,表示位置服务状态。 |
  | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 |

148 149 150 151 152 153 154
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
155 156 157 158 159 160 161 162

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var locationEnabledChange = (state) => {
      console.log('locationEnabledChange: ' + JSON.stringify(state));
  }
163 164 165 166 167
  try {
      geoLocationManager.on('locationEnabledChange', locationEnabledChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  ```


## geoLocationManager.off('locationEnabledChange')

off(type: 'locationEnabledChange', callback?: Callback<boolean>): void;

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

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“locationEnabledChange”,表示位置服务状态。 |
  | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

186 187 188 189 190 191 192
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
193 194 195 196 197 198 199 200

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var locationEnabledChange = (state) => {
      console.log('locationEnabledChange: state: ' + JSON.stringify(state));
  }
201 202 203 204 205 206
  try {
      geoLocationManager.on('locationEnabledChange', locationEnabledChange);
      geoLocationManager.off('locationEnabledChange', locationEnabledChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
207 208 209
  ```


210
## geoLocationManager.on('cachedGnssLocationsChange')
211 212 213 214 215

on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;

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

216
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
217 218 219 220 221 222 223 224 225 226 227

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”,表示GNSS缓存定位结果上报。 |
  | request |  [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
  | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 |

228 229 230 231 232 233 234 235 236
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.                                       |
237 238 239 240 241 242 243 244 245

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var cachedLocationsCb = (locations) => {
      console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
246 247 248 249 250
  try {
      geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
251 252 253
  ```


254
## geoLocationManager.off('cachedGnssLocationsChange')
255 256 257 258 259

off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;

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

260
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
261 262 263 264 265 266 267 268 269 270

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”,表示GNSS缓存定位结果上报。 |
  | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

271 272 273 274 275 276 277 278 279
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.                                       |
280 281 282 283 284 285 286 287 288

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var cachedLocationsCb = (locations) => {
      console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
289 290 291 292 293 294
  try {
      geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
      geoLocationManager.off('cachedGnssLocationsChange');
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
295 296 297
  ```


298
## geoLocationManager.on('satelliteStatusChange')
299 300 301 302 303

on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;

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

304
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
305 306 307 308 309 310 311 312 313 314

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”,表示订阅GNSS卫星状态信息上报。 |
  | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 接收GNSS卫星状态信息上报。 |

315 316 317 318 319 320 321 322
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
323 324 325 326 327 328 329 330

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var gnssStatusCb = (satelliteStatusInfo) => {
      console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
  }
331 332 333 334 335 336

  try {
      geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
337 338 339
  ```


340
## geoLocationManager.off('satelliteStatusChange')
341 342 343 344 345

off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;

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

346
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
347 348 349 350 351 352 353 354 355 356

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”,表示订阅GNSS卫星状态信息上报。 |
  | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

357 358 359 360 361 362 363 364 365 366
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |


367 368 369 370 371 372 373
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var gnssStatusCb = (satelliteStatusInfo) => {
      console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
  }
374 375 376 377 378 379
  try {
      geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
      geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
380 381 382
  ```


383
## geoLocationManager.on('nmeaMessage')
384 385 386 387 388

on(type: 'nmeaMessage', callback: Callback<string>): void;

订阅GNSS NMEA信息上报事件。

389
**需要权限**:ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
390 391 392 393 394 395 396 397 398 399

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“nmeaMessage”,表示订阅GNSS NMEA信息上报。 |
  | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 |

400 401 402 403 404 405 406 407 408
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |

409 410 411 412 413 414 415 416

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var nmeaCb = (str) => {
      console.log('nmeaMessage: ' + JSON.stringify(str));
  }
417 418 419 420 421 422

  try {
      geoLocationManager.on('nmeaMessage', nmeaCb );
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
423 424 425
  ```


426
## geoLocationManager.off('nmeaMessage')
427 428 429 430 431

off(type: 'nmeaMessage', callback?: Callback<string>): void;

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

432
**需要权限**:ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
433 434 435 436 437 438 439 440 441 442

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“nmeaMessage”,表示订阅GNSS NMEA信息上报。 |
  | callback | Callback<string> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

443 444 445 446 447 448 449 450 451
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |

452 453 454 455 456 457 458 459

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var nmeaCb = (str) => {
      console.log('nmeaMessage: ' + JSON.stringify(str));
  }
460 461 462 463 464 465 466

  try {
      geoLocationManager.on('nmeaMessage', nmeaCb);
      geoLocationManager.off('nmeaMessage', nmeaCb);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
467 468 469
  ```


470
## geoLocationManager.on('gnssFenceStatusChange')
471 472 473 474 475

on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;

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

476
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
477 478 479 480 481 482 483 484 485 486 487

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”,表示订阅围栏事件上报。 |
  | request |  [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |

488 489 490 491 492 493 494 495 496
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301600 | Failed to operate the geofence.                                     |
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
      wants: [
          {
              bundleName: "com.example.myapplication",
              abilityName: "com.example.myapplication.MainAbility",
              action: "action1",
          }
      ],
      operationType: wantAgent.OperationType.START_ABILITY,
      requestCode: 0,
      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}};
519 520 521 522 523
    try {
        geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
524 525 526 527
  });
  ```


528
## geoLocationManager.off('gnssFenceStatusChange')
529 530 531 532 533

off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;

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

534
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
535 536 537 538 539 540 541 542 543 544 545

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”,表示订阅围栏事件上报。 |
  | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |

546 547 548 549 550 551 552 553 554 555
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301600 | Failed to operate the geofence.                                     |

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
      wants: [
          {
              bundleName: "com.example.myapplication",
              abilityName: "com.example.myapplication.MainAbility",
              action: "action1",
          }
      ],
      operationType: wantAgent.OperationType.START_ABILITY,
      requestCode: 0,
      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}};
577 578 579 580 581 582
    try {
        geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
        geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
583 584 585 586
  });
  ```


L
liu-binjun 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
## geoLocationManager.on('countryCodeChange')

on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;

订阅国家码信息变化事件。

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息变化事件。 |
  | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 |

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301500 | Failed to query the area information.                                       |


**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
  }
620 621 622 623 624 625

  try {
      geoLocationManager.on('countryCodeChange', callback);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  ```


## geoLocationManager.off('countryCodeChange')

off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;

取消订阅国家码变化事件。

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示取消订阅国家码信息变化事件。 |
  | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数,则取消当前类型的所有订阅。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301500 | Failed to query the area information.                                       |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
  }
661 662 663 664 665 666 667

  try {
      geoLocationManager.on('countryCodeChange', callback);
      geoLocationManager.off('countryCodeChange', callback);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
668 669 670 671 672 673 674 675 676 677
  ```



## geoLocationManager.getCurrentLocation

getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void

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

678
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
679 680 681 682 683 684 685

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
686
  | request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 |
687 688
  | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 |

689 690 691 692 693 694 695 696 697 698
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.  |

699 700 701 702 703 704 705 706 707 708 709 710 711 712
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
  var locationChange = (err, location) => {
      if (err) {
          console.log('locationChanger: err=' + JSON.stringify(err));
      }
      if (location) {
          console.log('locationChanger: location=' + JSON.stringify(location));
      }
  };

713 714 715 716 717 718
  try {
      geoLocationManager.getCurrentLocation(requestInfo, locationChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```
719 720 721

## geoLocationManager.getCurrentLocation

722
getCurrentLocation(callback: AsyncCallback<Location>): void;
723

724
获取当前位置,通过callback方式异步返回结果。
725

726
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
727 728 729 730 731 732 733

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

**参数**

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

736
**错误码**
737

738
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
739

740 741 742 743 744
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301200 | Failed to obtain the geographical location.  |
745 746 747 748 749

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
750 751 752 753 754 755 756 757
  var locationChange = (err, location) => {
      if (err) {
          console.log('locationChanger: err=' + JSON.stringify(err));
      }
      if (location) {
          console.log('locationChanger: location=' + JSON.stringify(location));
      }
  };
758

759 760 761 762 763 764
  try {
      geoLocationManager.getCurrentLocation(locationChange);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
  ```
765

766
## geoLocationManager.getCurrentLocation
767

768
getCurrentLocation(request?: CurrentLocationRequest): Promise<Location>
L
liu-binjun 已提交
769

770
获取当前位置,使用Promise方式异步返回结果。
L
liu-binjun 已提交
771

772
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
L
liu-binjun 已提交
773 774 775 776 777 778 779

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
780 781 782 783 784 785 786
  | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |

**返回值**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<[Location](#location)>  | [Location](#location) | NA | 返回位置信息。 |
L
liu-binjun 已提交
787 788 789 790 791 792 793 794 795

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
796
|3301200 | Failed to obtain the geographical location.  |
797 798 799 800 801

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
802 803 804 805 806 807
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
  geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
      console.log('current location: ' + JSON.stringify(result));
  })  
  .catch((error) => {
      console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
808 809 810 811 812 813
  });
  ```


## geoLocationManager.getLastLocation

814
getLastLocation(): Location
815

816
获取上一次位置。
817

818
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
819 820 821 822 823

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

**返回值**

824 825 826
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Location  | [Location](#location) | NA | 位置信息。 |
827

828 829 830
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
L
liu-binjun 已提交
831

832 833 834 835 836
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.  |
|3301100 | The location switch is off.  |
|3301200 |Failed to obtain the geographical location.  |
L
liu-binjun 已提交
837 838 839 840 841

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
842 843 844 845
  try {
      var location = geoLocationManager.getLastLocation();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
L
liu-binjun 已提交
846 847 848 849
  }
  ```


850
## geoLocationManager.isLocationEnabled
L
liu-binjun 已提交
851

852
isLocationEnabled(): boolean
L
liu-binjun 已提交
853

854
判断位置服务是否已经使能。
L
liu-binjun 已提交
855 856 857

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

858
**返回值**
L
liu-binjun 已提交
859 860 861

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
862
  | boolean  | boolean | NA | 位置服务是否已经使能。 |
L
liu-binjun 已提交
863 864 865 866 867 868 869

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
870
|3301000 | Location service is unavailable.  |
L
liu-binjun 已提交
871 872 873 874 875

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
876 877 878 879
  try {
      var locationEnabled = geoLocationManager.isLocationEnabled();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
L
liu-binjun 已提交
880 881 882 883
  }
  ```


884
## geoLocationManager.requestEnableLocation
L
liu-binjun 已提交
885

886
requestEnableLocation(callback: AsyncCallback<boolean>): void
L
liu-binjun 已提交
887

888
请求使能位置服务,使用callback回调异步返回结果。
889

890
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
L
liu-binjun 已提交
891 892 893 894 895 896 897

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
898 899 900 901 902 903 904 905 906 907
  | callback | AsyncCallback<boolean> | 是 | callback返回true表示用户同意使能位置服务,false表示用户不同意使能位置服务。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.  |
|3301700 | No response to the request.  |
L
liu-binjun 已提交
908

909 910 911 912 913 914 915 916 917 918 919 920 921
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.requestEnableLocation((err, data) => {
      if (err) {
          console.log('requestEnableLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('requestEnableLocation: data=' + JSON.stringify(data));
      }
  });
  ```
L
liu-binjun 已提交
922 923


924 925 926 927
## geoLocationManager.requestEnableLocation

requestEnableLocation(): Promise<boolean>

928
请求使能位置服务,使用Promise方式异步返回结果。
929

930
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
931 932 933 934 935

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

**返回值**

936 937 938 939 940 941 942 943 944 945 946 947
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<boolean>  | boolean | NA | 返回true表示用户同意使能位置服务,false表示用户不同意使能位置服务。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.  |
|3301700 | No response to the request.  |
L
liu-binjun 已提交
948 949 950 951 952

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
953 954
  geoLocationManager.requestEnableLocation().then((result) => {
      console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
955 956 957
  })  
  .catch((error) => {
      console.log('promise, requestEnableLocation: error=' + JSON.stringify(error));
958
  });
L
liu-binjun 已提交
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
  ```


## geoLocationManager.enableLocation

enableLocation(callback: AsyncCallback<void>): void;

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.enableLocation((err, data) => {
      if (err) {
          console.log('enableLocation: err=' + JSON.stringify(err));
      }
  });
  ```


## geoLocationManager.enableLocation

enableLocation(): Promise<void>

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS

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

**返回值**

1014 1015 1016
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void>  | void | NA | 返回错误码信息。 |
L
liu-binjun 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.enableLocation().then((result) => {
      console.log('promise, enableLocation succeed');
  })
  .catch((error) => {
      console.log('promise, enableLocation: error=' + JSON.stringify(error));
  });
  ```

## geoLocationManager.disableLocation

1040
disableLocation(): void;
L
liu-binjun 已提交
1041

1042
关闭位置服务。
L
liu-binjun 已提交
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

**系统API**:此接口为系统接口,三方应用不支持调用。

**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS

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

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1062 1063 1064 1065 1066
  try {
      geoLocationManager.disableLocation();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1067 1068 1069 1070
  ```



1071
## geoLocationManager.getAddressesFromLocation
L
liu-binjun 已提交
1072

1073
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void
L
liu-binjun 已提交
1074

1075
调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。
L
liu-binjun 已提交
1076

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

L
liu-binjun 已提交
1079 1080
**参数**

1081 1082 1083
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
1084
  | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收逆地理编码结果的回调函数。 |
L
liu-binjun 已提交
1085 1086 1087 1088 1089 1090 1091

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1092 1093
|3301000 | Location service is unavailable.   |
|3301300 | Reverse geocoding query failed.   |
L
liu-binjun 已提交
1094 1095 1096 1097 1098

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1099 1100
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
L
liu-binjun 已提交
1101
      if (err) {
1102 1103 1104 1105
          console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
L
liu-binjun 已提交
1106 1107 1108 1109 1110
      }
  });
  ```


1111
## geoLocationManager.getAddressesFromLocation
L
liu-binjun 已提交
1112

1113
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;
L
liu-binjun 已提交
1114

1115
调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。
L
liu-binjun 已提交
1116

1117
**系统能力**:SystemCapability.Location.Location.Geocoder
L
liu-binjun 已提交
1118 1119 1120 1121 1122

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1123
  | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
1124 1125 1126

**返回值**

1127 1128 1129
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<Array<[GeoAddress](#geoaddress)>>  | Array<[GeoAddress](#geoaddress)> | NA | 返回地理描述信息。 |
L
liu-binjun 已提交
1130 1131 1132 1133 1134 1135 1136

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1137 1138
|3301000 | Location service is unavailable.   |
|3301300 | Reverse geocoding query failed.   |
L
liu-binjun 已提交
1139

1140 1141 1142 1143 1144 1145 1146
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
      console.log('getAddressesFromLocation: ' + JSON.stringify(data));
1147 1148 1149 1150
  })
  .catch((error) => {
      console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
});
1151
  ```
L
liu-binjun 已提交
1152 1153


1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
## geoLocationManager.getAddressesFromLocationName

getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void

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

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
  | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收地理编码结果的回调函数。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.   |
|3301400 | Geocoding query failed.   |
L
liu-binjun 已提交
1177 1178 1179 1180 1181

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1182 1183
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
L
liu-binjun 已提交
1184
      if (err) {
1185
          console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
L
liu-binjun 已提交
1186
      }
1187 1188
      if (data) {
          console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
L
liu-binjun 已提交
1189 1190 1191 1192 1193
      }
  });
  ```


1194
## geoLocationManager.getAddressesFromLocationName
L
liu-binjun 已提交
1195

1196
getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>
L
liu-binjun 已提交
1197

1198
调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。
L
liu-binjun 已提交
1199

1200
**系统能力**:SystemCapability.Location.Location.Geocoder
L
liu-binjun 已提交
1201 1202 1203 1204 1205

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1206
  | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
L
liu-binjun 已提交
1207

1208
**返回值**
L
liu-binjun 已提交
1209 1210 1211

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1212
  | Promise<Array<[GeoAddress](#geoaddress)>>  | Array<[GeoAddress](#geoaddress)> | NA | 返回地理编码查询结果。 |
L
liu-binjun 已提交
1213 1214 1215 1216 1217 1218 1219

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1220 1221
|3301000 | Location service is unavailable.   |
|3301400 | Geocoding query failed.   |
L
liu-binjun 已提交
1222 1223 1224 1225 1226

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1227 1228 1229
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
      console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
1230 1231 1232
  })
  .catch((error) => {
      console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
L
liu-binjun 已提交
1233 1234 1235
  });
  ```

1236
## geoLocationManager.isGeocoderAvailable
L
liu-binjun 已提交
1237

1238
isGeocoderAvailable(): boolean;
L
liu-binjun 已提交
1239

1240
判断(逆)地理编码服务状态。
L
liu-binjun 已提交
1241

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

1244
**返回值**
L
liu-binjun 已提交
1245

1246 1247
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1248
  | boolean  | boolean | NA | 返回(逆)地理编码服务是否可用。 |
L
liu-binjun 已提交
1249

1250 1251 1252 1253 1254 1255 1256
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.   |
L
liu-binjun 已提交
1257 1258 1259 1260 1261

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1262 1263 1264 1265 1266
  try {
      var isAvailable = geoLocationManager.isGeocoderAvailable();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1267 1268 1269
  ```


1270
## geoLocationManager.getCachedGnssLocationsSize
L
liu-binjun 已提交
1271

1272
getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;
L
liu-binjun 已提交
1273

1274
获取GNSS芯片缓存位置的个数。
L
liu-binjun 已提交
1275

1276
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
1277 1278

**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1279 1280 1281 1282 1283

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1284 1285
  | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 |

1286 1287 1288 1289 1290 1291 1292 1293 1294
**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.   |
|3301100 | The location switch is off.   |

1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.getCachedGnssLocationsSize((err, size) => {
      if (err) {
          console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
      }
      if (size) {
          console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
      }
  });
  ```


1310
## geoLocationManager.getCachedGnssLocationsSize
1311 1312 1313 1314 1315

getCachedGnssLocationsSize(): Promise<number>;

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

1316
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
1317 1318

**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1319 1320 1321

**返回值**

1322 1323 1324
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<number>  | number | NA | 返回GNSS缓存位置的个数。 |
L
liu-binjun 已提交
1325 1326 1327 1328 1329 1330 1331

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1332 1333
|3301000 | Location service is unavailable.   |
|3301100 | The location switch is off.   |
L
liu-binjun 已提交
1334 1335 1336 1337 1338

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1339 1340
  geoLocationManager.getCachedGnssLocationsSize().then((result) => {
      console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
1341
  }) 
L
liu-binjun 已提交
1342
  .catch((error) => {
1343
      console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
L
liu-binjun 已提交
1344 1345 1346 1347
  });
  ```


1348
## geoLocationManager.flushCachedGnssLocations
L
liu-binjun 已提交
1349

1350
flushCachedGnssLocations(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
1351

1352
读取并清空GNSS芯片所有缓存位置。
L
liu-binjun 已提交
1353

1354
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
1355 1356

**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1357 1358 1359 1360 1361

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1362
  | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 |
L
liu-binjun 已提交
1363 1364 1365 1366 1367 1368 1369

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1370 1371 1372
|3301000 | Location service is unavailable.   |
|3301100 | The location switch is off.   |
|3301200 | Failed to obtain the geographical location.   |
L
liu-binjun 已提交
1373 1374 1375 1376 1377

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1378
  geoLocationManager.flushCachedGnssLocations((err, result) => {
L
liu-binjun 已提交
1379
      if (err) {
1380
          console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
L
liu-binjun 已提交
1381 1382 1383 1384 1385
      }
  });
  ```


1386
## geoLocationManager.flushCachedGnssLocations
L
liu-binjun 已提交
1387

1388
flushCachedGnssLocations(): Promise<void>;
L
liu-binjun 已提交
1389

1390
读取并清空GNSS芯片所有缓存位置。
L
liu-binjun 已提交
1391

1392
**需要权限**:ohos.permission.APPROXIMATELY_LOCATION
L
liu-binjun 已提交
1393

1394
**系统能力**:SystemCapability.Location.Location.Gnss
L
liu-binjun 已提交
1395 1396 1397

**返回值**

1398 1399 1400
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void>  | void | NA | 接收错误码。 |
L
liu-binjun 已提交
1401 1402 1403 1404 1405 1406 1407

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1408 1409 1410
|3301000 | Location service is unavailable.   |
|3301100 | The location switch is off.   |
|3301200 | Failed to obtain the geographical location.   |
L
liu-binjun 已提交
1411 1412 1413 1414 1415

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1416
  geoLocationManager.flushCachedGnssLocations().then((result) => {
1417
      console.log('promise, flushCachedGnssLocations success');
L
liu-binjun 已提交
1418 1419
  })
  .catch((error) => {
1420
      console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
L
liu-binjun 已提交
1421 1422 1423 1424
  });
  ```


1425
## geoLocationManager.sendCommand
L
liu-binjun 已提交
1426

1427
sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
1428

1429
给位置服务子系统的各个部件发送扩展命令。
L
liu-binjun 已提交
1430 1431 1432 1433 1434 1435 1436

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1437
  | command |  [LocationCommand](#locationcommand) | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
1438
  | callback | AsyncCallback<void> | 是 | 用来接收错误码。 |
L
liu-binjun 已提交
1439 1440 1441 1442 1443 1444 1445

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
1446
|3301000 | Location service is unavailable.   |
L
liu-binjun 已提交
1447 1448 1449 1450 1451

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1452 1453
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geoLocationManager.sendCommand(requestInfo, (err, result) => {
L
liu-binjun 已提交
1454
      if (err) {
1455
          console.log('sendCommand: err=' + JSON.stringify(err));
L
liu-binjun 已提交
1456 1457 1458 1459 1460
      }
  });
  ```


1461
## geoLocationManager.sendCommand
L
liu-binjun 已提交
1462

1463
sendCommand(command: LocationCommand): Promise<void>;
L
liu-binjun 已提交
1464

1465
给位置服务子系统的各个部件发送扩展命令。
L
liu-binjun 已提交
1466 1467 1468 1469 1470 1471 1472

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

**参数**

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

**返回值**

1477 1478 1479
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void>  | void | NA | 接收错误码。 |
L
liu-binjun 已提交
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1493 1494
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geoLocationManager.sendCommand(requestInfo).then((result) => {
1495 1496
      console.log('promise, sendCommand success');
  })  
L
liu-binjun 已提交
1497
  .catch((error) => {
1498
      console.log('promise, sendCommand: error=' + JSON.stringify(error));
L
liu-binjun 已提交
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
  });
  ```


## geoLocationManager.getCountryCode

getCountryCode(callback: AsyncCallback<CountryCode>): void;

查询当前的国家码。

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301500 | Failed to query the area information.|

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.getCountryCode((err, result) => {
      if (err) {
          console.log('getCountryCode: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('getCountryCode: result=' + JSON.stringify(result));
      }
  });
  ```


## geoLocationManager.getCountryCode

getCountryCode(): Promise<CountryCode>;

查询当前的国家码。

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

**返回值**

1551 1552 1553
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 |
L
liu-binjun 已提交
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301500 | Failed to query the area information.|

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  geoLocationManager.getCountryCode()
  .then((result) => {
      console.log('promise, getCountryCode: result=' + JSON.stringify(result));
  })
  .catch((error) => {
      console.log('promise, getCountryCode: error=' + JSON.stringify(error));
  });
  ```


## geoLocationManager.enableLocationMock

1580
enableLocationMock(): void;
L
liu-binjun 已提交
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

使能位置模拟功能。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.|

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1601 1602 1603 1604 1605
  try {
      geoLocationManager.enableLocationMock();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1606 1607 1608 1609 1610
  ```


## geoLocationManager.disableLocationMock

1611
disableLocationMock(): void;
L
liu-binjun 已提交
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631

去使能位置模拟功能。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.|

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1632 1633 1634 1635 1636
  try {
      geoLocationManager.disableLocationMock();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1637 1638 1639 1640 1641
  ```


## geoLocationManager.setMockedLocations

1642
setMockedLocations(config: LocationMockConfig): void;
L
liu-binjun 已提交
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676

设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | config |  [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数,包含模拟位置上报的时间间隔和模拟位置数组。 |

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.|

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
  var locations = [
      {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
      {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
      {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
      {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
      {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
  ];
  var config = {"timeInterval": 5, "locations": locations};
1677 1678 1679 1680 1681
  try {
      geoLocationManager.setMockedLocations(config);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1682 1683 1684 1685 1686
  ```


## geoLocationManager.enableReverseGeocodingMock

1687
enableReverseGeocodingMock(): void;
L
liu-binjun 已提交
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706

使能逆地理编码模拟功能。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1707 1708 1709 1710 1711
  try {
      geoLocationManager.enableReverseGeocodingMock();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1712 1713 1714 1715 1716
  ```


## geoLocationManager.disableReverseGeocodingMock

1717
disableReverseGeocodingMock(): void;
L
liu-binjun 已提交
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736

去使能逆地理编码模拟功能。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1737 1738 1739 1740 1741
  try {
      geoLocationManager.disableReverseGeocodingMock();
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1742 1743 1744
  ```


1745
## geoLocationManager.setReverseGeocodingMockInfo
L
liu-binjun 已提交
1746

1747
setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void;
L
liu-binjun 已提交
1748

1749
设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。
L
liu-binjun 已提交
1750 1751 1752 1753 1754 1755 1756

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

**系统API**:此接口为系统接口,三方应用不支持调用。

**参数**

1757 1758 1759
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
L
liu-binjun 已提交
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1773 1774 1775 1776 1777 1778 1779
  var mockInfos = [
      {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
  ];
1780 1781 1782 1783 1784
  try {
      geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1785 1786 1787
  ```


1788
## geoLocationManager.isLocationPrivacyConfirmed
L
liu-binjun 已提交
1789

1790
isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
L
liu-binjun 已提交
1791

1792
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
L
liu-binjun 已提交
1793 1794 1795

**系统API**:此接口为系统接口,三方应用不支持调用。

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

L
liu-binjun 已提交
1798 1799 1800 1801
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1802 1803 1804 1805
  | type |  [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |

**返回值**

1806 1807 1808
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | boolean  | boolean | NA | 表示用户是否同意定位服务隐私申明。 |
L
liu-binjun 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1822 1823 1824 1825 1826
  try {
      var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1827 1828 1829
  ```


1830
## geoLocationManager.setLocationPrivacyConfirmStatus
L
liu-binjun 已提交
1831

1832
setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
L
liu-binjun 已提交
1833

1834
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
L
liu-binjun 已提交
1835 1836 1837

**系统API**:此接口为系统接口,三方应用不支持调用。

1838 1839 1840 1841
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS

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

L
liu-binjun 已提交
1842 1843 1844 1845
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
1846 1847
  | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
L
liu-binjun 已提交
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1861 1862 1863 1864 1865
  try {
      geoLocationManager.setLocationPrivacyConfirmStatus(1, true);
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
1866 1867 1868 1869 1870 1871 1872 1873 1874
  ```


## LocationRequestPriority

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

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

1875
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先,如果应用希望快速拿到1个位置,可以将优先级设置为该字段。 |


## LocationRequestScenario

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

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

1889
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。 |


## ReverseGeoCodeRequest

逆地理编码请求接口。

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

1905
| 名称 | 类型 | 可读 | 可写 | 说明 |
L
liu-binjun 已提交
1906
| -------- | -------- | -------- | -------- |
1907 1908 1909 1910
| locale | string | 是 | 是 | 指定位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| latitude | number | 是 | 是 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number | 是 | 是 | 表示经度信息,正值表示东经,负值表示西经。 |
| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
L
liu-binjun 已提交
1911 1912 1913 1914 1915 1916 1917 1918


## GeoCodeRequest

地理编码请求接口。

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

1919
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1920
| -------- | -------- | -------- | -------- |
1921 1922 1923 1924 1925 1926 1927
| locale | string | 是 | 是 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| description | number | 是 | 是 | 表示位置信息描述,如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 是 | 是 | 表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。 |
| minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
L
liu-binjun 已提交
1928 1929 1930 1931 1932 1933 1934 1935


## GeoAddress

地理编码类型。

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

1936
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1937
| -------- | -------- | -------- | -------- |
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
| latitude | number | 是 | 否  | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number | 是 | 否  | 表示经度信息,正值表示东经,负值表是西经。 |
| locale | string | 是 | 否  | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| placeName | string | 是 | 否  | 表示地区信息。 |
| countryCode | string | 是 | 否  | 表示国家码信息。 |
| countryName | string| 是 | 否 | 表示国家信息。 |
| administrativeArea | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea | string | 是 | 否 | 表示表示子区域信息。 |
| locality | string | 是 | 否 | 表示城市信息。 |
| subLocality | string | 是 | 否 | 表示子城市信息。 |
| roadName | string | 是 | 否 |表示路名信息。 |
| subRoadName | string | 是 | 否 | 表示子路名信息。 |
| premises | string| 是 | 否|表示门牌号信息。 |
| postalCode | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber | string | 是 | 否 | 表示联系方式信息。 |
| addressUrl | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions | Array<string> | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize | number | 是 | 否 | 表示附加的描述信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 |
L
liu-binjun 已提交
1957 1958 1959 1960 1961 1962 1963 1964


## LocationRequest

位置信息请求类型。

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

1965
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1966
| -------- | -------- | -------- | -------- |
1967 1968 1969 1970 1971
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
L
liu-binjun 已提交
1972 1973 1974 1975 1976 1977 1978 1979


## CurrentLocationRequest

当前位置信息请求类型。

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

1980
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1981
| -------- | -------- | -------- | -------- |
1982 1983 1984 1985
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 是 | 是| 表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 是 | 是 | 表示超时时间,单位是毫秒,最小为1000毫秒。 |
L
liu-binjun 已提交
1986 1987 1988 1989 1990 1991 1992 1993


## SatelliteStatusInfo

卫星状态信息。

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

1994
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1995
| -------- | -------- | -------- | -------- |
1996 1997 1998 1999 2000 2001
| satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array<number> | 是 | 否 | 表示每个卫星的ID,数组类型。 |
| carrierToNoiseDensitys | Array<number> | 是 | 否 | 表示载波噪声功率谱密度比,即cn0。 |
| altitudes | Array<number> | 是 | 否 | 表示高程信息。 |
| azimuths | Array<number> | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 |
L
liu-binjun 已提交
2002 2003 2004 2005 2006 2007 2008 2009


## CachedGnssLocationsRequest

请求订阅GNSS缓存位置上报功能接口的配置参数。

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

2010
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2011
| -------- | -------- | -------- | -------- |
2012 2013
| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期,单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | 是  | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。 |
L
liu-binjun 已提交
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035


## Geofence

GNSS围栏的配置参数。目前只支持圆形围栏。

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

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| latitude | number | 是 | 表示纬度。 |
| longitude | number | 是 | 表示经度。 |
| radius | number | 是 | 表示圆形围栏的半径。 |
| expiration | number | 是 | 围栏存活的时间,单位是毫秒。 |


## GeofenceRequest

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

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

2036
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2037
| -------- | -------- | -------- | -------- |
2038 2039
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是  |  表示定位场景。 |
| geofence |  [Geofence](#geofence)| 是 | 是  |  表示围栏信息。 |
L
liu-binjun 已提交
2040 2041 2042 2043 2044 2045 2046 2047


## LocationPrivacyType

定位服务隐私协议类型。

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

2048
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
| -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |


## LocationCommand

扩展命令结构体。

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

2061
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2062
| -------- | -------- | -------- | -------- |
2063 2064
| scenario | [LocationRequestScenario](#locationrequestscenario)  | 是 | 是  | 表示定位场景。 |
| command | string | 是 | 是  | 扩展命令字符串。 |
L
liu-binjun 已提交
2065 2066 2067 2068 2069 2070 2071 2072


## Location

位置信息类型。

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

2073
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2074
| -------- | -------- | -------- | -------- |
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
| latitude | number| 是 | 否 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number| 是 | 否 | 表示经度信息,正值表示东经,负值表是西经。 |
| altitude | number | 是 | 否 | 表示高度信息,单位米。 |
| accuracy | number | 是 | 否 | 表示精度信息,单位米。 |
| speed | number | 是 | 否 |表示速度信息,单位米每秒。 |
| timeStamp | number | 是 | 否 | 表示位置时间戳,UTC格式。 |
| direction | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot | number | 是 | 否 | 表示位置时间戳,开机时间格式。 |
| additions | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize | number | 是 | 否 | 附加信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示位置信息是否来自于位置模拟功能。 |
L
liu-binjun 已提交
2086 2087 2088 2089 2090 2091 2092 2093 2094 2095


## ReverseGeocodingMockInfo

逆地理编码模拟功能的配置信息,包含一个位置信息和一个地名信息。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

2096
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2097
| -------- | -------- | -------- | -------- |
2098 2099
| location |  [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 |
| geoAddress |  [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 |
L
liu-binjun 已提交
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109


## LocationMockConfig

位置模拟功能的配置参数,包含了模拟位置上报的时间间隔和模拟位置数组。

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

**系统API**:此接口为系统接口,三方应用不支持调用。

2110
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2111
| -------- | -------- | -------- | -------- |
2112 2113
| timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔,单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 是 | 表示模拟位置数组。 |
L
liu-binjun 已提交
2114 2115 2116 2117 2118 2119 2120 2121


## CountryCode

国家码信息结构体,包含国家码字符串和国家码的来源信息。

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

2122
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
2123
| -------- | -------- | -------- | -------- |
2124 2125
| country | string | 是 | 否 | 表示国家码字符串。 |
| type |  [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 |
L
liu-binjun 已提交
2126 2127 2128 2129 2130 2131 2132 2133


## CountryCodeType

国家码来源类型。

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

2134
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
2135 2136 2137 2138 2139
| -------- | -------- | -------- |
| COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 |
| COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 |
| COUNTRY_CODE_FROM_LOCATION | 3 | 基于用户的位置信息,通过逆地理编码查询到的国家码。 |
| COUNTRY_CODE_FROM_NETWORK | 4 | 从蜂窝网络注册信息中获取到的国家码。 |