js-apis-geoLocationManager.md 48.8 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
## geoLocationManager.on('countryCodeChange')
L
liu-binjun 已提交
45

46
on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;
L
liu-binjun 已提交
47

48
订阅国家码信息变化事件。
L
liu-binjun 已提交
49 50 51 52 53 54 55

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
56 57
  | type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息变化事件。 |
  | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 |
L
liu-binjun 已提交
58 59 60 61 62 63 64 65 66

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
67
|3301500 | Failed to query the area information.                                       |
L
liu-binjun 已提交
68 69 70 71 72 73


**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
74 75 76 77
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
  }

78
  try {
79
      geoLocationManager.on('countryCodeChange', callback);
80 81
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
L
liu-binjun 已提交
82 83 84 85
  }
  ```


86
## geoLocationManager.off('countryCodeChange')
L
liu-binjun 已提交
87

88
off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;
L
liu-binjun 已提交
89

90
取消订阅国家码变化事件。
L
liu-binjun 已提交
91 92 93

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

94
**参数**
L
liu-binjun 已提交
95 96 97

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

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
107 108 109
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.                                                 |
|3301500 | Failed to query the area information.                                       |
L
liu-binjun 已提交
110 111 112 113 114

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
115 116 117
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
  }
118
  try {
119 120
      geoLocationManager.on('countryCodeChange', callback);
      geoLocationManager.off('countryCodeChange', callback);
121 122
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
L
liu-binjun 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
  }
  ```


## 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

**返回值**

179 180 181
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void>  | void | NA | 返回错误码信息。 |
L
liu-binjun 已提交
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

**错误码**

以下错误码的详细介绍请参见[位置服务子系统错误码](../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

205
disableLocation(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
206

207
关闭位置服务,使用callback回调异步返回结果。
L
liu-binjun 已提交
208 209 210 211 212 213 214 215 216

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

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

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

**参数**

217 218
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
219
  | callback | AsyncCallback<void> | 是 | 用来接收错误码的回调。 |
L
liu-binjun 已提交
220 221 222 223 224 225 226

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
227
|3301000 | Location service is unavailable.                                            |
L
liu-binjun 已提交
228 229 230 231 232

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
233 234 235 236 237 238 239 240 241
  try {
      geoLocationManager.disableLocation((err, data) => {
          if (err) {
              console.log('disableLocation: err=' + JSON.stringify(err));
          }
      });
  } catch (err) {
      console.error("errCode:" + err.code + ",errMessage:" + err.message);
  }
L
liu-binjun 已提交
242 243 244
  ```


245
## geoLocationManager.disableLocation
L
liu-binjun 已提交
246

247
disableLocation(): Promise<void>
L
liu-binjun 已提交
248

249
关闭位置服务,使用Promise方式异步返回结果。
L
liu-binjun 已提交
250

251
**系统API**:此接口为系统接口,三方应用不支持调用。
L
liu-binjun 已提交
252

253
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
L
liu-binjun 已提交
254

255
**系统能力**:SystemCapability.Location.Location.Core
256 257 258

**返回值**

259 260
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
261
  | Promise<void> | void | NA |返回错误码。 |
L
liu-binjun 已提交
262 263 264 265 266 267 268

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
269
|3301000 | Location service is unavailable.                                            |
L
liu-binjun 已提交
270

271 272 273 274
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
275 276
  geoLocationManager.disableLocation().then((result) => {
      console.log('promise, disableLocation succeed');
277 278
  })
  .catch((error) => {
279 280
      console.log('promise, disableLocation: error=' + JSON.stringify(error));
  });
281
  ```
L
liu-binjun 已提交
282 283


284
## geoLocationManager.isLocationPrivacyConfirmed
285

286
isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>): void;
287

288
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
289

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

**系统能力**:SystemCapability.Location.Location.Core
293 294 295 296 297

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
298 299
  | type |  [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 |
300 301 302 303 304 305 306

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
307
|3301000 | Location service is unavailable.                                            |
L
liu-binjun 已提交
308 309 310 311 312

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
313
  geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => {
L
liu-binjun 已提交
314
      if (err) {
315
          console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err));
L
liu-binjun 已提交
316
      }
317 318
      if (result) {
          console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result));
L
liu-binjun 已提交
319 320 321 322 323
      }
  });
  ```


324
## geoLocationManager.isLocationPrivacyConfirmed
L
liu-binjun 已提交
325

326
isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise<boolean>;
L
liu-binjun 已提交
327

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

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

**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
333 334 335 336 337

**参数**

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

340
**返回值**
L
liu-binjun 已提交
341 342 343

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
344
  | Promise<boolean> |boolean| NA | 表示用户是否同意定位服务隐私申明。 |
L
liu-binjun 已提交
345 346 347 348 349 350 351

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
352
|3301000 | Location service is unavailable.                                            |
L
liu-binjun 已提交
353 354 355 356 357

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
358 359
  geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => {
      console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result));
L
liu-binjun 已提交
360 361 362 363
  });
  ```


