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

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

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


## 导入模块

L
liu-binjun 已提交
11
```js
Z
zengyawen 已提交
12 13 14 15 16 17 18 19 20
import geolocation from '@ohos.geolocation';
```

## geolocation.on('locationChange')

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

开启位置变化订阅,并发起定位请求。

L
liu-binjun 已提交
21 22 23 24
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
25 26
**参数**

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

L
liu-binjun 已提交
33

L
liu-binjun 已提交
34
**示例**
Z
zengyawen 已提交
35
  
L
liu-binjun 已提交
36
  ```js
Z
zengyawen 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
  geolocation.on('locationChange', requestInfo, locationChange);
  ```


## geolocation.off('locationChange')

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

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

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

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

L
liu-binjun 已提交
55 56
**参数**

Z
zengyawen 已提交
57
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
58
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
59 60
  | type | string | 是 | 设置事件类型。type为“locationChange”,表示位置变化。 |
  | callback | Callback<[Location](#location)> | 否 | 接收位置变化状态变化监听。 |
Z
zengyawen 已提交
61

L
liu-binjun 已提交
62

L
liu-binjun 已提交
63
**示例**
Z
zengyawen 已提交
64
  
L
liu-binjun 已提交
65
  ```js
Z
zengyawen 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
  var locationChange = (location) => {
      console.log('locationChanger: data: ' + JSON.stringify(location));
  };
  geolocation.on('locationChange', requestInfo, locationChange);
  geolocation.off('locationChange', locationChange);
  ```


## geolocation.on('locationServiceState')

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

订阅位置服务状态变化。

L
liu-binjun 已提交
81 82 83 84
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
85 86
**参数**

Z
zengyawen 已提交
87
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
88
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
89 90
  | type | string | 是 | 设置事件类型。type为“locationServiceState”,表示位置服务状态。 |
  | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 |
Z
zengyawen 已提交
91

L
liu-binjun 已提交
92

L
liu-binjun 已提交
93
**示例**
Z
zengyawen 已提交
94
  
L
liu-binjun 已提交
95
  ```js
Z
zengyawen 已提交
96
  var locationServiceState = (state) => {
L
liu-binjun 已提交
97
      console.log('locationServiceState: ' + JSON.stringify(state));
Z
zengyawen 已提交
98 99 100 101 102 103 104 105 106 107 108
  }
  geolocation.on('locationServiceState', locationServiceState);
  ```


## geolocation.off('locationServiceState')

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

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

L
liu-binjun 已提交
109 110 111 112
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
113 114
**参数**

Z
zengyawen 已提交
115
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
116
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
117 118
  | type | string | 是 | 设置事件类型。type为“locationServiceState”,表示位置服务状态。 |
  | callback | Callback<boolean> | 否 | 接收位置服务状态变化监听。 |
Z
zengyawen 已提交
119

L
liu-binjun 已提交
120

L
liu-binjun 已提交
121
**示例**
Z
zengyawen 已提交
122
  
L
liu-binjun 已提交
123
  ```js
Z
zengyawen 已提交
124
  var locationServiceState = (state) => {
L
liu-binjun 已提交
125
      console.log('locationServiceState: state: ' + JSON.stringify(state));
Z
zengyawen 已提交
126 127 128 129 130 131
  }
  geolocation.on('locationServiceState', locationServiceState);
  geolocation.off('locationServiceState', locationServiceState);
  ```


L
liu-binjun 已提交
132
## geolocation.on('cachedGnssLocationsReporting')<sup>8+</sup>
Z
zengyawen 已提交
133 134 135 136 137

on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;) : void;

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

L
liu-binjun 已提交
138 139 140 141
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
142 143
**参数**

Z
zengyawen 已提交
144
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
145
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
146 147 148
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。 |
  | request | CachedGnssLocationsRequest | 是 | GNSS缓存功能配置参数 |
  | callback | Callback&lt;boolean&gt; | 是 | 接收GNSS缓存位置上报。 |
Z
zengyawen 已提交
149

L
liu-binjun 已提交
150

L
liu-binjun 已提交
151
**示例**
Z
zengyawen 已提交
152
  
L
liu-binjun 已提交
153
  ```js
Z
zengyawen 已提交
154
  var cachedLocationsCb = (locations) => {
L
liu-binjun 已提交
155
      console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
Z
zengyawen 已提交
156 157 158 159 160 161
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
  geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
  ```


L
liu-binjun 已提交
162
## geolocation.off('cachedGnssLocationsReporting')<sup>8+</sup>
Z
zengyawen 已提交
163 164 165 166 167

off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Location&gt;&gt;) : void;

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

L
liu-binjun 已提交
168 169 170 171
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
172 173
**参数**

Z
zengyawen 已提交
174
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
175
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
176 177
  | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”,表示GNSS缓存定位结果上报。 |
  | callback | Callback&lt;boolean&gt; | 否 | 接收GNSS缓存位置上报。 |
Z
zengyawen 已提交
178

L
liu-binjun 已提交
179

L
liu-binjun 已提交
180
**示例**
Z
zengyawen 已提交
181
  
L
liu-binjun 已提交
182
  ```js
Z
zengyawen 已提交
183
  var cachedLocationsCb = (locations) => {
L
liu-binjun 已提交
184
      console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
Z
zengyawen 已提交
185 186 187 188 189 190 191
  }
  var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
  geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
  geolocation.off('cachedGnssLocationsReporting');
  ```


L
liu-binjun 已提交
192
## geolocation.on('gnssStatusChange')<sup>8+</sup>
Z
zengyawen 已提交
193 194 195 196 197

on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;) : void;

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

L
liu-binjun 已提交
198 199 200 201
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
202 203
**参数**

Z
zengyawen 已提交
204
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
205
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
206 207
  | type | string | 是 | 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。 |
  | callback | Callback&lt;SatelliteStatusInfo&gt; | 是 | 接收GNSS卫星状态信息上报。 |
Z
zengyawen 已提交
208

L
liu-binjun 已提交
209

L
liu-binjun 已提交
210
**示例**
Z
zengyawen 已提交
211
  
L
liu-binjun 已提交
212
  ```js
Z
zengyawen 已提交
213
  var gnssStatusCb = (satelliteStatusInfo) => {
L
liu-binjun 已提交
214
      console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
Z
zengyawen 已提交
215 216 217 218 219
  }
  geolocation.on('gnssStatusChange', gnssStatusCb);
  ```


L
liu-binjun 已提交
220
## geolocation.off('gnssStatusChange')<sup>8+</sup>
Z
zengyawen 已提交
221 222 223 224 225

off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;) : void;

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

L
liu-binjun 已提交
226 227 228 229
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
230 231
**参数**

Z
zengyawen 已提交
232
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
233
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
234 235
  | type | string | 是 | 设置事件类型。type为“gnssStatusChange”,表示订阅GNSS卫星状态信息上报。 |
  | callback | Callback&lt;SatelliteStatusInfo&gt; | 否 | 接收GNSS卫星状态信息上报。 |
Z
zengyawen 已提交
236

L
liu-binjun 已提交
237
**示例**
Z
zengyawen 已提交
238
  
