Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 d478984b 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!11603 错误码需求的文档交付 

Merge pull request !11603 from 刘彬俊/master
上级 b3bc1f8d 8a76aabc
显示空白变更内容
内联 并排
Showing with 1666 addition and 785 deletion
zh-cn/application-dev/device/device-location-geocoding.md
浏览文件 @ d478984b
...@@ -14,18 +14,17 @@ ...@@ -14,18 +14,17 @@
## 接口说明 ## 接口说明
进行坐标和地理编码信息的相互转化，所使用的接口说明如下。 进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍 **表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍
| 接口名 | 功能描述 | | 接口名 | 功能描述 |
| -------- | -------- | | -------- | -------- |
| isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void | 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 | | isGeocoderAvailable(): boolean; | 判断（逆）地理编码服务状态。 |
| isGeoServiceAvailable() : Promise<boolean> | 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 | | getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 | | getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>> | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>> | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 | | getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 | | getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 |
## 开发步骤 ## 开发步骤
...@@ -33,31 +32,30 @@ ...@@ -33,31 +32,30 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 > GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。
1. 导入geolocation模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。
``` ```ts
import geolocation from '@ohos.geolocation'; import geoLocationManager from '@ohos.geoLocationManager';
``` ```
2. 查询geoCoder服务是否可用。 2. 查询geoCoder服务是否可用。
- 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。 - 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。
``` ```ts
geolocation.isGeoServiceAvailable((err, data) => { import geoLocationManager from '@ohos.geoLocationManager';
if (err) { try {
console.log('isGeoServiceAvailable err: ' + JSON.stringify(err)); var isAvailable = geoLocationManager.isGeocoderAvailable();
} else { } catch (err) {
console.log('isGeoServiceAvailable data: ' + JSON.stringify(data)); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
});
``` ```
3. 获取转化结果。 3. 获取转化结果。
- 调用getAddressesFromLocation，坐标转化地理位置信息。 - 调用getAddressesFromLocation，坐标转化地理位置信息。
``` ```ts
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); console.log('getAddressesFromLocation err: ' + JSON.stringify(err));
} else { } else {
...@@ -66,12 +64,12 @@ ...@@ -66,12 +64,12 @@
}); });
``` ```
参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。
- 调用getAddressesFromLocationName位置描述转化坐标。 - 调用getAddressesFromLocationName位置描述转化坐标。
``` ```ts
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); console.log('getAddressesFromLocationName err: ' + JSON.stringify(err));
} else { } else {
...@@ -80,6 +78,6 @@ ...@@ -80,6 +78,6 @@
}); });
``` ```
参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。
如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。 如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。
zh-cn/application-dev/device/device-location-info.md
浏览文件 @ d478984b
...@@ -10,68 +10,42 @@ ...@@ -10,68 +10,42 @@
## 接口说明 ## 接口说明
获取设备的位置信息，所使用的接口说明如下。 获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表1** 获取位置信息API功能介绍
| 接口名 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void | 开启位置变化订阅，并发起定位请求。 |
| off(type: 'locationChange', callback?: Callback<Location>) : void | 关闭位置变化订阅，并删除对应的定位请求。 |
| on(type: 'locationServiceState', callback: Callback<boolean>) : void | 订阅位置服务状态变化。 |
| off(type: 'locationServiceState', callback: Callback<boolean>) : void | 取消订阅位置服务状态变化。 |
| on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>) : void; | 订阅缓存GNSS位置上报。 |
| off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; | 取消订阅缓存GNSS位置上报。 |
| on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; | 订阅卫星状态信息更新事件。 |
| off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; | 取消订阅卫星状态信息更新事件。 |
| on(type: 'nmeaMessageChange', callback: Callback<string>) : void; | 订阅GNSS NMEA信息上报。 |
| off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; | 取消订阅GNSS NMEA信息上报。 |
| on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 添加围栏，并订阅该围栏事件上报。 |
| off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 删除围栏，并取消订阅该围栏事件。 |
| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void | 获取当前位置，使用callback回调异步返回结果。 |
| getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> | 获取当前位置，使用Promise方式异步返回结果。 |
| getLastLocation(callback: AsyncCallback<Location>) : void | 获取上一次位置，使用callback回调异步返回结果。 |
| getLastLocation() : Promise<Location> | 获取上一次位置，使用Promise方式异步返回结果。 |
| isLocationEnabled(callback: AsyncCallback<boolean>) : void | 判断位置服务是否已经打开，使用callback回调异步返回结果。 |
| isLocationEnabled() : Promise<boolean> | 判断位置服务是否已经开启，使用Promise方式异步返回结果。 |
| requestEnableLocation(callback: AsyncCallback<boolean>) : void | 请求打开位置服务，使用callback回调异步返回结果。 |
| requestEnableLocation() : Promise<boolean> | 请求打开位置服务，使用Promise方式异步返回结果。 |
| enableLocation(callback: AsyncCallback<boolean>) : void | 打开位置服务，使用callback回调异步返回结果。 |
| enableLocation() : Promise<boolean> | 打开位置服务，使用Promise方式异步返回结果。 |
| disableLocation(callback: AsyncCallback<boolean>) : void | 关闭位置服务，使用callback回调异步返回结果。 |
| disableLocation() : Promise<boolean> | 关闭位置服务，使用Promise方式异步返回结果。 |
| getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; | 获取缓存GNSS位置的个数，使用callback回调异步返回结果。 |
| getCachedGnssLocationsSize() : Promise<number>; | 获取缓存GNSS位置的个数，使用Promise方式异步返回结果。 |
| flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用callback回调异步返回结果。 |
| flushCachedGnssLocations() : Promise<boolean>; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用Promise方式异步返回结果。 |
| sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; | 给位置服务子系统发送扩展命令，使用callback回调异步返回结果。 |
| sendCommand(command: LocationCommand) : Promise<boolean>; | 给位置服务子系统发送扩展命令，使用Promise方式异步返回结果。 |
| isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; | 查询用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 |
| isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; | 查询用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 |
| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean, callback: AsyncCallback<boolean>) : void; | 设置并记录用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 |
| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; | 设置并记录用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 |
## 开发步骤 ## 开发步骤
如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geolocation.md)。 如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。
系统提供的定位权限有： 系统提供的定位权限有：
- ohos.permission.LOCATION - ohos.permission.LOCATION
- ohos.permission.APPROXIMATELY_LOCATION
- ohos.permission.LOCATION_IN_BACKGROUND - ohos.permission.LOCATION_IN_BACKGROUND
访问设备的位置信息，必须申请ohos.permission.LOCATION权限，并且获得用户授权。 访问设备的位置信息，必须申请权限，并且获得用户授权。
API9之前的版本，申请ohos.permission.LOCATION即可。
API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。
| target API level | 申请位置权限 | 申请结果 | 位置的精确度 |
| -------- | -------- | -------- | -------- |
| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 |
| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 |
如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。 如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。
开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。 开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。
2. 导入geolocation模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。
``` ```ts
import geolocation from '@ohos.geolocation'; import geoLocationManager from '@ohos.geoLocationManager';
``` ```
3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。<br/> 3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。<br/>
...@@ -80,7 +54,7 @@ ...@@ -80,7 +54,7 @@
为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。 为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。
``` ```ts
export enum LocationRequestScenario { export enum LocationRequestScenario {
UNSET = 0x300, UNSET = 0x300,
NAVIGATION, NAVIGATION,
...@@ -104,8 +78,8 @@ ...@@ -104,8 +78,8 @@
以导航场景为例，实例化方式如下： 以导航场景为例，实例化方式如下：
``` ```ts
var requestInfo = {'scenario': geolocation.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; var requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
``` ```
**方式二：** **方式二：**
...@@ -113,7 +87,7 @@ ...@@ -113,7 +87,7 @@
如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。 如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。
``` ```ts
export enum LocationRequestPriority { export enum LocationRequestPriority {
UNSET = 0x200, UNSET = 0x200,
ACCURACY, ACCURACY,
...@@ -133,14 +107,14 @@ ...@@ -133,14 +107,14 @@
以定位精度优先策略为例，实例化方式如下： 以定位精度优先策略为例，实例化方式如下：
``` ```ts
var requestInfo = {'priority': geolocation.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
``` ```
4. 实例化Callback对象，用于向系统提供位置上报的途径。 4. 实例化Callback对象，用于向系统提供位置上报的途径。
应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。 应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。
``` ```ts
var locationChange = (location) => { var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location)); console.log('locationChanger: data: ' + JSON.stringify(location));
}; };
...@@ -148,26 +122,25 @@ ...@@ -148,26 +122,25 @@
5. 启动定位。 5. 启动定位。
``` ```ts
geolocation.on('locationChange', requestInfo, locationChange); geoLocationManager.on('locationChange', requestInfo, locationChange);
``` ```
6. （可选）结束定位。 6. （可选）结束定位。
``` ```ts
geolocation.off('locationChange', locationChange); geoLocationManager.off('locationChange', locationChange);
``` ```
如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。
``` ```ts
geolocation.getLastLocation((err, data) => { import geoLocationManager from '@ohos.geoLocationManager';
if (err) { try {
console.log('getLastLocation: err: ' + JSON.stringify(err)); var location = geoLocationManager.getLastLocation();
} else { } catch (err) {
console.log('getLastLocation: data: ' + JSON.stringify(data)); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
});
``` ```
此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md
浏览文件 @ d478984b
...@@ -5,19 +5,725 @@ ...@@ -5,19 +5,725 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 申请权限
应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。
系统提供的定位权限有：
- ohos.permission.LOCATION
- ohos.permission.APPROXIMATELY_LOCATION
- ohos.permission.LOCATION_IN_BACKGROUND
访问设备的位置信息，必须申请权限，并且获得用户授权。
API9之前的版本，申请ohos.permission.LOCATION即可。
API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。
| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 |
| -------- | -------- | -------- | -------- |
| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 |
| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 |
| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 |
如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。
开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../../security/accesstoken-guidelines.md)。
## 导入模块 ## 导入模块
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
``` ```
## geoLocationManager.on('locationChange')
on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void
开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报，
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 |
| callback | Callback&lt;[Location](#location)&gt; | 是 | 接收位置变化状态变化监听。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', requestInfo, locationChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('locationChange')
off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
关闭位置变化订阅，并删除对应的定位请求。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| callback | Callback&lt;[Location](#location)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
try {
geoLocationManager.on('locationChange', requestInfo, locationChange);
geoLocationManager.off('locationChange', locationChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.on('locationEnabledChange')
on(type: 'locationEnabledChange', callback: Callback&lt;boolean&gt;): void
订阅位置服务状态变化。
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| callback | Callback&lt;boolean&gt; | 是 | 接收位置服务状态变化监听。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
console.log('locationEnabledChange: ' + JSON.stringify(state));
}
try {
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('locationEnabledChange')
off(type: 'locationEnabledChange', callback?: Callback&lt;boolean&gt;): void;
取消订阅位置服务状态变化。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var locationEnabledChange = (state) => {
console.log('locationEnabledChange: state: ' + JSON.stringify(state));
}
try {
geoLocationManager.on('locationEnabledChange', locationEnabledChange);
geoLocationManager.off('locationEnabledChange', locationEnabledChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.on('cachedGnssLocationsChange')
on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
订阅缓存GNSS定位结果上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
| callback | Callback&lt;boolean&gt; | 是 | 接收GNSS缓存位置上报。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('cachedGnssLocationsChange')
off(type: 'cachedGnssLocationsChange', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
取消订阅缓存GNSS定位结果上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try {
geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
geoLocationManager.off('cachedGnssLocationsChange');
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.on('satelliteStatusChange')
on(type: 'satelliteStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void;
订阅GNSS卫星状态信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 是 | 接收GNSS卫星状态信息上报。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('satelliteStatusChange')
off(type: 'satelliteStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void;
取消订阅GNSS卫星状态信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try {
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.on('nmeaMessage')
on(type: 'nmeaMessage', callback: Callback&lt;string&gt;): void;
订阅GNSS NMEA信息上报事件。
**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 是 | 接收GNSS&nbsp;NMEA信息上报。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
try {
geoLocationManager.on('nmeaMessage', nmeaCb );
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('nmeaMessage')
off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。
**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
try {
geoLocationManager.on('nmeaMessage', nmeaCb);
geoLocationManager.off('nmeaMessage', nmeaCb);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.on('gnssFenceStatusChange')
on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
添加一个围栏，并订阅地理围栏事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
action: "action1",
}
],
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
try {
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
});
```
## geoLocationManager.off('gnssFenceStatusChange')
off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏，并取消订阅该围栏事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.wantAgent';
let wantAgentInfo = {
wants: [
{
bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility",
action: "action1",
}
],
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
try {
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj);
geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
});
```
## geoLocationManager.on('countryCodeChange')
on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
订阅国家码信息变化事件。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
try {
geoLocationManager.on('countryCodeChange', callback);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.off('countryCodeChange')
off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
取消订阅国家码变化事件。
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301500 | Failed to query the area information. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
try {
geoLocationManager.on('countryCodeChange', callback);
geoLocationManager.off('countryCodeChange', callback);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置，使用callback回调异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
## geoLocationManager.on('countryCodeChange') | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; **示例**
订阅国家码信息变化事件。 ```ts
import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
var locationChange = (err, location) => {
if (err) {
console.log('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try {
geoLocationManager.getCurrentLocation(requestInfo, locationChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.getCurrentLocation
getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void;
获取当前位置，通过callback方式异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -25,8 +731,7 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; ...@@ -25,8 +731,7 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | | callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 |
**错误码**： **错误码**：
...@@ -36,25 +741,35 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; ...@@ -36,25 +741,35 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301100 | The location switch is off. |
|3301500 | Failed to query the area information. | |3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => { var locationChange = (err, location) => {
console.log('countryCodeChange: ' + JSON.stringify(code)); if (err) {
console.log('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try {
geoLocationManager.getCurrentLocation(locationChange);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
geoLocationManager.on('countryCodeChange', callback);
``` ```
## geoLocationManager.getCurrentLocation
## geoLocationManager.off('countryCodeChange') getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void; 获取当前位置，使用Promise方式异步返回结果。
取消订阅国家码变化事件。 **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -62,8 +777,13 @@ off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void; ...@@ -62,8 +777,13 @@ off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Promise&lt;[Location](#location)&gt; | [Location](#location) | NA | 返回位置信息。 |
**错误码**： **错误码**：
...@@ -73,17 +793,169 @@ off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void; ...@@ -73,17 +793,169 @@ off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301100 | The location switch is off. |
|3301500 | Failed to query the area information. | |3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var callback = (code) => { var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
console.log('countryCodeChange: ' + JSON.stringify(code)); geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
console.log('current location: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
});
```
## geoLocationManager.getLastLocation
getLastLocation(): Location
获取上一次位置。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Location | [Location](#location) | NA | 位置信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 |Failed to obtain the geographical location. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
var location = geoLocationManager.getLastLocation();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
geoLocationManager.on('countryCodeChange', callback); ```
geoLocationManager.off('countryCodeChange', callback);
## geoLocationManager.isLocationEnabled
isLocationEnabled(): boolean
判断位置服务是否已经使能。
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 位置服务是否已经使能。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
var locationEnabled = geoLocationManager.isLocationEnabled();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.requestEnableLocation
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求使能位置服务，使用callback回调异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | callback返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301700 | No response to the request. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.requestEnableLocation((err, data) => {
if (err) {
console.log('requestEnableLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('requestEnableLocation: data=' + JSON.stringify(data));
}
});
```
## geoLocationManager.requestEnableLocation
requestEnableLocation(): Promise&lt;boolean&gt;
请求使能位置服务，使用Promise方式异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Promise&lt;boolean&gt; | boolean | NA | 返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301700 | No response to the request. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.requestEnableLocation().then((result) => {
console.log('promise, requestEnableLocation: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, requestEnableLocation: error=' + JSON.stringify(error));
});
``` ```
...@@ -139,9 +1011,9 @@ enableLocation(): Promise&lt;void&gt; ...@@ -139,9 +1011,9 @@ enableLocation(): Promise&lt;void&gt;
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | 返回错误码信息。 | | Promise&lt;void&gt; | void | NA | 返回错误码信息。 |
**错误码**： **错误码**：
...@@ -165,9 +1037,9 @@ enableLocation(): Promise&lt;void&gt; ...@@ -165,9 +1037,9 @@ enableLocation(): Promise&lt;void&gt;
## geoLocationManager.disableLocation ## geoLocationManager.disableLocation
disableLocation(callback: AsyncCallback&lt;void&gt;): void; disableLocation(): void;
关闭位置服务，使用callback回调异步返回结果。 关闭位置服务。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
...@@ -175,11 +1047,41 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -175,11 +1047,41 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
geoLocationManager.disableLocation();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.getAddressesFromLocation
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。
**系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码的回调。 | | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收逆地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -188,36 +1090,43 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -188,36 +1090,43 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301300 | Reverse geocoding query failed. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocation((err, data) => { var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('disableLocation: err=' + JSON.stringify(err)); console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
} }
}); });
``` ```
## geoLocationManager.disableLocation ## geoLocationManager.getAddressesFromLocation
disableLocation(): Promise&lt;void&gt; getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;;
关闭位置服务，使用Promise方式异步返回结果。 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统能力**：SystemCapability.Location.Location.Geocoder
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **参数**：
**系统能力**：SystemCapability.Location.Location.Core | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | 返回错误码。 | | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理描述信息。 |
**错误码**： **错误码**：
...@@ -226,36 +1135,36 @@ disableLocation(): Promise&lt;void&gt; ...@@ -226,36 +1135,36 @@ disableLocation(): Promise&lt;void&gt;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301300 | Reverse geocoding query failed. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocation().then((result) => { var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
console.log('promise, disableLocation succeed'); geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
console.log('getAddressesFromLocation: ' + JSON.stringify(data));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, disableLocation: error=' + JSON.stringify(error)); console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
}); });
``` ```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.getAddressesFromLocationName
isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&lt;boolean&gt;): void;
查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
**系统API**：此接口为系统接口，三方应用不支持调用。 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 表示用户是否同意定位服务隐私申明。 | | callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -264,43 +1173,43 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l ...@@ -264,43 +1173,43 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301400 | Geocoding query failed. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => { var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err)); console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
} }
if (result) { if (data) {
console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result)); console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
} }
}); });
``` ```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.getAddressesFromLocationName
isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise&lt;boolean&gt;;
查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
**系统API**：此接口为系统接口，三方应用不支持调用。 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;boolean&gt; | 表示用户是否同意定位服务隐私申明。 | | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理编码查询结果。 |
**错误码**： **错误码**：
...@@ -309,36 +1218,70 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise&lt;boolean&gt;; ...@@ -309,36 +1218,70 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise&lt;boolean&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301400 | Geocoding query failed. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => { var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result)); geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
}); });
``` ```
## geoLocationManager.isGeocoderAvailable
## geoLocationManager.setLocationPrivacyConfirmStatus isGeocoderAvailable(): boolean;
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback&lt;void&gt;): void; 判断（逆）地理编码服务状态。
设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 **系统能力**：SystemCapability.Location.Location.Geocoder
**系统API**：此接口为系统接口，三方应用不支持调用。 **返回值**：
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 返回（逆）地理编码服务是否可用。 |
**系统能力**：SystemCapability.Location.Location.Core **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
var isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## geoLocationManager.getCachedGnssLocationsSize
getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
获取GNSS芯片缓存位置的个数。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | callback | AsyncCallback&lt;number&gt; | 是 | 用来接收GNSS芯片缓存位置个数的回调。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 接收错误码信息。 |
**错误码**： **错误码**：
...@@ -347,43 +1290,38 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean ...@@ -347,43 +1290,38 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => { geoLocationManager.getCachedGnssLocationsSize((err, size) => {
if (err) { if (err) {
console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err)); console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
}
if (size) {
console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
} }
}); });
``` ```
## geoLocationManager.setLocationPrivacyConfirmStatus ## geoLocationManager.getCachedGnssLocationsSize
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise&lt;void&gt;;
设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 getCachedGnssLocationsSize(): Promise&lt;number&gt;;
**系统API**：此接口为系统接口，三方应用不支持调用。 获取GNSS芯片缓存位置的个数。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | Promise&lt;number&gt; | number | NA | 返回GNSS缓存位置的个数。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 接收错误码。 |
**错误码**： **错误码**：
...@@ -392,33 +1330,36 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea ...@@ -392,33 +1330,36 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.setLocationPrivacyConfirmStatus(1, true).then((result) => { geoLocationManager.getCachedGnssLocationsSize().then((result) => {
console.log('promise, setLocationPrivacyConfirmStatus succeed'); console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, disableLocation: error=' + JSON.stringify(error)); console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
}); });
``` ```
## geoLocationManager.getCountryCode ## geoLocationManager.flushCachedGnssLocations
getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void; flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void;
查询当前的国家码。 读取并清空GNSS芯片所有缓存位置。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[CountryCode](#countrycode)&gt; | 是 | 用来接收国家码。 | | callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码信息。 |
**错误码**： **错误码**：
...@@ -427,40 +1368,36 @@ getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void; ...@@ -427,40 +1368,36 @@ getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301500 | Failed to query the area information.| |3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getCountryCode((err, result) => { geoLocationManager.flushCachedGnssLocations((err, result) => {
if (err) { if (err) {
console.log('getCountryCode: err=' + JSON.stringify(err)); console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
}
if (result) {
console.log('getCountryCode: result=' + JSON.stringify(result));
} }
}); });
``` ```
## geoLocationManager.getCountryCode ## geoLocationManager.flushCachedGnssLocations
getCountryCode(): Promise&lt;CountryCode&gt;;
查询当前的国家码。 flushCachedGnssLocations(): Promise&lt;void&gt;;
**系统能力**：SystemCapability.Location.Location.Core 读取并清空GNSS芯片所有缓存位置。
**参数**： **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
无 **系统能力**：SystemCapability.Location.Location.Gnss
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;[CountryCode](#countrycode)&gt; | 返回国家码。 | | Promise&lt;void&gt; | void | NA | 接收错误码。 |
**错误码**： **错误码**：
...@@ -469,37 +1406,36 @@ getCountryCode(): Promise&lt;CountryCode&gt;; ...@@ -469,37 +1406,36 @@ getCountryCode(): Promise&lt;CountryCode&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301500 | Failed to query the area information.| |3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.getCountryCode() geoLocationManager.flushCachedGnssLocations().then((result) => {
.then((result) => { console.log('promise, flushCachedGnssLocations success');
console.log('promise, getCountryCode: result=' + JSON.stringify(result));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, getCountryCode: error=' + JSON.stringify(error)); console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
}); });
``` ```
## geoLocationManager.enableLocationMock ## geoLocationManager.sendCommand
enableLocationMock(callback: AsyncCallback&lt;void&gt;): void; sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void;
使能位置模拟功能。 给位置服务子系统的各个部件发送扩展命令。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码。 |
**错误码**： **错误码**：
...@@ -508,38 +1444,39 @@ enableLocationMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -508,38 +1444,39 @@ enableLocationMock(callback: AsyncCallback&lt;void&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableLocationMock((err, result) => { var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geoLocationManager.sendCommand(requestInfo, (err, result) => {
if (err) { if (err) {
console.log('enableLocationMock: err=' + JSON.stringify(err)); console.log('sendCommand: err=' + JSON.stringify(err));
} }
}); });
``` ```
## geoLocationManager.enableLocationMock
enableLocationMock(): Promise&lt;void&gt;; ## geoLocationManager.sendCommand
使能位置模拟功能。 sendCommand(command: LocationCommand): Promise&lt;void&gt;;
**系统能力**：SystemCapability.Location.Location.Core 给位置服务子系统的各个部件发送扩展命令。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数**：
无 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | | Promise&lt;void&gt; | void | NA | 接收错误码。 |
**错误码**： **错误码**：
...@@ -548,39 +1485,34 @@ enableLocationMock(): Promise&lt;void&gt;; ...@@ -548,39 +1485,34 @@ enableLocationMock(): Promise&lt;void&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableLocationMock() var requestInfo = {'scenario': 0x301, 'command': "command_1"};
.then((result) => { geoLocationManager.sendCommand(requestInfo).then((result) => {
console.log('promise, enableLocationMock: succeed'); console.log('promise, sendCommand success');
}) })
.catch((error) => { .catch((error) => {
if (error) { console.log('promise, sendCommand: error=' + JSON.stringify(error));
console.log('promise, enableLocationMock: error=' + JSON.stringify(error));
}
}); });
``` ```
## geoLocationManager.disableLocationMock ## geoLocationManager.getCountryCode
disableLocationMock(callback: AsyncCallback&lt;void&gt;): void; getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void;
去使能位置模拟功能。 查询当前的国家码。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | | callback | AsyncCallback&lt;[CountryCode](#countrycode)&gt; | 是 | 用来接收国家码。 |
**错误码**： **错误码**：
...@@ -589,39 +1521,36 @@ disableLocationMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -589,39 +1521,36 @@ disableLocationMock(callback: AsyncCallback&lt;void&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.| |3301500 | Failed to query the area information.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocationMock((err, result) => { geoLocationManager.getCountryCode((err, result) => {
if (err) { if (err) {
console.log('disableLocationMock: err=' + JSON.stringify(err)); console.log('getCountryCode: err=' + JSON.stringify(err));
}
if (result) {
console.log('getCountryCode: result=' + JSON.stringify(result));
} }
}); });
``` ```
## geoLocationManager.disableLocationMock ## geoLocationManager.getCountryCode
disableLocationMock(): Promise&lt;void&gt;; getCountryCode(): Promise&lt;CountryCode&gt;;
去使能位置模拟功能。 查询当前的国家码。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数**：
无
**返回值**： **返回值**：
| 参数名 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | | Promise&lt;[CountryCode](#countrycode)&gt; | [CountryCode](#countrycode) | NA | 用来接收国家码。 |
**错误码**： **错误码**：
...@@ -630,41 +1559,32 @@ disableLocationMock(): Promise&lt;void&gt;; ...@@ -630,41 +1559,32 @@ disableLocationMock(): Promise&lt;void&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.| |3301500 | Failed to query the area information.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocationMock() geoLocationManager.getCountryCode()
.then((result) => { .then((result) => {
console.log('promise, disableLocationMock succeed'); console.log('promise, getCountryCode: result=' + JSON.stringify(result));
}) })
.catch((error) => { .catch((error) => {
if (error) { console.log('promise, getCountryCode: error=' + JSON.stringify(error));
console.log('promise, disableLocationMock: error=' + JSON.stringify(error));
}
}); });
``` ```
## geoLocationManager.setMockedLocations ## geoLocationManager.enableLocationMock
setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&gt;): void; enableLocationMock(): void;
设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 使能位置模拟功能。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
...@@ -678,43 +1598,24 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&g ...@@ -678,43 +1598,24 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback&lt;void&g
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var locations = [ try {
{"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true}, geoLocationManager.enableLocationMock();
{"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true}, } catch (err) {
{"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true}, console.error("errCode:" + err.code + ",errMessage:" + err.message);
{"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations": locations};
geoLocationManager.setMockedLocations(config, (err, data) => {
if (err) {
console.log('setMockedLocations: err=' + JSON.stringify(err));
} }
});
``` ```
## geoLocationManager.setMockedLocations
setMockedLocations(config: LocationMockConfig): Promise&lt;void&gt;; ## geoLocationManager.disableLocationMock
disableLocationMock(): void;
设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 去使能位置模拟功能。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 |
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
...@@ -728,31 +1629,19 @@ setMockedLocations(config: LocationMockConfig): Promise&lt;void&gt;; ...@@ -728,31 +1629,19 @@ setMockedLocations(config: LocationMockConfig): Promise&lt;void&gt;;
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var locations = [ try {
{"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true}, geoLocationManager.disableLocationMock();
{"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true}, } catch (err) {
{"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true}, console.error("errCode:" + err.code + ",errMessage:" + err.message);
{"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations":locations};
geoLocationManager.setMockedLocations(config)
.then((result) => {
console.log('promise, setMockedLocations succeed');
})
.catch((error) => {
if (error) {
console.log('promise, setMockedLocations: error=' + JSON.stringify(error));
} }
});
``` ```
## geoLocationManager.enableReverseGeocodingMock ## geoLocationManager.setMockedLocations
enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; setMockedLocations(config: LocationMockConfig): void;
使能逆地理编码模拟功能。 设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -762,7 +1651,7 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -762,7 +1651,7 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 |
**错误码**： **错误码**：
...@@ -771,22 +1660,31 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -771,22 +1660,31 @@ enableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableReverseGeocodingMock((err, data) => { var locations = [
if (err) { {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
console.log('enableReverseGeocodingMock: err=' + JSON.stringify(err)); {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations": locations};
try {
geoLocationManager.setMockedLocations(config);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
});
``` ```
## geoLocationManager.enableReverseGeocodingMock ## geoLocationManager.enableReverseGeocodingMock
enableReverseGeocodingMock(): Promise&lt;void&gt;; enableReverseGeocodingMock(): void;
使能逆地理编码模拟功能。 使能逆地理编码模拟功能。
...@@ -794,16 +1692,6 @@ enableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -794,16 +1692,6 @@ enableReverseGeocodingMock(): Promise&lt;void&gt;;
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**参数**：
无
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
...@@ -816,21 +1704,17 @@ enableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -816,21 +1704,17 @@ enableReverseGeocodingMock(): Promise&lt;void&gt;;
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.enableReverseGeocodingMock() try {
.then((result) => { geoLocationManager.enableReverseGeocodingMock();
console.log('promise, enableReverseGeocodingMock succeed'); } catch (err) {
}) console.error("errCode:" + err.code + ",errMessage:" + err.message);
.catch((error) => {
if (error) {
console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error));
} }
});
``` ```
## geoLocationManager.disableReverseGeocodingMock ## geoLocationManager.disableReverseGeocodingMock
disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; disableReverseGeocodingMock(): void;
去使能逆地理编码模拟功能。 去使能逆地理编码模拟功能。
...@@ -838,12 +1722,6 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -838,12 +1722,6 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
...@@ -856,19 +1734,19 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void; ...@@ -856,19 +1734,19 @@ disableReverseGeocodingMock(callback: AsyncCallback&lt;void&gt;): void;
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableReverseGeocodingMock((err, result) => { try {
if (err) { geoLocationManager.disableReverseGeocodingMock();
console.log('disableReverseGeocodingMock: err=' + JSON.stringify(err)); } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
});
``` ```
## geoLocationManager.disableReverseGeocodingMock ## geoLocationManager.setReverseGeocodingMockInfo
disableReverseGeocodingMock(): Promise&lt;void&gt;; setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): void;
去使能逆地理编码模拟功能。 设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -876,13 +1754,9 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -876,13 +1754,9 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;;
**参数**： **参数**：
无 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
**返回值**： | mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
...@@ -896,34 +1770,42 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;; ...@@ -896,34 +1770,42 @@ disableReverseGeocodingMock(): Promise&lt;void&gt;;
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableReverseGeocodingMock() var mockInfos = [
.then((result) => { {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
console.log('promise, disableReverseGeocodingMock succeed'); {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
}) {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
.catch((error) => { {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
if (error) { {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error)); ];
try {
geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
});
``` ```
## geoLocationManager.setReverseGeocodingMockInfo ## geoLocationManager.isLocationPrivacyConfirmed
setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, callback: AsyncCallback&lt;void&gt;): void;
设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
**系统能力**：SystemCapability.Location.Location.Core 查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 |
**错误码**： **错误码**：
...@@ -937,42 +1819,32 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, ca ...@@ -937,42 +1819,32 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;, ca
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [ try {
{"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}}, var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1);
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}}, } catch (err) {
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}}, console.error("errCode:" + err.code + ",errMessage:" + err.message);
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
geoLocationManager.setReverseGeocodingMockInfo(mockInfos, (err, data) => {
if (err) {
console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err));
} }
});
``` ```
## geoLocationManager.setReverseGeocodingMockInfo ## geoLocationManager.setLocationPrivacyConfirmStatus
setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): Promise&lt;void&gt;;
设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
**系统能力**：SystemCapability.Location.Location.Core 设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 | | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 |
**错误码**： **错误码**：
...@@ -986,22 +1858,11 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -986,22 +1858,11 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [ try {
{"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}}, geoLocationManager.setLocationPrivacyConfirmStatus(1, true);
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}}, } catch (err) {
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}}, console.error("errCode:" + err.code + ",errMessage:" + err.message);
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
geoLocationManager.setReverseGeocodingMockInfo(mockInfos)
.then((result) => {
console.log('promise, setReverseGeocodingMockInfo succeed');
})
.catch((error) => {
if (error) {
console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error));
} }
});
``` ```
...@@ -1011,7 +1872,7 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1011,7 +1872,7 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 | | UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 | | ACCURACY | 0x201 | 表示精度优先。 |
...@@ -1025,7 +1886,7 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1025,7 +1886,7 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 | | UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 | | NAVIGATION | 0x301 | 表示导航场景。 |
...@@ -1041,12 +1902,12 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1041,12 +1902,12 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | | longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 |
| maxItems | number | 否 | 指定返回位置信息的最大个数。 | | maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
## GeoCodeRequest ## GeoCodeRequest
...@@ -1055,15 +1916,15 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1055,15 +1916,15 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | | description | number | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 否 | 表示返回位置信息的最大个数。 | | maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | | minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 |
| minLongitude | number | 否 | 表示最小经度信息。 | | minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 否 | 表示最大纬度信息。 | | maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 否 | 表示最大经度信息。 | | maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
## GeoAddress ## GeoAddress
...@@ -1072,27 +1933,27 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1072,27 +1933,27 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | | longitude | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| placeName | string | 否 | 表示地区信息。 | | placeName | string | 是 | 否 | 表示地区信息。 |
| countryCode | string | 否 | 表示国家码信息。 | | countryCode | string | 是 | 否 | 表示国家码信息。 |
| countryName | string | 否 | 表示国家信息。 | | countryName | string| 是 | 否 | 表示国家信息。 |
| administrativeArea | string | 否 | 表示省份区域信息。 | | administrativeArea | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea | string | 否 | 表示表示子区域信息。 | | subAdministrativeArea | string | 是 | 否 | 表示表示子区域信息。 |
| locality | string | 否 | 表示城市信息。 | | locality | string | 是 | 否 | 表示城市信息。 |
| subLocality | string | 否 | 表示子城市信息。 | | subLocality | string | 是 | 否 | 表示子城市信息。 |
| roadName | string | 否 | 表示路名信息。 | | roadName | string | 是 | 否 |表示路名信息。 |
| subRoadName | string | 否 | 表示子路名信息。 | | subRoadName | string | 是 | 否 | 表示子路名信息。 |
| premises | string | 否 | 表示门牌号信息。 | | premises | string| 是 | 否|表示门牌号信息。 |
| postalCode | string | 否 | 表示邮政编码信息。 | | postalCode | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber | string | 否 | 表示联系方式信息。 | | phoneNumber | string | 是 | 否 | 表示联系方式信息。 |
| addressUrl | string | 否 | 表示位置信息附件的网址信息。 | | addressUrl | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions | Array&lt;string&gt; | 否 | 表示附加的描述信息。 | | descriptions | Array&lt;string&gt; | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize | number | 否 | 表示附加的描述信息数量。 | | descriptionsSize | number | 是 | 否 | 表示附加的描述信息数量。 |
| isFromMock | Boolean | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 | | isFromMock | Boolean | 是 | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 |
## LocationRequest ## LocationRequest
...@@ -1101,13 +1962,13 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1101,13 +1962,13 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | | timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | | distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 否 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | | maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
## CurrentLocationRequest ## CurrentLocationRequest
...@@ -1116,12 +1977,12 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1116,12 +1977,12 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 否 | 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | | maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | | timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 |
## SatelliteStatusInfo ## SatelliteStatusInfo
...@@ -1130,14 +1991,14 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1130,14 +1991,14 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| satellitesNumber | number | 是 | 表示卫星个数。 | | satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array&lt;number&gt; | 是 | 表示每个卫星的ID，数组类型。 | | satelliteIds | Array&lt;number&gt; | 是 | 否 | 表示每个卫星的ID，数组类型。 |
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 表示载波噪声功率谱密度比，即cn0。 | | carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 |
| altitudes | Array&lt;number&gt; | 是 | 表示高程信息。 | | altitudes | Array&lt;number&gt; | 是 | 否 | 表示高程信息。 |
| azimuths | Array&lt;number&gt; | 是 | 表示方位角。 | | azimuths | Array&lt;number&gt; | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array&lt;number&gt; | 是 | 表示载波频率。 | | carrierFrequencies | Array&lt;number&gt; | 是 | 否 | 表示载波频率。 |
## CachedGnssLocationsRequest ## CachedGnssLocationsRequest
...@@ -1146,10 +2007,10 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P ...@@ -1146,10 +2007,10 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): P
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | | reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | | wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 |
## Geofence ## Geofence
...@@ -1172,11 +2033,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1172,11 +2033,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 表示位置信息优先级。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 |
| geofence | [Geofence](#geofence) | 是 | 表示围栏信息。 |
## LocationPrivacyType ## LocationPrivacyType
...@@ -1185,7 +2045,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1185,7 +2045,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 | | OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 | | STARTUP | 1 | 开机向导场景下的隐私协议。 |
...@@ -1198,10 +2058,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1198,10 +2058,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| command | string | 是 | 扩展命令字符串。 | | command | string | 是 | 是 | 扩展命令字符串。 |
## Location ## Location
...@@ -1210,19 +2070,19 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1210,19 +2070,19 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude | number| 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | | longitude | number| 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| altitude | number | 是 | 表示高度信息，单位米。 | | altitude | number | 是 | 否 | 表示高度信息，单位米。 |
| accuracy | number | 是 | 表示精度信息，单位米。 | | accuracy | number | 是 | 否 | 表示精度信息，单位米。 |
| speed | number | 是 | 表示速度信息，单位米每秒。 | | speed | number | 是 | 否 |表示速度信息，单位米每秒。 |
| timeStamp | number | 是 | 表示位置时间戳，UTC格式。 | | timeStamp | number | 是 | 否 | 表示位置时间戳，UTC格式。 |
| direction | number | 是 | 表示航向信息。 | | direction | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot | number | 是 | 表示位置时间戳，开机时间格式。 | | timeSinceBoot | number | 是 | 否 | 表示位置时间戳，开机时间格式。 |
| additions | Array&lt;string&gt; | 否 | 附加信息。 | | additions | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize | number | 否 | 附加信息数量。 | | additionSize | number | 是 | 否 | 附加信息数量。 |
| isFromMock | Boolean | 否 | 表示位置信息是否来自于位置模拟功能。 | | isFromMock | Boolean | 是 | 否 | 表示位置信息是否来自于位置模拟功能。 |
## ReverseGeocodingMockInfo ## ReverseGeocodingMockInfo
...@@ -1233,10 +2093,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1233,10 +2093,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 表示经纬度信息。 | | location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 |
| geoAddress | [GeoAddress](#geoaddress) | 是 | 表示地名信息。 | | geoAddress | [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 |
## LocationMockConfig ## LocationMockConfig
...@@ -1247,10 +2107,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1247,10 +2107,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| timeInterval | number | 是 | 表示模拟位置上报的时间间隔，单位是秒。 | | timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔，单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 表示模拟位置数组。 | | locations | Array&lt;Location&gt; | 是 | 是 | 表示模拟位置数组。 |
## CountryCode ## CountryCode
...@@ -1259,10 +2119,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1259,10 +2119,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| country | string | 是 | 表示国家码字符串。 | | country | string | 是 | 否 | 表示国家码字符串。 |
| type | [CountryCodeType](#countrycodetype)| 是 | 表示国家码信息来源。 | | type | [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 |
## CountryCodeType ## CountryCodeType
...@@ -1271,7 +2131,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1271,7 +2131,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 | | COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 |
| COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 | | COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 |
......
zh-cn/application-dev/reference/apis/js-apis-geolocation.md
浏览文件 @ d478984b
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。
## 导入模块 ## 导入模块
...@@ -12,12 +12,15 @@ ...@@ -12,12 +12,15 @@
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
``` ```
## geolocation.on('locationChange') ## geolocation.on('locationChange')<sup>(deprecated) </sup>
on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void
开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， 开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报，
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -44,12 +47,15 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat ...@@ -44,12 +47,15 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat
``` ```
## geolocation.off('locationChange') ## geolocation.off('locationChange')<sup>(deprecated) </sup>
off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
关闭位置变化订阅，并删除对应的定位请求。 关闭位置变化订阅，并删除对应的定位请求。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -75,12 +81,15 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void ...@@ -75,12 +81,15 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
``` ```
## geolocation.on('locationServiceState') ## geolocation.on('locationServiceState')<sup>(deprecated) </sup>
on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
订阅位置服务状态变化。 订阅位置服务状态变化。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationenabledchange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -104,12 +113,15 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void ...@@ -104,12 +113,15 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
``` ```
## geolocation.off('locationServiceState') ## geolocation.off('locationServiceState')<sup>(deprecated) </sup>
off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void; off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
取消订阅位置服务状态变化。 取消订阅位置服务状态变化。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationenabledchange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -134,12 +146,16 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void; ...@@ -134,12 +146,16 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
``` ```
## geolocation.on('cachedGnssLocationsReporting')<sup>8+</sup> ## geolocation.on('cachedGnssLocationsReporting')<sup>(deprecated) </sup>
on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void; on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
订阅缓存GNSS定位结果上报事件。 订阅缓存GNSS定位结果上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.on('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroncachedgnsslocationschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -165,12 +181,16 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ...@@ -165,12 +181,16 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca
``` ```
## geolocation.off('cachedGnssLocationsReporting')<sup>8+</sup> ## geolocation.off('cachedGnssLocationsReporting')<sup>(deprecated) </sup>
off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void; off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
取消订阅缓存GNSS定位结果上报事件。 取消订阅缓存GNSS定位结果上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.off('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroffcachedgnsslocationschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -196,12 +216,16 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati ...@@ -196,12 +216,16 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati
``` ```
## geolocation.on('gnssStatusChange')<sup>8+</sup> ## geolocation.on('gnssStatusChange')<sup>(deprecated) </sup>
on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void; on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void;
订阅GNSS卫星状态信息上报事件。 订阅GNSS卫星状态信息上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.on('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageronsatellitestatuschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -225,12 +249,16 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi ...@@ -225,12 +249,16 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi
``` ```
## geolocation.off('gnssStatusChange')<sup>8+</sup> ## geolocation.off('gnssStatusChange')<sup>(deprecated) </sup>
off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void; off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void;
取消订阅GNSS卫星状态信息上报事件。 取消订阅GNSS卫星状态信息上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.off('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffsatellitestatuschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -254,12 +282,16 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v ...@@ -254,12 +282,16 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v
``` ```
## geolocation.on('nmeaMessageChange')<sup>8+</sup> ## geolocation.on('nmeaMessageChange')<sup>(deprecated) </sup>
on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void; on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
订阅GNSS NMEA信息上报事件。 订阅GNSS NMEA信息上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.on('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageronnmeamessage)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -283,12 +315,16 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void; ...@@ -283,12 +315,16 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
``` ```
## geolocation.off('nmeaMessageChange')<sup>8+</sup> ## geolocation.off('nmeaMessageChange')<sup>(deprecated) </sup>
off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void; off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。 取消订阅GNSS NMEA信息上报事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.off('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageroffnmeamessage)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -313,12 +349,16 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void; ...@@ -313,12 +349,16 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
``` ```
## geolocation.on('fenceStatusChange')<sup>8+</sup> ## geolocation.on('fenceStatusChange')<sup>(deprecated) </sup>
on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
添加一个围栏，并订阅地理围栏事件。 添加一个围栏，并订阅地理围栏事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.on('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanagerongnssfencestatuschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Geofence
...@@ -358,12 +398,16 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -358,12 +398,16 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
``` ```
## geolocation.off('fenceStatusChange')<sup>8+</sup> ## geolocation.off('fenceStatusChange')<sup>(deprecated) </sup>
off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏，并取消订阅该围栏事件。 删除一个围栏，并取消订阅该围栏事件。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.off('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffgnssfencestatuschange)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Geofence
...@@ -403,13 +447,15 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -403,13 +447,15 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
``` ```
## geolocation.getCurrentLocation ## geolocation.getCurrentLocation<sup>(deprecated) </sup>
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置，使用callback回调异步返回结果。 获取当前位置，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -439,13 +485,15 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L ...@@ -439,13 +485,15 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L
``` ```
## geolocation.getCurrentLocation ## geolocation.getCurrentLocation<sup>(deprecated) </sup>
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
获取当前位置，使用Promise方式异步返回结果。 获取当前位置，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation-2)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -474,12 +522,15 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; ...@@ -474,12 +522,15 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
``` ```
## geolocation.getLastLocation ## geolocation.getLastLocation<sup>(deprecated) </sup>
getLastLocation(callback: AsyncCallback&lt;Location&gt;): void getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
获取上一次位置，使用callback回调异步返回结果。 获取上一次位置，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -506,12 +557,15 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void ...@@ -506,12 +557,15 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
``` ```
## geolocation.getLastLocation ## geolocation.getLastLocation<sup>(deprecated) </sup>
getLastLocation(): Promise&lt;Location&gt; getLastLocation(): Promise&lt;Location&gt;
获取上一次位置，使用Promise方式异步返回结果。 获取上一次位置，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -533,13 +587,15 @@ getLastLocation(): Promise&lt;Location&gt; ...@@ -533,13 +587,15 @@ getLastLocation(): Promise&lt;Location&gt;
``` ```
## geolocation.isLocationEnabled ## geolocation.isLocationEnabled<sup>(deprecated) </sup>
isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
判断位置服务是否已经打开，使用callback回调异步返回结果。 判断位置服务是否已经打开，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -565,12 +621,15 @@ isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -565,12 +621,15 @@ isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
``` ```
## geolocation.isLocationEnabled ## geolocation.isLocationEnabled<sup>(deprecated) </sup>
isLocationEnabled(): Promise&lt;boolean&gt; isLocationEnabled(): Promise&lt;boolean&gt;
判断位置服务是否已经开启，使用Promise方式异步返回结果。 判断位置服务是否已经开启，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -591,13 +650,15 @@ isLocationEnabled(): Promise&lt;boolean&gt; ...@@ -591,13 +650,15 @@ isLocationEnabled(): Promise&lt;boolean&gt;
``` ```
## geolocation.requestEnableLocation ## geolocation.requestEnableLocation<sup>(deprecated) </sup>
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求打开位置服务，使用callback回调异步返回结果。 请求打开位置服务，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -623,12 +684,15 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -623,12 +684,15 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
``` ```
## geolocation.requestEnableLocation ## geolocation.requestEnableLocation<sup>(deprecated) </sup>
requestEnableLocation(): Promise&lt;boolean&gt; requestEnableLocation(): Promise&lt;boolean&gt;
请求打开位置服务，使用Promise方式异步返回结果。 请求打开位置服务，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -649,132 +713,15 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -649,132 +713,15 @@ requestEnableLocation(): Promise&lt;boolean&gt;
``` ```
## geolocation.enableLocation ## geolocation.isGeoServiceAvailable<sup>(deprecated) </sup>
enableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
打开位置服务，使用callback回调异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.enableLocation((err, data) => {
if (err) {
console.log('enableLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('enableLocation: data=' + JSON.stringify(data));
}
});
```
## geolocation.enableLocation
enableLocation(): Promise&lt;boolean&gt;
打开位置服务，使用Promise方式异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.enableLocation().then((result) => {
console.log('promise, enableLocation: ' + JSON.stringify(result));
});
```
## geolocation.disableLocation
disableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
关闭位置服务，使用callback回调异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.disableLocation((err, data) => {
if (err) {
console.log('disableLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('disableLocation: data=' + JSON.stringify(data));
}
});
```
## geolocation.disableLocation
disableLocation(): Promise&lt;boolean&gt;
关闭位置服务，使用Promise方式异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.disableLocation().then((result) => {
console.log('promise, disableLocation: ' + JSON.stringify(result));
});
```
## geolocation.isGeoServiceAvailable
isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void
判断（逆）地理编码服务状态，使用callback回调异步返回结果。 判断（逆）地理编码服务状态，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -800,12 +747,15 @@ isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -800,12 +747,15 @@ isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void
``` ```
## geolocation.isGeoServiceAvailable ## geolocation.isGeoServiceAvailable<sup>(deprecated) </sup>
isGeoServiceAvailable(): Promise&lt;boolean&gt; isGeoServiceAvailable(): Promise&lt;boolean&gt;
判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -826,12 +776,15 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt; ...@@ -826,12 +776,15 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt;
``` ```
## geolocation.getAddressesFromLocation ## geolocation.getAddressesFromLocation<sup>(deprecated) </sup>
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -859,12 +812,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ...@@ -859,12 +812,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback
``` ```
## geolocation.getAddressesFromLocation ## geolocation.getAddressesFromLocation<sup>(deprecated) </sup>
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;; getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;;
调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation-1)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -892,12 +848,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -892,12 +848,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
``` ```
## geolocation.getAddressesFromLocationName ## geolocation.getAddressesFromLocationName<sup>(deprecated) </sup>
getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -925,12 +884,15 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt ...@@ -925,12 +884,15 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt
``` ```
## geolocation.getAddressesFromLocationName ## geolocation.getAddressesFromLocationName<sup>(deprecated) </sup>
getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt; getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname-1)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
...@@ -958,12 +920,16 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd ...@@ -958,12 +920,16 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd
``` ```
## geolocation.getCachedGnssLocationsSize<sup>8+</sup> ## geolocation.getCachedGnssLocationsSize<sup>(deprecated) </sup>
getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -989,12 +955,16 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; ...@@ -989,12 +955,16 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
``` ```
## geolocation.getCachedGnssLocationsSize<sup>8+</sup> ## geolocation.getCachedGnssLocationsSize<sup>(deprecated) </sup>
getCachedGnssLocationsSize(): Promise&lt;number&gt;; getCachedGnssLocationsSize(): Promise&lt;number&gt;;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize-1)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -1015,12 +985,16 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;; ...@@ -1015,12 +985,16 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;;
``` ```
## geolocation.flushCachedGnssLocations<sup>8+</sup> ## geolocation.flushCachedGnssLocations<sup>(deprecated) </sup>
flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void; flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -1046,12 +1020,16 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void; ...@@ -1046,12 +1020,16 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
``` ```
## geolocation.flushCachedGnssLocations<sup>8+</sup> ## geolocation.flushCachedGnssLocations<sup>(deprecated) </sup>
flushCachedGnssLocations(): Promise&lt;boolean&gt;; flushCachedGnssLocations(): Promise&lt;boolean&gt;;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations-1)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
...@@ -1072,12 +1050,16 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;; ...@@ -1072,12 +1050,16 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;;
``` ```
## geolocation.sendCommand<sup>8+</sup> ## geolocation.sendCommand<sup>(deprecated) </sup>
sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): void; sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): void;
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -1105,12 +1087,16 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v ...@@ -1105,12 +1087,16 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v
``` ```
## geolocation.sendCommand<sup>8+</sup> ## geolocation.sendCommand<sup>(deprecated) </sup>
sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -1138,16 +1124,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1138,16 +1124,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
``` ```
## LocationRequestPriority<sup>(deprecated) </sup>
## LocationRequestPriority
位置请求中位置信息优先级设置。 位置请求中位置信息优先级设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 | | UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 | | ACCURACY | 0x201 | 表示精度优先。 |
...@@ -1155,15 +1143,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1155,15 +1143,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | | FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 |
## LocationRequestScenario ## LocationRequestScenario<sup>(deprecated) </sup>
位置请求中定位场景设置。 位置请求中定位场景设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 | | UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 | | NAVIGATION | 0x301 | 表示导航场景。 |
...@@ -1173,15 +1164,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1173,15 +1164,18 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | | NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## GeoLocationErrorCode ## GeoLocationErrorCode<sup>(deprecated) </sup>
位置服务中的错误码信息。 位置服务中的错误码信息。
> **说明：**<br/>
> 从API version 9开始废弃。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 | | INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 |
| REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 | | REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 |
...@@ -1192,213 +1186,255 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1192,213 +1186,255 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
| LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位，没有在指定时间内返回位置。 | | LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位，没有在指定时间内返回位置。 |
## ReverseGeoCodeRequest ## ReverseGeoCodeRequest<sup>(deprecated) </sup>
逆地理编码请求接口。 逆地理编码请求接口。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | | longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 |
| maxItems | number | 否 | 指定返回位置信息的最大个数。 | | maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
## GeoCodeRequest ## GeoCodeRequest<sup>(deprecated) </sup>
地理编码请求接口。 地理编码请求接口。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.GeoCodeRequest](js-apis-geoLocationManager.md#geocoderequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | | description | number | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 否 | 表示返回位置信息的最大个数。 | | maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | | minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 |
| minLongitude | number | 否 | 表示最小经度信息。 | | minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 否 | 表示最大纬度信息。 | | maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 否 | 表示最大经度信息。 | | maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
## GeoAddress ## GeoAddress<sup>(deprecated) </sup>
地理编码类型。 地理编码类型。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.GeoAddress](js-apis-geoLocationManager.md#geoaddress)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Geocoder
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude<sup>7+</sup> | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude<sup>7+</sup> | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude<sup>7+</sup> | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | | longitude<sup>7+</sup> | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| locale<sup>7+</sup> | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | | locale<sup>7+</sup> | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| placeName<sup>7+</sup> | string | 否 | 表示地区信息。 | | placeName<sup>7+</sup> | string | 是 | 否 | 表示地区信息。 |
| countryCode<sup>7+</sup> | string | 否 | 表示国家码信息。 | | countryCode<sup>7+</sup> | string | 是 | 否 | 表示国家码信息。 |
| countryName<sup>7+</sup> | string | 否 | 表示国家信息。 | | countryName<sup>7+</sup> | string | 是 | 否 | 表示国家信息。 |
| administrativeArea<sup>7+</sup> | string | 否 | 表示省份区域信息。 | | administrativeArea<sup>7+</sup> | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea<sup>7+</sup> | string | 否 | 表示表示子区域信息。 | | subAdministrativeArea<sup>7+</sup> | string | 是 | 否 | 表示表示子区域信息。 |
| locality<sup>7+</sup> | string | 否 | 表示城市信息。 | | locality<sup>7+</sup> | string | 是 | 否 | 表示城市信息。 |
| subLocality<sup>7+</sup> | string | 否 | 表示子城市信息。 | | subLocality<sup>7+</sup> | string | 是 | 否 | 表示子城市信息。 |
| roadName<sup>7+</sup> | string | 否 | 表示路名信息。 | | roadName<sup>7+</sup> | string | 是 | 否 | 表示路名信息。 |
| subRoadName<sup>7+</sup> | string | 否 | 表示子路名信息。 | | subRoadName<sup>7+</sup> | string | 是 | 否 | 表示子路名信息。 |
| premises<sup>7+</sup> | string | 否 | 表示门牌号信息。 | | premises<sup>7+</sup> | string | 是 | 否 | 表示门牌号信息。 |
| postalCode<sup>7+</sup> | string | 否 | 表示邮政编码信息。 | | postalCode<sup>7+</sup> | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber<sup>7+</sup> | string | 否 | 表示联系方式信息。 | | phoneNumber<sup>7+</sup> | string | 是 | 否| 表示联系方式信息。 |
| addressUrl<sup>7+</sup> | string | 否 | 表示位置信息附件的网址信息。 | | addressUrl<sup>7+</sup> | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions<sup>7+</sup> | Array&lt;string&gt; | 否 | 表示附加的描述信息。 | | descriptions<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize<sup>7+</sup> | number | 否 | 表示附加的描述信息数量。 | | descriptionsSize<sup>7+</sup> | number | 是 | 否 | 表示附加的描述信息数量。 |
## LocationRequest ## LocationRequest<sup>(deprecated) </sup>
位置信息请求类型。 位置信息请求类型。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequest](js-apis-geoLocationManager.md#locationrequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | | timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | | distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 否 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | | maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
## CurrentLocationRequest ## CurrentLocationRequest<sup>(deprecated) </sup>
当前位置信息请求类型。 当前位置信息请求类型。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.CurrentLocationRequest](js-apis-geoLocationManager.md#currentlocationrequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 否 | 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | | maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | | timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 |
## SatelliteStatusInfo<sup>8+</sup> ## SatelliteStatusInfo<sup>(deprecated) </sup>
卫星状态信息。 卫星状态信息。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.SatelliteStatusInfo](js-apis-geoLocationManager.md#satellitestatusinfo)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| satellitesNumber | number | 是 | 表示卫星个数。 | | satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array&lt;number&gt; | 是 | 表示每个卫星的ID，数组类型。 | | satelliteIds | Array&lt;number&gt; | 是 | 否 | 表示每个卫星的ID，数组类型。 |
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 表示载波噪声功率谱密度比，即cn0。 | | carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 |
| altitudes | Array&lt;number&gt; | 是 | 表示高程信息。 | | altitudes | Array&lt;number&gt; | 是 | 否 | 表示高程信息。 |
| azimuths | Array&lt;number&gt; | 是 | 表示方位角。 | | azimuths | Array&lt;number&gt; | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array&lt;number&gt; | 是 | 表示载波频率。 | | carrierFrequencies | Array&lt;number&gt; | 是 | 否 | 表示载波频率。 |
## CachedGnssLocationsRequest<sup>8+</sup> ## CachedGnssLocationsRequest<sup>(deprecated) </sup>
请求订阅GNSS缓存位置上报功能接口的配置参数。 请求订阅GNSS缓存位置上报功能接口的配置参数。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.CachedGnssLocationsRequest](js-apis-geoLocationManager.md#cachedgnsslocationsrequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | | reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | | wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 |
## Geofence<sup>8+</sup> ## Geofence<sup>(deprecated) </sup>
GNSS围栏的配置参数。目前只支持圆形围栏。 GNSS围栏的配置参数。目前只支持圆形围栏。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.Geofence](js-apis-geoLocationManager.md#geofence)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 表示纬度。 | | latitude | number | 是 | 是 | 表示纬度。 |
| longitude | number | 是 | 表示经度。 | | longitude | number | 是 | 是 | 表示经度。 |
| radius | number | 是 | 表示圆形围栏的半径。 | | radius | number | 是 | 是 | 表示圆形围栏的半径。 |
| expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | | expiration | number | 是 | 是 | 围栏存活的时间，单位是毫秒。 |
## GeofenceRequest<sup>8+</sup> ## GeofenceRequest<sup>(deprecated) </sup>
请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.GeofenceRequest](js-apis-geoLocationManager.md#geofencerequest)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Geofence
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 表示位置信息优先级。 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示位置信息优先级。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| geofence | [Geofence](#geofence)| 是 | 表示围栏信息。 | | geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 |
## LocationPrivacyType<sup>8+</sup> ## LocationPrivacyType<sup>(deprecated) </sup>
定位服务隐私协议类型。 定位服务隐私协议类型。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 默认值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 | | OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 | | STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | | CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
## LocationCommand<sup>8+</sup> ## LocationCommand<sup>(deprecated) </sup>
扩展命令结构体。 扩展命令结构体。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationCommand](js-apis-geoLocationManager.md#locationcommand)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| command | string | 是 | 扩展命令字符串。 | | command | string | 是 | 是 | 扩展命令字符串。 |
## Location ## Location<sup>(deprecated) </sup>
位置信息类型。 位置信息类型。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.Location](js-apis-geoLocationManager.md#location)替代。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude<sup>7+</sup> | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | latitude<sup>7+</sup> | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude<sup>7+</sup> | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | | longitude<sup>7+</sup> | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| altitude<sup>7+</sup> | number | 是 | 表示高度信息，单位米。 | | altitude<sup>7+</sup> | number | 是 | 否 | 表示高度信息，单位米。 |
| accuracy<sup>7+</sup> | number | 是 | 表示精度信息，单位米。 | | accuracy<sup>7+</sup> | number | 是 | 否 | 表示精度信息，单位米。 |
| speed<sup>7+</sup> | number | 是 | 表示速度信息，单位米每秒。 | | speed<sup>7+</sup> | number | 是 | 否 | 表示速度信息，单位米每秒。 |
| timeStamp<sup>7+</sup> | number | 是 | 表示位置时间戳，UTC格式。 | | timeStamp<sup>7+</sup> | number | 是 | 否 | 表示位置时间戳，UTC格式。 |
| direction<sup>7+</sup> | number | 是 | 表示航向信息。 | | direction<sup>7+</sup> | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot<sup>7+</sup> | number | 是 | 表示位置时间戳，开机时间格式。 | | timeSinceBoot<sup>7+</sup> | number | 是 | 否 | 表示位置时间戳，开机时间格式。 |
| additions<sup>7+</sup> | Array&lt;string&gt; | 否 | 附加信息。 | | additions<sup>7+</sup> | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize<sup>7+</sup> | number | 否 | 附加信息数量。 | | additionSize<sup>7+</sup> | number | 是 | 否 | 附加信息数量。 |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-location.md
浏览文件 @ d478984b
# 地理位置 # 地理位置
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.geolocation`](js-apis-geolocation.md)。
>
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。
## 导入模块 ## 导入模块
...@@ -19,12 +18,15 @@ import geolocation from '@system.geolocation'; ...@@ -19,12 +18,15 @@ import geolocation from '@system.geolocation';
ohos.permission.LOCATION ohos.permission.LOCATION
## geolocation.getLocation ## geolocation.getLocation<sup>(deprecated) </sup>
getLocation(Object): void getLocation(Object): void
获取设备的地理位置。 获取设备的地理位置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -75,12 +77,15 @@ export default { ...@@ -75,12 +77,15 @@ export default {
``` ```
## geolocation.getLocationType ## geolocation.getLocationType<sup>(deprecated) </sup>
getLocationType(Object): void getLocationType(Object): void
获取当前设备支持的定位类型。 获取当前设备支持的定位类型。
> **说明：**<br/>
> 从API version 9开始废弃。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
**参数：** **参数：**
...@@ -115,12 +120,15 @@ export default { ...@@ -115,12 +120,15 @@ export default {
``` ```
## geolocation.subscribe ## geolocation.subscribe<sup>(deprecated) </sup>
subscribe(Object): void subscribe(Object): void
订阅设备的地理位置信息。多次调用的话，只有最后一次的调用生效。 订阅设备的地理位置信息。多次调用的话，只有最后一次的调用生效。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
**参数：** **参数：**
...@@ -167,12 +175,15 @@ export default { ...@@ -167,12 +175,15 @@ export default {
``` ```
## geolocation.unsubscribe ## geolocation.unsubscribe<sup>(deprecated) </sup>
unsubscribe(): void unsubscribe(): void
取消订阅设备的地理位置信息。 取消订阅设备的地理位置信息。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
**示例：** **示例：**
...@@ -186,12 +197,15 @@ export default { ...@@ -186,12 +197,15 @@ export default {
``` ```
## geolocation.getSupportedCoordTypes ## geolocation.getSupportedCoordTypes<sup>(deprecated) </sup>
getSupportedCoordTypes(): Array&lt;string&gt; getSupportedCoordTypes(): Array&lt;string&gt;
获取设备支持的坐标系类型。 获取设备支持的坐标系类型。
> **说明：**<br/>
> 从API version 9开始废弃。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
**返回值：** **返回值：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或