# @ohos.geoLocationManager (位置服务)
位置服务提供GNSS定位、网络定位（蜂窝基站、WLAN、蓝牙定位技术）、地理编码、逆地理编码、国家码和地理围栏等基本功能。
使用位置服务时请打开设备“位置”开关。如果“位置”开关关闭并且代码未设置捕获异常，可能导致应用异常。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块能力仅支持WGS-84坐标系。
## 申请权限
请参考[申请位置权限开发指导](../../device/location/location-permission-guidelines.md#开发步骤)。
## 导入模块
```ts
import { geoLocationManager } from '@kit.LocationKit';
```
## ReverseGeoCodeRequest
逆地理编码请求参数。
**系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| locale | string | 否 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。默认值从设置中的“语言和地区”获取。 |
| country12+ | string | 否 | 是 | 限制查询结果在指定的国家内，采用ISO 3166-1 alpha-2 。“CN”代表中国。默认值从设置中的“语言和地区”获取。 |
| latitude | number | 否 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。取值范围为-90到90。仅支持WGS84坐标系。 |
| longitude | number | 否 | 否 | 表示经度信息，正值表示东经，负值表示西经。取值范围为-180到180。仅支持WGS84坐标系。 |
| maxItems | number | 否 | 是 | 指定返回位置信息的最大个数。取值范围为大于等于0，推荐该值小于10。默认值是1。 |
## GeoCodeRequest
地理编码请求参数。
**系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| locale | string | 否 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。默认值从设置中的“语言和地区”获取。 |
| country12+ | string | 否 | 是 | 限制查询结果在指定的国家内，采用ISO 3166-1 alpha-2 。“CN”代表中国。默认值从设置中的“语言和地区”获取。 |
| description | string | 否 | 否 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 否 | 是 | 表示返回位置信息的最大个数。取值范围为大于等于0，推荐该值小于10。默认值是1。 |
| minLatitude | number | 否 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。取值范围为-90到90。仅支持WGS84坐标系。如果该参数有值时，下面三个参数必填。 |
| minLongitude | number | 否 | 是 | 表示最小经度信息。取值范围为-180到180。仅支持WGS84坐标系。 |
| maxLatitude | number | 否 | 是 | 表示最大纬度信息。取值范围为-90到90。仅支持WGS84坐标系。 |
| maxLongitude | number | 否 | 是 | 表示最大经度信息。取值范围为-180到180。仅支持WGS84坐标系。 |
## GeoAddress
地理编码地址信息。
**系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 否 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。取值范围为-90到90。仅支持WGS84坐标系。 |
| longitude | number | 否 | 是 | 表示经度信息，正值表示东经，负值表是西经。取值范围为-180到180。仅支持WGS84坐标系。 |
| locale | string | 否 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| placeName | string | 否 | 是 | 表示详细地址信息。 |
| countryCode | string | 否 | 是 | 表示国家码信息。 |
| countryName | string | 否 | 是 | 表示国家信息。 |
| administrativeArea | string | 否 | 是 | 表示国家以下的一级行政区，一般是省/州。 |
| subAdministrativeArea | string | 否 | 是 | 表示国家以下的二级行政区，一般是市。 |
| locality | string | 否 | 是 | 表示城市信息，一般是市。 |
| subLocality | string | 否 | 是 | 表示子城市信息，一般是区/县。 |
| roadName | string | 否 | 是 | 表示路名信息。 |
| subRoadName | string | 否 | 是 | 表示子路名信息。 |
| premises | string | 否 | 是 | 表示门牌号信息。 |
| postalCode | string | 否 | 是 | 表示邮政编码信息。 |
| phoneNumber | string | 否 | 是 | 表示联系方式信息。 |
| addressUrl | string | 否 | 是 | 表示位置信息附件的网址信息。 |
| descriptions | Array<string> | 否 | 是 | 表示附加的描述信息。目前包含城市编码cityCode（Array下标为0）和区划编码adminCode（Array下标为1），例如["025","320114001"]。 |
| descriptionsSize | number | 否 | 是 | 表示附加的描述信息数量。取值范围为大于等于0，推荐该值小于10。 |
## LocationRequest
位置信息请求参数。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 是 | 表示优先级信息。当scenario取值为UNSET时，priority参数生效，否则priority参数不生效；当scenario和priority均取值为UNSET时，无法发起定位请求。取值范围见[LocationRequestPriority](#locationrequestpriority)的定义。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 是 | 表示场景信息。当scenario取值为UNSET时，priority参数生效，否则priority参数不生效；当scenario和priority均取值为UNSET时，无法发起定位请求。取值范围见[LocationRequestScenario](#locationrequestscenario)的定义。 |
| timeInterval | number | 否 | 是 | 表示上报位置信息的时间间隔，单位为秒。
取值范围为大于等于0的值。
默认值为对应定位模式下允许的最小时间间隔：
默认值在GNSS定位时为1秒，网络定位时为20秒。
当设置值小于最小间隔时，以最小时间间隔生效。
设置为0时不对时间间隔进行校验，直接上报位置信息。 |
| distanceInterval | number | 否 | 是 | 表示上报位置信息的距离间隔。单位是米，默认值为0，取值范围为大于等于0。等于0时对位置上报距离间隔无限制。 |
| maxAccuracy | number | 否 | 是 | 应用向系统请求位置信息时要求的精度值，单位为米。该参数仅在精确位置功能场景（即同时授权了ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION 权限）下有效，模糊位置功能生效场景（即仅授权了ohos.permission.APPROXIMATELY_LOCATION 权限）下该字段无意义。
该参数生效的情况下，系统会对比GNSS或网络定位服务上报的位置信息与应用的位置信息申请。当位置信息[Location](#location)中的精度值（accuracy）小于等于应用要求的精度值（maxAccuracy）时，位置信息会返回给应用；否则系统将丢弃本次收到的位置信息。
默认值为0，表示不限制位置信息的精度，取值范围为大于等于0。
当scenario为NAVIGATION/TRAJECTORY_TRACKING/CAR_HAILING或者priority为ACCURACY时建议设置maxAccuracy为大于10的值。
当scenario为DAILY_LIFE_SERVICE/NO_POWER或者priority为LOW_POWER/FIRST_FIX时建议设置maxAccuracy为大于100的值。
|
## CurrentLocationRequest
当前位置信息请求参数。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 是 | 表示优先级信息。当scenario取值为UNSET时，priority参数生效，否则priority参数不生效；当scenario和priority均取值为UNSET时，无法发起定位请求。取值范围见[LocationRequestPriority](#locationrequestpriority)的定义。|
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 是 | 表示场景信息。当scenario取值为UNSET时，priority参数生效，否则priority参数不生效；当scenario和priority均取值为UNSET时，无法发起定位请求。取值范围见[LocationRequestScenario](#locationrequestscenario)的定义。 |
| maxAccuracy | number | 否 | 是| 应用向系统请求位置信息时要求的精度值，单位为米。该参数仅在精确位置功能场景（即同时授权了ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION 权限）下有效，模糊位置功能生效场景（即仅授权了ohos.permission.APPROXIMATELY_LOCATION 权限）下该字段无意义。
该参数生效的情况下，系统会对比GNSS或网络定位服务上报的位置信息与应用的位置信息申请。当位置信息[Location](#location)中的精度值（accuracy）小于等于应用要求的精度值（maxAccuracy）时，位置信息会返回给应用；否则系统将丢弃本次收到的位置信息。
默认值为0，表示不限制位置信息的精度，取值范围为大于等于0。
当scenario为NAVIGATION/TRAJECTORY_TRACKING/CAR_HAILING或者priority为ACCURACY时建议设置maxAccuracy为大于10的值。
当scenario为DAILY_LIFE_SERVICE/NO_POWER或者priority为LOW_POWER/FIRST_FIX时建议设置maxAccuracy为大于100的值。 |
| timeoutMs | number | 否 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。取值范围为大于等于1000。 |
## ContinuousLocationRequest12+
持续定位的请求参数。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| interval | number | 否 | 否 | 表示上报位置信息的时间间隔，单位是秒。默认值为1，取值范围为大于等于0。等于0时对位置上报时间间隔无限制。|
| locationScenario | [UserActivityScenario](#useractivityscenario12) | [PowerConsumptionScenario](#powerconsumptionscenario12) | 否 | 否 | 表示定位的场景信息。取值范围见[UserActivityScenario](#useractivityscenario12)和[PowerConsumptionScenario](#powerconsumptionscenario12)的定义。 |
## SingleLocationRequest12+
单次定位的请求参数。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| locatingPriority | [LocatingPriority](#locatingpriority12) | 否 | 否 | 表示优先级信息。取值范围见[LocatingPriority](#locatingpriority12)的定义。|
| locatingTimeoutMs | number | 否 | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。取值范围为大于等于1000。 |
## SatelliteStatusInfo
卫星状态信息。
**系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| satellitesNumber | number | 否 | 否 | 表示卫星个数。取值范围为大于等于0。 |
| satelliteIds | Array<number> | 否 | 否 | 表示每个卫星的ID，数组类型。取值范围为大于等于0。 |
| carrierToNoiseDensitys | Array<number> | 否 | 否 | 表示载波噪声功率谱密度比，即cn0。取值范围为大于0。 |
| altitudes | Array<number> | 否 | 否 | 表示卫星高度角信息。单位是“度”，取值范围为-90到90。 |
| azimuths | Array<number> | 否 | 否 | 表示方位角。单位是“度”，取值范围为0到360。 |
| carrierFrequencies | Array<number> | 否 | 否 | 表示载波频率。单位是Hz，取值范围为大于等于0。 |
| satelliteConstellation12+ | Array<[SatelliteConstellationCategory](#satelliteconstellationcategory12)> | 否 | 是 | 表示卫星星座类型。 |
| satelliteAdditionalInfo12+ | Array<number> | 否 | 是 | 表示卫星的附加信息。
每个比特位代表不同含义，具体定义参见[SatelliteAdditionalInfo](#satelliteadditionalinfo12)。 |
## CachedGnssLocationsRequest
请求订阅GNSS缓存位置上报功能接口的配置参数。
**系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| reportingPeriodSec | number | 否 | 否 | 表示GNSS缓存位置上报的周期，单位是毫秒。取值范围为大于0。 |
| wakeUpCacheQueueFull | boolean | 否 | 否 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 |
## Geofence
GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 否 | 否 |表示纬度。取值范围为-90到90。 |
| longitude | number | 否 |否 | 表示经度。取值范围为-180到180。 |
| coordinateSystemType12+ | [CoordinateSystemType](#coordinatesystemtype12) | 否 |是 | 表示地理围栏圆心坐标的坐标系。
APP应先使用[getGeofenceSupportedCoordTypes](#geolocationmanagergetgeofencesupportedcoordtypes12)查询支持的坐标系，然后传入正确的圆心坐标。 |
| radius | number | 否 |否 | 表示圆形围栏的半径。单位是米，取值范围为大于0。 |
| expiration | number | 否 |否 | 围栏存活的时间，单位是毫秒。取值范围为大于0。 |
## GeofenceRequest
请求添加GNSS围栏消息中携带的参数，包括定位场景和围栏信息。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 否 | 表示定位场景。 |
| geofence | [Geofence](#geofence)| 否 | 否 | 表示围栏信息。 |
## LocationCommand
扩展命令参数。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 否 | 表示定位场景。 |
| command | string | 否 | 否 | 扩展命令字符串。 |
## Location
位置信息。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number| 否 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。取值范围为-90到90。仅支持WGS84坐标系。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| longitude | number| 否 | 否 | 表示经度信息，正值表示东经，负值表是西经。取值范围为-180到180。仅支持WGS84坐标系。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| altitude | number | 否 | 否 | 表示高度信息，单位米。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| accuracy | number | 否 | 否 | 表示精度信息，单位米。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| speed | number | 否 | 否 |表示速度信息，单位米每秒。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| timeStamp | number | 否 | 否 | 表示位置时间戳，UTC格式。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| direction | number | 否 | 否 | 表示航向信息。单位是“度”，取值范围为0到360。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| timeSinceBoot | number | 否 | 否 | 表示位置时间戳，开机时间格式。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| additions | Array<string>| 否 | 是 | 附加信息。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| additionSize | number| 否 | 是 | 附加信息数量。取值范围为大于等于0。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| additionsMap12+ | Map<string, string>| 否 | 是 | 附加信息。具体内容和顺序与additions一致。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
| altitudeAccuracy12+ |number | 否 | 是 | 表示高度信息的精度，单位米。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
| speedAccuracy12+ | number| 否 | 是 | 表示速度信息的精度，单位米每秒。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
| directionAccuracy12+ | number| 否 | 是 | 表示航向信息的精度。单位是“度”，取值范围为0到360。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
| uncertaintyOfTimeSinceBoot12+ | number| 否 | 是 | 表示位置时间戳的不确定度。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
| sourceType12+ | [LocationSourceType](#locationsourcetype12) | 否 | 是 | 表示定位结果的来源。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 |
## GeofenceTransition12+
地理围栏事件信息；包含地理围栏ID和具体的地理围栏事件。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| geofenceId | number| 否 | 否 | 表示地理围栏ID。 |
| transitionEvent | [GeofenceTransitionEvent](#geofencetransitionevent12) | 否 | 否 | 表示当前发生的地理围栏事件。 |
## GnssGeofenceRequest12+
GNSS地理围栏请求参数。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| geofence | [Geofence](#geofence) | 否 | 否 | 表示地理围栏信息，包含圆形围栏圆心坐标、半径等信息。 |
| monitorTransitionEvents | Array<[GeofenceTransitionEvent](#geofencetransitionevent12)> | 否 | 否 | 表示APP监听的地理围栏事件列表。 |
| notifications | Array<[NotificationRequest](../apis-notification-kit/js-apis-notification.md#notificationrequest)> | 否 | 是 | 表示地理围栏事件发生后弹出的通知对象列表。
monitorTransitionEvents与notifications中的顺序要一一对应，例如monitorTransitionEvents[0]为[GeofenceTransitionEvent](#geofencetransitionevent12).GEOFENCE_TRANSITION_EVENT_ENTER，那notifications[0]中就需要填入用户进入围栏时需要弹出的通知对象。 |
| geofenceTransitionCallback | AsyncCallback<[GeofenceTransition](#geofencetransition12)> | 否 | 否 | 表示用于接收地理围栏事件的回调函数。 |
## CountryCode
国家码信息，包含国家码字符串和国家码的来源信息。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 只读 | 可选 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| country | string | 否 | 否 | 表示国家码字符串。 |
| type | [CountryCodeType](#countrycodetype) | 否 | 否 | 表示国家码信息来源。 |
## LocationRequestPriority
位置请求中位置信息优先级类型。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级，表示[LocationRequestPriority](#locationrequestpriority)无效。 |
| ACCURACY | 0x201 | 表示精度优先。
定位精度优先策略主要以GNSS定位技术为主。我们会在GNSS提供稳定位置结果之前使用网络定位技术提供服务。在持续定位过程中，如果超过30秒无法获取GNSS定位结果则使用网络定位技术。对设备的硬件资源消耗较大，功耗较大。 |
| LOW_POWER | 0x202 | 表示低功耗优先。
低功耗定位优先策略仅使用网络定位技术，在室内和户外场景均可提供定位服务，因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况，定位结果的精度波动范围较大，推荐在对定位结果精度要求不高的场景下使用该策略，可以有效节省设备功耗。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到一个位置，可以将优先级设置为该字段。
快速定位优先策略会同时使用GNSS定位和网络定位技术，以便在室内和户外场景下均可以快速获取到位置结果；当各种定位技术都有提供位置结果时，系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用，对设备的硬件资源消耗较大，功耗也较大。 |
## LocationRequestScenario
位置请求中定位场景类型。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
> **说明：**
>
> 当使用NAVIGATION/TRAJECTORY_TRACKING/CAR_HAILING场景进行单次定位或持续定位时，我们会在GNSS提供稳定位置结果之前使用网络定位技术提供服务；在持续定位时，如果超过30秒无法获取GNSS定位结果则会使用网络定位技术获取位置。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。
表示[LocationRequestScenario](#locationrequestscenario)字段无效。 |
| NAVIGATION | 0x301 | 表示导航场景。
适用于在户外获取设备实时位置的场景，如车载、步行导航。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。
适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| CAR_HAILING | 0x303 | 表示打车场景。
适用于用户出行打车时定位当前位置的场景，如网约车类应用。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。
适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用。
该场景仅使用网络定位技术提供定位服务，功耗较低。 |
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## CountryCodeType
国家码来源类型。
**系统能力**：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 | 从蜂窝网络注册信息中获取到的国家码。 |
## CoordinateSystemType12+
坐标系类型。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| WGS84 | 1 | World Geodetic System 1984，是为GPS全球定位系统使用而建立的坐标系统。 |
| GCJ02 | 2 | GCJ-02是由中国国家测绘局制订的地理信息系统的坐标系统。 |
## GeofenceTransitionEvent12+
地理围栏事件。
**系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| GEOFENCE_TRANSITION_EVENT_ENTER | 1 | 该事件表示设备从地理围栏外进入地理围栏内。 |
| GEOFENCE_TRANSITION_EVENT_EXIT | 2 | 该事件表示设备从地理围栏内退出到地理围栏外。 |
| GEOFENCE_TRANSITION_EVENT_DWELL | 4 | 该事件表示设备在地理围栏范围内，且持续徘徊超过10秒。 |
## SatelliteConstellationCategory12+
卫星星座类型。
**系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| CONSTELLATION_CATEGORY_UNKNOWN | 0 | 默认值。 |
| CONSTELLATION_CATEGORY_GPS | 1 | GPS（Global Positioning System），即全球定位系统，是美国研制发射的一种以人造地球卫星为基础的高精度无线电导航的定位系统。 |
| CONSTELLATION_CATEGORY_SBAS | 2 | SBAS（Satellite-Based Augmentation System），即星基增强系统，通过地球静止轨道（GEO）卫星搭载卫星导航增强信号转发器，可以向用户播发星历误差、卫星钟差、电离层延迟等多种修正信息，实现对于原有卫星导航系统定位精度的改进。 |
| CONSTELLATION_CATEGORY_GLONASS | 3 | GLONASS（GLOBAL NAVIGATION SATELLITE SYSTEM），是苏联/俄罗斯研制卫星导航系统。 |
| CONSTELLATION_CATEGORY_QZSS | 4 | QZSS（Quasi-Zenith Satellite System），即准天顶卫星系统，是以三颗人造卫星透过时间转移完成全球定位系统区域性功能的卫星扩增系统，是日本研发的卫星系统。 |
| CONSTELLATION_CATEGORY_BEIDOU | 5 | 北斗卫星导航系统（Beidou Navigation Satellite System）是中国自行研制的全球卫星导航系统。 |
| CONSTELLATION_CATEGORY_GALILEO | 6 | GALILEO（Galileo satellite navigation system），即伽利略卫星导航系统，是由欧盟研制和建立的全球卫星导航定位系统。 |
| CONSTELLATION_CATEGORY_IRNSS | 7 | IRNSS（Indian Regional Navigation Satellite System），即印度区域导航卫星系统，是一个由印度空间研究组织（ISRO）发展的自由区域型卫星导航系统。 |
## SatelliteAdditionalInfo12+
卫星附加信息类型。
**系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| SATELLITES_ADDITIONAL_INFO_NULL | 0 | 默认值。 |
| SATELLITES_ADDITIONAL_INFO_EPHEMERIS_DATA_EXIST | 1 | 表示本卫星具有星历数据。 |
| SATELLITES_ADDITIONAL_INFO_ALMANAC_DATA_EXIST | 2 | 表示本卫星具有年历数据。 |
| SATELLITES_ADDITIONAL_INFO_USED_IN_FIX | 4 | 表示在最新的位置解算中使用了本卫星。 |
| SATELLITES_ADDITIONAL_INFO_CARRIER_FREQUENCY_EXIST | 8 | 表示本卫星具有载波频率。 |
## PowerConsumptionScenario12+
位置请求中的功耗场景类型。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| HIGH_POWER_CONSUMPTION | 0x601 | 高功耗。
以GNSS定位技术为主。我们会在GNSS提供稳定位置结果之前使用网络定位技术提供服务；在持续定位时，如果超过30秒无法获取GNSS定位结果则会使用网络定位技术获取位置。对设备的硬件资源消耗较大，功耗较大。 |
| LOW_POWER_CONSUMPTION | 0x602 | 低功耗。
适用于对用户位置精度要求不高的使用场景，如新闻资讯、网购、点餐类应用。
该场景仅使用网络定位技术提供定位服务，功耗较低。 |
| NO_POWER_CONSUMPTION | 0x603 | 无功耗。
这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## UserActivityScenario12+
位置请求中的用户活动场景类型。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
> **说明：**
>
> 当使用NAVIGATION/SPORT/TRANSPORT场景进行单次定位或持续定位时，我们会在GNSS提供稳定位置结果之前使用网络定位技术提供服务；在持续定位时，如果超过30秒无法获取GNSS定位结果则会使用网络定位技术获取位置。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| NAVIGATION | 0x401 | 表示导航场景。
适用于在户外获取设备实时位置的场景，如车载、步行导航。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| SPORT | 0x402 | 表示运动场景。
适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| TRANSPORT | 0x403 | 表示出行场景。
适用于用户出行场景，如打车、乘坐公共交通等场景。
主要使用GNSS定位技术提供定位服务，功耗较高。 |
| DAILY_LIFE_SERVICE | 0x404 | 表示日常服务使用场景。
适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用。
该场景仅使用网络定位技术提供定位服务，功耗较低。 |
## LocatingPriority12+
单次位置请求中的优先级类型。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| PRIORITY_ACCURACY | 0x501 | 表示精度优先。
定位精度优先策略会同时使用GNSS定位和网络定位技术，并把一段时间内精度较好的结果返回给应用；这个时间段长度为[SingleLocationRequest](#singlelocationrequest12).locatingTimeoutMs与“30秒”中的较小者。
对设备的硬件资源消耗较大，功耗较大。 |
| PRIORITY_LOCATING_SPEED | 0x502 | 表示快速获取位置优先，如果应用希望快速拿到一个位置，可以将优先级设置为该类型。
快速定位优先策略会同时使用GNSS定位和网络定位技术，以便在室内和户外场景下均可以快速获取到位置结果，我们会把最先拿到的定位结果返回给应用。对设备的硬件资源消耗较大，功耗也较大。 |
## LocationError12+
持续定位过程中的错误信息。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| LOCATING_FAILED_DEFAULT | -1 | 默认值。 |
| LOCATING_FAILED_LOCATION_PERMISSION_DENIED | -2 | 表示ohos.permission.APPROXIMATELY_LOCATION权限或ohos.permission.LOCATION权限校验失败导致持续定位失败。 |
| LOCATING_FAILED_BACKGROUND_PERMISSION_DENIED | -3 | 表示应用在后台时位置权限校验失败导致持续定位失败。APP在后台定位时的位置权限申请方式参见[申请位置权限开发指导](../../device/location/location-permission-guidelines.md#开发步骤)。 |
| LOCATING_FAILED_LOCATION_SWITCH_OFF | -4 | 表示位置信息开关关闭导致持续定位失败。 |
| LOCATING_FAILED_INTERNET_ACCESS_FAILURE | -5 | 表示无法访问网络，导致网络定位失败。 |
## LocationSourceType12+
定位结果的来源。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| GNSS | 1 | 表示定位结果来自于GNSS定位技术。 |
| NETWORK | 2 | 表示定位结果来自于网络定位技术。 |
| INDOOR | 3 | 表示定位结果来自于室内高精度定位技术。 |
| RTK | 4 | 表示定位结果来自于室外高精度定位技术。 |
## geoLocationManager.on('locationChange')
on(type: 'locationChange', request: LocationRequest | ContinuousLocationRequest, callback: Callback<Location>): void
开启位置变化订阅，并发起定位请求。使用callback异步回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| request | [LocationRequest](#locationrequest) | [ContinuousLocationRequest](#continuouslocationrequest12) | 是 | 设置位置请求参数。
ContinuousLocationRequest为API12新增参数。 |
| callback | Callback<[Location](#location)> | 是 | 回调函数，返回位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
// 方式一：使用LocationRequest作为入参
let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location:geoLocationManager.Location):void => {
console.info('locationChanger: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', requestInfo, locationChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
// 方式二：使用ContinuousLocationRequest作为入参
let request:geoLocationManager.ContinuousLocationRequest = {'interval': 1, 'locationScenario': geoLocationManager.UserActivityScenario.NAVIGATION};
let locationCallback = (location:geoLocationManager.Location):void => {
console.info('locationCallback: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', request, locationCallback);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('locationChange')
off(type: 'locationChange', callback?: Callback<Location>): void
关闭位置变化订阅，并删除对应的定位请求。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location:geoLocationManager.Location):void => {
console.info('locationChanger: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', requestInfo, locationChange);
geoLocationManager.off('locationChange', locationChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('locationError')12+
on(type: 'locationError', callback: Callback<LocationError>): void
订阅持续定位过程中的错误码。使用callback异步回调。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationError”，表示持续定位过程中的错误码变化。 |
| callback | Callback<[LocationError](#locationerror12)> | 是 | 回调函数，返回持续定位过程中的错误码。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('locationError')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let requestInfo:geoLocationManager.LocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET, 'timeInterval': 1, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location:geoLocationManager.Location):void => {
console.info('locationChanger: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', requestInfo, locationChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
let locationErrorChange = (errcode: geoLocationManager.LocationError):void => {
console.info('locationErrorChange: data: ' + JSON.stringify(errcode));
};
try {
geoLocationManager.on('locationError', locationErrorChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('locationError')12+
off(type: 'locationError', callback?: Callback<LocationError>): void
取消订阅持续定位过程中的错误码。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationError”，表示持续定位过程中的错误码变化。 |
| callback | Callback<[LocationError](#locationerror12)> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('locationError')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let locationErrorChange = (errcode: geoLocationManager.LocationError):void => {
console.info('locationErrorChange: data: ' + JSON.stringify(errcode));
};
try {
geoLocationManager.on('locationError', locationErrorChange);
geoLocationManager.off('locationError', locationErrorChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('locationEnabledChange')
on(type: 'locationEnabledChange', callback: Callback<boolean>): void
订阅位置服务状态变化。使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| callback | Callback<boolean> | 是 | 回调函数。返回true表示位置信息开关已经开启；返回false表示位置信息开关已经关闭。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('locationEnabledChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let locationEnabledChange = (state:boolean):void => {
console.info('locationEnabledChange: ' + JSON.stringify(state));
}
try {
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('locationEnabledChange')
off(type: 'locationEnabledChange', callback?: Callback<boolean>): void
取消订阅位置服务状态变化。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('locationEnabledChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let locationEnabledChange = (state:boolean):void => {
console.info('locationEnabledChange: state: ' + JSON.stringify(state));
}
try {
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
geoLocationManager.off('locationEnabledChange', locationEnabledChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('cachedGnssLocationsChange')
on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void
订阅缓存GNSS定位结果上报事件。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。使用callback异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
| callback | Callback<Array<[Location](#location)>> | 是 | 回调函数，返回GNSS缓存位置。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('cachedGnssLocationsChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let cachedLocationsCb = (locations:Array):void => {
console.info('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
let requestInfo:geoLocationManager.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('cachedGnssLocationsChange')
off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void
取消订阅缓存GNSS定位结果上报事件。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| callback | Callback<Array<[Location](#location)>> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('cachedGnssLocationsChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let cachedLocationsCb = (locations:Array):void => {
console.info('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
let requestInfo:geoLocationManager.CachedGnssLocationsRequest = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
geoLocationManager.off('cachedGnssLocationsChange');
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('satelliteStatusChange')
on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void
订阅GNSS卫星状态信息上报事件。使用callback异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 回调函数，返回GNSS卫星状态信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('satelliteStatusChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let gnssStatusCb = (satelliteStatusInfo:geoLocationManager.SatelliteStatusInfo):void => {
console.info('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('satelliteStatusChange')
off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void
取消订阅GNSS卫星状态信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('satelliteStatusChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let gnssStatusCb = (satelliteStatusInfo:geoLocationManager.SatelliteStatusInfo):void => {
console.info('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('nmeaMessage')
on(type: 'nmeaMessage', callback: Callback<string>): void
订阅GNSS NMEA信息上报事件。使用callback异步回调。
**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 |
| callback | Callback<string> | 是 | 回调函数，返回GNSS NMEA信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('nmeaMessage')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let nmeaCb = (str:string):void => {
console.info('nmeaMessage: ' + JSON.stringify(str));
}
try {
geoLocationManager.on('nmeaMessage', nmeaCb );
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('nmeaMessage')
off(type: 'nmeaMessage', callback?: Callback<string>): void
取消订阅GNSS NMEA信息上报事件。
**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 |
| callback | Callback<string> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('nmeaMessage')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let nmeaCb = (str:string):void => {
console.info('nmeaMessage: ' + JSON.stringify(str));
}
try {
geoLocationManager.on('nmeaMessage', nmeaCb);
geoLocationManager.off('nmeaMessage', nmeaCb);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.on('gnssFenceStatusChange')
on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void
添加一个围栏，并订阅地理围栏事件。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | [WantAgent](../apis-ability-kit/js-apis-app-ability-wantAgent.md) | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('gnssFenceStatusChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { wantAgent } from '@kit.AbilityKit';
let wantAgentInfo:wantAgent.WantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "EntryAbility",
action: "action1"
}
],
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 31.12, "longitude": 121.11, "radius": 100, "expiration": 10000}};
try {
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
});
```
## geoLocationManager.off('gnssFenceStatusChange')
off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void
删除一个围栏，并取消订阅该围栏事件。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | [WantAgent](../apis-ability-kit/js-apis-app-ability-wantAgent.md) | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('gnssFenceStatusChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { wantAgent } from '@kit.AbilityKit';
let wantAgentInfo:wantAgent.WantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "EntryAbility",
action: "action1",
}
],
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let requestInfo:geoLocationManager.GeofenceRequest = {'scenario': 0x301, "geofence": {"latitude": 31.12, "longitude": 121.11, "radius": 100, "expiration": 10000}};;
try {
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
});
```
## geoLocationManager.on('countryCodeChange')
on(type: 'countryCodeChange', callback: Callback<CountryCode>): void
订阅国家码信息变化事件。使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 |
| callback | Callback<[CountryCode](#countrycode)> | 是 | 回调函数，返回国家码信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.on('countryCodeChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let callback = (code:geoLocationManager.CountryCode):void => {
console.info('countryCodeChange: ' + JSON.stringify(code));
}
try {
geoLocationManager.on('countryCodeChange', callback);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.off('countryCodeChange')
off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void
取消订阅国家码变化事件。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 |
| callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。该回调函数需要与on接口传入的回调函数保持一致。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.off('countryCodeChange')} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let callback = (code:geoLocationManager.CountryCode):void => {
console.info('countryCodeChange: ' + JSON.stringify(code));
}
try {
geoLocationManager.on('countryCodeChange', callback);
geoLocationManager.off('countryCodeChange', callback);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request: CurrentLocationRequest | SingleLocationRequest, callback: AsyncCallback<Location>): void
获取当前位置，使用callback异步回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | [SingleLocationRequest](#singlelocationrequest12) | 是 | 设置位置请求参数。
SingleLocationRequest为API12新增参数。 |
| callback | AsyncCallback<[Location](#location)> | 是 | 回调函数，返回当前位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 方式一：使用CurrentLocationRequest作为入参
let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
let locationChange = (err:BusinessError, location:geoLocationManager.Location):void => {
if (err) {
console.error('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.info('locationChanger: location=' + JSON.stringify(location));
}
};
try {
geoLocationManager.getCurrentLocation(requestInfo, locationChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
// 方式二：使用SingleLocationRequest作为入参
let request:geoLocationManager.SingleLocationRequest = {'locatingTimeoutMs': 10000, 'locatingPriority': geoLocationManager.LocatingPriority.PRIORITY_ACCURACY};
let locationCallback = (err:BusinessError, location:geoLocationManager.Location):void => {
if (err) {
console.error('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.info('locationChanger: location=' + JSON.stringify(location));
}
};
try {
geoLocationManager.getCurrentLocation(request, locationCallback);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(callback: AsyncCallback<Location>): void
获取当前位置，使用callback异步回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<[Location](#location)> | 是 | 回调函数，返回当前位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let locationChange = (err:BusinessError, location:geoLocationManager.Location) => {
if (err) {
console.error('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.info('locationChanger: location=' + JSON.stringify(location));
}
};
try {
geoLocationManager.getCurrentLocation(locationChange);
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request?: CurrentLocationRequest | SingleLocationRequest): Promise<Location>
获取当前位置，使用Promise异步回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | [SingleLocationRequest](#singlelocationrequest12) | 否 | 设置位置请求参数。
SingleLocationRequest为API12新增参数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<[Location](#location)> | Promise对象，返回当前位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 方式一：使用CurrentLocationRequest作为入参
let requestInfo:geoLocationManager.CurrentLocationRequest = {'priority': geoLocationManager.LocationRequestPriority.FIRST_FIX, 'scenario': geoLocationManager.LocationRequestScenario.UNSET,'maxAccuracy': 0};
try {
geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
console.info('current location: ' + JSON.stringify(result));
})
.catch((error:BusinessError) => {
console.error('promise, getCurrentLocation: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
// 方式二：使用SingleLocationRequest作为入参
let request:geoLocationManager.SingleLocationRequest = {'locatingTimeoutMs': 10000, 'locatingPriority': geoLocationManager.LocatingPriority.PRIORITY_ACCURACY};
try {
geoLocationManager.getCurrentLocation(request).then((result) => {
console.info('current location: ' + JSON.stringify(result));
})
.catch((error:BusinessError) => {
console.error('promise, getCurrentLocation: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getLastLocation
getLastLocation(): Location
获取上一次位置。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| [Location](#location) | 位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getLastLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 |Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
let location = geoLocationManager.getLastLocation();
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.isLocationEnabled
isLocationEnabled(): boolean
判断位置服务是否已经开启。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true：位置信息开关已开启
false：位置信息开关已关闭 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|801 | Capability not supported. Failed to call ${geoLocationManager.isLocationEnabled} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
let locationEnabled = geoLocationManager.isLocationEnabled();
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getAddressesFromLocation
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void
调用逆地理编码服务，将坐标转换为地理描述，使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Geocoder
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
| callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 回调函数，返回逆地理编码结果。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301300 | Reverse geocoding query failed. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) {
console.error('getAddressesFromLocation: err=' + JSON.stringify(err));
}
if (data) {
console.info('getAddressesFromLocation: data=' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getAddressesFromLocation
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>
调用逆地理编码服务，将坐标转换为地理描述，使用Promise异步回调。
**系统能力**：SystemCapability.Location.Location.Geocoder
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<Array<[GeoAddress](#geoaddress)>> | Promise对象，返回地理描述信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301300 | Reverse geocoding query failed. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let reverseGeocodeRequest:geoLocationManager.ReverseGeoCodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
console.info('getAddressesFromLocation: ' + JSON.stringify(data));
})
.catch((error:BusinessError) => {
console.error('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getAddressesFromLocationName
getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void
调用地理编码服务，将地理描述转换为具体坐标，使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Geocoder
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
| callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 回调函数，返回地理编码结果。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301400 | Geocoding query failed. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) {
console.error('getAddressesFromLocationName: err=' + JSON.stringify(err));
}
if (data) {
console.info('getAddressesFromLocationName: data=' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getAddressesFromLocationName
getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>
调用地理编码服务，将地理描述转换为具体坐标，使用Promise异步回调。
**系统能力**：SystemCapability.Location.Location.Geocoder
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<Array<[GeoAddress](#geoaddress)>> | Promise对象，返回地理编码查询结果。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301400 | Geocoding query failed. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let geocodeRequest:geoLocationManager.GeoCodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
console.info('getAddressesFromLocationName: ' + JSON.stringify(result));
})
.catch((error:BusinessError) => {
console.error('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.isGeocoderAvailable
isGeocoderAvailable(): boolean
判断地理编码与逆地理编码服务状态。
**系统能力**：SystemCapability.Location.Location.Geocoder
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true:地理编码与逆地理编码服务可用
false：地理编码与逆地理编码服务不可用。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|801 | Capability not supported. Failed to call ${geoLocationManager.isGeocoderAvailable} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
let isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCachedGnssLocationsSize
getCachedGnssLocationsSize(callback: AsyncCallback<number>): void
获取GNSS芯片缓存位置的个数。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。使用callback异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<number> | 是 | 回调函数，返回GNSS芯片缓存位置个数。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
geoLocationManager.getCachedGnssLocationsSize((err, size) => {
if (err) {
console.error('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
}
if (size) {
console.info('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCachedGnssLocationsSize
getCachedGnssLocationsSize(): Promise<number>
获取GNSS芯片缓存位置的个数。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。使用Promise异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | Promise对象，返回GNSS缓存位置的个数。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
geoLocationManager.getCachedGnssLocationsSize().then((result) => {
console.info('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
})
.catch((error:BusinessError) => {
console.error('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.flushCachedGnssLocations
flushCachedGnssLocations(callback: AsyncCallback<void>): void
读取并清空GNSS芯片所有缓存位置。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。使用callback异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<void> | 是 | 回调函数。当操作成功，err为undefined，否则为错误对象。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
geoLocationManager.flushCachedGnssLocations((err) => {
if (err) {
console.error('flushCachedGnssLocations: err=' + JSON.stringify(err));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.flushCachedGnssLocations
flushCachedGnssLocations(): Promise<void>
读取并清空GNSS芯片所有缓存位置。该接口功能由GNSS定位芯片提供（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。使用Promise异步回调。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise对象。无返回结果的Promise对象 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|801 | Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
geoLocationManager.flushCachedGnssLocations().then(() => {
console.info('promise, flushCachedGnssLocations success');
})
.catch((error:BusinessError) => {
console.error('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.sendCommand
sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void
给位置服务子系统的各个部件发送扩展命令。使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则为错误对象。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
let requestInfo:geoLocationManager.LocationCommand = {'scenario': 0x301, 'command': "command_1"};
try {
geoLocationManager.sendCommand(requestInfo, (err) => {
if (err) {
console.error('sendCommand: err=' + JSON.stringify(err));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.sendCommand
sendCommand(command: LocationCommand): Promise<void>
给位置服务子系统的各个部件发送扩展命令。使用Promise异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise对象。无返回结果的Promise对象 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
let requestInfo:geoLocationManager.LocationCommand = {'scenario': 0x301, 'command': "command_1"};
try {
geoLocationManager.sendCommand(requestInfo).then(() => {
console.info('promise, sendCommand success');
})
.catch((error:BusinessError) => {
console.error('promise, sendCommand: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCountryCode
getCountryCode(callback: AsyncCallback<CountryCode>): void
查询当前的国家码。使用callback异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 回调函数，返回国家码信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301500 | Failed to query the area information.|
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
geoLocationManager.getCountryCode((err, result) => {
if (err) {
console.error('getCountryCode: err=' + JSON.stringify(err));
}
if (result) {
console.info('getCountryCode: result=' + JSON.stringify(result));
}
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.getCountryCode
getCountryCode(): Promise<CountryCode>
查询当前的国家码。使用Promise异步回调。
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<[CountryCode](#countrycode)> | Promise对象，返回国家码信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301500 | Failed to query the area information.|
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
geoLocationManager.getCountryCode()
.then((result) => {
console.info('promise, getCountryCode: result=' + JSON.stringify(result));
})
.catch((error:BusinessError) => {
console.error('promise, getCountryCode: error=' + JSON.stringify(error));
});
} catch (err) {
console.error("errCode:" + err.code + ", message:" + err.message);
}
```
## geoLocationManager.addGnssGeofence12+
addGnssGeofence(fenceRequest: GnssGeofenceRequest): Promise<number>
添加一个GNSS地理围栏，并订阅地理围栏事件。使用Promise异步回调。
APP可以在入参[GnssGeofenceRequest](#gnssgeofencerequest12)中传入回调函数用于接收地理围栏事件；也可以传入通知对象[NotificationRequest](../apis-notification-kit/js-apis-notification.md#notificationrequest)，在系统识别到地理围栏事件发生时会弹出APP创建的通知。
GNSS地理围栏功能依赖GNSS定位芯片（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。
**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| fenceRequest | [GnssGeofenceRequest](#gnssgeofencerequest12) | 是 | 添加GNSS地理围栏请求参数。
包含圆形围栏信息、需要监听的地理围栏事件、地理围栏事件触发后弹出的通知对象和监听地理围栏事件的回调函数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | Promise对象，返回地理围栏ID。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.addGnssGeofence} due to limited device capabilities. |
|3301000 | The location service is unavailable.|
|3301100 | The location switch is off.|
|3301601 | The number of geofences exceeds the maximum.|
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { notificationManager } from '@kit.NotificationKit';
// 创建围栏
let geofence: geoLocationManager.Geofence = {
"latitude": 34.12, "longitude": 124.11, "radius": 10000.0, "expiration": 10000.0
}
// 指定APP需要监听的地理围栏事件类型，这里表示需要监听进入围栏和退出围栏事件
let transitionStatusList: Array = [
geoLocationManager.GeofenceTransitionEvent.GEOFENCE_TRANSITION_EVENT_ENTER,
geoLocationManager.GeofenceTransitionEvent.GEOFENCE_TRANSITION_EVENT_EXIT,
];
// 创建GEOFENCE_TRANSITION_EVENT_ENTER事件对应的通知对象
let notificationRequest1: notificationManager.NotificationRequest = {
id: 1,
content: {
notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: "围栏通知",
text: "围栏进入",
additionalText: ""
}
}
};
// 创建GEOFENCE_TRANSITION_EVENT_EXIT事件对应的通知对象
let notificationRequest2: notificationManager.NotificationRequest = {
id: 2,
content: {
notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
normal: {
title: '围栏通知',
text: '围栏退出',
additionalText: ""
}
}
};
// 把创建的通知对象存入Array中，存入顺序与transitionStatusList一致
let notificationRequestList: Array =
[notificationRequest1, notificationRequest2];
// 构造GNSS地理围栏请求对象gnssGeofenceRequest
let gnssGeofenceRequest: geoLocationManager.GnssGeofenceRequest = {
// 围栏属性，包含圆心和半径等信息
geofence: geofence,
// 指定APP需要监听的地理围栏事件类型
monitorTransitionEvents: transitionStatusList,
// 地理围栏事件对应的通知对象，该参数为可选
notifications: notificationRequestList,
// 用于监听围栏事件的callback
geofenceTransitionCallback: (err : BusinessError, transition : geoLocationManager.GeofenceTransition) => {
if (err) {
console.error('geofenceTransitionCallback: err=' + JSON.stringify(err));
}
if (transition) {
console.info("GeofenceTransition: %{public}s", JSON.stringify(transition));
}
}
}
try {
// 添加围栏
geoLocationManager.addGnssGeofence(gnssGeofenceRequest).then((id) => {
// 围栏添加成功后返回围栏ID
console.info("addGnssGeofence success, fence id: " + id);
let fenceId = id;
}).catch((err: BusinessError) => {
console.error("addGnssGeofence failed, promise errCode:" + (err as BusinessError).code +
",errMessage:" + (err as BusinessError).message);
});
} catch(error) {
console.error("addGnssGeofence failed, err:" + JSON.stringify(error));
}
```
## geoLocationManager.removeGnssGeofence12+
removeGnssGeofence(geofenceId: number): Promise<void>
删除一个GNSS地理围栏，并取消订阅该地理围栏事件。使用Promise异步回调。
GNSS地理围栏功能依赖GNSS定位芯片（仅部分型号支持），如果设备无此芯片或使用的芯片型号不支持该功能，则返回错误码801（Capability not supported）。
**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| geofenceId | number | 是 | GNSS地理围栏的ID。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise对象。无返回结果的Promise对象。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
|801 | Capability not supported. Failed to call ${geoLocationManager.removeGnssGeofence} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301602 | Failed to delete a geofence due to an incorrect ID. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
import { BusinessError } from '@kit.BasicServicesKit';
// fenceId是在geoLocationManager.addGnssGeofence执行成功后获取的
let fenceId = 1;
try {
geoLocationManager.removeGnssGeofence(fenceId).then(() => {
console.info("removeGnssGeofence success fenceId:" + fenceId);
}).catch((error : BusinessError) => {
console.error("removeGnssGeofence: error=" + JSON.stringify(error));
});
} catch(error) {
console.error("removeGnssGeofence: error=" + JSON.stringify(error));
}
```
## geoLocationManager.getGeofenceSupportedCoordTypes12+
getGeofenceSupportedCoordTypes(): Array<CoordinateSystemType>
获取地理围栏功能支持的坐标系列表。
**系统能力**：SystemCapability.Location.Location.Geofence
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Array<[CoordinateSystemType](#coordinatesystemtype12)> | 地理围栏功能支持的坐标系列表。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|801 | Capability not supported. Failed to call ${geoLocationManager.getGeofenceSupportedCoordTypes} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
let supportedCoordTypes: Array = geoLocationManager.getGeofenceSupportedCoordTypes();
console.info("getGeofenceSupportedCoordTypes return:" + JSON.stringify(supportedCoordTypes));
} catch(error) {
console.error("getGeofenceSupportedCoordTypes: error=" + JSON.stringify(error));
}
```
## geoLocationManager.getCurrentWifiBssidForLocating14+
getCurrentWifiBssidForLocating(): string
获取连接的Wi-Fi AP（Access Point）的Bssid（Basic Service Set Identifier）信息
**需要权限**：ohos.permission.LOCATION 和 ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| string | Wi-Fi Bssid |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|201 | Permission verification failed. The application does not have the permission required to call the API. |
|801 | Capability not supported. Failed to call ${geoLocationManager.getCurrentWifiBssidForLocating()} due to limited device capabilities. |
|3301000 | The location service is unavailable. |
|3301100 | The location switch is off. |
|3301900 | Failed to obtain the BSSID of the Wi-Fi hotspot. The Wi-Fi network is not connected. |
**示例**
```ts
import { geoLocationManager } from '@kit.LocationKit';
try {
let bssid: string = geoLocationManager.getCurrentWifiBssidForLocating();
console.info("get wifi bssid:" + bssid);
} catch(error) {
console.error("getCurrentWifiBssidForLocating: errCode" + error.code + ", errMessage" + error.message);
}
```