L
liu-binjun 已提交
239
  ```js
Z
zengyawen 已提交
240
  var gnssStatusCb = (satelliteStatusInfo) => {
L
liu-binjun 已提交
241
      console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
Z
zengyawen 已提交
242 243 244 245 246 247
  }
  geolocation.on('gnssStatusChange', gnssStatusCb);
  geolocation.off('gnssStatusChange', gnssStatusCb);
  ```


L
liu-binjun 已提交
248
## geolocation.on('nmeaMessageChange')<sup>8+</sup>
Z
zengyawen 已提交
249 250 251 252 253

on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;) : void;

订阅GNSS NMEA信息上报事件。

L
liu-binjun 已提交
254 255 256 257
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
258 259
**参数**

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

L
liu-binjun 已提交
265

L
liu-binjun 已提交
266
**示例**
Z
zengyawen 已提交
267
  
L
liu-binjun 已提交
268
  ```js
Z
zengyawen 已提交
269
  var nmeaCb = (str) => {
L
liu-binjun 已提交
270
      console.log('nmeaMessageChange: ' + JSON.stringify(str));
Z
zengyawen 已提交
271 272 273 274 275
  }
  geolocation.on('nmeaMessageChange', nmeaCb );
  ```


L
liu-binjun 已提交
276
## geolocation.off('nmeaMessageChange')<sup>8+</sup>
Z
zengyawen 已提交
277 278 279 280 281

off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;) : void;

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

L
liu-binjun 已提交
282 283 284 285
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
286 287
**参数**

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

L
liu-binjun 已提交
293

L
liu-binjun 已提交
294
**示例**
Z
zengyawen 已提交
295
  
L
liu-binjun 已提交
296
  ```js
Z
zengyawen 已提交
297
  var nmeaCb = (str) => {
L
liu-binjun 已提交
298
      console.log('nmeaMessageChange: ' + JSON.stringify(str));
Z
zengyawen 已提交
299 300 301 302 303 304
  }
  geolocation.on('nmeaMessageChange', nmeaCb);
  geolocation.off('nmeaMessageChange', nmeaCb);
  ```


L
liu-binjun 已提交
305
## geolocation.on('fenceStatusChange')<sup>8+</sup>
Z
zengyawen 已提交
306 307 308 309 310

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

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

L
liu-binjun 已提交
311 312 313 314
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
315 316
**参数**

Z
zengyawen 已提交
317
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
318
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
319 320 321
  | type | string | 是 | 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。 |
  | request | GeofenceRequest | 是 | 围栏的配置参数。 |
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
Z
zengyawen 已提交
322

L
liu-binjun 已提交
323

L
liu-binjun 已提交
324
**示例**
Z
zengyawen 已提交
325
  
L
liu-binjun 已提交
326 327 328 329 330
  ```js
  import geolocation from '@ohos.geolocation';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
Z
zengyawen 已提交
331 332
      wants: [
          {
L
liu-binjun 已提交
333 334
              bundleName: "com.example.myapplication",
              abilityName: "com.example.myapplication.MainAbility"
Z
zengyawen 已提交
335 336 337
              action: "action1",
          }
      ],
L
liu-binjun 已提交
338
      operationType: wantAgent.OperationType.START_ABILITY,
Z
zengyawen 已提交
339
      requestCode: 0,
L
liu-binjun 已提交
340 341 342 343 344 345 346
      wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  
  wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
    geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
  });
Z
zengyawen 已提交
347 348 349
  ```


L
liu-binjun 已提交
350
## geolocation.off('fenceStatusChange')<sup>8+</sup>
Z
zengyawen 已提交
351 352 353 354 355

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

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

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

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

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

Z
zengyawen 已提交
362
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
363
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
364 365 366
  | type | string | 是 | 设置事件类型。type为“fenceStatusChange”,表示订阅围栏事件上报。 |
  | request | GeofenceRequest | 是 | 围栏的配置参数。 |
  | want | WantAgent | 是 | 用于接收地理围栏事件上报(进出围栏)。 |
Z
zengyawen 已提交
367

L
liu-binjun 已提交
368
**示例**
Z
zengyawen 已提交
369
  
L
liu-binjun 已提交
370 371 372 373 374
  ```js
  import geolocation from '@ohos.geolocation';
  import wantAgent from '@ohos.wantAgent';
  
  let wantAgentInfo = {
Z
zengyawen 已提交
375 376
      wants: [
          {
L
liu-binjun 已提交
377 378
              bundleName: "com.example.myapplication",
              abilityName: "com.example.myapplication.MainAbility"
Z
zengyawen 已提交
379 380 381
              action: "action1",
          }
      ],
L
liu-binjun 已提交
382
      operationType: wantAgent.OperationType.START_ABILITY,
Z
zengyawen 已提交
383
      requestCode: 0,
L
liu-binjun 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
      wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  
  wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
    geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
    geolocation.off('fenceStatusChange', requestInfo, wantAgentObj);
  });
  ```


## geolocation.on('countryCodeChange')<sup>9+</sup>

on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;) : void;

订阅国家码信息上报事件。

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示订阅国家码信息上报。 |
  | callback | Callback&lt;CountryCode&gt; | 是 | 接收国家码信息上报。 |


**示例**
  
  ```js
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
  }
  geolocation.on('countryCodeChange', callback);
  ```


## geolocation.off('countryCodeChange')<sup>9+</sup>

off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;) : void;

取消订阅国家码上报事件。

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | string | 是 | 设置事件类型。type为“countryCodeChange”,表示取消订阅国家码信息上报。 |
  | callback | Callback&lt;CountryCode&gt; | 是 | 接收国家码信息上报。 |


**示例**
  
  ```js
  var callback = (code) => {
      console.log('countryCodeChange: ' + JSON.stringify(code));
Z
zengyawen 已提交
442
  }
L
liu-binjun 已提交
443 444
  geolocation.on('countryCodeChange', callback);
  geolocation.off('countryCodeChange', callback);
Z
zengyawen 已提交
445 446 447 448 449 450 451 452 453 454
  ```


## geolocation.getCurrentLocation

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


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

L
liu-binjun 已提交
455 456 457
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
459 460
**参数**

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

L
liu-binjun 已提交
466
**示例**
Z
zengyawen 已提交
467
  
L
liu-binjun 已提交
468
  ```js
Z
zengyawen 已提交
469 470
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
  var locationChange = (err, location) => {
L
liu-binjun 已提交
471 472 473 474 475 476
      if (err) {
          console.log('locationChanger: err=' + JSON.stringify(err));
      }
      if (location) {
          console.log('locationChanger: location=' + JSON.stringify(location));
      }
Z
zengyawen 已提交
477 478 479 480 481 482 483 484 485 486 487 488 489
  };
  geolocation.getCurrentLocation(requestInfo, locationChange);
  geolocation.getCurrentLocation(locationChange);
  ```


## geolocation.getCurrentLocation

getCurrentLocation(request?: CurrentLocationRequest) : Promise&lt;Location&gt;


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

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

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

L
liu-binjun 已提交
494 495
**参数**

Z
zengyawen 已提交
496
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
497
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
498
  | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