364
## geoLocationManager.setLocationPrivacyConfirmStatus
L
liu-binjun 已提交
365

366
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
367

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

370
**系统API**:此接口为系统接口,三方应用不支持调用。
L
liu-binjun 已提交
371

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

374
**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
375 376 377 378 379

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
380 381 382
  | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
  | callback | AsyncCallback<void> | 是 | 接收错误码信息。 |
383

384 385 386 387 388 389
**错误码**

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

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

392 393 394 395
**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
396
  geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => {
397
      if (err) {
398
          console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err));
399 400 401 402 403
      }
  });
  ```


404
## geoLocationManager.setLocationPrivacyConfirmStatus
405

406
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise<void>;
407

408
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
409

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

412 413 414 415 416 417 418 419 420 421
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
L
liu-binjun 已提交
422 423 424

**返回值**

425 426
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
427
  | Promise<void> |void|NA| 接收错误码。 |
L
liu-binjun 已提交
428 429 430 431 432 433 434

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
435
|3301000 | Location service is unavailable.                                            |
L
liu-binjun 已提交
436 437 438 439 440

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
441 442 443
  geoLocationManager.setLocationPrivacyConfirmStatus(1, true).then((result) => {
      console.log('promise, setLocationPrivacyConfirmStatus succeed');
  })
L
liu-binjun 已提交
444
  .catch((error) => {
445
      console.log('promise, disableLocation: error=' + JSON.stringify(error));
L
liu-binjun 已提交
446 447 448 449
  });
  ```


450
## geoLocationManager.getCountryCode
L
liu-binjun 已提交
451

452
getCountryCode(callback: AsyncCallback<CountryCode>): void;
L
liu-binjun 已提交
453

454
查询当前的国家码。
455

456
**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
457 458 459 460 461

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
462
  | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 |
