Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 634da1ad 编写于 作者: L liu-binjun
浏览文件
操作

bugfix:fix bug 

Signed-off-by: Nliu-binjun <liubinjun@huawei.com>
上级 d416fb86
隐藏空白更改
内联 并排
Showing with 1467 addition and 1425 deletion
zh-cn/application-dev/device/device-location-geocoding.md 已删除 100644 → 0
浏览文件 @ d416fb86
# （逆）地理编码转化
## 场景介绍
使用坐标描述一个位置，非常准确，但是并不直观，面向用户表达并不友好。系统向开发者提供了以下两种转化能力。
- 地理编码转化：将地理描述转化为具体坐标。
- 逆地理编码转化能力：将坐标转化为地理描述。
其中地理编码包含多个属性来描述位置，包括国家、行政区划、街道、门牌号、地址描述等等，这样的信息更便于用户理解。
## 接口说明
进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍
| 接口名 | 功能描述 |
| -------- | -------- |
| isGeocoderAvailable(): boolean; | 判断（逆）地理编码服务状态。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt; | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt; | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 |
## 开发步骤
> **说明：**
> GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。
1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
```
2. 查询geoCoder服务是否可用。
- 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
var isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
3. 获取转化结果。
- 调用getAddressesFromLocation，坐标转化地理位置信息。
```ts
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) {
console.log('getAddressesFromLocation err: ' + JSON.stringify(err));
} else {
console.log('getAddressesFromLocation data: ' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。
- 调用getAddressesFromLocationName位置描述转化坐标。
```ts
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) {
console.log('getAddressesFromLocationName err: ' + JSON.stringify(err));
} else {
console.log('getAddressesFromLocationName data: ' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。
如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。
zh-cn/application-dev/device/device-location-info.md 已删除 100644 → 0
浏览文件 @ d416fb86
# 获取设备的位置信息
## 场景介绍
开发者可以调用OpenHarmony位置相关接口，获取设备实时位置，或者最近的历史位置。
对于位置敏感的应用业务，建议获取设备实时位置信息。如果不需要设备实时位置信息，并且希望尽可能的节省耗电，开发者可以考虑获取最近的历史位置。
## 接口说明
获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
## 开发步骤
如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。
系统提供的定位权限有：
- 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。
| 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权限，这样应用在切入后台之后，系统可以继续上报位置信息。
开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。
2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
```
3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。<br/>
**方式一：**
为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。
```ts
export enum LocationRequestScenario {
UNSET = 0x300,
NAVIGATION,
TRAJECTORY_TRACKING,
CAR_HAILING,
DAILY_LIFE_SERVICE,
NO_POWER,
}
```
**表2** 定位场景类型说明
| 场景名称 | 常量定义 | 说明 |
| ------------ | ------------------- | ------------------------------------------------------------ |
| 导航场景 | NAVIGATION | 适用于在户外定位设备实时位置的场景，如车载、步行导航。在此场景下，为保证系统提供位置结果精度最优，主要使用GNSS定位技术提供定位服务，结合场景特点，在导航启动之初，用户很可能在室内、车库等遮蔽环境，GNSS技术很难提供位置服务。为解决此问题，我们会在GNSS提供稳定位置结果之前，使用系统网络定位技术，向应用提供位置服务，以在导航初始阶段提升用户体验。<br/>此场景默认以最小1秒间隔上报定位结果，使用此场景的应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 轨迹跟踪场景 | TRAJECTORY_TRACKING | 适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。主要使用GNSS定位技术提供定位服务。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 出行约车场景 | CAR_HAILING | 适用于用户出行打车时定位当前位置的场景，如网约车类应用。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 生活服务场景 | DAILY_LIFE_SERVICE | 生活服务场景，适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用，做推荐、推送时定位用户大致位置即可。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 无功耗场景 | NO_POWER | 无功耗场景，适用于不需要主动启动定位业务。系统在响应其他应用启动定位业务并上报位置结果时，会同时向请求此场景的应用程序上报定位结果，当前的应用程序不产生定位功耗。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用需要申请ohos.permission.LOCATION权限，同时获得用户授权。 |
以导航场景为例，实例化方式如下：
```ts
var requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
```
**方式二：**
如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。
```ts
export enum LocationRequestPriority {
UNSET = 0x200,
ACCURACY,
LOW_POWER,
FIRST_FIX,
}
```
**表3** 定位优先级策略类型说明：
| 策略类型 | 常量定义 | 说明 |
| ------------------ | -------------- | ------------------------------------------------------------ |
| 定位精度优先策略 | ACCURACY | 定位精度优先策略主要以GNSS定位技术为主，在开阔场景下可以提供米级的定位精度，具体性能指标依赖用户设备的定位硬件能力，但在室内等强遮蔽定位场景下，无法提供准确的位置服务。<br/>应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 快速定位优先策略 | FAST_FIRST_FIX | 快速定位优先策略会同时使用GNSS定位、基站定位和WLAN、蓝牙定位技术，以便室内和户外场景下，通过此策略都可以获得位置结果，当各种定位技术都有提供位置结果时，系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用，对设备的硬件资源消耗较大，功耗也较大。<br/>应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 低功耗定位优先策略 | LOW_POWER | 低功耗定位优先策略主要使用基站定位和WLAN、蓝牙定位技术，也可以同时提供室内和户外场景下的位置服务，因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况，定位结果的精度波动范围较大，如果对定位结果精度要求不高，或者使用场景多在有基站、可见WLAN、蓝牙设备高密度分布的情况下，推荐使用，可以有效节省设备功耗。<br/>应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 |
以定位精度优先策略为例，实例化方式如下：
```ts
var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
```
4. 实例化Callback对象，用于向系统提供位置上报的途径。
应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。
```ts
var locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
```
5. 启动定位。
```ts
geoLocationManager.on('locationChange', requestInfo, locationChange);
```
6. （可选）结束定位。
```ts
geoLocationManager.off('locationChange', locationChange);
```
如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
var location = geoLocationManager.getLastLocation();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。
\ No newline at end of file
zh-cn/application-dev/device/device-location-overview.md 已删除 100644 → 0
浏览文件 @ d416fb86
# 位置开发概述
移动终端设备已经深入人们日常生活的方方面面，如查看所在城市的天气、新闻轶事、出行打车、旅行导航、运动记录。这些习以为常的活动，都离不开定位用户终端设备的位置。
当用户处于这些丰富的使用场景中时，系统的位置能力可以提供实时准确的位置数据。对于开发者，设计基于位置体验的服务，也可以使应用的使用体验更贴近每个用户。
当应用在实现基于设备位置的功能时，如：驾车导航，记录运动轨迹等，可以调用该模块的API接口，完成位置信息的获取。
## 基本概念
位置能力用于确定用户设备在哪里，系统使用位置坐标标示设备的位置，并用多种定位技术提供服务，如GNSS定位、基站定位、WLAN/蓝牙定位（基站定位、WLAN/蓝牙定位后续统称“网络定位技术”）。通过这些定位技术，无论用户设备在室内或是户外，都可以准确地确定设备位置。
- **坐标**<br/>
系统以1984年世界大地坐标系统为参考，使用经度、纬度数据描述地球上的一个位置。
- **GNSS定位**<br/>
基于全球导航卫星系统，包含：GPS、GLONASS、北斗、Galileo等，通过导航卫星、设备芯片提供的定位算法，来确定设备准确位置。定位过程具体使用哪些定位系统，取决于用户设备的硬件能力。
- **基站定位**<br/>
根据设备当前驻网基站和相邻基站的位置，估算设备当前位置。此定位方式的定位结果精度相对较低，并且需要设备可以访问蜂窝网络。
- **WLAN、蓝牙定位**<br/>
根据设备可搜索到的周围WLAN、蓝牙设备位置，估算设备当前位置。此定位方式的定位结果精度依赖设备周围可见的固定WLAN、蓝牙设备的分布，密度较高时，精度也相较于基站定位方式更高，同时也需要设备可以访问网络。
## 运作机制
位置能力作为系统为应用提供的一种基础服务，需要应用在所使用的业务场景，向系统主动发起请求，并在业务场景结束时，主动结束此请求，在此过程中系统会将实时的定位结果上报给应用。
## 约束与限制
使用设备的位置能力，需要用户进行确认并主动开启位置开关。如果位置开关没有开启，系统不会向任何应用提供位置服务。
设备位置信息属于用户敏感数据，所以即使用户已经开启位置开关，应用在获取设备位置前仍需向用户申请位置访问权限。在用户确认允许后，系统才会向应用提供位置服务。
## 相关实例
针对位置服务，有以下相关实例可供参考：
- [`Location`：位置服务（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/device/Location)
zh-cn/application-dev/device/location-guidelines.md 0 → 100644
浏览文件 @ 634da1ad
# 位置服务开发指南
## 位置服务开发概述
移动终端设备已经深入人们日常生活的方方面面，如查看所在城市的天气、新闻轶事、出行打车、旅行导航、运动记录。这些习以为常的活动，都离不开定位用户终端设备的位置。
当用户处于这些丰富的使用场景中时，系统的位置能力可以提供实时准确的位置数据。对于开发者，设计基于位置体验的服务，也可以使应用的使用体验更贴近每个用户。
当应用在实现基于设备位置的功能时，如：驾车导航，记录运动轨迹等，可以调用该模块的API接口，完成位置信息的获取。
### 位置服务简介
位置能力用于确定用户设备在哪里，系统使用位置坐标标示设备的位置，并用多种定位技术提供服务，如GNSS定位、基站定位、WLAN/蓝牙定位（基站定位、WLAN/蓝牙定位后续统称“网络定位技术”）。通过这些定位技术，无论用户设备在室内或是户外，都可以准确地确定设备位置。
- **坐标**<br/>
系统以1984年世界大地坐标系统为参考，使用经度、纬度数据描述地球上的一个位置。
- **GNSS定位**<br/>
基于全球导航卫星系统，包含：GPS、GLONASS、北斗、Galileo等，通过导航卫星、设备芯片提供的定位算法，来确定设备准确位置。定位过程具体使用哪些定位系统，取决于用户设备的硬件能力。
- **基站定位**<br/>
根据设备当前驻网基站和相邻基站的位置，估算设备当前位置。此定位方式的定位结果精度相对较低，并且需要设备可以访问蜂窝网络。
- **WLAN、蓝牙定位**<br/>
根据设备可搜索到的周围WLAN、蓝牙设备位置，估算设备当前位置。此定位方式的定位结果精度依赖设备周围可见的固定WLAN、蓝牙设备的分布，密度较高时，精度也相较于基站定位方式更高，同时也需要设备可以访问网络。
位置服务还提供了地理围栏、地理编码、逆地理编码、国家码等功能和接口。
### 运作机制
位置能力作为系统为应用提供的一种基础服务，需要应用在所使用的业务场景，向系统主动发起请求，并在业务场景结束时，主动结束此请求，在此过程中系统会将实时的定位结果上报给应用。
### 约束与限制
使用设备的位置能力，需要用户进行确认并主动开启位置开关。如果位置开关没有开启，系统不会向任何应用提供位置服务。
设备位置信息属于用户敏感数据，所以即使用户已经开启位置开关，应用在获取设备位置前仍需向用户申请位置访问权限。在用户确认允许后，系统才会向应用提供位置服务。
### 相关实例
针对位置服务，有以下相关实例可供参考：
- [`Location`：位置服务（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/device/Location)
## 申请位置权限开发指导
### 场景概述
应用在使用位置服务系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限。
系统提供的定位权限有：
- 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。
**表1** 位置权限申请方式介绍
| 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权限，这样应用在切入后台之后，系统可以继续上报位置信息。
开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。
位置服务每个接口需要申请哪些权限可以参见如下文档：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
### 开发步骤
具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。
## 获取设备的位置信息开发指导
### 场景概述
开发者可以调用OpenHarmony位置相关接口，获取设备实时位置，或者最近的历史位置。
对于位置敏感的应用业务，建议获取设备实时位置信息。如果不需要设备实时位置信息，并且希望尽可能的节省耗电，开发者可以考虑获取最近的历史位置。
### 接口说明
获取设备的位置信息所使用的接口如下，详细说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表2** 获取设备的位置信息接口介绍
| 接口名 | 功能描述 |
| -------- | -------- |
| on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void | 开启位置变化订阅，并发起定位请求。 |
| off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void | 关闭位置变化订阅，并删除对应的定位请求。 |
| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void | 获取当前位置，使用callback回调异步返回结果。 |
| getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; | 获取当前位置，使用Promise方式异步返回结果。 |
| getLastLocation(): Location | 获取上一次位置。 |
### 开发步骤
1. 获取设备的位置信息，需要有位置权限，位置权限申请的方法和步骤见[申请位置权限开发指导](#申请位置权限开发指导)。
2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
```
3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。<br/>
**方式一：**
为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。
```ts
export enum LocationRequestScenario {
UNSET = 0x300,
NAVIGATION,
TRAJECTORY_TRACKING,
CAR_HAILING,
DAILY_LIFE_SERVICE,
NO_POWER,
}
```
**表3** 定位场景类型说明
| 场景名称 | 常量定义 | 说明 |
| ------------ | ------------------- | ------------------------------------------------------------ |
| 导航场景 | NAVIGATION | 适用于在户外定位设备实时位置的场景，如车载、步行导航。在此场景下，为保证系统提供位置结果精度最优，主要使用GNSS定位技术提供定位服务，结合场景特点，在导航启动之初，用户很可能在室内、车库等遮蔽环境，GNSS技术很难提供位置服务。为解决此问题，我们会在GNSS提供稳定位置结果之前，使用系统网络定位技术，向应用提供位置服务，以在导航初始阶段提升用户体验。<br/>此场景默认以最小1秒间隔上报定位结果，使用此场景的应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 轨迹跟踪场景 | TRAJECTORY_TRACKING | 适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。主要使用GNSS定位技术提供定位服务。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 出行约车场景 | CAR_HAILING | 适用于用户出行打车时定位当前位置的场景，如网约车类应用。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 生活服务场景 | DAILY_LIFE_SERVICE | 生活服务场景，适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用，做推荐、推送时定位用户大致位置即可。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 无功耗场景 | NO_POWER | 无功耗场景，适用于不需要主动启动定位业务。系统在响应其他应用启动定位业务并上报位置结果时，会同时向请求此场景的应用程序上报定位结果，当前的应用程序不产生定位功耗。<br/>此场景默认以最小1秒间隔上报定位结果，并且应用需要申请ohos.permission.LOCATION权限，同时获得用户授权。 |
以导航场景为例，实例化方式如下：
```ts
let requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
```
**方式二：**
如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。
```ts
export enum LocationRequestPriority {
UNSET = 0x200,
ACCURACY,
LOW_POWER,
FIRST_FIX,
}
```
**表4** 定位优先级策略类型说明：
| 策略类型 | 常量定义 | 说明 |
| ------------------ | -------------- | ------------------------------------------------------------ |
| 定位精度优先策略 | ACCURACY | 定位精度优先策略主要以GNSS定位技术为主，在开阔场景下可以提供米级的定位精度，具体性能指标依赖用户设备的定位硬件能力，但在室内等强遮蔽定位场景下，无法提供准确的位置服务。<br/>应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 快速定位优先策略 | FIRST_FIX | 快速定位优先策略会同时使用GNSS定位、基站定位和WLAN、蓝牙定位技术，以便室内和户外场景下，通过此策略都可以获得位置结果，当各种定位技术都有提供位置结果时，系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用，对设备的硬件资源消耗较大，功耗也较大。<br/>应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 |
| 低功耗定位优先策略 | LOW_POWER | 低功耗定位优先策略主要使用基站定位和WLAN、蓝牙定位技术，也可以同时提供室内和户外场景下的位置服务，因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况，定位结果的精度波动范围较大，如果对定位结果精度要求不高，或者使用场景多在有基站、可见WLAN、蓝牙设备高密度分布的情况下，推荐使用，可以有效节省设备功耗。<br/>应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 |
以定位精度优先策略为例，实例化方式如下：
```ts
let requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
```
4. 实例化Callback对象，用于向系统提供位置上报的途径。
应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。
```ts
let locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location));
};
```
5. 启动定位。
```ts
geoLocationManager.on('locationChange', requestInfo, locationChange);
```
6. （可选）结束定位。
```ts
geoLocationManager.off('locationChange', locationChange);
```
如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
let location = geoLocationManager.getLastLocation();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## （逆）地理编码转化开发指导
### 场景概述
使用坐标描述一个位置，非常准确，但是并不直观，面向用户表达并不友好。系统向开发者提供了以下两种转化能力。
- 地理编码转化：将地理描述转化为具体坐标。
- 逆地理编码转化能力：将坐标转化为地理描述。
其中地理编码包含多个属性来描述位置，包括国家、行政区划、街道、门牌号、地址描述等等，这样的信息更便于用户理解。
### 接口说明
进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表5** （逆）地理编码转化接口介绍
| 接口名 | 功能描述 |
| -------- | -------- |
| isGeocoderAvailable(): boolean; | 判断（逆）地理编码服务状态。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 |
| getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt; | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 |
| getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt; | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 |
### 开发步骤
> **说明：**
> GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。
1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
```
2. 查询geoCoder服务是否可用。
- 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
let isAvailable = geoLocationManager.isGeocoderAvailable();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
3. 获取转化结果。
- 调用getAddressesFromLocation，坐标转化地理位置信息。
```ts
let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) {
console.log('getAddressesFromLocation err: ' + JSON.stringify(err));
} else {
console.log('getAddressesFromLocation data: ' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。
- 调用getAddressesFromLocationName位置描述转化坐标。
```ts
let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) {
console.log('getAddressesFromLocationName err: ' + JSON.stringify(err));
} else {
console.log('getAddressesFromLocationName data: ' + JSON.stringify(data));
}
});
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。
如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。
## 地理围栏开发指导
### 场景概述
地理围栏就是虚拟地理边界，当设备进入、离开某个特定地理区域时，可以接收自动通知和警告。
目前仅支持圆形围栏，并且依赖GNSS芯片的地理围栏功能。
应用场景举例：开发者可以使用地理围栏，在企业周围创建一个区域进行广告定位，在不同的地点，在移动设备上进行有针对性的促销优惠。
### 接口说明
地理围栏所使用的接口如下，详细说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。
**表6** 地理围栏接口介绍
| 接口名 | 功能描述 |
| -------- | -------- |
| on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; | 添加一个围栏，并订阅地理围栏事件。 |
| off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; | 删除一个围栏，并取消订阅该围栏事件。 |
### 开发步骤
1. 使用地理围栏功能，需要有权限ohos.permission.APPROXIMATELY_LOCATION，位置权限申请的方法和步骤见[申请位置权限开发指导](#申请位置权限开发指导)。
2. 导入geoLocationManager模块和wantAgent模块。
```ts
import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.wantAgent';
```
3. 创建WantAgentInfo信息。
场景一：创建拉起Ability的WantAgentInfo信息。
```ts
let wantAgentObj = null; // 用于保存创建成功的wantAgent对象，后续使用其完成触发的动作。
// 通过WantAgentInfo的operationType设置动作类型
let wantAgentInfo = {
wants: [
{
deviceId: '',
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility',
action: '',
entities: [],
uri: '',
parameters: {}
}
],
operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags:[wantAgent.WantAgentFlags.CONSTANT_FLAG]
};
```
场景二：创建发布[公共事件](../application-models/common-event-overview.md)的WantAgentInfo信息。
```ts
let wantAgentObj = null; // 用于保存创建成功的WantAgent对象，后续使用其完成触发的动作。
// 通过WantAgentInfo的operationType设置动作类型
let wantAgentInfo = {
wants: [
{
action: 'event_name', // 设置事件名
parameters: {},
}
],
operationType: wantAgent.OperationType.SEND_COMMON_EVENT,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.CONSTANT_FLAG],
}
```
4. 调用[getWantAgent()](../reference/apis/js-apis-app-ability-wantAgent.md#wantagentgetwantagent)方法进行创建WantAgent。
并且在获取到WantAgent对象之后调用地理围栏接口添加围栏。
```ts
// 创建WantAgent
wantAgent.getWantAgent(wantAgentInfo, (err, data) => {
if (err) {
console.error('getWantAgent err=' + JSON.stringify(err));
return;
}
console.info('getWantAgent success');
wantAgentObj = data;
let 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);
}
});
```
5. 当设备进入或者退出该围栏时，系统会自动触发WantAgent的动作。
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md
浏览文件 @ 634da1ad
...@@ -42,404 +42,296 @@ import geoLocationManager from '@ohos.geoLocationManager'; ...@@ -42,404 +42,296 @@ import geoLocationManager from '@ohos.geoLocationManager';
``` ```
## geoLocationManager.on('locationChange') ## ReverseGeoCodeRequest
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') **系统能力**：SystemCapability.Location.Location.Geocoder
off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 |
| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
关闭位置变化订阅，并删除对应的定位请求。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION ## GeoCodeRequest
**系统能力**：SystemCapability.Location.Location.Core 地理编码请求接口。
**参数：** **系统能力**：SystemCapability.Location.Location.Geocoder
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | | locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| callback | Callback&lt;[Location](#location)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | | description | string | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 |
| minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 ## GeoAddress
| 错误码ID | 错误信息 | 地理编码类型。
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例** **系统能力**：SystemCapability.Location.Location.Geocoder
```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);
}
```
| 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| locale | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| placeName | string | 是 | 否 | 表示地区信息。 |
| countryCode | string | 是 | 否 | 表示国家码信息。 |
| countryName | string| 是 | 否 | 表示国家信息。 |
| administrativeArea | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea | string | 是 | 否 | 表示表示子区域信息。 |
| locality | string | 是 | 否 | 表示城市信息。 |
| subLocality | string | 是 | 否 | 表示子城市信息。 |
| roadName | string | 是 | 否 |表示路名信息。 |
| subRoadName | string | 是 | 否 | 表示子路名信息。 |
| premises | string| 是 | 否|表示门牌号信息。 |
| postalCode | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber | string | 是 | 否 | 表示联系方式信息。 |
| addressUrl | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions | Array&lt;string&gt; | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize | number | 是 | 否 | 表示附加的描述信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 |
## geoLocationManager.on('locationEnabledChange')
on(type: 'locationEnabledChange', callback: Callback&lt;boolean&gt;): void ## LocationRequest
订阅位置服务状态变化。 位置信息请求类型。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**参数：** | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 类型 | 必填 | 说明 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| -------- | -------- | -------- | -------- | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | | timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 |
| callback | Callback&lt;boolean&gt; | 是 | 接收位置服务状态变化监听。 | | distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 |
| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../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; ## CurrentLocationRequest
取消订阅位置服务状态变化。 当前位置信息请求类型。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**参数**： | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 类型 | 必填 | 说明 | | priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| -------- | -------- | -------- | -------- | | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | | maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | | timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 | ## SatelliteStatusInfo
| -------- | ---------------------------------------- |
|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);
}
```
**系统能力**：SystemCapability.Location.Location.Gnss
## geoLocationManager.on('cachedGnssLocationsChange') | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| satellitesNumber | number | 是 | 否 | 表示卫星个数。 |
| satelliteIds | Array&lt;number&gt; | 是 | 否 | 表示每个卫星的ID，数组类型。 |
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 |
| altitudes | Array&lt;number&gt; | 是 | 否 | 表示高程信息。 |
| azimuths | Array&lt;number&gt; | 是 | 否 | 表示方位角。 |
| carrierFrequencies | Array&lt;number&gt; | 是 | 否 | 表示载波频率。 |
on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
订阅缓存GNSS定位结果上报事件。 ## CachedGnssLocationsRequest
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION 请求订阅GNSS缓存位置上报功能接口的配置参数。
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 类型 | 必填 | 说明 | | reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 |
| -------- | -------- | -------- | -------- | | wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
| callback | Callback&lt;boolean&gt; | 是 | 接收GNSS缓存位置上报。 |
**错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 | ## Geofence
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例** GNSS围栏的配置参数。目前只支持圆形围栏。
```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);
}
```
**系统能力**：SystemCapability.Location.Location.Geofence
## geoLocationManager.off('cachedGnssLocationsChange') | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 是 |表示纬度。 |
| longitude | number | 是 |是 | 表示经度。 |
| radius | number | 是 |是 | 表示圆形围栏的半径。 |
| expiration | number | 是 |是 | 围栏存活的时间，单位是毫秒。 |
off(type: 'cachedGnssLocationsChange', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
取消订阅缓存GNSS定位结果上报事件。 ## GeofenceRequest
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Geofence
**参数**： | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： ## LocationCommand
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 扩展命令结构体。
| 错误码ID | 错误信息 | **系统能力**：SystemCapability.Location.Location.Core
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. |
**示例** | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
```ts | scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
import geoLocationManager from '@ohos.geoLocationManager'; | command | string | 是 | 是 | 扩展命令字符串。 |
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') ## Location
on(type: 'satelliteStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void; 位置信息类型。
订阅GNSS卫星状态信息上报事件。 **系统能力**：SystemCapability.Location.Location.Core
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number| 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number| 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| altitude | number | 是 | 否 | 表示高度信息，单位米。 |
| accuracy | number | 是 | 否 | 表示精度信息，单位米。 |
| speed | number | 是 | 否 |表示速度信息，单位米每秒。 |
| timeStamp | number | 是 | 否 | 表示位置时间戳，UTC格式。 |
| direction | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot | number | 是 | 否 | 表示位置时间戳，开机时间格式。 |
| additions | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize | number | 是 | 否 | 附加信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示位置信息是否来自于位置模拟功能。 |
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**： ## ReverseGeocodingMockInfo
| 参数名 | 类型 | 必填 | 说明 | 逆地理编码模拟功能的配置信息，包含一个位置信息和一个地名信息。
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 是 | 接收GNSS卫星状态信息上报。 |
**错误码**： **系统能力**：SystemCapability.Location.Location.Core
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 **系统API**：此接口为系统接口，三方应用不支持调用。
| 错误码ID | 错误信息 | | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | ---------------------------------------- | | -------- | -------- | -------- | -------- | -------- |
|3301000 | Location service is unavailable. | | location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 |
|3301100 | The location switch is off. | | geoAddress | [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
var gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try { ## LocationMockConfig
geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
位置模拟功能的配置参数，包含了模拟位置上报的时间间隔和模拟位置数组。
## geoLocationManager.off('satelliteStatusChange') **系统能力**：SystemCapability.Location.Location.Core
off(type: 'satelliteStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void; **系统API**：此接口为系统接口，三方应用不支持调用。
取消订阅GNSS卫星状态信息上报事件。 | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔，单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 是 | 表示模拟位置数组。 |
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss ## CountryCode
**参数**： 国家码信息结构体，包含国家码字符串和国家码的来源信息。
| 参数名 | 类型 | 必填 | 说明 | **系统能力**：SystemCapability.Location.Location.Core
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： | 名称 | 类型 | 可读|可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| country | string | 是 | 否 | 表示国家码字符串。 |
| type | [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 |
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
| 错误码ID | 错误信息 | ## LocationRequestPriority
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
位置请求中位置信息优先级设置。
**示例** **系统能力**：SystemCapability.Location.Location.Core
```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);
}
```
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 |
## geoLocationManager.on('nmeaMessage')
on(type: 'nmeaMessage', callback: Callback&lt;string&gt;): void; ## LocationRequestScenario
订阅GNSS NMEA信息上报事件。 位置请求中定位场景设置。
**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION **系统能力**：SystemCapability.Location.Location.Core
**系统能力**：SystemCapability.Location.Location.Gnss | 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
**参数**：
| 参数名 | 类型 | 必填 | 说明 | ## LocationPrivacyType
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 是 | 接收GNSS&nbsp;NMEA信息上报。 |
**错误码**： 定位服务隐私协议类型。
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 **系统能力**：SystemCapability.Location.Location.Core
| 错误码ID | 错误信息 | | 名称 | 值 | 说明 |
| -------- | ---------------------------------------- | | -------- | -------- | -------- |
|3301000 | Location service is unavailable. | | OTHERS | 0 | 其他场景。 |
|3301100 | The location switch is off. | | STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
**示例** ## CountryCodeType
```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);
}
```
**系统能力**：SystemCapability.Location.Location.Core
## geoLocationManager.off('nmeaMessage') | 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 |
| COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 |
| COUNTRY_CODE_FROM_LOCATION | 3 | 基于用户的位置信息，通过逆地理编码查询到的国家码。 |
| COUNTRY_CODE_FROM_NETWORK | 4 | 从蜂窝网络注册信息中获取到的国家码。 |
off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。 ## geoLocationManager.on('locationChange')
**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void
**系统能力**：SystemCapability.Location.Location.Gnss 开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报，
**参数**： **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 | | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| callback | Callback&lt;string&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | | request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 |
| callback | Callback&lt;[Location](#location)&gt; | 是 | 接收位置变化状态变化监听。 |
**错误码**： **错误码**：
...@@ -449,42 +341,41 @@ off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void; ...@@ -449,42 +341,41 @@ off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void;
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |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';
var nmeaCb = (str) => { let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
console.log('nmeaMessage: ' + JSON.stringify(str)); let locationChange = (location) => {
} console.log('locationChanger: data: ' + JSON.stringify(location));
};
try { try {
geoLocationManager.on('nmeaMessage', nmeaCb); geoLocationManager.on('locationChange', requestInfo, locationChange);
geoLocationManager.off('nmeaMessage', nmeaCb);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.on('gnssFenceStatusChange') ## geoLocationManager.off('locationChange')
on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
添加一个围栏，并订阅地理围栏事件。 关闭位置变化订阅，并删除对应的定位请求。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | | callback | Callback&lt;[Location](#location)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**： **错误码**：
...@@ -494,55 +385,39 @@ on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): vo ...@@ -494,55 +385,39 @@ on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): vo
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. | |3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.wantAgent'; let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
let locationChange = (location) => {
let wantAgentInfo = { console.log('locationChanger: data: ' + JSON.stringify(location));
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],
}; };
try {
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { geoLocationManager.on('locationChange', requestInfo, locationChange);
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; geoLocationManager.off('locationChange', locationChange);
try { } catch (err) {
geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} catch (err) { }
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
});
``` ```
## geoLocationManager.off('gnssFenceStatusChange') ## geoLocationManager.on('locationEnabledChange')
off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏，并取消订阅该围栏事件。 on(type: 'locationEnabledChange', callback: Callback&lt;boolean&gt;): void
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION 订阅位置服务状态变化。
**系统能力**：SystemCapability.Location.Location.Geofence **系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | | callback | Callback&lt;boolean&gt; | 是 | 接收位置服务状态变化监听。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**： **错误码**：
...@@ -551,45 +426,27 @@ off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): v ...@@ -551,45 +426,27 @@ off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): v
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
import wantAgent from '@ohos.wantAgent'; let locationEnabledChange = (state) => {
console.log('locationEnabledChange: ' + JSON.stringify(state));
let wantAgentInfo = { }
wants: [ try {
{ geoLocationManager.on('locationEnabledChange', locationEnabledChange);
bundleName: "com.example.myapplication", } catch (err) {
abilityName: "com.example.myapplication.MainAbility", console.error("errCode:" + err.code + ",errMessage:" + err.message);
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') ## geoLocationManager.off('locationEnabledChange')
on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; off(type: 'locationEnabledChange', callback?: Callback&lt;boolean&gt;): void;
订阅国家码信息变化事件。 取消订阅位置服务状态变化。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -597,8 +454,8 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; ...@@ -597,8 +454,8 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 | | callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： **错误码**：
...@@ -607,40 +464,40 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void; ...@@ -607,40 +464,40 @@ on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&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';
var callback = (code) => { let locationEnabledChange = (state) => {
console.log('countryCodeChange: ' + JSON.stringify(code)); console.log('locationEnabledChange: state: ' + JSON.stringify(state));
} }
try { try {
geoLocationManager.on('countryCodeChange', callback); geoLocationManager.on('locationEnabledChange', locationEnabledChange);
geoLocationManager.off('locationEnabledChange', locationEnabledChange);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.off('countryCodeChange') ## geoLocationManager.on('cachedGnssLocationsChange')
off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void; on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback&lt;Array&lt;Location&gt;&gt;): void;
取消订阅国家码变化事件。 订阅缓存GNSS定位结果上报事件。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | | request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 |
| callback | Callback&lt;boolean&gt; | 是 | 接收GNSS缓存位置上报。 |
**错误码**： **错误码**：
...@@ -650,42 +507,40 @@ off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void; ...@@ -650,42 +507,40 @@ 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) => { let cachedLocationsCb = (locations) => {
console.log('countryCodeChange: ' + JSON.stringify(code)); console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
} }
let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
try { try {
geoLocationManager.on('countryCodeChange', callback); geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
geoLocationManager.off('countryCodeChange', callback);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.off('cachedGnssLocationsChange')
## geoLocationManager.getCurrentLocation off(type: 'cachedGnssLocationsChange', callback?: Callback&lt;Array&lt;Location&gt;&gt;): void;
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置，使用callback回调异步返回结果。 取消订阅缓存GNSS定位结果上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 | | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 | | callback | Callback&lt;boolean&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： **错误码**：
...@@ -695,44 +550,41 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L ...@@ -695,44 +550,41 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301100 | The location switch is off. |
|3301200 | Failed to obtain the geographical location. | |3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; let cachedLocationsCb = (locations) => {
var locationChange = (err, location) => { console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations));
if (err) { }
console.log('locationChanger: err=' + JSON.stringify(err)); let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try { try {
geoLocationManager.getCurrentLocation(requestInfo, locationChange); geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb);
geoLocationManager.off('cachedGnssLocationsChange');
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCurrentLocation
getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void; ## geoLocationManager.on('satelliteStatusChange')
获取当前位置，通过callback方式异步返回结果。 on(type: 'satelliteStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): void;
订阅GNSS卫星状态信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 | | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 是 | 接收GNSS卫星状态信息上报。 |
**错误码**： **错误码**：
...@@ -742,49 +594,39 @@ getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void; ...@@ -742,49 +594,39 @@ getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void;
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |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';
var locationChange = (err, location) => { let gnssStatusCb = (satelliteStatusInfo) => {
if (err) { console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
console.log('locationChanger: err=' + JSON.stringify(err)); }
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try { try {
geoLocationManager.getCurrentLocation(locationChange); geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCurrentLocation
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; ## geoLocationManager.off('satelliteStatusChange')
获取当前位置，使用Promise方式异步返回结果。 off(type: 'satelliteStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): void;
取消订阅GNSS卫星状态信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 |
| callback | Callback&lt;[SatelliteStatusInfo](#satellitestatusinfo)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Promise&lt;[Location](#location)&gt; | [Location](#location) | NA | 返回位置信息。 |
**错误码**： **错误码**：
...@@ -794,41 +636,40 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; ...@@ -794,41 +636,40 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |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';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; let gnssStatusCb = (satelliteStatusInfo) => {
console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo));
}
try { try {
geoLocationManager.getCurrentLocation(requestInfo).then((result) => { geoLocationManager.on('satelliteStatusChange', gnssStatusCb);
console.log('current location: ' + JSON.stringify(result)); geoLocationManager.off('satelliteStatusChange', gnssStatusCb);
})
.catch((error) => {
console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getLastLocation ## geoLocationManager.on('nmeaMessage')
getLastLocation(): Location on(type: 'nmeaMessage', callback: Callback&lt;string&gt;): void;
获取上一次位置。 订阅GNSS NMEA信息上报事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Gnss
**返回值**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Location | [Location](#location) | NA | 位置信息。 | | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 是 | 接收GNSS&nbsp;NMEA信息上报。 |
**错误码**： **错误码**：
...@@ -836,35 +677,42 @@ getLastLocation(): Location ...@@ -836,35 +677,42 @@ getLastLocation(): Location
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |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';
let nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
try { try {
var location = geoLocationManager.getLastLocation(); geoLocationManager.on('nmeaMessage', nmeaCb );
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.isLocationEnabled ## geoLocationManager.off('nmeaMessage')
isLocationEnabled(): boolean off(type: 'nmeaMessage', callback?: Callback&lt;string&gt;): void;
判断位置服务是否已经使能。 取消订阅GNSS NMEA信息上报事件。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
**返回值**： **系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 位置服务是否已经使能。 | | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS&nbsp;NMEA信息上报。 |
| callback | Callback&lt;string&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： **错误码**：
...@@ -872,35 +720,44 @@ isLocationEnabled(): boolean ...@@ -872,35 +720,44 @@ isLocationEnabled(): 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';
let nmeaCb = (str) => {
console.log('nmeaMessage: ' + JSON.stringify(str));
}
try { try {
var locationEnabled = geoLocationManager.isLocationEnabled(); geoLocationManager.on('nmeaMessage', nmeaCb);
geoLocationManager.off('nmeaMessage', nmeaCb);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.requestEnableLocation ## geoLocationManager.on('gnssFenceStatusChange')
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
请求使能位置服务，使用callback回调异步返回结果。 添加一个围栏，并订阅地理围栏事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geofence
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | callback返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**： **错误码**：
...@@ -908,43 +765,57 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -908,43 +765,57 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301700 | No response to the request. | |3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { import wantAgent from '@ohos.wantAgent';
geoLocationManager.requestEnableLocation((err, data) => {
if (err) { let wantAgentInfo = {
console.log('requestEnableLocation: err=' + JSON.stringify(err)); wants: [
} {
if (data) { bundleName: "com.example.myapplication",
console.log('requestEnableLocation: data=' + JSON.stringify(data)); abilityName: "EntryAbility",
action: "action1",
} }
}); ],
} catch (err) { operationType: wantAgent.OperationType.START_ABILITY,
console.error("errCode:" + err.code + ",errMessage:" + err.message); requestCode: 0,
} wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG],
};
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let 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.requestEnableLocation ## geoLocationManager.off('gnssFenceStatusChange')
requestEnableLocation(): Promise&lt;boolean&gt; off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
请求使能位置服务，使用Promise方式异步返回结果。 删除一个围栏，并取消订阅该围栏事件。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geofence
**返回值**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;boolean&gt; | boolean | NA | 返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 |
| request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 |
| want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 |
**错误码**： **错误码**：
...@@ -952,35 +823,46 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -952,35 +823,46 @@ requestEnableLocation(): Promise&lt;boolean&gt;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301700 | No response to the request. | |3301100 | The location switch is off. |
|3301600 | Failed to operate the geofence. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { import wantAgent from '@ohos.wantAgent';
geoLocationManager.requestEnableLocation().then((result) => {
console.log('promise, requestEnableLocation: ' + JSON.stringify(result)); let wantAgentInfo = {
}) wants: [
.catch((error) => { {
console.log('promise, requestEnableLocation: error=' + JSON.stringify(error)); bundleName: "com.example.myapplication",
}); abilityName: "EntryAbility",
} catch (err) { action: "action1",
console.error("errCode:" + err.code + ",errMessage:" + err.message); }
} ],
``` operationType: wantAgent.OperationType.START_ABILITY,
requestCode: 0,
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
## geoLocationManager.enableLocation };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
let 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);
}
});
```
enableLocation(callback: AsyncCallback&lt;void&gt;): void;
打开位置服务，使用callback回调异步返回结果。 ## geoLocationManager.on('countryCodeChange')
**系统API**：此接口为系统接口，三方应用不支持调用。 on(type: 'countryCodeChange', callback: Callback&lt;CountryCode&gt;): void;
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 订阅国家码信息变化事件。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
...@@ -988,7 +870,8 @@ enableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -988,7 +870,8 @@ enableLocation(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码信息。 | | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 是 | 接收国家码信息上报。 |
**错误码**： **错误码**：
...@@ -997,40 +880,40 @@ enableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -997,40 +880,40 @@ enableLocation(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';
let callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
try { try {
geoLocationManager.enableLocation((err, data) => { geoLocationManager.on('countryCodeChange', callback);
if (err) {
console.log('enableLocation: err=' + JSON.stringify(err));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.enableLocation ## geoLocationManager.off('countryCodeChange')
enableLocation(): Promise&lt;void&gt;
打开位置服务，使用Promise方式异步返回结果。
**系统API**：此接口为系统接口，三方应用不支持调用。 off(type: 'countryCodeChange', callback?: Callback&lt;CountryCode&gt;): void;
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 取消订阅国家码变化事件。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**返回值**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | void | NA | 返回错误码信息。 | | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 |
| callback | Callback&lt;[CountryCode](#countrycode)&gt; | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 |
**错误码**： **错误码**：
...@@ -1039,35 +922,44 @@ enableLocation(): Promise&lt;void&gt; ...@@ -1039,35 +922,44 @@ enableLocation(): 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';
let callback = (code) => {
console.log('countryCodeChange: ' + JSON.stringify(code));
}
try { try {
geoLocationManager.enableLocation().then((result) => { geoLocationManager.on('countryCodeChange', callback);
console.log('promise, enableLocation succeed'); geoLocationManager.off('countryCodeChange', callback);
})
.catch((error) => {
console.log('promise, enableLocation: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.disableLocation
disableLocation(): void;
关闭位置服务。 ## geoLocationManager.getCurrentLocation
**系统API**：此接口为系统接口，三方应用不支持调用。 getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 获取当前位置，使用callback回调异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 |
| callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
**错误码**： **错误码**：
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
...@@ -1075,34 +967,45 @@ disableLocation(): void; ...@@ -1075,34 +967,45 @@ disableLocation(): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|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';
let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
let locationChange = (err, location) => {
if (err) {
console.log('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try { try {
geoLocationManager.disableLocation(); geoLocationManager.getCurrentLocation(requestInfo, locationChange);
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCurrentLocation
getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void;
## geoLocationManager.getAddressesFromLocation 获取当前位置，通过callback方式异步返回结果。
getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | | callback | AsyncCallback&lt;[Location](#location)&gt; | 是 | 用来接收位置信息的回调。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收逆地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -1110,48 +1013,51 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ...@@ -1110,48 +1013,51 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301300 | Reverse geocoding query failed. | |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';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; let locationChange = (err, location) => {
if (err) {
console.log('locationChanger: err=' + JSON.stringify(err));
}
if (location) {
console.log('locationChanger: location=' + JSON.stringify(location));
}
};
try { try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { geoLocationManager.getCurrentLocation(locationChange);
if (err) {
console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCurrentLocation
## geoLocationManager.getAddressesFromLocation getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;; 获取当前位置，使用Promise方式异步返回结果。
调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统能力**：SystemCapability.Location.Location.Geocoder **系统能力**：SystemCapability.Location.Location.Core
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 |
**返回值**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理描述信息。 | | Promise&lt;[Location](#location)&gt; | [Location](#location) | NA | 返回位置信息。 |
**错误码**： **错误码**：
...@@ -1159,20 +1065,21 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -1159,20 +1065,21 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301300 | Reverse geocoding query failed. | |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';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
try { try {
geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { geoLocationManager.getCurrentLocation(requestInfo).then((result) => {
console.log('getAddressesFromLocation: ' + JSON.stringify(data)); console.log('current location: ' + JSON.stringify(result));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error)); console.log('promise, getCurrentLocation: error=' + JSON.stringify(error));
}); });
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
...@@ -1180,20 +1087,21 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -1180,20 +1087,21 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
``` ```
## geoLocationManager.getAddressesFromLocationName ## geoLocationManager.getLastLocation
getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void getLastLocation(): Location
调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 获取上一次位置。
**系统能力**：SystemCapability.Location.Location.Geocoder **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**参数**： **系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | | Location | [Location](#location) | NA | 位置信息。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -1201,48 +1109,35 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt ...@@ -1201,48 +1109,35 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301400 | Geocoding query failed. | |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';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try { try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { let location = geoLocationManager.getLastLocation();
if (err) {
console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getAddressesFromLocationName ## geoLocationManager.isLocationEnabled
getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。
**系统能力**：SystemCapability.Location.Location.Geocoder isLocationEnabled(): boolean
**参数**： 判断位置服务是否已经使能。
| 参数名 | 类型 | 必填 | 说明 | **系统能力**：SystemCapability.Location.Location.Core
| -------- | -------- | -------- | -------- |
| request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
**返回值**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理编码查询结果。 | | boolean | boolean | NA | 位置服务是否已经使能。 |
**错误码**： **错误码**：
...@@ -1250,39 +1145,37 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd ...@@ -1250,39 +1145,37 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd
| 错误码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';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try { try {
geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => { let locationEnabled = geoLocationManager.isLocationEnabled();
console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.isGeocoderAvailable
isGeocoderAvailable(): boolean; ## geoLocationManager.enableLocation
判断（逆）地理编码服务状态。 enableLocation(callback: AsyncCallback&lt;void&gt;): void;
**系统能力**：SystemCapability.Location.Location.Geocoder 打开位置服务，使用callback回调异步返回结果。
**返回值**： **系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 返回（逆）地理编码服务是否可用。 | | callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码信息。 |
**错误码**： **错误码**：
...@@ -1290,35 +1183,41 @@ isGeocoderAvailable(): boolean; ...@@ -1290,35 +1183,41 @@ isGeocoderAvailable(): boolean;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { try {
var isAvailable = geoLocationManager.isGeocoderAvailable(); geoLocationManager.enableLocation((err, data) => {
if (err) {
console.log('enableLocation: err=' + JSON.stringify(err));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCachedGnssLocationsSize ## geoLocationManager.enableLocation
getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; enableLocation(): Promise&lt;void&gt;
获取GNSS芯片缓存位置的个数。 打开位置服务，使用Promise方式异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **系统API**：此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Location.Location.Gnss **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**参数**： **系统能力**：SystemCapability.Location.Location.Core
**返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | | Promise&lt;void&gt; | void | NA | 返回错误码信息。 |
**错误码**： **错误码**：
...@@ -1326,43 +1225,35 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; ...@@ -1326,43 +1225,35 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&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';
try { try {
geoLocationManager.getCachedGnssLocationsSize((err, size) => { geoLocationManager.enableLocation().then((result) => {
if (err) { console.log('promise, enableLocation succeed');
console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err)); })
} .catch((error) => {
if (size) { console.log('promise, enableLocation: error=' + JSON.stringify(error));
console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
}
}); });
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.disableLocation
## geoLocationManager.getCachedGnssLocationsSize disableLocation(): void;
getCachedGnssLocationsSize(): Promise&lt;number&gt;;
获取GNSS芯片缓存位置的个数。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION 关闭位置服务。
**系统能力**：SystemCapability.Location.Location.Gnss **系统API**：此接口为系统接口，三方应用不支持调用。
**返回值**： **需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
| 参数名 | 类型 | 必填 | 说明 | **系统能力**：SystemCapability.Location.Location.Core
| -------- | -------- | -------- | -------- |
| Promise&lt;number&gt; | number | NA | 返回GNSS缓存位置的个数。 |
**错误码**： **错误码**：
...@@ -1370,41 +1261,35 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;; ...@@ -1370,41 +1261,35 @@ getCachedGnssLocationsSize(): Promise&lt;number&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';
try { try {
geoLocationManager.getCachedGnssLocationsSize().then((result) => { geoLocationManager.disableLocation();
console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.flushCachedGnssLocations
flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void; ## geoLocationManager.getAddressesFromLocation
读取并清空GNSS芯片所有缓存位置。 getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。
**系统能力**：SystemCapability.Location.Location.Gnss **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码信息。 | | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收逆地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -1413,17 +1298,20 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void; ...@@ -1413,17 +1298,20 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301300 | Reverse geocoding query failed. |
|3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try { try {
geoLocationManager.flushCachedGnssLocations((err, result) => { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('flushCachedGnssLocations: err=' + JSON.stringify(err)); console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocation: data=' + JSON.stringify(data));
} }
}); });
} catch (err) { } catch (err) {
...@@ -1432,21 +1320,25 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void; ...@@ -1432,21 +1320,25 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.flushCachedGnssLocations ## geoLocationManager.getAddressesFromLocation
flushCachedGnssLocations(): Promise&lt;void&gt;; getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;;
读取并清空GNSS芯片所有缓存位置。 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。
**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder
**系统能力**：SystemCapability.Location.Location.Gnss **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 |
**返回值**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | void | NA | 接收错误码。 | | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理描述信息。 |
**错误码**： **错误码**：
...@@ -1455,19 +1347,19 @@ flushCachedGnssLocations(): Promise&lt;void&gt;; ...@@ -1455,19 +1347,19 @@ flushCachedGnssLocations(): Promise&lt;void&gt;;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off. | |3301300 | Reverse geocoding query failed. |
|3301200 | Failed to obtain the geographical location. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
try { try {
geoLocationManager.flushCachedGnssLocations().then((result) => { geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
console.log('promise, flushCachedGnssLocations success'); console.log('getAddressesFromLocation: ' + JSON.stringify(data));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error)); console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error));
}); });
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
...@@ -1475,20 +1367,20 @@ flushCachedGnssLocations(): Promise&lt;void&gt;; ...@@ -1475,20 +1367,20 @@ flushCachedGnssLocations(): Promise&lt;void&gt;;
``` ```
## geoLocationManager.sendCommand ## geoLocationManager.getAddressesFromLocationName
sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void; getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt;Array&lt;GeoAddress&gt;&gt;): void
给位置服务子系统的各个部件发送扩展命令。 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码。 | | callback | AsyncCallback&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | 是 | 接收地理编码结果的回调函数。 |
**错误码**： **错误码**：
...@@ -1497,16 +1389,20 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void ...@@ -1497,16 +1389,20 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void
| 错误码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';
var requestInfo = {'scenario': 0x301, 'command': "command_1"}; let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try { try {
geoLocationManager.sendCommand(requestInfo, (err, result) => { geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('sendCommand: err=' + JSON.stringify(err)); console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
}
if (data) {
console.log('getAddressesFromLocationName: data=' + JSON.stringify(data));
} }
}); });
} catch (err) { } catch (err) {
...@@ -1515,25 +1411,25 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void ...@@ -1515,25 +1411,25 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void
``` ```
## geoLocationManager.sendCommand ## geoLocationManager.getAddressesFromLocationName
sendCommand(command: LocationCommand): Promise&lt;void&gt;; getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAddress&gt;&gt;
给位置服务子系统的各个部件发送扩展命令。 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 |
**返回值**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | void | NA | 接收错误码。 | | Promise&lt;Array&lt;[GeoAddress](#geoaddress)&gt;&gt; | Array&lt;[GeoAddress](#geoaddress)&gt; | NA | 返回地理编码查询结果。 |
**错误码**： **错误码**：
...@@ -1541,39 +1437,39 @@ sendCommand(command: LocationCommand): Promise&lt;void&gt;; ...@@ -1541,39 +1437,39 @@ sendCommand(command: LocationCommand): Promise&lt;void&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';
var requestInfo = {'scenario': 0x301, 'command': "command_1"}; let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
try { try {
geoLocationManager.sendCommand(requestInfo).then((result) => { geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => {
console.log('promise, sendCommand success'); console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
}) })
.catch((error) => { .catch((error) => {
console.log('promise, sendCommand: error=' + JSON.stringify(error)); console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error));
}); });
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.isGeocoderAvailable
## geoLocationManager.getCountryCode isGeocoderAvailable(): boolean;
getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void;
查询当前的国家码。 判断（逆）地理编码服务状态。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Geocoder
**参数**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;[CountryCode](#countrycode)&gt; | 是 | 用来接收国家码。 | | boolean | boolean | NA | 返回（逆）地理编码服务是否可用。 |
**错误码**： **错误码**：
...@@ -1581,41 +1477,35 @@ getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void; ...@@ -1581,41 +1477,35 @@ 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.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { try {
geoLocationManager.getCountryCode((err, result) => { let isAvailable = geoLocationManager.isGeocoderAvailable();
if (err) {
console.log('getCountryCode: err=' + JSON.stringify(err));
}
if (result) {
console.log('getCountryCode: result=' + JSON.stringify(result));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.getCountryCode ## geoLocationManager.getCachedGnssLocationsSize
getCountryCode(): Promise&lt;CountryCode&gt;; getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
查询当前的国家码。 获取GNSS芯片缓存位置的个数。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**返回值**： **系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| Promise&lt;[CountryCode](#countrycode)&gt; | [CountryCode](#countrycode) | NA | 用来接收国家码。 | | callback | AsyncCallback&lt;number&gt; | 是 | 用来接收GNSS芯片缓存位置个数的回调。 |
**错误码**： **错误码**：
...@@ -1623,20 +1513,21 @@ getCountryCode(): Promise&lt;CountryCode&gt;; ...@@ -1623,20 +1513,21 @@ 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. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { try {
geoLocationManager.getCountryCode() geoLocationManager.getCachedGnssLocationsSize((err, size) => {
.then((result) => { if (err) {
console.log('promise, getCountryCode: result=' + JSON.stringify(result)); console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err));
}) }
.catch((error) => { if (size) {
console.log('promise, getCountryCode: error=' + JSON.stringify(error)); console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size));
}
}); });
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
...@@ -1644,15 +1535,21 @@ getCountryCode(): Promise&lt;CountryCode&gt;; ...@@ -1644,15 +1535,21 @@ getCountryCode(): Promise&lt;CountryCode&gt;;
``` ```
## geoLocationManager.enableLocationMock ## geoLocationManager.getCachedGnssLocationsSize
enableLocationMock(): void; getCachedGnssLocationsSize(): Promise&lt;number&gt;;
使能位置模拟功能。 获取GNSS芯片缓存位置的个数。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统能力**：SystemCapability.Location.Location.Gnss
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Promise&lt;number&gt; | number | NA | 返回GNSS缓存位置的个数。 |
**错误码**： **错误码**：
...@@ -1660,30 +1557,41 @@ enableLocationMock(): void; ...@@ -1660,30 +1557,41 @@ enableLocationMock(): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.| |3301100 | The location switch is off. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { try {
geoLocationManager.enableLocationMock(); geoLocationManager.getCachedGnssLocationsSize().then((result) => {
console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.disableLocationMock ## geoLocationManager.flushCachedGnssLocations
disableLocationMock(): void; flushCachedGnssLocations(callback: AsyncCallback&lt;void&gt;): void;
去使能位置模拟功能。 读取并清空GNSS芯片所有缓存位置。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统能力**：SystemCapability.Location.Location.Gnss
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码信息。 |
**错误码**： **错误码**：
...@@ -1691,36 +1599,41 @@ disableLocationMock(): void; ...@@ -1691,36 +1599,41 @@ disableLocationMock(): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.| |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';
try { try {
geoLocationManager.disableLocationMock(); geoLocationManager.flushCachedGnssLocations((err, result) => {
if (err) {
console.log('flushCachedGnssLocations: err=' + JSON.stringify(err));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.setMockedLocations ## geoLocationManager.flushCachedGnssLocations
setMockedLocations(config: LocationMockConfig): void; flushCachedGnssLocations(): Promise&lt;void&gt;;
设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 读取并清空GNSS芯片所有缓存位置。
**系统能力**：SystemCapability.Location.Location.Core **需要权限**：ohos.permission.APPROXIMATELY_LOCATION
**系统API**：此接口为系统接口，三方应用不支持调用。 **系统能力**：SystemCapability.Location.Location.Gnss
**参数**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | | Promise&lt;void&gt; | void | NA | 接收错误码。 |
**错误码**： **错误码**：
...@@ -1728,38 +1641,41 @@ setMockedLocations(config: LocationMockConfig): void; ...@@ -1728,38 +1641,41 @@ setMockedLocations(config: LocationMockConfig): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301100 | The location switch is off.| |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';
var locations = [
{"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true},
{"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true}
];
var config = {"timeInterval": 5, "locations": locations};
try { try {
geoLocationManager.setMockedLocations(config); geoLocationManager.flushCachedGnssLocations().then((result) => {
console.log('promise, flushCachedGnssLocations success');
})
.catch((error) => {
console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.enableReverseGeocodingMock ## geoLocationManager.sendCommand
enableReverseGeocodingMock(): void; sendCommand(command: LocationCommand, callback: AsyncCallback&lt;void&gt;): void;
使能逆地理编码模拟功能。 给位置服务子系统的各个部件发送扩展命令。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。 **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码。 |
**错误码**： **错误码**：
...@@ -1767,29 +1683,44 @@ enableReverseGeocodingMock(): void; ...@@ -1767,29 +1683,44 @@ enableReverseGeocodingMock(): void;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
let requestInfo = {'scenario': 0x301, 'command': "command_1"};
try { try {
geoLocationManager.enableReverseGeocodingMock(); geoLocationManager.sendCommand(requestInfo, (err, result) => {
if (err) {
console.log('sendCommand: err=' + JSON.stringify(err));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.disableReverseGeocodingMock ## geoLocationManager.sendCommand
disableReverseGeocodingMock(): void; sendCommand(command: LocationCommand): Promise&lt;void&gt;;
去使能逆地理编码模拟功能。 给位置服务子系统的各个部件发送扩展命令。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。 **参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 |
**返回值**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| Promise&lt;void&gt; | void | NA | 接收错误码。 |
**错误码**： **错误码**：
...@@ -1800,32 +1731,36 @@ disableReverseGeocodingMock(): void; ...@@ -1800,32 +1731,36 @@ disableReverseGeocodingMock(): void;
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
let requestInfo = {'scenario': 0x301, 'command': "command_1"};
try { try {
geoLocationManager.disableReverseGeocodingMock(); geoLocationManager.sendCommand(requestInfo).then((result) => {
console.log('promise, sendCommand success');
})
.catch((error) => {
console.log('promise, sendCommand: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.setReverseGeocodingMockInfo ## geoLocationManager.getCountryCode
setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): void; getCountryCode(callback: AsyncCallback&lt;CountryCode&gt;): void;
设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 查询当前的国家码。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数**： **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | | callback | AsyncCallback&lt;[CountryCode](#countrycode)&gt; | 是 | 用来接收国家码。 |
**错误码**： **错误码**：
...@@ -1834,47 +1769,40 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): v ...@@ -1834,47 +1769,40 @@ setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): v
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301500 | Failed to query the area information.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
var mockInfos = [
{"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
try { try {
geoLocationManager.setReverseGeocodingMockInfo(mockInfos); geoLocationManager.getCountryCode((err, result) => {
if (err) {
console.log('getCountryCode: err=' + JSON.stringify(err));
}
if (result) {
console.log('getCountryCode: result=' + JSON.stringify(result));
}
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.getCountryCode
isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 getCountryCode(): Promise&lt;CountryCode&gt;;
**系统API**：此接口为系统接口，三方应用不支持调用。 查询当前的国家码。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
**返回值**： **返回值**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 | | Promise&lt;[CountryCode](#countrycode)&gt; | [CountryCode](#countrycode) | NA | 用来接收国家码。 |
**错误码**： **错误码**：
...@@ -1883,37 +1811,35 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; ...@@ -1883,37 +1811,35 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- | | -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. | |3301000 | Location service is unavailable. |
|3301500 | Failed to query the area information.|
**示例** **示例**
```ts ```ts
import geoLocationManager from '@ohos.geoLocationManager'; import geoLocationManager from '@ohos.geoLocationManager';
try { try {
var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); geoLocationManager.getCountryCode()
.then((result) => {
console.log('promise, getCountryCode: result=' + JSON.stringify(result));
})
.catch((error) => {
console.log('promise, getCountryCode: error=' + JSON.stringify(error));
});
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## geoLocationManager.setLocationPrivacyConfirmStatus ## geoLocationManager.enableLocationMock
setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。
**系统API**：此接口为系统接口，三方应用不支持调用。 enableLocationMock(): void;
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS 使能位置模拟功能。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
**参数**： **系统API**：此接口为系统接口，三方应用不支持调用。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
**错误码**： **错误码**：
...@@ -1922,287 +1848,281 @@ setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean) ...@@ -1922,287 +1848,281 @@ 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';
try { try {
geoLocationManager.setLocationPrivacyConfirmStatus(1, true); geoLocationManager.enableLocationMock();
} catch (err) { } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message); console.error("errCode:" + err.code + ",errMessage:" + err.message);
} }
``` ```
## LocationRequestPriority ## geoLocationManager.disableLocationMock
位置请求中位置信息优先级设置。
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 |
## LocationRequestScenario disableLocationMock(): void;
位置请求中定位场景设置。 去使能位置模拟功能。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 | **系统API**：此接口为系统接口，三方应用不支持调用。
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## ReverseGeoCodeRequest **错误码**：
逆地理编码请求接口。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
**系统能力**：SystemCapability.Location.Location.Geocoder | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
| 名称 | 类型 | 可读 | 可写 | 说明 | **示例**
| -------- | -------- | -------- | -------- | -------- |
| locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 |
| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 |
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
geoLocationManager.disableLocationMock();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## GeoCodeRequest
地理编码请求接口。 ## geoLocationManager.setMockedLocations
**系统能力**：SystemCapability.Location.Location.Geocoder setMockedLocations(config: LocationMockConfig): void;
| 名称 | 类型 | 可读|可写 | 说明 | 设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。
| -------- | -------- | -------- | -------- | -------- |
| locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| description | string | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 |
| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 |
| minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 |
| minLongitude | number | 是 | 是 | 表示最小经度信息。 |
| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 |
| maxLongitude | number | 是 | 是 | 表示最大经度信息。 |
该接口需要在调用[enableLocationMock](#enablelocationmock)之后才能调用。
## GeoAddress **系统能力**：SystemCapability.Location.Location.Core
地理编码类型。 **系统API**：此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Location.Location.Geocoder **参数**：
| 名称 | 类型 | 可读|可写 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 |
| longitude | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| locale | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 |
| placeName | string | 是 | 否 | 表示地区信息。 |
| countryCode | string | 是 | 否 | 表示国家码信息。 |
| countryName | string| 是 | 否 | 表示国家信息。 |
| administrativeArea | string | 是 | 否 | 表示省份区域信息。 |
| subAdministrativeArea | string | 是 | 否 | 表示表示子区域信息。 |
| locality | string | 是 | 否 | 表示城市信息。 |
| subLocality | string | 是 | 否 | 表示子城市信息。 |
| roadName | string | 是 | 否 |表示路名信息。 |
| subRoadName | string | 是 | 否 | 表示子路名信息。 |
| premises | string| 是 | 否|表示门牌号信息。 |
| postalCode | string | 是 | 否 | 表示邮政编码信息。 |
| phoneNumber | string | 是 | 否 | 表示联系方式信息。 |
| addressUrl | string | 是 | 否 | 表示位置信息附件的网址信息。 |
| descriptions | Array&lt;string&gt; | 是 | 否 | 表示附加的描述信息。 |
| descriptionsSize | number | 是 | 否 | 表示附加的描述信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 |
**错误码**：
## LocationRequest 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
位置信息请求类型。 | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
|3301100 | The location switch is off.|
**系统能力**：SystemCapability.Location.Location.Core **示例**
| 名称 | 类型 | 可读|可写 | 说明 | ```ts
| -------- | -------- | -------- | -------- | -------- | import geoLocationManager from '@ohos.geoLocationManager';
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 | let locations = [
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 | {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true},
| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 | {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true},
| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 | {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true},
| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | {"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}
];
let config = {"timeInterval": 5, "locations": locations};
try {
geoLocationManager.enableLocationMock();
geoLocationManager.setMockedLocations(config);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## CurrentLocationRequest ## geoLocationManager.enableReverseGeocodingMock
当前位置信息请求类型。 enableReverseGeocodingMock(): void;
使能逆地理编码模拟功能。
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 可读|可写 | 说明 | **系统API**：此接口为系统接口，三方应用不支持调用。
| -------- | -------- | -------- | -------- | -------- |
| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 |
| maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 |
| timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 |
**错误码**：
## SatelliteStatusInfo 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
卫星状态信息。 | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**系统能力**：SystemCapability.Location.Location.Gnss **示例**
| 名称 | 类型 | 可读|可写 | 说明 | ```ts
| -------- | -------- | -------- | -------- | -------- | import geoLocationManager from '@ohos.geoLocationManager';
| satellitesNumber | number | 是 | 否 | 表示卫星个数。 | try {
| satelliteIds | Array&lt;number&gt; | 是 | 否 | 表示每个卫星的ID，数组类型。 | geoLocationManager.enableReverseGeocodingMock();
| carrierToNoiseDensitys | Array&lt;number&gt; | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 | } catch (err) {
| altitudes | Array&lt;number&gt; | 是 | 否 | 表示高程信息。 | console.error("errCode:" + err.code + ",errMessage:" + err.message);
| azimuths | Array&lt;number&gt; | 是 | 否 | 表示方位角。 | }
| carrierFrequencies | Array&lt;number&gt; | 是 | 否 | 表示载波频率。 | ```
## CachedGnssLocationsRequest ## geoLocationManager.disableReverseGeocodingMock
请求订阅GNSS缓存位置上报功能接口的配置参数。 disableReverseGeocodingMock(): void;
**系统能力**：SystemCapability.Location.Location.Gnss 去使能逆地理编码模拟功能。
| 名称 | 类型 | 可读|可写 | 说明 | **系统能力**：SystemCapability.Location.Location.Core
| -------- | -------- | -------- | -------- | -------- |
| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 |
| wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。<br/>false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 |
**系统API**：此接口为系统接口，三方应用不支持调用。
## Geofence **错误码**：
GNSS围栏的配置参数。目前只支持圆形围栏。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
**系统能力**：SystemCapability.Location.Location.Geofence | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
| 名称 | 类型 | 可读|可写 | 说明 | **示例**
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 是 |表示纬度。 |
| longitude | number | 是 |是 | 表示经度。 |
| radius | number | 是 |是 | 表示圆形围栏的半径。 |
| expiration | number | 是 |是 | 围栏存活的时间，单位是毫秒。 |
```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
geoLocationManager.disableReverseGeocodingMock();
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## GeofenceRequest
请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 ## geoLocationManager.setReverseGeocodingMockInfo
**系统能力**：SystemCapability.Location.Location.Geofence setReverseGeocodingMockInfo(mockInfos: Array&lt;ReverseGeocodingMockInfo&gt;): void;
| 名称 | 类型 | 可读|可写 | 说明 | 设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。
| -------- | -------- | -------- | -------- | -------- |
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 |
| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 |
该接口需要在调用[enableReverseGeocodingMock](#enablereversegeocodingmock)之后才能调用。
## LocationPrivacyType **系统能力**：SystemCapability.Location.Location.Core
定位服务隐私协议类型。 **系统API**：此接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Location.Location.Core **参数**：
| 名称 | 值 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 | | mockInfos | Array&lt;[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)&gt; | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
**错误码**：
## LocationCommand 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
扩展命令结构体。 | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**系统能力**：SystemCapability.Location.Location.Core **示例**
| 名称 | 类型 | 可读|可写 | 说明 | ```ts
| -------- | -------- | -------- | -------- | -------- | import geoLocationManager from '@ohos.geoLocationManager';
| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | let mockInfos = [
| command | string | 是 | 是 | 扩展命令字符串。 | {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}},
{"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}},
];
try {
geoLocationManager.enableReverseGeocodingMock();
geoLocationManager.setReverseGeocodingMockInfo(mockInfos);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
## Location ## geoLocationManager.isLocationPrivacyConfirmed
位置信息类型。 isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
**系统能力**：SystemCapability.Location.Location.Core 查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。
| 名称 | 类型 | 可读|可写 | 说明 | **系统API**：此接口为系统接口，三方应用不支持调用。
| -------- | -------- | -------- | -------- | -------- |
| latitude | number| 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 |
| longitude | number| 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 |
| altitude | number | 是 | 否 | 表示高度信息，单位米。 |
| accuracy | number | 是 | 否 | 表示精度信息，单位米。 |
| speed | number | 是 | 否 |表示速度信息，单位米每秒。 |
| timeStamp | number | 是 | 否 | 表示位置时间戳，UTC格式。 |
| direction | number | 是 | 否 | 表示航向信息。 |
| timeSinceBoot | number | 是 | 否 | 表示位置时间戳，开机时间格式。 |
| additions | Array&lt;string&gt; | 是 | 否 | 附加信息。 |
| additionSize | number | 是 | 否 | 附加信息数量。 |
| isFromMock | Boolean | 是 | 否 | 表示位置信息是否来自于位置模拟功能。 |
**系统能力**：SystemCapability.Location.Location.Core
## ReverseGeocodingMockInfo **参数**：
逆地理编码模拟功能的配置信息，包含一个位置信息和一个地名信息。 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
**系统能力**：SystemCapability.Location.Location.Core **返回值**：
**系统API**：此接口为系统接口，三方应用不支持调用。 | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 |
| 名称 | 类型 | 可读|可写 | 说明 | **错误码**：
| -------- | -------- | -------- | -------- | -------- |
| location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 |
| geoAddress | [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 |
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
## LocationMockConfig | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
位置模拟功能的配置参数，包含了模拟位置上报的时间间隔和模拟位置数组。 **示例**
**系统能力**：SystemCapability.Location.Location.Core ```ts
import geoLocationManager from '@ohos.geoLocationManager';
try {
let isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1);
} catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
**系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读|可写 | 说明 | ## geoLocationManager.setLocationPrivacyConfirmStatus
| -------- | -------- | -------- | -------- | -------- |
| timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔，单位是秒。 |
| locations | Array&lt;Location&gt; | 是 | 是 | 表示模拟位置数组。 |
setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
## CountryCode 设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。
国家码信息结构体，包含国家码字符串和国家码的来源信息。 **系统API**：此接口为系统接口，三方应用不支持调用。
**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**：SystemCapability.Location.Location.Core **系统能力**：SystemCapability.Location.Location.Core
| 名称 | 类型 | 可读|可写 | 说明 | **参数**：
| -------- | -------- | -------- | -------- | -------- |
| country | string | 是 | 否 | 表示国家码字符串。 |
| type | [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 |
## CountryCodeType **错误码**：
国家码来源类型。 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。
**系统能力**：SystemCapability.Location.Location.Core | 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
| 名称 | 值 | 说明 | **示例**
| -------- | -------- | -------- |
| COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 | ```ts
| COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 | import geoLocationManager from '@ohos.geoLocationManager';
| COUNTRY_CODE_FROM_LOCATION | 3 | 基于用户的位置信息，通过逆地理编码查询到的国家码。 | try {
| COUNTRY_CODE_FROM_NETWORK | 4 | 从蜂窝网络注册信息中获取到的国家码。 | geoLocationManager.setLocationPrivacyConfirmStatus(1, true);
\ No newline at end of file } catch (err) {
console.error("errCode:" + err.code + ",errMessage:" + err.message);
}
```
zh-cn/application-dev/reference/apis/js-apis-geolocation.md
浏览文件 @ 634da1ad
...@@ -68,8 +68,8 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat ...@@ -68,8 +68,8 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => { let locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location)); console.log('locationChanger: data: ' + JSON.stringify(location));
}; };
geolocation.on('locationChange', requestInfo, locationChange); geolocation.on('locationChange', requestInfo, locationChange);
...@@ -101,8 +101,8 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void ...@@ -101,8 +101,8 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; let requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => { let locationChange = (location) => {
console.log('locationChanger: data: ' + JSON.stringify(location)); console.log('locationChanger: data: ' + JSON.stringify(location));
}; };
geolocation.on('locationChange', requestInfo, locationChange); geolocation.on('locationChange', requestInfo, locationChange);
...@@ -135,7 +135,7 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void ...@@ -135,7 +135,7 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var locationServiceState = (state) => { let locationServiceState = (state) => {
console.log('locationServiceState: ' + JSON.stringify(state)); console.log('locationServiceState: ' + JSON.stringify(state));
} }
geolocation.on('locationServiceState', locationServiceState); geolocation.on('locationServiceState', locationServiceState);
...@@ -167,7 +167,7 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void; ...@@ -167,7 +167,7 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var locationServiceState = (state) => { let locationServiceState = (state) => {
console.log('locationServiceState: state: ' + JSON.stringify(state)); console.log('locationServiceState: state: ' + JSON.stringify(state));
} }
geolocation.on('locationServiceState', locationServiceState); geolocation.on('locationServiceState', locationServiceState);
...@@ -202,10 +202,10 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ...@@ -202,10 +202,10 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var cachedLocationsCb = (locations) => { let cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
} }
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
``` ```
...@@ -236,10 +236,10 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati ...@@ -236,10 +236,10 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var cachedLocationsCb = (locations) => { let cachedLocationsCb = (locations) => {
console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations)); console.log('cachedGnssLocationsReporting: locations: ' + JSON.stringify(locations));
} }
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; let requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
geolocation.off('cachedGnssLocationsReporting'); geolocation.off('cachedGnssLocationsReporting');
``` ```
...@@ -271,7 +271,7 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi ...@@ -271,7 +271,7 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var gnssStatusCb = (satelliteStatusInfo) => { let gnssStatusCb = (satelliteStatusInfo) => {
console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo)); console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
} }
geolocation.on('gnssStatusChange', gnssStatusCb); geolocation.on('gnssStatusChange', gnssStatusCb);
...@@ -303,7 +303,7 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v ...@@ -303,7 +303,7 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var gnssStatusCb = (satelliteStatusInfo) => { let gnssStatusCb = (satelliteStatusInfo) => {
console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo)); console.log('gnssStatusChange: ' + JSON.stringify(satelliteStatusInfo));
} }
geolocation.on('gnssStatusChange', gnssStatusCb); geolocation.on('gnssStatusChange', gnssStatusCb);
...@@ -337,7 +337,7 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void; ...@@ -337,7 +337,7 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var nmeaCb = (str) => { let nmeaCb = (str) => {
console.log('nmeaMessageChange: ' + JSON.stringify(str)); console.log('nmeaMessageChange: ' + JSON.stringify(str));
} }
geolocation.on('nmeaMessageChange', nmeaCb ); geolocation.on('nmeaMessageChange', nmeaCb );
...@@ -370,7 +370,7 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void; ...@@ -370,7 +370,7 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var nmeaCb = (str) => { let nmeaCb = (str) => {
console.log('nmeaMessageChange: ' + JSON.stringify(str)); console.log('nmeaMessageChange: ' + JSON.stringify(str));
} }
geolocation.on('nmeaMessageChange', nmeaCb); geolocation.on('nmeaMessageChange', nmeaCb);
...@@ -411,7 +411,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -411,7 +411,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility", abilityName: "EntryAbility",
action: "action1", action: "action1",
} }
], ],
...@@ -421,7 +421,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -421,7 +421,7 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
}); });
``` ```
...@@ -459,7 +459,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -459,7 +459,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
wants: [ wants: [
{ {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
abilityName: "com.example.myapplication.MainAbility", abilityName: "EntryAbility",
action: "action1", action: "action1",
} }
], ],
...@@ -469,7 +469,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -469,7 +469,7 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
}; };
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; let requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
geolocation.on('fenceStatusChange', requestInfo, wantAgentObj); geolocation.on('fenceStatusChange', requestInfo, wantAgentObj);
geolocation.off('fenceStatusChange', requestInfo, wantAgentObj); geolocation.off('fenceStatusChange', requestInfo, wantAgentObj);
}); });
...@@ -500,8 +500,8 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L ...@@ -500,8 +500,8 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
var locationChange = (err, location) => { let locationChange = (err, location) => {
if (err) { if (err) {
console.log('locationChanger: err=' + JSON.stringify(err)); console.log('locationChanger: err=' + JSON.stringify(err));
} }
...@@ -537,7 +537,7 @@ getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void ...@@ -537,7 +537,7 @@ getCurrentLocation(callback: AsyncCallback&lt;Location&gt;): void
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var locationChange = (err, location) => { let locationChange = (err, location) => {
if (err) { if (err) {
console.log('locationChanger: err=' + JSON.stringify(err)); console.log('locationChanger: err=' + JSON.stringify(err));
} }
...@@ -579,7 +579,7 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; ...@@ -579,7 +579,7 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; let requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
geolocation.getCurrentLocation(requestInfo).then((result) => { geolocation.getCurrentLocation(requestInfo).then((result) => {
console.log('current location: ' + JSON.stringify(result)); console.log('current location: ' + JSON.stringify(result));
}); });
...@@ -721,7 +721,7 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -721,7 +721,7 @@ requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求打开位置服务，使用callback回调异步返回结果。 请求打开位置服务，使用callback回调异步返回结果。
> **说明：**<br/> > **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。 > 从API version 9开始废弃，建议由应用本身弹框请求用户跳转到settings开启位置开关，并且在弹框上写清楚会在什么场景下使用位置信息。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
...@@ -755,7 +755,7 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -755,7 +755,7 @@ requestEnableLocation(): Promise&lt;boolean&gt;
请求打开位置服务，使用Promise方式异步返回结果。 请求打开位置服务，使用Promise方式异步返回结果。
> **说明：**<br/> > **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。 > 从API version 9开始废弃，建议由应用本身弹框请求用户跳转到settings开启位置开关，并且在弹框上写清楚会在什么场景下使用位置信息。
**需要权限**：ohos.permission.LOCATION **需要权限**：ohos.permission.LOCATION
...@@ -864,7 +864,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ...@@ -864,7 +864,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); console.log('getAddressesFromLocation: err=' + JSON.stringify(err));
...@@ -905,7 +905,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -905,7 +905,7 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; let reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {
console.log('getAddressesFromLocation: ' + JSON.stringify(data)); console.log('getAddressesFromLocation: ' + JSON.stringify(data));
}); });
...@@ -936,7 +936,7 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt ...@@ -936,7 +936,7 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {
if (err) { if (err) {
console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); console.log('getAddressesFromLocationName: err=' + JSON.stringify(err));
...@@ -977,7 +977,7 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd ...@@ -977,7 +977,7 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; let geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => { geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => {
console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
}); });
...@@ -1139,7 +1139,7 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v ...@@ -1139,7 +1139,7 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'scenario': 0x301, 'command': "command_1"}; let requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo, (err, result) => { geolocation.sendCommand(requestInfo, (err, result) => {
if (err) { if (err) {
console.log('sendCommand: err=' + JSON.stringify(err)); console.log('sendCommand: err=' + JSON.stringify(err));
...@@ -1181,75 +1181,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1181,75 +1181,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
```ts ```ts
import geolocation from '@ohos.geolocation'; import geolocation from '@ohos.geolocation';
var requestInfo = {'scenario': 0x301, 'command': "command_1"}; let requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo).then((result) => { geolocation.sendCommand(requestInfo).then((result) => {
console.log('promise, sendCommand: ' + JSON.stringify(result)); console.log('promise, sendCommand: ' + JSON.stringify(result));
}); });
``` ```
## LocationRequestPriority<sup>(deprecated) </sup>
位置请求中位置信息优先级设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 |
## LocationRequestScenario<sup>(deprecated) </sup>
位置请求中定位场景设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## GeoLocationErrorCode<sup>(deprecated) </sup>
位置服务中的错误码信息。
> **说明：**<br/>
> 从API version 9开始废弃。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 |
| REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 |
| GEOCODE_ERROR<sup>7+</sup> | 103 | 表示地理编码接口调用失败。 |
| LOCATOR_ERROR<sup>7+</sup> | 104 | 表示定位失败。 |
| LOCATION_SWITCH_ERROR<sup>7+</sup> | 105 | 表示定位开关。 |
| LAST_KNOWN_LOCATION_ERROR<sup>7+</sup> | 106 | 表示获取上次位置失败。 |
| LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位，没有在指定时间内返回位置。 |
## ReverseGeoCodeRequest<sup>(deprecated) </sup> ## ReverseGeoCodeRequest<sup>(deprecated) </sup>
逆地理编码请求接口。 逆地理编码请求接口。
...@@ -1442,25 +1380,6 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1442,25 +1380,6 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | | geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 |
## LocationPrivacyType<sup>(deprecated) </sup>
定位服务隐私协议类型。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
## LocationCommand<sup>(deprecated) </sup> ## LocationCommand<sup>(deprecated) </sup>
扩展命令结构体。 扩展命令结构体。
...@@ -1501,4 +1420,85 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1501,4 +1420,85 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
| 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
## LocationPrivacyType<sup>(deprecated) </sup>
定位服务隐私协议类型。
> **说明：**<br/>
> 从API version 8开始支持。
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| OTHERS | 0 | 其他场景。 |
| STARTUP | 1 | 开机向导场景下的隐私协议。 |
| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 |
## LocationRequestPriority<sup>(deprecated) </sup>
位置请求中位置信息优先级设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x200 | 表示未设置优先级。 |
| ACCURACY | 0x201 | 表示精度优先。 |
| LOW_POWER | 0x202 | 表示低功耗优先。 |
| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 |
## LocationRequestScenario<sup>(deprecated) </sup>
位置请求中定位场景设置。
> **说明：**<br/>
> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| UNSET | 0x300 | 表示未设置场景信息。 |
| NAVIGATION | 0x301 | 表示导航场景。 |
| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 |
| CAR_HAILING | 0x303 | 表示打车场景。 |
| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 |
| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 |
## GeoLocationErrorCode<sup>(deprecated) </sup>
位置服务中的错误码信息。
> **说明：**<br/>
> 从API version 9开始废弃。
**需要权限**：ohos.permission.LOCATION
**系统能力**：SystemCapability.Location.Location.Core
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INPUT_PARAMS_ERROR<sup>7+</sup> | 101 | 表示输入参数错误。 |
| REVERSE_GEOCODE_ERROR<sup>7+</sup> | 102 | 表示逆地理编码接口调用失败。 |
| GEOCODE_ERROR<sup>7+</sup> | 103 | 表示地理编码接口调用失败。 |
| LOCATOR_ERROR<sup>7+</sup> | 104 | 表示定位失败。 |
| LOCATION_SWITCH_ERROR<sup>7+</sup> | 105 | 表示定位开关。 |
| LAST_KNOWN_LOCATION_ERROR<sup>7+</sup> | 106 | 表示获取上次位置失败。 |
| LOCATION_REQUEST_TIMEOUT_ERROR<sup>7+</sup> | 107 | 表示单次定位，没有在指定时间内返回位置。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-location.md
浏览文件 @ 634da1ad
# @system.geolocation (地理位置) # @system.geolocation (地理位置)
本模块仅提供GNSS定位、网络定位等基本功能。
> **说明：** > **说明：**
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 > - 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。
...@@ -7,7 +9,6 @@ ...@@ -7,7 +9,6 @@
## 导入模块 ## 导入模块
``` ```
import geolocation from '@system.geolocation'; import geolocation from '@system.geolocation';
``` ```
...@@ -84,7 +85,7 @@ getLocationType(Object): void ...@@ -84,7 +85,7 @@ getLocationType(Object): void
获取当前设备支持的定位类型。 获取当前设备支持的定位类型。
> **说明：**<br/> > **说明：**<br/>
> 从API version 9开始废弃。 > 从API version 9开始废弃。位置服务子系统仅支持gps和network两种定位类型，后续不再提供接口查询支持的定位类型。
**系统能力：** SystemCapability.Location.Location.Lite **系统能力：** SystemCapability.Location.Location.Lite
...@@ -204,7 +205,7 @@ getSupportedCoordTypes(): Array&lt;string&gt; ...@@ -204,7 +205,7 @@ getSupportedCoordTypes(): Array&lt;string&gt;
获取设备支持的坐标系类型。 获取设备支持的坐标系类型。
> **说明：**<br/> > **说明：**<br/>
> 从API version 9开始废弃。 > 从API version 9开始废弃。位置服务子系统仅支持wgs84坐标系，后续不再提供接口查询支持的坐标系类型。
**系统能力：** 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.
先完成此消息的编辑！
想要评论请 注册 或