Z
zengyawen 已提交
499

L
liu-binjun 已提交
500 501
**返回值**

Z
zengyawen 已提交
502
    | 参数名 | 说明 |
Z
zengyawen 已提交
503
  | -------- | -------- |
Z
zengyawen 已提交
504
  | Promise&lt;[Location](#location)&gt; | 返回位置信息。 |
Z
zengyawen 已提交
505

L
liu-binjun 已提交
506

L
liu-binjun 已提交
507
**示例**
Z
zengyawen 已提交
508
  
L
liu-binjun 已提交
509
  ```js
Z
zengyawen 已提交
510
  var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
L
liu-binjun 已提交
511
  geolocation.getCurrentLocation(requestInfo).then((result) => {
Z
zengyawen 已提交
512 513 514 515 516 517 518 519 520 521 522
      console.log('current location: ' + JSON.stringify(result));
  });
  ```


## geolocation.getLastLocation

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

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

L
liu-binjun 已提交
523 524 525 526
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
527 528
**参数**

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

L
liu-binjun 已提交
533

L
liu-binjun 已提交
534
**示例**
Z
zengyawen 已提交
535
  
L
liu-binjun 已提交
536
  ```js
Z
zengyawen 已提交
537
  geolocation.getLastLocation((err, data) => {
L
liu-binjun 已提交
538 539 540 541 542 543
      if (err) {
          console.log('getLastLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getLastLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
544 545 546 547 548 549 550 551 552 553
  });
  ```


## geolocation.getLastLocation

getLastLocation() : Promise&lt;Location&gt;

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

L
liu-binjun 已提交
554 555 556 557
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
558 559
**返回值**

Z
zengyawen 已提交
560
    | 参数名 | 说明 |
Z
zengyawen 已提交
561
  | -------- | -------- |
Z
zengyawen 已提交
562
  | Promise&lt;[Location](#location)&gt; | 返回上次位置信息。 |
Z
zengyawen 已提交
563

L
liu-binjun 已提交
564

L
liu-binjun 已提交
565
**示例**
Z
zengyawen 已提交
566
  
L
liu-binjun 已提交
567
  ```js
Z
zengyawen 已提交
568 569 570 571 572 573 574 575 576 577 578 579 580
  geolocation.getLastLocation().then((result) => {
      console.log('getLastLocation: result: ' + JSON.stringify(result));
  });
  ```


## geolocation.isLocationEnabled

isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;) : void


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

L
liu-binjun 已提交
581 582 583
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
585 586
**参数**

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

L
liu-binjun 已提交
591
**示例**
Z
zengyawen 已提交
592
  
L
liu-binjun 已提交
593
  ```js
Z
zengyawen 已提交
594
  geolocation.isLocationEnabled((err, data) => {
L
liu-binjun 已提交
595 596 597 598 599 600
      if (err) {
          console.log('isLocationEnabled: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('isLocationEnabled: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
601 602 603 604 605 606 607 608 609 610
  });
  ```


## geolocation.isLocationEnabled

isLocationEnabled() : Promise&lt;boolean&gt;

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

L
liu-binjun 已提交
611 612 613 614
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
615 616
**返回值**

Z
zengyawen 已提交
617
    | 参数名 | 说明 |
Z
zengyawen 已提交
618
  | -------- | -------- |
Z
zengyawen 已提交
619
  | Promise&lt;boolean&gt; | 返回位置服务是否可用的状态。 |
Z
zengyawen 已提交
620

L
liu-binjun 已提交
621
**示例**
Z
zengyawen 已提交
622
  
L
liu-binjun 已提交
623
  ```js
Z
zengyawen 已提交
624
  geolocation.isLocationEnabled().then((result) => {
L
liu-binjun 已提交
625
      console.log('promise, isLocationEnabled: ' + JSON.stringify(result));
Z
zengyawen 已提交
626 627 628 629 630 631 632 633 634 635 636
  });
  ```


## geolocation.requestEnableLocation

requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;) : void


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

L
liu-binjun 已提交
637 638 639
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
641 642
**参数**

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

L
liu-binjun 已提交
647
**示例**
Z
zengyawen 已提交
648
  
L
liu-binjun 已提交
649
  ```js
Z
zengyawen 已提交
650
  geolocation.requestEnableLocation((err, data) => {
L
liu-binjun 已提交
651 652 653 654 655 656
      if (err) {
          console.log('requestEnableLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('requestEnableLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
657 658 659 660 661 662 663 664 665 666
  });
  ```


## geolocation.requestEnableLocation

requestEnableLocation() : Promise&lt;boolean&gt;

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

L
liu-binjun 已提交
667 668 669 670
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
671 672
**返回值**

Z
zengyawen 已提交
673
    | 参数名 | 说明 |
Z
zengyawen 已提交
674
  | -------- | -------- |
Z
zengyawen 已提交
675
  | Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
Z
zengyawen 已提交
676

L
liu-binjun 已提交
677
**示例**
Z
zengyawen 已提交
678
  
L
liu-binjun 已提交
679
  ```js
Z
zengyawen 已提交
680
  geolocation.requestEnableLocation().then((result) => {
L
liu-binjun 已提交
681
      console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
Z
zengyawen 已提交
682 683 684 685
  });
  ```


L
liu-binjun 已提交
686 687 688 689 690 691 692 693
## geolocation.enableLocation

enableLocation(callback: AsyncCallback&lt;boolean&gt;) : void;

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

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

L
liu-binjun 已提交
694
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
L
liu-binjun 已提交
695 696 697

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

L
liu-binjun 已提交
698 699
**参数**

L
liu-binjun 已提交
700 701 702 703
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |

L
liu-binjun 已提交
704
**示例**
L
liu-binjun 已提交
705
  
L
liu-binjun 已提交
706
  ```js
L
liu-binjun 已提交
707
  geolocation.enableLocation((err, data) => {
L
liu-binjun 已提交
708 709 710 711 712 713
      if (err) {
          console.log('enableLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('enableLocation: data=' + JSON.stringify(data));
      }
L
liu-binjun 已提交
714 715 716 717 718 719 720 721 722 723 724 725
  });
  ```


## geolocation.enableLocation

enableLocation() : Promise&lt;boolean&gt;

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

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

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

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

L
liu-binjun 已提交
730 731
**返回值**

L
liu-binjun 已提交
732 733 734 735
    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 返回位置服务是否可用。 |

L
liu-binjun 已提交
736
**示例**
L
liu-binjun 已提交
737
  
L
liu-binjun 已提交
738
  ```js
L
liu-binjun 已提交
739
  geolocation.enableLocation().then((result) => {
L
liu-binjun 已提交
740
      console.log('promise, enableLocation: ' + JSON.stringify(result));
L
liu-binjun 已提交
741 742 743 744 745 746 747
  });
  ```

## geolocation.disableLocation

disableLocation(callback: AsyncCallback&lt;boolean&gt;) : void;

748
关闭位置服务,使用callback回调异步返回结果。
L
liu-binjun 已提交
749 750 751

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

L
liu-binjun 已提交
752
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
L
liu-binjun 已提交
753 754 755

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