L
liu-binjun 已提交
463 464 465 466 467 468 469

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
470 471
|3301000 | Location service is unavailable.                                            |
|3301500 | Failed to query the area information.|
L
liu-binjun 已提交
472 473 474 475 476

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
477
  geoLocationManager.getCountryCode((err, result) => {
L
liu-binjun 已提交
478
      if (err) {
479 480 481 482
          console.log('getCountryCode: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('getCountryCode: result=' + JSON.stringify(result));
L
liu-binjun 已提交
483 484 485 486 487
      }
  });
  ```


488
## geoLocationManager.getCountryCode
L
liu-binjun 已提交
489

490
getCountryCode(): Promise<CountryCode>;
L
liu-binjun 已提交
491

492
查询当前的国家码。
L
liu-binjun 已提交
493

494
**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
495 496 497

**返回值**

498 499
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
500
  | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 |
L
liu-binjun 已提交
501 502 503 504 505 506 507

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
508 509
|3301000 | Location service is unavailable.                                            |
|3301500 | Failed to query the area information.|
L
liu-binjun 已提交
510 511 512 513 514

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
515 516 517
  geoLocationManager.getCountryCode()
  .then((result) => {
      console.log('promise, getCountryCode: result=' + JSON.stringify(result));
L
liu-binjun 已提交
518 519
  })
  .catch((error) => {
520
      console.log('promise, getCountryCode: error=' + JSON.stringify(error));
L
liu-binjun 已提交
521 522 523 524
  });
  ```


525
## geoLocationManager.enableLocationMock
L
liu-binjun 已提交
526

527
enableLocationMock(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
528

529
使能位置模拟功能。
L
liu-binjun 已提交
530 531 532

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

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

L
liu-binjun 已提交
535 536 537 538
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
539
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
L
liu-binjun 已提交
540 541 542 543 544 545 546

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
547 548
|3301000 | Location service is unavailable.                                            |
|3301100 | The location switch is off.|
L
liu-binjun 已提交
549 550 551 552 553

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
554
  geoLocationManager.enableLocationMock((err, result) => {
L
liu-binjun 已提交
555
      if (err) {
556
          console.log('enableLocationMock: err=' + JSON.stringify(err));
L
liu-binjun 已提交
557 558 559 560
      }
  });
  ```

561
## geoLocationManager.enableLocationMock
L
liu-binjun 已提交
562

563
enableLocationMock(): Promise<void>;
L
liu-binjun 已提交
564

565
使能位置模拟功能。
L
liu-binjun 已提交
566 567 568

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

569
**系统API**:此接口为系统接口,三方应用不支持调用。
L
liu-binjun 已提交
570 571 572

**返回值**

573 574
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
575
  | Promise<void> | void|NA|用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |
L
liu-binjun 已提交
576 577 578 579 580 581 582 583

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
584
|3301100 | The location switch is off.|
L
liu-binjun 已提交
585 586 587 588 589

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
590 591 592 593
  geoLocationManager.enableLocationMock()
  .then((result) => {
      console.log('promise, enableLocationMock: succeed');
  })
L
liu-binjun 已提交
594
  .catch((error) => {
595 596 597
      if (error) {
        console.log('promise, enableLocationMock: error=' + JSON.stringify(error));
      }
L
liu-binjun 已提交
598 599 600 601
  });
  ```


602
## geoLocationManager.disableLocationMock
L
liu-binjun 已提交
603

604
disableLocationMock(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
605

606
去使能位置模拟功能。
L
liu-binjun 已提交
607 608 609

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

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

L
liu-binjun 已提交
612 613 614 615
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
616
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
L
liu-binjun 已提交
617 618 619 620 621 622 623 624

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
625
|3301100 | The location switch is off.|
L
liu-binjun 已提交
626 627 628 629 630

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
631
  geoLocationManager.disableLocationMock((err, result) => {
L
liu-binjun 已提交
632
      if (err) {
633
          console.log('disableLocationMock: err=' + JSON.stringify(err));
L
liu-binjun 已提交
634 635 636 637 638
      }
  });
  ```


639
## geoLocationManager.disableLocationMock
L
liu-binjun 已提交
640

641
disableLocationMock(): Promise<void>;
L
liu-binjun 已提交
642

643
去使能位置模拟功能。
L
liu-binjun 已提交
644 645 646

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

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

L
liu-binjun 已提交
649 650
**返回值**

651 652
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
653
  | Promise<void> |void|NA| 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |
L
liu-binjun 已提交
654 655 656 657 658 659 660 661

**错误码**

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable.                                            |
662
|3301100 | The location switch is off.|
L
liu-binjun 已提交
663 664 665 666 667

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
668
  geoLocationManager.disableLocationMock()
L
liu-binjun 已提交
669
  .then((result) => {
670
        console.log('promise, disableLocationMock succeed');
L
liu-binjun 已提交
671 672
  })
  .catch((error) => {
673 674 675
      if (error) {
        console.log('promise, disableLocationMock: error=' + JSON.stringify(error));
      }
L
liu-binjun 已提交
676 677 678 679
  });
  ```


680
## geoLocationManager.setMockedLocations
L
liu-binjun 已提交
681

682
setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
683

684
设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。
L
liu-binjun 已提交
685 686 687 688 689

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

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

690 691 692 693 694 695 696
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | config |  [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数,包含模拟位置上报的时间间隔和模拟位置数组。 |
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |

L
liu-binjun 已提交
697 698 699 700 701 702 703 704 705 706 707 708 709
**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
710 711 712 713 714 715 716 717 718 719 720 721 722
  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};
  geoLocationManager.setMockedLocations(config, (err, data) => {
      if (err) {
          console.log('setMockedLocations: err=' + JSON.stringify(err));
      }
  });
L
liu-binjun 已提交
723 724
  ```

725
## geoLocationManager.setMockedLocations
L
liu-binjun 已提交
726

727
setMockedLocations(config: LocationMockConfig): Promise<void>;
L
liu-binjun 已提交
728

729
设置模拟的位置信息,后面会以该接口中携带的时间间隔上报模拟位置。
L
liu-binjun 已提交
730 731 732 733 734

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

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

735 736 737 738 739 740 741 742 743 744 745 746
**参数**

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

**返回值**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void> |void|NA| 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

L
liu-binjun 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759
**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
  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};
  geoLocationManager.setMockedLocations(config)
  .then((result) => {
      console.log('promise, setMockedLocations succeed');
  })
  .catch((error) => {
      if (error) {
        console.log('promise, setMockedLocations: error=' + JSON.stringify(error));
      }
  });
L
liu-binjun 已提交
777 778 779
  ```


780
## geoLocationManager.enableReverseGeocodingMock
L
liu-binjun 已提交
781

782
enableReverseGeocodingMock(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
783

784
使能逆地理编码模拟功能。
L
liu-binjun 已提交
785 786 787 788 789 790 791 792 793

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

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

**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
794
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
L
liu-binjun 已提交
795 796 797 798 799 800 801 802 803 804 805 806 807

**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
808 809 810 811 812
  geoLocationManager.enableReverseGeocodingMock((err, data) => {
      if (err) {
          console.log('enableReverseGeocodingMock: err=' + JSON.stringify(err));
      }
  });
L
liu-binjun 已提交
813 814 815 816 817
  ```


## geoLocationManager.enableReverseGeocodingMock

818
enableReverseGeocodingMock(): Promise<void>;
L
liu-binjun 已提交
819 820 821 822 823 824 825

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

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

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

826 827 828 829 830 831
**返回值**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | Promise<void> | void|NA|用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

L
liu-binjun 已提交
832 833 834 835 836 837 838 839 840 841 842 843
**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
844 845 846 847 848 849 850 851 852
  geoLocationManager.enableReverseGeocodingMock()
  .then((result) => {
      console.log('promise, enableReverseGeocodingMock succeed');
  })
  .catch((error) => {
      if (error) {
        console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error));
      }
  });
L
liu-binjun 已提交
853 854 855 856 857
  ```


## geoLocationManager.disableReverseGeocodingMock

858
disableReverseGeocodingMock(callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
859 860 861 862 863 864 865

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

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

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

866 867 868 869 870 871
**参数**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |

L
liu-binjun 已提交
872 873 874 875 876 877 878 879 880 881 882 883
**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
884 885 886 887 888
  geoLocationManager.disableReverseGeocodingMock((err, result) => {
      if (err) {
          console.log('disableReverseGeocodingMock: err=' + JSON.stringify(err));
      }
  });
L
liu-binjun 已提交
889 890 891
  ```


892
## geoLocationManager.disableReverseGeocodingMock
L
liu-binjun 已提交
893

894
disableReverseGeocodingMock(): Promise<void>;
L
liu-binjun 已提交
895

896
去使能逆地理编码模拟功能。
L
liu-binjun 已提交
897 898 899 900 901

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

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

902
**返回值**
L
liu-binjun 已提交
903

904 905
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
906
  | Promise<void> |void|NA| 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |
L
liu-binjun 已提交
907 908 909 910 911 912 913 914 915 916 917 918 919

**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
920 921 922 923 924 925 926 927 928
  geoLocationManager.disableReverseGeocodingMock()
  .then((result) => {
      console.log('promise, disableReverseGeocodingMock succeed');
  })
  .catch((error) => {
      if (error) {
        console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error));
      }
  });
L
liu-binjun 已提交
929 930 931
  ```


932
## geoLocationManager.setReverseGeocodingMockInfo
L
liu-binjun 已提交
933

934
setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, callback: AsyncCallback<void>): void;
L
liu-binjun 已提交
935

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

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

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

942
**参数**
943

944 945
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
946 947
  | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
  | callback | AsyncCallback<void> | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |
L
liu-binjun 已提交
948 949 950 951 952 953 954 955 956 957 958 959 960

**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
961 962 963 964 965 966 967 968 969 970 971 972
  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}},
  ];
  geoLocationManager.setReverseGeocodingMockInfo(mockInfos, (err, data) => {
      if (err) {
          console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err));
      }
  });
