1# @ohos.geoLocationManager (位置服务)(系统接口) 2 3位置服务提供GNSS定位、网络定位、地理编码、逆地理编码、国家码和地理围栏等基本功能。 4 5> **说明：** 6> 7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.geoLocationManager (位置服务)](js-apis-geoLocationManager.md)。 9> 本模块能力仅支持WGS-84坐标系。 10 11## 申请权限 12 13应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 14 15系统提供的定位权限有： 16- ohos.permission.LOCATION 17 18- ohos.permission.APPROXIMATELY_LOCATION 19 20- ohos.permission.LOCATION_IN_BACKGROUND 21 22访问设备的位置信息，必须申请权限，并且获得用户授权。 23 24API9之前的版本，申请ohos.permission.LOCATION即可。 25 26API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。 27 28| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 | 29| -------- | -------- | -------- | -------- | 30| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | 31| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 | 32| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 | 33| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | 34 35如果应用在后台运行时也需要访问设备位置，需要申请LOCATION类型的长时任务，这样应用在切入后台之后，系统可以继续上报位置信息。长时任务申请可参考[长时任务](../../task-management/continuous-task.md)。 36 37应用如需使用ohos.permission.LOCATION_IN_BACKGROUND权限，需要在设置界面由用户手动授予，具体授权方式可参考[ohos.permission.LOCATION_IN_BACKGROUND权限说明](../../security/AccessToken/permissions-for-all-user.md#ohospermissionlocation_in_background)。 38 39开发者可以在应用配置文件中声明所需要的权限，具体可参考[向用户申请授权](../../security/AccessToken/request-user-authorization.md)。 40 41 42## 导入模块 43 44```ts 45import { geoLocationManager } from '@kit.LocationKit'; 46``` 47 48## GeoAddress 49 50地理编码地址信息。 51 52**系统能力**：SystemCapability.Location.Location.Geocoder 53 54| 名称 | 类型 | 只读 | 可选 | 说明 | 55| -------- | -------- | -------- | -------- | -------- | 56| isFromMock | Boolean | 否 | 是 | true：地名信息来自于逆地理编码模拟功能<br/>false：地名信息不是来自于逆地理编码模拟功能<br/>**系统API**：此接口为系统接口。 | 57 58 59## Location 60 61位置信息。 62 63**系统能力**：SystemCapability.Location.Location.Core 64 65| 名称 | 类型 | 只读 | 可选 | 说明 | 66| -------- | -------- | -------- | -------- | -------- | 67| isFromMock | Boolean | 否 | 是 | true：位置信息来自于位置模拟功能<br/>false：位置信息不是来自于位置模拟功能<br/>**系统API**：此接口为系统接口。 | 68 69 70## ReverseGeocodingMockInfo 71 72逆地理编码模拟功能的配置信息，包含一个位置信息和一个地名信息。 73 74**系统能力**：SystemCapability.Location.Location.Core 75 76**系统API**：此接口为系统接口。 77 78| 名称 | 类型 | 只读 | 可选 | 说明 | 79| -------- | -------- | -------- | -------- | -------- | 80| location | [ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest) | 否 | 否 | 表示经纬度信息。 | 81| geoAddress | [GeoAddress](#geoaddress) | 否 | 否 |表示地名信息。 | 82 83 84## LocationMockConfig 85 86位置模拟功能的配置参数，包含了模拟位置上报的时间间隔和模拟位置数组。 87 88**系统能力**：SystemCapability.Location.Location.Core 89 90**系统API**：此接口为系统接口。 91 92| 名称 | 类型 | 只读 | 可选 | 说明 | 93| -------- | -------- | -------- | -------- | -------- | 94| timeInterval | number | 否 | 否 | 表示模拟位置上报的时间间隔，单位是秒。 | 95| locations | Array<[Location](#location)> | 否 | 否 | 表示模拟位置数组。 | 96 97## LocatingRequiredDataConfig<sup>10+</sup> 98 99获取定位所需数据时的配置参数。 100 101**系统能力**：SystemCapability.Location.Location.Core 102 103**系统API**：此接口为系统接口。 104 105| 名称 | 类型 | 只读 | 可选 | 说明 | 106| -------- | -------- | -------- | -------- | -------- | 107| type | [LocatingRequiredDataType](#locatingrequireddatatype10) | 否 | 否 | 表示请求获取数据的类型。 | 108| needStartScan | boolean | 否 | 否 | true：需要发起扫描<br/>false：不需要发起扫描 | 109| scanInterval | number | 否 | 是 | 表示扫描的时间间隔。单位是毫秒，默认值是10000毫秒，取值范围为大于0。 | 110| scanTimeout | number | 否 | 是 | 表示单次扫描的超时时间。单位是毫秒，默认值是10000毫秒，取值范围为大于0小于600000。 | 111 112 113## LocatingRequiredData<sup>10+</sup> 114 115表示定位业务所需的数据，包含WiFi或蓝牙扫描结果，APP拿到这些数据之后可以用于网络定位等业务。 116 117**系统能力**：SystemCapability.Location.Location.Core 118 119**系统API**：此接口为系统接口。 120 121| 名称 | 类型 | 只读 | 可选 | 说明 | 122| -------- | -------- | -------- | -------- | -------- | 123| wifiData | [WifiScanInfo](#wifiscaninfo10) | 否 | 是 | 表示WiFi扫描结果。 | 124| bluetoothData | [BluetoothScanInfo](#bluetoothscaninfo10) | 否 | 是 | 表示蓝牙扫描结果。 | 125 126 127## WifiScanInfo<sup>10+</sup> 128 129WiFi扫描信息，包含扫描到的WiFi热点的ssid、bssid和rssi等信息。 130 131**系统能力**：SystemCapability.Location.Location.Core 132 133**系统API**：此接口为系统接口。 134 135| 名称 | 类型 | 只读 | 可选 | 说明 | 136| -------- | -------- | -------- | -------- | -------- | 137| ssid | string | 否 | 否 | WiFi热点的SSID，编码格式为UTF-8。 | 138| bssid | string | 否 | 否 | WiFi热点的BSSID。 | 139| rssi | number | 否 | 否 | WiFi热点的信号强度(dBm)。 | 140| frequency | number | 否 | 否 | WiFi热点的频率。 | 141| timestamp | number | 否 | 否 | 时间戳。 | 142 143 144## BluetoothScanInfo<sup>10+</sup> 145 146蓝牙扫描信息。 147 148**系统能力**：SystemCapability.Location.Location.Core 149 150**系统API**：此接口为系统接口。 151 152| 名称 | 类型 | 只读 | 可选 | 说明 | 153| -------- | -------- | -------- | -------- | -------- | 154| deviceName | string | 否 | 否 | 蓝牙设备名称。 | 155| macAddress | string | 否 | 否 | 蓝牙设备的MAC地址。 | 156| rssi | number | 否 | 否 | 蓝牙设备的信号强度(dBm)。 | 157| timestamp | number | 否 | 否 | 时间戳。 | 158 159## LocationPrivacyType 160 161定位服务隐私协议类型。 162 163**系统能力**：SystemCapability.Location.Location.Core 164 165**系统API**：此接口为系统接口。 166 167| 名称 | 值 | 说明 | 168| -------- | -------- | -------- | 169| OTHERS | 0 | 其他场景。预留字段。 | 170| STARTUP | 1 | 开机向导场景下的隐私协议。在开机时弹出协议，提醒用户阅读并选择是否授权。 | 171| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | 172 173## LocatingRequiredDataType<sup>10+</sup> 174 175定位业务所需数据的类型。 176 177**系统能力**：SystemCapability.Location.Location.Core 178 179**系统API**：此接口为系统接口。 180 181| 名称 | 值 | 说明 | 182| -------- | -------- | -------- | 183| WIFI | 1 | 表示WiFi扫描信息。 | 184| BLUETOOTH | 2 | 表示蓝牙扫描信息。 | 185 186 187## LocationIconStatus<sup>12+</sup> 188 189定位图标状态。 190 191**系统能力**：SystemCapability.Location.Location.Core 192 193**系统API**：此接口为系统接口。 194 195| 名称 | 值 | 说明 | 196| -------- | -------- | -------- | 197| LOCATING_NOT_STARTED | 0 | 表示当前无定位业务，无需显示定位图标。 | 198| LOCATING_STARTED | 1 | 表示当前在进行普通定位业务，需要显示普通定位图标。 | 199| HD_LOCATING_STARTED | 2 | 表示当前正在进行高精度定位业务，需要显示高精度定位图标。 | 200 201 202## geoLocationManager.on('locatingRequiredDataChange')<sup>10+</sup> 203 204on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callback: Callback<Array<LocatingRequiredData>>): void 205 206订阅定位业务所需数据的变化，主要包含WiFi和蓝牙扫描信息；根据入参决定是否启动WiFi和蓝牙扫描。使用callback异步回调。 207 208**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION 209 210**系统能力**：SystemCapability.Location.Location.Core 211 212**系统API**：此接口为系统接口。 213 214**参数**： 215 216 | 参数名 | 类型 | 必填 | 说明 | 217 | -------- | -------- | -------- | -------- | 218 | type | string | 是 | 设置事件类型。type为“locatingRequiredDataChange”，表示订阅定位业务所需数据的变化。 | 219 | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | 是 | 表示获取定位所需数据时的配置参数。 | 220 | callback | Callback<Array<[LocatingRequiredData](#locatingrequireddata10)>> | 是 | 回调函数，返回定位业务所需数据。 | 221 222**错误码**： 223 224以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 225 226| 错误码ID | 错误信息 | 227| -------- | ---------------------------------------- | 228|201 | Permission verification failed. The application does not have the permission required to call the API. | 229|202 | Permission verification failed. A non-system application calls a system API. | 230|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 231|801 | Capability not supported. Failed to call ${geoLocationManager.on('locatingRequiredDataChange')} due to limited device capabilities. | 232|3301800 | Failed to start WiFi or Bluetooth scanning. | 233 234**示例** 235 236 ```ts 237 import { geoLocationManager } from '@kit.LocationKit'; 238 let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => { 239 console.info('locatingRequiredDataChange: ' + JSON.stringify(code)); 240 } 241 let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; 242 try { 243 geoLocationManager.on('locatingRequiredDataChange', config, callback); 244 } catch (err) { 245 console.error("errCode:" + err.code + ", message:" + err.message); 246 } 247 ``` 248 249 250## geoLocationManager.off('locatingRequiredDataChange')<sup>10+</sup> 251 252off(type: 'locatingRequiredDataChange', callback?: Callback<Array<LocatingRequiredData>>): void 253 254取消订阅定位业务所需数据的变化，并停止WiFi和蓝牙扫描。 255 256**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION 257 258**系统能力**：SystemCapability.Location.Location.Core 259 260**系统API**：此接口为系统接口。 261 262**参数**： 263 264 | 参数名 | 类型 | 必填 | 说明 | 265 | -------- | -------- | -------- | -------- | 266 | type | string | 是 | 设置事件类型。type为“locatingRequiredDataChange”，表示取消订阅定位业务所需数据的变化。 | 267 | callback | Callback<Array<[LocatingRequiredData](#locatingrequireddata10)>> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 | 268 269**错误码**： 270 271错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 272 273| 错误码ID | 错误信息 | 274| -------- | ---------------------------------------- | 275|201 | Permission verification failed. The application does not have the permission required to call the API. | 276|202 | Permission verification failed. A non-system application calls a system API. | 277|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 278|801 | Capability not supported. Failed to call ${geoLocationManager.off('locatingRequiredDataChange')} due to limited device capabilities. | 279 280**示例** 281 282 ```ts 283 import { geoLocationManager } from '@kit.LocationKit'; 284 let callback = (code:Array<geoLocationManager.LocatingRequiredData>):void => { 285 console.info('locatingRequiredDataChange: ' + JSON.stringify(code)); 286 } 287 let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; 288 try { 289 geoLocationManager.on('locatingRequiredDataChange', config, callback); 290 geoLocationManager.off('locatingRequiredDataChange', callback); 291 } catch (err) { 292 console.error("errCode:" + err.code + ", message:" + err.message); 293 } 294 ``` 295 296## geoLocationManager.enableLocation 297 298enableLocation(callback: AsyncCallback<void>): void 299 300打开位置服务，使用callback异步回调。 301 302**系统API**：此接口为系统接口。 303 304**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 305 306**系统能力**：SystemCapability.Location.Location.Core 307 308**参数**： 309 310 | 参数名 | 类型 | 必填 | 说明 | 311 | -------- | -------- | -------- | -------- | 312 | callback | AsyncCallback<void> | 是 | 回调函数，当打开位置服务成功，err为undefined，否则为错误对象。 | 313 314**错误码**： 315 316以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 317 318| 错误码ID | 错误信息 | 319| -------- | ---------------------------------------- | 320|201 | Permission verification failed. The application does not have the permission required to call the API. | 321|202 | Permission verification failed. A non-system application calls a system API. | 322|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 323|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities. | 324|3301000 | The location service is unavailable. | 325 326**示例** 327 328 ```ts 329 import { geoLocationManager } from '@kit.LocationKit'; 330 try { 331 geoLocationManager.enableLocation((err) => { 332 if (err) { 333 console.error('enableLocation: err=' + JSON.stringify(err)); 334 } 335 }); 336 } catch (err) { 337 console.error("errCode:" + err.code + ", message:" + err.message); 338 } 339 ``` 340 341 342## geoLocationManager.enableLocation 343 344enableLocation(): Promise<void> 345 346打开位置服务，使用Promise异步回调。 347 348**系统API**：此接口为系统接口。 349 350**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 351 352**系统能力**：SystemCapability.Location.Location.Core 353 354**返回值**： 355 356 | 类型 | 说明 | 357 | -------- | -------- | 358 | Promise<void> | Promise对象。无返回结果的Promise对象 | 359 360**错误码**： 361 362以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 363 364| 错误码ID | 错误信息 | 365| -------- | ---------------------------------------- | 366|201 | Permission verification failed. The application does not have the permission required to call the API. | 367|202 | Permission verification failed. A non-system application calls a system API. | 368|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities. | 369|3301000 | The location service is unavailable. | 370 371**示例** 372 373 ```ts 374 import { geoLocationManager } from '@kit.LocationKit'; 375 import { BusinessError } from '@kit.BasicServicesKit'; 376 try { 377 geoLocationManager.enableLocation().then(() => { 378 console.info('promise, enableLocation succeed'); 379 }) 380 .catch((error:BusinessError) => { 381 console.error('promise, enableLocation: error=' + JSON.stringify(error)); 382 }); 383 } catch (err) { 384 console.error("errCode:" + err.code + ", message:" + err.message); 385 } 386 ``` 387 388## geoLocationManager.disableLocation 389 390disableLocation(): void 391 392关闭位置服务。 393 394**系统API**：此接口为系统接口。 395 396**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 397 398**系统能力**：SystemCapability.Location.Location.Core 399 400**错误码**： 401 402以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 403 404| 错误码ID | 错误信息 | 405| -------- | ---------------------------------------- | 406|201 | Permission verification failed. The application does not have the permission required to call the API. | 407|202 | Permission verification failed. A non-system application calls a system API. | 408|801 | Capability not supported. Failed to call ${geoLocationManager.disableLocation} due to limited device capabilities. | 409|3301000 | The location service is unavailable. | 410 411**示例** 412 413 ```ts 414 import { geoLocationManager } from '@kit.LocationKit'; 415 try { 416 geoLocationManager.disableLocation(); 417 } catch (err) { 418 console.error("errCode:" + err.code + ", message:" + err.message); 419 } 420 ``` 421 422## geoLocationManager.enableLocationMock 423 424enableLocationMock(): void 425 426使能位置模拟功能。 427 428**系统能力**：SystemCapability.Location.Location.Core 429 430**系统API**：此接口为系统接口。 431 432**错误码**： 433 434以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 435 436| 错误码ID | 错误信息 | 437| -------- | ---------------------------------------- | 438|202 | Permission verification failed. A non-system application calls a system API. | 439|801 | Capability not supported. Failed to call ${geoLocationManager.enableLocationMock} due to limited device capabilities. | 440|3301000 | The location service is unavailable. | 441|3301100 | The location switch is off.| 442 443**示例** 444 445 ```ts 446 import { geoLocationManager } from '@kit.LocationKit'; 447 try { 448 geoLocationManager.enableLocationMock(); 449 } catch (err) { 450 console.error("errCode:" + err.code + ", message:" + err.message); 451 } 452 ``` 453 454 455## geoLocationManager.disableLocationMock 456 457disableLocationMock(): void 458 459去使能位置模拟功能。 460 461**系统能力**：SystemCapability.Location.Location.Core 462 463**系统API**：此接口为系统接口。 464 465**错误码**： 466 467以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 468 469| 错误码ID | 错误信息 | 470| -------- | ---------------------------------------- | 471|202 | Permission verification failed. A non-system application calls a system API. | 472|801 | Capability not supported. Failed to call ${geoLocationManager.disableLocationMock} due to limited device capabilities. | 473|3301000 | The location service is unavailable. | 474|3301100 | The location switch is off.| 475 476**示例** 477 478 ```ts 479 import { geoLocationManager } from '@kit.LocationKit'; 480 try { 481 geoLocationManager.disableLocationMock(); 482 } catch (err) { 483 console.error("errCode:" + err.code + ", message:" + err.message); 484 } 485 ``` 486 487 488## geoLocationManager.setMockedLocations 489 490setMockedLocations(config: LocationMockConfig): void 491 492设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 493 494该接口需要在调用[geoLocationManager.enableLocationMock](#geolocationmanagerenablelocationmock)之后才能调用。 495 496**系统能力**：SystemCapability.Location.Location.Core 497 498**系统API**：此接口为系统接口。 499 500**参数**： 501 502 | 参数名 | 类型 | 必填 | 说明 | 503 | -------- | -------- | -------- | -------- | 504 | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | 505 506**错误码**： 507 508以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 509 510| 错误码ID | 错误信息 | 511| -------- | ---------------------------------------- | 512|202 | Permission verification failed. A non-system application calls a system API. | 513|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 514|801 | Capability not supported. Failed to call ${geoLocationManager.setMockedLocations} due to limited device capabilities. | 515|3301000 | The location service is unavailable. | 516|3301100 | The location switch is off.| 517 518**示例** 519 520 ```ts 521 import { geoLocationManager } from '@kit.LocationKit'; 522 let locations:Array<geoLocationManager.Location> = [ 523 {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true}, 524 {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true}, 525 {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true}, 526 {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true}, 527 {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true} 528 ]; 529 let config:geoLocationManager.LocationMockConfig = {"timeInterval": 5, "locations": locations}; 530 try { 531 geoLocationManager.enableLocationMock(); 532 geoLocationManager.setMockedLocations(config); 533 } catch (err) { 534 console.error("errCode:" + err.code + ", message:" + err.message); 535 } 536 ``` 537 538 539## geoLocationManager.enableReverseGeocodingMock 540 541enableReverseGeocodingMock(): void 542 543使能逆地理编码模拟功能。 544 545**系统能力**：SystemCapability.Location.Location.Core 546 547**系统API**：此接口为系统接口。 548 549**错误码**： 550 551以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 552 553| 错误码ID | 错误信息 | 554| -------- | ---------------------------------------- | 555|202 | Permission verification failed. A non-system application calls a system API. | 556|801 | Capability not supported. Failed to call ${geoLocationManager.enableReverseGeocodingMock} due to limited device capabilities. | 557|3301000 | The location service is unavailable. | 558 559**示例** 560 561 ```ts 562 import { geoLocationManager } from '@kit.LocationKit'; 563 try { 564 geoLocationManager.enableReverseGeocodingMock(); 565 } catch (err) { 566 console.error("errCode:" + err.code + ", message:" + err.message); 567 } 568 ``` 569 570 571## geoLocationManager.disableReverseGeocodingMock 572 573disableReverseGeocodingMock(): void 574 575去使能逆地理编码模拟功能。 576 577**系统能力**：SystemCapability.Location.Location.Core 578 579**系统API**：此接口为系统接口。 580 581**错误码**： 582 583以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 584 585| 错误码ID | 错误信息 | 586| -------- | ---------------------------------------- | 587|202 | Permission verification failed. A non-system application calls a system API. | 588|801 | Capability not supported. Failed to call ${geoLocationManager.disableReverseGeocodingMock} due to limited device capabilities. | 589|3301000 | The location service is unavailable. | 590 591**示例** 592 593 ```ts 594 import { geoLocationManager } from '@kit.LocationKit'; 595 try { 596 geoLocationManager.disableReverseGeocodingMock(); 597 } catch (err) { 598 console.error("errCode:" + err.code + ", message:" + err.message); 599 } 600 ``` 601 602 603## geoLocationManager.setReverseGeocodingMockInfo 604 605setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void 606 607设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 608 609该接口需要在调用[geoLocationManager.enableReverseGeocodingMock](#geolocationmanagerenablereversegeocodingmock)之后才能调用。 610 611**系统能力**：SystemCapability.Location.Location.Core 612 613**系统API**：此接口为系统接口。 614 615**参数**： 616 617 | 参数名 | 类型 | 必填 | 说明 | 618 | -------- | -------- | -------- | -------- | 619 | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | 620 621**错误码**： 622 623以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 624 625| 错误码ID | 错误信息 | 626| -------- | ---------------------------------------- | 627|202 | Permission verification failed. A non-system application calls a system API. | 628|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 629|801 | Capability not supported. Failed to call ${geoLocationManager.setReverseGeocodingMockInfo} due to limited device capabilities. | 630|3301000 | The location service is unavailable. | 631 632**示例** 633 634 ```ts 635 import { geoLocationManager } from '@kit.LocationKit'; 636 let mockInfos:Array<geoLocationManager.ReverseGeocodingMockInfo> = [ 637 {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "isFromMock": true}}, 638 {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "isFromMock": true}}, 639 {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "isFromMock": true}}, 640 {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "isFromMock": true}}, 641 {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "isFromMock": true}}, 642 ]; 643 try { 644 geoLocationManager.enableReverseGeocodingMock(); 645 geoLocationManager.setReverseGeocodingMockInfo(mockInfos); 646 } catch (err) { 647 console.error("errCode:" + err.code + ", message:" + err.message); 648 } 649 ``` 650 651 652## geoLocationManager.isLocationPrivacyConfirmed 653 654isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean 655 656查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 657 658**系统API**：此接口为系统接口。 659 660**系统能力**：SystemCapability.Location.Location.Core 661 662**参数**： 663 664 | 参数名 | 类型 | 必填 | 说明 | 665 | -------- | -------- | -------- | -------- | 666 | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | 667 668**返回值**： 669 670 | 类型 | 说明 | 671 | -------- | -------- | 672 | boolean | true：用户同意定位服务隐私申明<br/>false：用户不同意定位服务隐私申明 | 673 674**错误码**： 675 676以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 677 678| 错误码ID | 错误信息 | 679| -------- | ---------------------------------------- | 680|202 | Permission verification failed. A non-system application calls a system API. | 681|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 682|801 | Capability not supported. Failed to call ${geoLocationManager.isLocationPrivacyConfirmed} due to limited device capabilities. | 683|3301000 | The location service is unavailable. | 684 685**示例** 686 687 ```ts 688 import { geoLocationManager } from '@kit.LocationKit'; 689 try { 690 let isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); 691 } catch (err) { 692 console.error("errCode:" + err.code + ", message:" + err.message); 693 } 694 ``` 695 696 697## geoLocationManager.setLocationPrivacyConfirmStatus 698 699setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void 700 701设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 702 703**系统API**：此接口为系统接口。 704 705**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 706 707**系统能力**：SystemCapability.Location.Location.Core 708 709**参数**： 710 711 | 参数名 | 类型 | 必填 | 说明 | 712 | -------- | -------- | -------- | -------- | 713 | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | 714 | isConfirmed | boolean | 是 | true：用户同意定位服务隐私申明<br/>false：用户不同意定位服务隐私申明 | 715 716**错误码**： 717 718以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 719 720| 错误码ID | 错误信息 | 721| -------- | ---------------------------------------- | 722|201 | Permission verification failed. The application does not have the permission required to call the API. | 723|202 | Permission verification failed. A non-system application calls a system API. | 724|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 725|801 | Capability not supported. Failed to call ${geoLocationManager.setLocationPrivacyConfirmStatus} due to limited device capabilities. | 726|3301000 | The location service is unavailable. | 727 728**示例** 729 730 ```ts 731 import { geoLocationManager } from '@kit.LocationKit'; 732 try { 733 geoLocationManager.setLocationPrivacyConfirmStatus(1, true); 734 } catch (err) { 735 console.error("errCode:" + err.code + ", message:" + err.message); 736 } 737 ``` 738 739 740## geoLocationManager.getLocatingRequiredData<sup>10+</sup> 741 742getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise<Array<LocatingRequiredData>> 743 744单次获取定位业务所需数据，包含WiFi蓝牙扫描信息，使用Promise方式异步返回结果。 745 746**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION 747 748**系统能力**：SystemCapability.Location.Location.Core 749 750**系统API**：此接口为系统接口。 751 752**参数**： 753 754 | 参数名 | 类型 | 必填 | 说明 | 755 | -------- | -------- | -------- | -------- | 756 | config | [LocatingRequiredDataConfig](#locatingrequireddataconfig10) | 是 | 表示获取定位所需数据时的配置参数。 | 757 758**返回值**： 759 760 | 类型 | 说明 | 761 | -------- | -------- | 762 | Promise<Array<[LocatingRequiredData](#locatingrequireddata10)>> | 以Promise形式返回定位业务所需数据，包含WiFi蓝牙扫描信息。 | 763 764**错误码**： 765 766以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 767 768| 错误码ID | 错误信息 | 769| -------- | ---------------------------------------- | 770|201 | Permission verification failed. The application does not have the permission required to call the API. | 771|202 | Permission verification failed. A non-system application calls a system API. | 772|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 773|801 | Capability not supported. Failed to call ${geoLocationManager.getLocatingRequiredData} due to limited device capabilities. | 774|3301800 | Failed to start WiFi or Bluetooth scanning. | 775 776**示例** 777 778 ```ts 779 import { geoLocationManager } from '@kit.LocationKit'; 780 import { BusinessError } from '@kit.BasicServicesKit'; 781 let config:geoLocationManager.LocatingRequiredDataConfig = {'type': 1, 'needStartScan': true, 'scanInterval': 10000}; 782 try { 783 geoLocationManager.getLocatingRequiredData(config).then((result) => { 784 console.info('getLocatingRequiredData return: ' + JSON.stringify(result)); 785 }) 786 .catch((error:BusinessError) => { 787 console.error('promise, getLocatingRequiredData: error=' + JSON.stringify(error)); 788 }); 789 } catch (err) { 790 console.error("errCode:" + err.code + ", message:" + err.message); 791 } 792 ``` 793 794 795## geoLocationManager.on('locationIconStatusChange')<sup>12+</sup> 796 797on(type: 'locationIconStatusChange', callback: Callback<LocationIconStatus>): void 798 799订阅定位图标状态变化。使用callback异步回调。 800 801**系统能力**：SystemCapability.Location.Location.Core 802 803**系统API**：此接口为系统接口。 804 805**参数**： 806 807 | 参数名 | 类型 | 必填 | 说明 | 808 | -------- | -------- | -------- | -------- | 809 | type | string | 是 | 设置事件类型。type为“locationIconStatusChange”，表示订阅定位图标状态变化。 | 810 | callback | Callback<[LocationIconStatus](#locationiconstatus12)> | 是 | 回调函数，返回定位图标状态。 | 811 812**错误码**： 813 814以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 815 816| 错误码ID | 错误信息 | 817| -------- | ---------------------------------------- | 818|202 | Permission verification failed. A non-system application calls a system API. | 819|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 820|801 | Capability not supported. Failed to call ${geoLocationManager.on('locationIconStatusChange')} due to limited device capabilities. | 821|3301000 | The location service is unavailable. | 822 823**示例** 824 825 ```ts 826 import { geoLocationManager } from '@kit.LocationKit'; 827 let callback = (code: geoLocationManager.LocationIconStatus):void => { 828 console.info('LocationIconStatus: ' + JSON.stringify(code)); 829 } 830 try { 831 geoLocationManager.on('locationIconStatusChange', callback); 832 } catch (err) { 833 console.error("errCode:" + err.code + ", message:" + err.message); 834 } 835 ``` 836 837 838## geoLocationManager.off('locationIconStatusChange')<sup>12+</sup> 839 840off(type: 'locationIconStatusChange', callback?: Callback<LocationIconStatus>): void 841 842取消订阅定位图标状态的变化。 843 844**系统能力**：SystemCapability.Location.Location.Core 845 846**系统API**：此接口为系统接口。 847 848**参数**： 849 850 | 参数名 | 类型 | 必填 | 说明 | 851 | -------- | -------- | -------- | -------- | 852 | type | string | 是 | 设置事件类型。type为“locationIconStatusChange”，表示取消订阅定位图标状态变化。 | 853 | callback | Callback<[LocationIconStatus](#locationiconstatus12)> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 | 854 855**错误码**： 856 857错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 858 859| 错误码ID | 错误信息 | 860| -------- | ---------------------------------------- | 861|202 | Permission verification failed. A non-system application calls a system API. | 862|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 863|801 | Capability not supported. Failed to call ${geoLocationManager.off('locationIconStatusChange')} due to limited device capabilities. | 864|3301000 | The location service is unavailable. | 865 866**示例** 867 868 ```ts 869 import { geoLocationManager } from '@kit.LocationKit'; 870 let callback = (code: geoLocationManager.LocationIconStatus):void => { 871 console.info('LocationIconStatus: ' + JSON.stringify(code)); 872 } 873 try { 874 geoLocationManager.on('locationIconStatusChange', callback); 875 geoLocationManager.off('locationIconStatusChange', callback); 876 } catch (err) { 877 console.error("errCode:" + err.code + ", message:" + err.message); 878 } 879 ``` 880 881 882## geoLocationManager.getLocationIconStatus<sup>12+</sup> 883 884getLocationIconStatus(): LocationIconStatus 885 886获取当前的定位图标状态。 887 888**系统能力**：SystemCapability.Location.Location.Core 889 890**系统API**：此接口为系统接口。 891 892**返回值**： 893 894 | 类型 | 说明 | 895 | -------- | -------- | 896 | [LocationIconStatus](#locationiconstatus12) | 返回定位图标状态。 | 897 898**错误码**： 899 900以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。 901 902| 错误码ID | 错误信息 | 903| -------- | ---------------------------------------- | 904|202 | Permission verification failed. A non-system application calls a system API. | 905|801 | Capability not supported. Failed to call ${geoLocationManager.getLocationIconStatus} due to limited device capabilities. | 906|3301000 | The location service is unavailable. | 907 908**示例** 909 910 ```ts 911 import { geoLocationManager } from '@kit.LocationKit'; 912 try { 913 let iconStatus = geoLocationManager.getLocationIconStatus(); 914 } catch (err) { 915 console.error("errCode:" + err.code + ", message:" + err.message); 916 } 917 ```