L
liu-binjun 已提交
756 757
**参数**

L
liu-binjun 已提交
758 759 760 761
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |

L
liu-binjun 已提交
762
**示例**
L
liu-binjun 已提交
763
  
L
liu-binjun 已提交
764
  ```js
L
liu-binjun 已提交
765
  geolocation.disableLocation((err, data) => {
L
liu-binjun 已提交
766 767 768 769 770 771
      if (err) {
          console.log('disableLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('disableLocation: data=' + JSON.stringify(data));
      }
L
liu-binjun 已提交
772 773 774 775 776 777 778 779
  });
  ```


## geolocation.disableLocation

disableLocation() : Promise&lt;boolean&gt;

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

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

L
liu-binjun 已提交
784
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
L
liu-binjun 已提交
785 786 787

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

L
liu-binjun 已提交
788 789
**返回值**

L
liu-binjun 已提交
790 791 792 793
    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;boolean&gt; | 返回位置服务是否可用。 |

L
liu-binjun 已提交
794
**示例**
L
liu-binjun 已提交
795
  
L
liu-binjun 已提交
796
  ```js
L
liu-binjun 已提交
797
  geolocation.disableLocation().then((result) => {
L
liu-binjun 已提交
798
      console.log('promise, disableLocation: ' + JSON.stringify(result));
L
liu-binjun 已提交
799 800 801
  });
  ```

Z
zengyawen 已提交
802 803 804 805 806 807
## geolocation.isGeoServiceAvailable

isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;) : void

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

L
liu-binjun 已提交
808 809 810 811
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
812 813
**参数**

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

L
liu-binjun 已提交
818
**示例**
Z
zengyawen 已提交
819
  
L
liu-binjun 已提交
820
  ```js
Z
zengyawen 已提交
821
  geolocation.isGeoServiceAvailable((err, data) => {
L
liu-binjun 已提交
822 823 824 825 826 827
      if (err) {
          console.log('isGeoServiceAvailable: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('isGeoServiceAvailable: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
828 829 830 831 832 833 834 835 836 837
  });
  ```


## geolocation.isGeoServiceAvailable

isGeoServiceAvailable() : Promise&lt;boolean&gt;

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

L
liu-binjun 已提交
838 839 840 841
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
842 843
**返回值**

Z
zengyawen 已提交
844
    | 参数名 | 说明 |
Z
zengyawen 已提交
845
  | -------- | -------- |
Z
zengyawen 已提交
846
  | Promise&lt;boolean&gt; | 返回地理编码服务是否可用的状态。 |
Z
zengyawen 已提交
847

L
liu-binjun 已提交
848
**示例**
Z
zengyawen 已提交
849
  
L
liu-binjun 已提交
850
  ```js
Z
zengyawen 已提交
851
  geolocation.isGeoServiceAvailable().then((result) => {
L
liu-binjun 已提交
852
      console.log('promise, isGeoServiceAvailable: ' + JSON.stringify(result));
Z
zengyawen 已提交
853 854 855 856 857 858 859 860 861 862
  });
  ```


## geolocation.getAddressesFromLocation

getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;) : void

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

L
liu-binjun 已提交
863 864 865 866
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
867 868
**参数**

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

L
liu-binjun 已提交
874
**示例**
Z
zengyawen 已提交
875
  
L
liu-binjun 已提交
876
  ```js
Z
zengyawen 已提交
877 878
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
L
liu-binjun 已提交
879 880 881 882 883 884
      if (err) {
          console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
885 886 887 888 889 890 891 892 893 894
  });
  ```


## geolocation.getAddressesFromLocation

getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise&lt;Array&lt;GeoAddress&gt;&gt;;

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

L
liu-binjun 已提交
895 896 897 898
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
899 900
**参数**

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

L
liu-binjun 已提交
905 906
**返回值**

Z
zengyawen 已提交
907
    | 参数名 | 说明 |
Z
zengyawen 已提交
908
  | -------- | -------- |
Z
zengyawen 已提交
909
  | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 返回地理描述信息。 |
Z
zengyawen 已提交
910

L
liu-binjun 已提交
911
**示例**
Z
zengyawen 已提交
912
  
L
liu-binjun 已提交
913
  ```js
Z
zengyawen 已提交
914 915 916 917 918 919 920 921 922 923 924 925 926
  var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
  geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
      console.log('getAddressesFromLocation: ' + JSON.stringify(data));
  });
  ```


## geolocation.getAddressesFromLocationName

getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;) : void

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

L
liu-binjun 已提交
927 928 929 930
**需要权限**:ohos.permission.LOCATION

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

L
liu-binjun 已提交
931 932
**参数**

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

L
liu-binjun 已提交
938
**示例**
Z
zengyawen 已提交
939
  
L
liu-binjun 已提交
940
  ```js
Z
zengyawen 已提交
941 942
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {
L
liu-binjun 已提交
943 944 945 946 947 948
      if (err) {
          console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
949 950 951 952 953 954 955 956 957 958
  });
  ```


## geolocation.getAddressesFromLocationName

getAddressesFromLocationName(request: GeoCodeRequest) : Promise&lt;Array&lt;GeoAddress&gt;&gt;

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

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

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

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

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

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

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

L
liu-binjun 已提交
975
**示例**
Z
zengyawen 已提交
976
  
L
liu-binjun 已提交
977
  ```js
Z
zengyawen 已提交
978 979 980 981 982 983 984
  var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
  geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => {
      console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
  });
  ```


L
liu-binjun 已提交
985
## geolocation.getCachedGnssLocationsSize<sup>8+</sup>
Z
zengyawen 已提交
986 987 988 989 990

getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;) : void;

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

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

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

L
liu-binjun 已提交
995 996
**参数**

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

L
liu-binjun 已提交
1001
**示例**
Z
zengyawen 已提交
1002
  
L
liu-binjun 已提交
1003
  ```js
Z
zengyawen 已提交
1004
  geolocation.getCachedGnssLocationsSize((err, size) => {
L
liu-binjun 已提交
1005 1006 1007 1008 1009 1010
      if (err) {
          console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
      }
      if (size) {
          console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
      }
Z
zengyawen 已提交
1011 1012 1013 1014
  });
  ```


L
liu-binjun 已提交
1015
## geolocation.getCachedGnssLocationsSize<sup>8+</sup>
Z
zengyawen 已提交
1016 1017 1018 1019 1020

getCachedGnssLocationsSize() : Promise&lt;number&gt;;

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

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

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

L
liu-binjun 已提交
1025 1026
**返回值**

Z
zengyawen 已提交
1027
    | 参数名 | 说明 |
Z
zengyawen 已提交
1028
  | -------- | -------- |
Z
zengyawen 已提交
1029
  | Promise&lt;number&gt; | 返回GNSS缓存位置的个数。 |
Z
zengyawen 已提交
1030

L
liu-binjun 已提交
1031
**示例**
Z
zengyawen 已提交
1032
  
L
liu-binjun 已提交
1033
  ```js
Z
zengyawen 已提交
1034
  geolocation.getCachedGnssLocationsSize().then((result) => {
L
liu-binjun 已提交
1035
      console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
Z
zengyawen 已提交
1036 1037 1038 1039
  });
  ```