L
liu-binjun 已提交
973 974 975
  ```


976
## geoLocationManager.setReverseGeocodingMockInfo
L
liu-binjun 已提交
977

978
setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): Promise<void>;
L
liu-binjun 已提交
979

980 981 982
设置逆地理编码模拟功能的配置信息,包含了位置和地名的对应关系,后续进行逆地理编码查询时如果位置信息位于配置信息中,就返回对应的地名。

**系统能力**:SystemCapability.Location.Location.Core
L
liu-binjun 已提交
983 984 985

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

986
**参数**
987

988 989 990
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 |
991

992
**返回值**
L
liu-binjun 已提交
993 994 995

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
996
  | Promise<void> | void | NA | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |
L
liu-binjun 已提交
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

**错误码**

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

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

**示例**
  
  ```ts
  import geoLocationManager from '@ohos.geoLocationManager';
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
  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}},
  ];
  geoLocationManager.setReverseGeocodingMockInfo(mockInfos)
  .then((result) => {
      console.log('promise, setReverseGeocodingMockInfo succeed');
  })
  .catch((error) => {
      if (error) {
        console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error));
      }
  });
L
liu-binjun 已提交
1026 1027 1028 1029 1030 1031 1032 1033 1034
  ```


## LocationRequestPriority

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

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

1035
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先,如果应用希望快速拿到1个位置,可以将优先级设置为该字段。 |


## LocationRequestScenario

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

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

1049
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。 |


## ReverseGeoCodeRequest

逆地理编码请求接口。

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

1065
| 名称 | 类型 | 可读 | 可写 | 说明 |
L
liu-binjun 已提交
1066
| -------- | -------- | -------- | -------- |
1067 1068 1069 1070
| locale | string | 是 | 是 | 指定位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| latitude | number | 是 | 是 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number | 是 | 是 | 表示经度信息,正值表示东经,负值表示西经。 |
| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
L
liu-binjun 已提交
1071 1072 1073 1074 1075 1076 1077 1078


## GeoCodeRequest

地理编码请求接口。

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

1079
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1080
| -------- | -------- | -------- | -------- |
1081 1082 1083 1084 1085 1086 1087
| locale | string | 是 | 是 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| description | number | 是 | 是 | 表示位置信息描述,如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 是 | 是 | 表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。 |
| minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
L
liu-binjun 已提交
1088 1089 1090 1091 1092 1093 1094 1095


## GeoAddress

地理编码类型。

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

1096
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1097
| -------- | -------- | -------- | -------- |
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
| 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 已提交
1117 1118 1119 1120 1121 1122 1123 1124


## LocationRequest

位置信息请求类型。

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

1125
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1126
| -------- | -------- | -------- | -------- |
1127 1128 1129 1130 1131
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
L
liu-binjun 已提交
1132 1133 1134 1135 1136 1137 1138 1139


## CurrentLocationRequest

当前位置信息请求类型。

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

1140
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1141
| -------- | -------- | -------- | -------- |
1142 1143 1144 1145
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 是 | 是| 表示精度信息,单位是米。仅在精确位置功能场景下有效,模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 是 | 是 | 表示超时时间,单位是毫秒,最小为1000毫秒。 |
L
liu-binjun 已提交
1146 1147 1148 1149 1150 1151 1152 1153


## SatelliteStatusInfo

卫星状态信息。

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

1154
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1155
| -------- | -------- | -------- | -------- |
1156 1157 1158 1159 1160 1161
| satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array<number> | 是 | 否 | 表示每个卫星的ID,数组类型。 |
| carrierToNoiseDensitys | Array<number> | 是 | 否 | 表示载波噪声功率谱密度比,即cn0。 |
| altitudes | Array<number> | 是 | 否 | 表示高程信息。 |
| azimuths | Array<number> | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 |
L
liu-binjun 已提交
1162 1163 1164 1165 1166 1167 1168 1169


## CachedGnssLocationsRequest

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

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

1170
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1171
| -------- | -------- | -------- | -------- |
1172 1173
| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期,单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | 是  | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。 |
L
liu-binjun 已提交
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195


## Geofence

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

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

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


## GeofenceRequest

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

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

1196
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1197
| -------- | -------- | -------- | -------- |
1198 1199 1200
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是  | 表示位置信息优先级。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是  | 表示定位场景。 |
| geofence |  [Geofence](#geofence) | 是 | 是  | 表示围栏信息。 |
L
liu-binjun 已提交
1201 1202 1203 1204 1205 1206 1207 1208


## LocationPrivacyType

定位服务隐私协议类型。

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

1209
| 名称 | 值 | 说明 |
L
liu-binjun 已提交
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
| -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |


## LocationCommand

扩展命令结构体。

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

1222
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1223
| -------- | -------- | -------- | -------- |
1224 1225
| scenario | [LocationRequestScenario](#locationrequestscenario)  | 是 | 是  | 表示定位场景。 |
| command | string | 是 | 是  | 扩展命令字符串。 |
L
liu-binjun 已提交
1226 1227 1228 1229 1230 1231 1232 1233


## Location

位置信息类型。

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

1234
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1235
| -------- | -------- | -------- | -------- |
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
| 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 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256


## ReverseGeocodingMockInfo

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

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

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

1257
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1258
| -------- | -------- | -------- | -------- |
1259 1260
| location |  [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 |
| geoAddress |  [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 |
L
liu-binjun 已提交
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270


## LocationMockConfig

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

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

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

1271
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1272
| -------- | -------- | -------- | -------- |
1273 1274
| timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔,单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 是 | 表示模拟位置数组。 |
L
liu-binjun 已提交
1275 1276 1277 1278 1279 1280 1281 1282


## CountryCode

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

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

1283
| 名称 | 类型 | 可读|可写 | 说明 |
L
liu-binjun 已提交
1284
| -------- | -------- | -------- | -------- |
1285 1286
| country | string | 是 | 否 | 表示国家码字符串。 |
| type |  [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 |
L
liu-binjun 已提交
1287 1288 1289 1290 1291 1292 1293 1294


## CountryCodeType

国家码来源类型。

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

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