L
liu-binjun 已提交
1040
## geolocation.flushCachedGnssLocations<sup>8+</sup>
Z
zengyawen 已提交
1041 1042 1043 1044 1045

flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;) : void;

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

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

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

L
liu-binjun 已提交
1050 1051
**参数**

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

L
liu-binjun 已提交
1056
**示例**
Z
zengyawen 已提交
1057
  
L
liu-binjun 已提交
1058
  ```js
Z
zengyawen 已提交
1059
  geolocation.flushCachedGnssLocations((err, result) => {
L
liu-binjun 已提交
1060 1061 1062 1063 1064 1065
      if (err) {
          console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('flushCachedGnssLocations: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1066 1067 1068 1069
  });
  ```


L
liu-binjun 已提交
1070
## geolocation.flushCachedGnssLocations<sup>8+</sup>
Z
zengyawen 已提交
1071 1072 1073 1074 1075

flushCachedGnssLocations() : Promise&lt;boolean&gt;;

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

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

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

L
liu-binjun 已提交
1080 1081
**返回值**

Z
zengyawen 已提交
1082
    | 参数名 | 说明 |
Z
zengyawen 已提交
1083
  | -------- | -------- |
Z
zengyawen 已提交
1084
  | Promise&lt;boolean&gt; | 清空所有GNSS缓存位置是否成功。 |
Z
zengyawen 已提交
1085

L
liu-binjun 已提交
1086
**示例**
Z
zengyawen 已提交
1087
  
L
liu-binjun 已提交
1088
  ```js
Z
zengyawen 已提交
1089
  geolocation.flushCachedGnssLocations().then((result) => {
L
liu-binjun 已提交
1090
      console.log('promise, flushCachedGnssLocations: ' + JSON.stringify(result));
Z
zengyawen 已提交
1091 1092 1093 1094
  });
  ```


L
liu-binjun 已提交
1095
## geolocation.sendCommand<sup>8+</sup>
Z
zengyawen 已提交
1096 1097 1098 1099 1100

sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;) : void;

给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。

L
liu-binjun 已提交
1101
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1102 1103 1104

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

L
liu-binjun 已提交
1105 1106
**参数**

Z
zengyawen 已提交
1107
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1108
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1109 1110
  | command | LocationCommand | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收命令发送的结果。 |
Z
zengyawen 已提交
1111

L
liu-binjun 已提交
1112
**示例**
Z
zengyawen 已提交
1113
  
L
liu-binjun 已提交
1114
  ```js
Z
zengyawen 已提交
1115 1116
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geolocation.sendCommand(requestInfo, (err, result) => {
L
liu-binjun 已提交
1117 1118 1119 1120 1121 1122
      if (err) {
          console.log('sendCommand: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('sendCommand: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1123 1124 1125 1126
  });
  ```


L
liu-binjun 已提交
1127
## geolocation.sendCommand<sup>8+</sup>
Z
zengyawen 已提交
1128 1129 1130 1131 1132

sendCommand(command: LocationCommand) : Promise&lt;boolean&gt;;

给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。

L
liu-binjun 已提交
1133
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1134 1135 1136

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

L
liu-binjun 已提交
1137 1138
**参数**

Z
zengyawen 已提交
1139
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1140
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1141
  | command | LocationCommand | 是 | 指定目标场景,和将要发送的命令(字符串)。 |
Z
zengyawen 已提交
1142

L
liu-binjun 已提交
1143 1144
**返回值**

Z
zengyawen 已提交
1145
    | 参数名 | 说明 |
Z
zengyawen 已提交
1146
  | -------- | -------- |
Z
zengyawen 已提交
1147
  | Promise&lt;boolean&gt; | 表示命令发送成功或失败。 |
Z
zengyawen 已提交
1148

L
liu-binjun 已提交
1149
**示例**
Z
zengyawen 已提交
1150
  
L
liu-binjun 已提交
1151
  ```js
Z
zengyawen 已提交
1152 1153
  var requestInfo = {'scenario': 0x301, 'command': "command_1"};
  geolocation.sendCommand(requestInfo).then((result) => {
L
liu-binjun 已提交
1154
      console.log('promise, sendCommand: ' + JSON.stringify(result));
Z
zengyawen 已提交
1155 1156 1157 1158
  });
  ```


L
liu-binjun 已提交
1159
## geolocation.isLocationPrivacyConfirmed<sup>8+</sup>
Z
zengyawen 已提交
1160 1161 1162 1163 1164

isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&lt;boolean&gt;) : void;

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

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

L
liu-binjun 已提交
1167
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1168 1169 1170

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

L
liu-binjun 已提交
1171 1172
**参数**

Z
zengyawen 已提交
1173
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1174
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1175 1176
  | type | LocationPrivacyType | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 表示用户是否同意定位服务隐私申明。 |
Z
zengyawen 已提交
1177

L
liu-binjun 已提交
1178
**示例**
Z
zengyawen 已提交
1179
  
L
liu-binjun 已提交
1180
  ```js
Z
zengyawen 已提交
1181
  geolocation.isLocationPrivacyConfirmed(1, (err, result) => {
L
liu-binjun 已提交
1182 1183 1184 1185 1186 1187
      if (err) {
          console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1188 1189 1190 1191
  });
  ```


L
liu-binjun 已提交
1192
## geolocation.isLocationPrivacyConfirmed<sup>8+</sup>
Z
zengyawen 已提交
1193 1194 1195 1196 1197

isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise&lt;boolean&gt;;

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

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

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

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

L
liu-binjun 已提交
1204 1205
**参数**

Z
zengyawen 已提交
1206
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1207
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1208
  | type | LocationPrivacyType | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
Z
zengyawen 已提交
1209

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

Z
zengyawen 已提交
1212
    | 参数名 | 说明 |
Z
zengyawen 已提交
1213
  | -------- | -------- |
Z
zengyawen 已提交
1214
  | Promise&lt;boolean&gt; | 表示用户是否同意定位服务隐私申明。 |
Z
zengyawen 已提交
1215

L
liu-binjun 已提交
1216
**示例**
Z
zengyawen 已提交
1217
  
L
liu-binjun 已提交
1218
  ```js
Z
zengyawen 已提交
1219
  geolocation.isLocationPrivacyConfirmed(1).then((result) => {
L
liu-binjun 已提交
1220
      console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result));
Z
zengyawen 已提交
1221 1222 1223 1224
  });
  ```


L
liu-binjun 已提交
1225
## geolocation.setLocationPrivacyConfirmStatus<sup>8+</sup>
Z
zengyawen 已提交
1226 1227 1228 1229 1230

setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback&lt;boolean&gt;) : void;

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

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

L
liu-binjun 已提交
1233
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1234 1235 1236

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

L
liu-binjun 已提交
1237 1238
**参数**

Z
zengyawen 已提交
1239
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1240
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1241 1242 1243
  | type | LocationPrivacyType | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
  | callback | AsyncCallback&lt;boolean&gt; | 是 | 表示操作是否成功。 |
Z
zengyawen 已提交
1244

L
liu-binjun 已提交
1245
**示例**
Z
zengyawen 已提交
1246
  
L
liu-binjun 已提交
1247
  ```js
Z
zengyawen 已提交
1248
  geolocation.setLocationPrivacyConfirmStatus(1, true, (err, result) => {
L
liu-binjun 已提交
1249 1250 1251 1252 1253 1254
      if (err) {
          console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('setLocationPrivacyConfirmStatus: result=' + JSON.stringify(result));
      }
Z
zengyawen 已提交
1255 1256 1257 1258
  });
  ```


L
liu-binjun 已提交
1259
## geolocation.setLocationPrivacyConfirmStatus<sup>8+</sup>
Z
zengyawen 已提交
1260 1261 1262 1263 1264

setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise&lt;boolean&gt;;

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

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

L
liu-binjun 已提交
1267
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1268 1269 1270

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

L
liu-binjun 已提交
1271 1272
**参数**

Z
zengyawen 已提交
1273
    | 参数名 | 类型 | 必填 | 说明 |
Z
zengyawen 已提交
1274
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1275 1276
  | type | LocationPrivacyType | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
  | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
Z
zengyawen 已提交
1277

L
liu-binjun 已提交
1278 1279
**返回值**

Z
zengyawen 已提交
1280
    | 参数名 | 说明 |
Z
zengyawen 已提交
1281
  | -------- | -------- |
Z
zengyawen 已提交
1282
  | Promise&lt;boolean&gt; | 表示操作是否成功。 |
Z
zengyawen 已提交
1283

L
liu-binjun 已提交
1284
**示例**
Z
zengyawen 已提交
1285
  
L
liu-binjun 已提交
1286
  ```js
Z
zengyawen 已提交
1287
  geolocation.setLocationPrivacyConfirmStatus(1, true).then((result) => {
L
liu-binjun 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 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 1551 1552 1553 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 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
      console.log('promise, setLocationPrivacyConfirmStatus: ' + JSON.stringify(result));
  });
  ```


## geolocation.getCountryCode<sup>9+</sup>

getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;) : void;

查询当前的国家码。

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callback | AsyncCallback&lt;CountryCode&gt; | 是 | 用来接收国家码。 |

**示例**
  
  ```js
  geolocation.getCountryCode((err, result) => {
      if (err) {
          console.log('getCountryCode: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('getCountryCode: result=' + JSON.stringify(result));
      }
  });
  ```


## geolocation.getCountryCode<sup>9+</sup>

getCountryCode() : Promise&lt;CountryCode&gt;;

查询当前的国家码。

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

**参数**



**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;CountryCode&gt; | 返回国家码。 |

**示例**
  
  ```js
  geolocation.getCountryCode()
  .then((result) => {
      console.log('promise, getCountryCode: result=' + JSON.stringify(result));
  })
  .catch((error) => {
      console.log('promise, getCountryCode: error=' + JSON.stringify(error));
  });
  ```


## geolocation.enableLocationMock<sup>9+</sup>

enableLocationMock(scenario?: LocationRequestScenario, callback: AsyncCallback&lt;void&gt;) : void;

使能某个场景的位置模拟功能,同一时间只能使能一个场景的位置模拟功能。

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | scenario | LocationRequestScenario | 否 | 指示在什么场景下使能位置模拟功能。 |
  | callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |

**示例**
  
  ```js
  var request = {"scenario": 0x0301};
  geolocation.enableLocationMock(request, (err, result) => {
      if (err) {
          console.log('enableLocationMock: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('enableLocationMock: result=' + JSON.stringify(result));
      }
  });
  ```

## geolocation.enableLocationMock<sup>9+</sup>

enableLocationMock(scenario?: LocationRequestScenario) : Promise&lt;void&gt;;

使能某个场景的位置模拟功能,同一时间只能使能一个场景的位置模拟功能。

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | scenario | LocationRequestScenario | 否 | 指示使能什么场景的位置模拟功能。如果不携带该参数则表示使能所有场景的位置模拟功能。 |


**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  var request = {"scenario": 0x0301};
  geolocation.enableLocationMock(request)
  .then((result) => {
      if (result) {
        console.log('promise, enableLocationMock: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, enableLocationMock: error=' + JSON.stringify(error));
      }
  });
  ```


## geolocation.disableLocationMock<sup>9+</sup>

disableLocationMock(scenario?: LocationRequestScenario, callback: AsyncCallback&lt;void&gt;) : void;

去使能位置模拟功能。

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | scenario | LocationRequestScenario | 否 | 指示去使能某个场景的位置模拟功能。如果不携带该参数则表示去使能所有场景的位置模拟功能。 |
  | callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |

**示例**
  
  ```js
  var request = {"scenario": 0x0301};
  geolocation.disableLocationMock(request, (err, result) => {
      if (err) {
          console.log('disableLocationMock: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('disableLocationMock: result=' + JSON.stringify(result));
      }
  });
  ```


## geolocation.disableLocationMock<sup>9+</sup>

disableLocationMock(scenario?: LocationRequestScenario) : Promise&lt;void&gt;;

去使能位置模拟功能。

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | scenario | LocationRequestScenario | 否 | 指示去使能某个场景的位置模拟功能。如果不携带该参数则表示去使能所有场景的位置模拟功能。 |

**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  var request = {"scenario": 0x0301};
  geolocation.disableLocationMock(request)
  .then((result) => {
      if (result) {
        console.log('promise, disableLocationMock: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, disableLocationMock: error=' + JSON.stringify(error));
      }
  });
  ```


## geolocation.setMockedLocations<sup>9+</sup>

setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&gt;) : void;

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

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

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

**参数**

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

**示例**
  
  ```js
  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};
  geolocation.setMockedLocations(config, (err, data) => {
      if (err) {
          console.log('setMockedLocations: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('setMockedLocations: data=' + JSON.stringify(data));
      }
  });
  ```

## geolocation.setMockedLocations<sup>9+</sup>

setMockedLocations(config: LocationMockConfig) : Promise&lt;void&gt;;

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

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

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

**参数**

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

**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  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};
  geolocation.setMockedLocations(config)
  .then((result) => {
      if (result) {
        console.log('promise, setMockedLocations: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, setMockedLocations: error=' + JSON.stringify(error));
      }
  });
  ```



## geolocation.enableReverseGeocodingMock<sup>9+</sup>

enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;) : void;

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

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

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

**参数**

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

**示例**
  
  ```js
  geolocation.enableReverseGeocodingMock((err, data) => {
      if (err) {
          console.log('enableReverseGeocodingMock: err=' + JSON.stringify(err));
      }
      if (data) {
          console.log('enableReverseGeocodingMock: data=' + JSON.stringify(data));
      }
Z
zengyawen 已提交
1608 1609 1610 1611
  });
  ```


L
liu-binjun 已提交
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 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 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
## geolocation.enableReverseGeocodingMock<sup>9+</sup>

enableReverseGeocodingMock() : Promise&lt;void&gt;;

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

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

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

**参数**



**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  geolocation.enableReverseGeocodingMock()
  .then((result) => {
      if (result) {
        console.log('promise, enableReverseGeocodingMock: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error));
      }
  });
  ```


## geolocation.disableReverseGeocodingMock<sup>9+</sup>

disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;) : void;

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

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

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

**参数**

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

**示例**
  
  ```js
  geolocation.disableReverseGeocodingMock((err, result) => {
      if (err) {
          console.log('disableReverseGeocodingMock: err=' + JSON.stringify(err));
      }
      if (result) {
          console.log('disableReverseGeocodingMock: result=' + JSON.stringify(result));
      }
  });
  ```


## geolocation.disableReverseGeocodingMock<sup>9+</sup>

disableReverseGeocodingMock() : Promise&lt;void&gt;;

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

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

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

**参数**



**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  geolocation.disableReverseGeocodingMock()
  .then((result) => {
      if (result) {
        console.log('promise, disableReverseGeocodingMock: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error));
      }
  });
  ```


## geolocation.setReverseGeocodingMockInfo<sup>9+</sup>

setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, callback: AsyncCallback&lt;void&gt;) : void;

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

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | mockInfos | Array&lt;ReverseGeocodingMockInfo&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
  | callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。 |

**示例**
  
  ```js
  var mockInfos = [
      {"location": {"locale": "shanghai", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "shanghai", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "beijing", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "beijing", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "shenzhen", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "shenzhen", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "wuhan", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "wuhan", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "chengdu", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "chengdu", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
  ];
  geolocation.setReverseGeocodingMockInfo(mockInfos, (err, data) => {
      if (err) {
          console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err));
      } 
      if (data) {
          console.log('promise, setReverseGeocodingMockInfo, data:' + JSON.stringify(data));
      }
  });
  ```


## geolocation.setReverseGeocodingMockInfo<sup>9+</sup>

setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;) : Promise&lt;void&gt;;

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

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

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

**参数**

    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | mockInfos | Array&lt;ReverseGeocodingMockInfo&gt; | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 |

**返回值**

    | 参数名 | 说明 |
  | -------- | -------- |
  | Promise&lt;void&gt; | 用来接收执行结果,如果执行成功就返回nullptr,否则就返回错误信息。  |

**示例**
  
  ```js
  var mockInfos = [
      {"location": {"locale": "shanghai", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "shanghai", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "beijing", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "beijing", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "shenzhen", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "shenzhen", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "wuhan", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "wuhan", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
      {"location": {"locale": "chengdu", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "chengdu", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
  ];
  geolocation.setReverseGeocodingMockInfo(mockInfos)
  .then((result) => {
      if (result) {
        console.log('promise, setReverseGeocodingMockInfo: result=' + JSON.stringify(result));
      }
  })
  .catch((error) => {
      if (error) {
        console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error));
      }
  });
  ```

Z
zengyawen 已提交
1799 1800 1801 1802 1803

## LocationRequestPriority

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

L
liu-binjun 已提交
1804
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1805 1806 1807

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

Z
zengyawen 已提交
1808
| 名称 | 默认值 | 说明 |
Z
zengyawen 已提交
1809
| -------- | -------- | -------- |
Z
zengyawen 已提交
1810 1811 1812 1813
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先,如果应用希望快速拿到1个位置,可以将优先级设置为该字段。 |
Z
zengyawen 已提交
1814 1815 1816 1817 1818


## LocationRequestScenario

  位置请求中定位场景设置。
L
liu-binjun 已提交
1819

L
liu-binjun 已提交
1820
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1821 1822 1823

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

Z
zengyawen 已提交
1824
| 名称 | 默认值 | 说明 |
Z
zengyawen 已提交
1825
| -------- | -------- | -------- |
Z
zengyawen 已提交
1826 1827 1828 1829 1830 1831
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景,这种场景下不会主动触发定位,会在其他应用定位时,才给当前应用返回位置。 |
Z
zengyawen 已提交
1832 1833 1834 1835 1836 1837


## GeoLocationErrorCode

位置服务中的错误码信息。

L
liu-binjun 已提交
1838
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1839 1840 1841

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

Z
zengyawen 已提交
1842
| 名称 | 默认值 | 说明 |
Z
zengyawen 已提交
1843
| -------- | -------- | -------- |
L
liu-binjun 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852
| NOT_SUPPORTED<sup>9+</sup> | 100 | 表示该接口功能不支持。 |
| INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 |
| REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 |
| GEOCODE_ERROR<sup>7+</sup> | 103 | 表示地理编码接口调用失败。 |
| LOCATOR_ERROR<sup>7+</sup> | 104 | 表示定位失败。 |
| LOCATION_SWITCH_ERROR<sup>7+</sup> | 105 | 表示定位开关。 |
| LAST_KNOWN_LOCATION_ERROR<sup>7+</sup> | 106 | 表示获取上次位置失败。 |
| LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位,没有在指定时间内返回位置。 |
| QUERY_COUNTRY_CODE_ERROR<sup>9+</sup> | 108 | 表示国家码查询失败。 |
Z
zengyawen 已提交
1853 1854 1855 1856 1857 1858


## ReverseGeoCodeRequest

逆地理编码请求接口。

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

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

Z
zengyawen 已提交
1863
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1864
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1865 1866 1867 1868
| locale | string | 否 | 指定位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| latitude | number | 是 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude | number | 是 | 表示经度信息,正值表示东经,负值表示西经。 |
| maxItems | number | 否 | 指定返回位置信息的最大个数。 |
Z
zengyawen 已提交
1869 1870 1871 1872 1873 1874


## GeoCodeRequest

地理编码请求接口。

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

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

Z
zengyawen 已提交
1879
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1880
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1881 1882 1883 1884 1885 1886 1887
| locale | string | 否 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| description | number | 是 | 表示位置信息描述,如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 否 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 否 | 表示最小纬度信息,与下面三个参数一起,表示一个经纬度范围。 |
| minLongitude | number | 否 | 表示最小经度信息。 |
| maxLatitude | number | 否 | 表示最大纬度信息。 |
| maxLongitude | number | 否 | 表示最大经度信息。 |
Z
zengyawen 已提交
1888 1889 1890 1891 1892 1893


## GeoAddress

地理编码类型。

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

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

Z
zengyawen 已提交
1898
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1899
| -------- | -------- | -------- | -------- |
L
liu-binjun 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
| latitude<sup>7+</sup> | number | 否 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude<sup>7+</sup> | number | 否 | 表示经度信息,正值表示东经,负值表是西经。 |
| locale<sup>7+</sup> | string | 否 | 表示位置描述信息的语言,“zh”代表中文,“en”代表英文。 |
| placeName<sup>7+</sup> | string | 否 | 表示地区信息。 |
| countryCode<sup>7+</sup> | string | 否 | 表示国家码信息。 |
| countryName<sup>7+</sup> | string | 否 | 表示国家信息。 |
| administrativeArea<sup>7+</sup> | string | 否 | 表示省份区域信息。 |
| subAdministrativeArea<sup>7+</sup> | string | 否 | 表示表示子区域信息。 |
| locality<sup>7+</sup> | string | 否 | 表示城市信息。 |
| subLocality<sup>7+</sup> | string | 否 | 表示子城市信息。 |
| roadName<sup>7+</sup> | string | 否 | 表示路名信息。 |
| subRoadName<sup>7+</sup> | string | 否 | 表示子路名信息。 |
| premises<sup>7+</sup> | string | 否 | 表示门牌号信息。 |
| postalCode<sup>7+</sup> | string | 否 | 表示邮政编码信息。 |
| phoneNumber<sup>7+</sup> | string | 否 | 表示联系方式信息。 |
| addressUrl<sup>7+</sup> | string | 否 | 表示位置信息附件的网址信息。 |
| descriptions<sup>7+</sup> | Array&lt;string&gt; | 否 | 表示附加的描述信息。 |
| descriptionsSize<sup>7+</sup> | number | 否 | 表示附加的描述信息数量。 |
| isFromMock<sup>9+</sup> | Boolean | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 |
Z
zengyawen 已提交
1919 1920 1921 1922 1923 1924


## LocationRequest

位置信息请求类型。

L
liu-binjun 已提交
1925
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1926 1927 1928

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

Z
zengyawen 已提交
1929
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1930
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1931 1932 1933 1934 1935
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 |
| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 否 | 表示精度信息。 |
Z
zengyawen 已提交
1936 1937 1938 1939 1940 1941


## CurrentLocationRequest

当前位置信息请求类型。

L
liu-binjun 已提交
1942
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
1943 1944 1945

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

Z
zengyawen 已提交
1946
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1947
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1948 1949 1950 1951
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 |
| maxAccuracy | number | 否 | 表示精度信息,单位是米。 |
| timeoutMs | number | 否 | 表示超时时间,单位是毫秒,最小为1000毫秒。 |
Z
zengyawen 已提交
1952 1953


L
liu-binjun 已提交
1954
## SatelliteStatusInfo<sup>8+</sup>
Z
zengyawen 已提交
1955 1956 1957

卫星状态信息。

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

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

Z
zengyawen 已提交
1962
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1963
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1964 1965 1966 1967 1968 1969
| satellitesNumber | number | 是 | 表示卫星个数。 |
| satelliteIds | Array&lt;number&gt; | 是 | 表示每个卫星的ID,数组类型。 |
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 表示载波噪声功率谱密度比,即cn0。 |
| altitudes | Array&lt;number&gt; | 是 | 表示高程信息。 |
| azimuths | Array&lt;number&gt; | 是 | 表示方位角。 |
| carrierFrequencies | Array&lt;number&gt; | 是 | 表示载波频率。 |
Z
zengyawen 已提交
1970 1971


L
liu-binjun 已提交
1972
## CachedGnssLocationsRequest<sup>8+</sup>
Z
zengyawen 已提交
1973 1974 1975

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

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

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

Z
zengyawen 已提交
1980
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1981
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1982 1983
| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期,单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片,并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片,会把缓存位置直接丢弃。 |
Z
zengyawen 已提交
1984 1985


L
liu-binjun 已提交
1986
## Geofence<sup>8+</sup>
Z
zengyawen 已提交
1987 1988 1989

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

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

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

Z
zengyawen 已提交
1994
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
1995
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1996 1997 1998 1999
| latitude | number | 是 | 表示纬度。 |
| longitude | number | 是 | 表示经度。 |
| radius | number | 是 | 表示圆形围栏的半径。 |
| expiration | number | 是 | 围栏存活的时间,单位是毫秒。 |
Z
zengyawen 已提交
2000 2001


L
liu-binjun 已提交
2002
## GeofenceRequest<sup>8+</sup>
Z
zengyawen 已提交
2003 2004 2005

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

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

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

Z
zengyawen 已提交
2010
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
2011
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
2012 2013 2014
| priority | LocationRequestPriority | 是 | 表示位置信息优先级。 |
| scenario | LocationRequestScenario | 是 | 表示定位场景。 |
| geofence | Geofence | 是 | 表示围栏信息。 |
Z
zengyawen 已提交
2015 2016


L
liu-binjun 已提交
2017
## LocationPrivacyType<sup>8+</sup>
Z
zengyawen 已提交
2018 2019 2020

定位服务隐私协议类型。

L
liu-binjun 已提交
2021
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
2022 2023 2024

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

Z
zengyawen 已提交
2025
| 名称 | 默认值 | 说明 |
Z
zengyawen 已提交
2026
| -------- | -------- | -------- |
Z
zengyawen 已提交
2027 2028 2029
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
Z
zengyawen 已提交
2030 2031


L
liu-binjun 已提交
2032
## LocationCommand<sup>8+</sup>
Z
zengyawen 已提交
2033 2034 2035

扩展命令结构体。

L
liu-binjun 已提交
2036
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
2037 2038 2039

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

Z
zengyawen 已提交
2040
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
2041
| -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
2042 2043
| scenario | LocationRequestScenario | 是 | 表示定位场景。 |
| command | string | 是 | 扩展命令字符串。 |
Z
zengyawen 已提交
2044 2045 2046 2047 2048 2049


## Location

位置信息类型。

L
liu-binjun 已提交
2050
**需要权限**:ohos.permission.LOCATION
L
liu-binjun 已提交
2051 2052 2053

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

Z
zengyawen 已提交
2054
| 名称 | 参数类型 | 必填 | 说明 |
Z
zengyawen 已提交
2055
| -------- | -------- | -------- | -------- |
L
liu-binjun 已提交
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120
| latitude<sup>7+</sup> | number | 是 | 表示纬度信息,正值表示北纬,负值表示南纬。 |
| longitude<sup>7+</sup> | number | 是 | 表示经度信息,正值表示东经,负值表是西经。 |
| altitude<sup>7+</sup> | number | 是 | 表示高度信息,单位米。 |
| accuracy<sup>7+</sup> | number | 是 | 表示精度信息,单位米。 |
| speed<sup>7+</sup> | number | 是 | 表示速度信息,单位米每秒。 |
| timeStamp<sup>7+</sup> | number | 是 | 表示位置时间戳,UTC格式。 |
| direction<sup>7+</sup> | number | 是 | 表示航向信息。 |
| timeSinceBoot<sup>7+</sup> | number | 是 | 表示位置时间戳,开机时间格式。 |
| additions<sup>7+</sup> | Array&lt;string&gt; | 否 | 附加信息。 |
| additionSize<sup>7+</sup> | number | 否 | 附加信息数量。 |
| isFromMock<sup>9+</sup> | Boolean | 否 | 表示位置信息是否来自于位置模拟功能。 |


## ReverseGeocodingMockInfo<sup>9+</sup>

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

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

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

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| location | ReverseGeoCodeRequest | 是 | 表示经纬度信息。 |
| geoAddress | GeoAddress | 是 | 表示地名信息。 |


## LocationMockConfig<sup>9+</sup>

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

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

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

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| timeInterval | number | 是 | 表示模拟位置上报的时间间隔,单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 表示模拟位置数组。 |


## CountryCode<sup>9+</sup>

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

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

| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| country | string | 是 | 表示国家码字符串。 |
| type | CountryCodeType | 是 | 表示国家码信息来源。 |


## CountryCodeType<sup>9+</sup>

国家码来源类型。

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

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