From b636bf98c94514059bb989922d1c21a499554930 Mon Sep 17 00:00:00 2001 From: liu-binjun Date: Sat, 26 Nov 2022 17:31:44 +0800 Subject: [PATCH] bugfix:Rewind error code data modification Signed-off-by: liu-binjun --- .../device/device-location-geocoding.md | 38 +- .../device/device-location-info.md | 33 +- .../apis/js-apis-geoLocationManager.md | 1495 ++++------------- .../reference/apis/js-apis-geolocation.md | 471 +++--- .../reference/apis/js-apis-system-location.md | 28 +- 5 files changed, 604 insertions(+), 1461 deletions(-) diff --git a/zh-cn/application-dev/device/device-location-geocoding.md b/zh-cn/application-dev/device/device-location-geocoding.md index 2a5b0f843a..6a6eaf336b 100644 --- a/zh-cn/application-dev/device/device-location-geocoding.md +++ b/zh-cn/application-dev/device/device-location-geocoding.md @@ -14,17 +14,18 @@ ## 接口说明 -进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 +进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geolocation.md)。 **表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍 | 接口名 | 功能描述 | | -------- | -------- | -| isGeocoderAvailable(): boolean; | 判断（逆）地理编码服务状态。 | -| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 | -| getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>> | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 | -| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 | -| getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 | +| isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void | 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 | +| isGeoServiceAvailable() : Promise<boolean> | 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 | +| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 | +| getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>> | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 | +| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 | +| getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 | ## 开发步骤 @@ -32,22 +33,23 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 -1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 +1. 导入geolocation模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 ```ts - import geoLocationManager from '@ohos.geoLocationManager'; + import geolocation from '@ohos.geolocation'; ``` 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); - } + geolocation.isGeoServiceAvailable((err, data) => { + if (err) { + console.log('isGeoServiceAvailable err: ' + JSON.stringify(err)); + } else { + console.log('isGeoServiceAvailable data: ' + JSON.stringify(data)); + } + }); ``` 3. 获取转化结果。 @@ -55,7 +57,7 @@ ```ts var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; - geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); } else { @@ -64,12 +66,12 @@ }); ``` - 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 + 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 - 调用getAddressesFromLocationName位置描述转化坐标。 ```ts var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; - geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { + geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); } else { @@ -78,6 +80,6 @@ }); ``` - 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 + 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。 diff --git a/zh-cn/application-dev/device/device-location-info.md b/zh-cn/application-dev/device/device-location-info.md index 10f006b399..6a1954e0b7 100644 --- a/zh-cn/application-dev/device/device-location-info.md +++ b/zh-cn/application-dev/device/device-location-info.md @@ -10,12 +10,12 @@ ## 接口说明 -获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 +获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geolocation.md)。 ## 开发步骤 -如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 +如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geolocation.md)。 1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 系统提供的定位权限有： @@ -42,10 +42,10 @@ 开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。 -2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 +2. 导入geolocation模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; + ``` + import geolocation from '@ohos.geolocation'; ``` 3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。
@@ -78,8 +78,8 @@ 以导航场景为例，实例化方式如下： - ```ts - var requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ``` + var requestInfo = {'scenario': geolocation.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` **方式二：** @@ -108,7 +108,7 @@ 以定位精度优先策略为例，实例化方式如下： ```ts - var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var requestInfo = {'priority': geolocation.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` 4. 实例化Callback对象，用于向系统提供位置上报的途径。 @@ -123,24 +123,25 @@ 5. 启动定位。 ```ts - geoLocationManager.on('locationChange', requestInfo, locationChange); + geolocation.on('locationChange', requestInfo, locationChange); ``` 6. （可选）结束定位。 ```ts - geoLocationManager.off('locationChange', locationChange); + geolocation.off('locationChange', locationChange); ``` 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - try { - var location = geoLocationManager.getLastLocation(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + geolocation.getLastLocation((err, data) => { + if (err) { + console.log('getLastLocation: err: ' + JSON.stringify(err)); + } else { + console.log('getLastLocation: data: ' + JSON.stringify(data)); + } + }); ``` 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md index 7f46f13cb2..aacaa31355 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md @@ -41,735 +41,11 @@ import geoLocationManager from '@ohos.geoLocationManager'; ``` -## geoLocationManager.on('locationChange') - -on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void - -开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | - | request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 | - | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; - var locationChange = (location) => { - console.log('locationChanger: data: ' + JSON.stringify(location)); - }; - try { - geoLocationManager.on('locationChange', requestInfo, locationChange); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - - ``` - - -## geoLocationManager.off('locationChange') - -off(type: 'locationChange', callback?: Callback<Location>): void - -关闭位置变化订阅，并删除对应的定位请求。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | - | callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; - var locationChange = (location) => { - console.log('locationChanger: data: ' + JSON.stringify(location)); - }; - try { - geoLocationManager.on('locationChange', requestInfo, locationChange); - geoLocationManager.off('locationChange', locationChange); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.on('locationEnabledChange') - -on(type: 'locationEnabledChange', callback: Callback<boolean>): void - -订阅位置服务状态变化。 - -**系统能力**：SystemCapability.Location.Location.Core - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | - | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../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<boolean>): void; - -取消订阅位置服务状态变化。 - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | - | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var locationEnabledChange = (state) => { - console.log('locationEnabledChange: state: ' + JSON.stringify(state)); - } - try { - geoLocationManager.on('locationEnabledChange', locationEnabledChange); - geoLocationManager.off('locationEnabledChange', locationEnabledChange); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.on('cachedGnssLocationsChange') - -on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void; - -订阅缓存GNSS定位结果上报事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | - | request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 | - | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var cachedLocationsCb = (locations) => { - console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); - } - var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; - try { - geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.off('cachedGnssLocationsChange') - -off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void; - -取消订阅缓存GNSS定位结果上报事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | - | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var cachedLocationsCb = (locations) => { - console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); - } - var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; - try { - geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); - geoLocationManager.off('cachedGnssLocationsChange'); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.on('satelliteStatusChange') - -on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void; - -订阅GNSS卫星状态信息上报事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | - | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 接收GNSS卫星状态信息上报。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var gnssStatusCb = (satelliteStatusInfo) => { - console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); - } - - try { - geoLocationManager.on('satelliteStatusChange', gnssStatusCb); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.off('satelliteStatusChange') - -off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void; - -取消订阅GNSS卫星状态信息上报事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | - | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | - - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var gnssStatusCb = (satelliteStatusInfo) => { - console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); - } - try { - geoLocationManager.on('satelliteStatusChange', gnssStatusCb); - geoLocationManager.off('satelliteStatusChange', gnssStatusCb); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.on('nmeaMessage') - -on(type: 'nmeaMessage', callback: Callback<string>): void; - -订阅GNSS NMEA信息上报事件。 - -**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | - | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | - - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var nmeaCb = (str) => { - console.log('nmeaMessage: ' + JSON.stringify(str)); - } - - try { - geoLocationManager.on('nmeaMessage', nmeaCb ); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.off('nmeaMessage') - -off(type: 'nmeaMessage', callback?: Callback<string>): void; - -取消订阅GNSS NMEA信息上报事件。 - -**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Gnss - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | - | callback | Callback<string> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | - - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var nmeaCb = (str) => { - console.log('nmeaMessage: ' + JSON.stringify(str)); - } - - try { - geoLocationManager.on('nmeaMessage', nmeaCb); - geoLocationManager.off('nmeaMessage', nmeaCb); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.on('gnssFenceStatusChange') - -on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; - -添加一个围栏，并订阅地理围栏事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Geofence - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | - | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | - | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301600 | Failed to operate the geofence. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - import wantAgent from '@ohos.wantAgent'; - - let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "com.example.myapplication.MainAbility", - action: "action1", - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG], - }; - - wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; - try { - geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - }); - ``` - - -## geoLocationManager.off('gnssFenceStatusChange') - -off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; - -删除一个围栏，并取消订阅该围栏事件。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Geofence - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | - | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | - | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301600 | Failed to operate the geofence. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - import wantAgent from '@ohos.wantAgent'; - - let wantAgentInfo = { - wants: [ - { - bundleName: "com.example.myapplication", - abilityName: "com.example.myapplication.MainAbility", - action: "action1", - } - ], - operationType: wantAgent.OperationType.START_ABILITY, - requestCode: 0, - wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] - }; - - wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { - var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; - try { - geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); - geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - }); - ``` - - -## geoLocationManager.on('countryCodeChange') - -on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; - -订阅国家码信息变化事件。 - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301500 | Failed to query the area information. | - - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); - } - - try { - geoLocationManager.on('countryCodeChange', callback); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - -## geoLocationManager.off('countryCodeChange') - -off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; - -取消订阅国家码变化事件。 - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301500 | Failed to query the area information. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); - } - - try { - geoLocationManager.on('countryCodeChange', callback); - geoLocationManager.off('countryCodeChange', callback); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - - -## geoLocationManager.getCurrentLocation - -getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void - -获取当前位置，使用callback回调异步返回结果。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 | - | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../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,'maxAccuracy': 0}; - var locationChange = (err, location) => { - if (err) { - console.log('locationChanger: err=' + JSON.stringify(err)); - } - if (location) { - console.log('locationChanger: location=' + JSON.stringify(location)); - } - }; - - try { - geoLocationManager.getCurrentLocation(requestInfo, locationChange); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - -## geoLocationManager.getCurrentLocation - -getCurrentLocation(callback: AsyncCallback<Location>): void; - -获取当前位置，通过callback方式异步返回结果。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../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 locationChange = (err, location) => { - if (err) { - console.log('locationChanger: err=' + JSON.stringify(err)); - } - if (location) { - console.log('locationChanger: location=' + JSON.stringify(location)); - } - }; - - try { - geoLocationManager.getCurrentLocation(locationChange); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - -## geoLocationManager.getCurrentLocation - -getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> +## geoLocationManager.on('countryCodeChange') -获取当前位置，使用Promise方式异步返回结果。 +on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION +订阅国家码信息变化事件。 **系统能力**：SystemCapability.Location.Location.Core @@ -777,13 +53,8 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Promise<[Location](#location)> | [Location](#location) | NA | 返回位置信息。 | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | **错误码**： @@ -793,73 +64,39 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> | -------- | ---------------------------------------- | |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,'maxAccuracy': 0}; - geoLocationManager.getCurrentLocation(requestInfo).then((result) => { - console.log('current location: ' + JSON.stringify(result)); - }) - .catch((error) => { - console.log('promise, getCurrentLocation: error=' + JSON.stringify(error)); - }); - ``` - - -## geoLocationManager.getLastLocation - -getLastLocation(): Location - -获取上一次位置。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Location | [Location](#location) | NA | 位置信息。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 +|3301500 | Failed to query the area information. | -| 错误码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 callback = (code) => { + console.log('countryCodeChange: ' + JSON.stringify(code)); + } + try { - var location = geoLocationManager.getLastLocation(); + geoLocationManager.on('countryCodeChange', callback); } catch (err) { console.error("errCode:" + err.code + ",errMessage:" + err.message); } ``` -## geoLocationManager.isLocationEnabled +## geoLocationManager.off('countryCodeChange') -isLocationEnabled(): boolean +off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; -判断位置服务是否已经使能。 +取消订阅国家码变化事件。 **系统能力**：SystemCapability.Location.Location.Core -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | boolean | boolean | NA | 位置服务是否已经使能。 | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -867,98 +104,26 @@ isLocationEnabled(): boolean | 错误码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 import geoLocationManager from '@ohos.geoLocationManager'; + var callback = (code) => { + console.log('countryCodeChange: ' + JSON.stringify(code)); + } try { - var locationEnabled = geoLocationManager.isLocationEnabled(); + geoLocationManager.on('countryCodeChange', callback); + geoLocationManager.off('countryCodeChange', callback); } catch (err) { console.error("errCode:" + err.code + ",errMessage:" + err.message); } ``` -## geoLocationManager.requestEnableLocation - -requestEnableLocation(callback: AsyncCallback<boolean>): void - -请求使能位置服务，使用callback回调异步返回结果。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<boolean> | 是 | callback返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301700 | No response to the request. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.requestEnableLocation((err, data) => { - if (err) { - console.log('requestEnableLocation: err=' + JSON.stringify(err)); - } - if (data) { - console.log('requestEnableLocation: data=' + JSON.stringify(data)); - } - }); - ``` - - -## geoLocationManager.requestEnableLocation - -requestEnableLocation(): Promise<boolean> - -请求使能位置服务，使用Promise方式异步返回结果。 - -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION - -**系统能力**：SystemCapability.Location.Location.Core - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Promise<boolean> | boolean | NA | 返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301700 | No response to the request. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.requestEnableLocation().then((result) => { - console.log('promise, requestEnableLocation: ' + JSON.stringify(result)); - }) - .catch((error) => { - console.log('promise, requestEnableLocation: error=' + JSON.stringify(error)); - }); - ``` - - ## geoLocationManager.enableLocation enableLocation(callback: AsyncCallback<void>): void; @@ -1037,9 +202,9 @@ enableLocation(): Promise<void> ## geoLocationManager.disableLocation -disableLocation(): void; +disableLocation(callback: AsyncCallback<void>): void; -关闭位置服务。 +关闭位置服务，使用callback回调异步返回结果。 **系统API**：此接口为系统接口，三方应用不支持调用。 @@ -1047,41 +212,11 @@ disableLocation(): void; **系统能力**：SystemCapability.Location.Location.Core -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.disableLocation(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` - - - -## geoLocationManager.getAddressesFromLocation - -getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void - -调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 - -**系统能力**：SystemCapability.Location.Location.Geocoder - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | - | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收逆地理编码结果的回调函数。 | + | callback | AsyncCallback<void> | 是 | 用来接收错误码的回调。 | **错误码**： @@ -1089,44 +224,41 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301300 | Reverse geocoding query failed. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; - geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { - if (err) { - console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); - } - if (data) { - console.log('getAddressesFromLocation: data=' + JSON.stringify(data)); - } - }); + try { + geoLocationManager.disableLocation((err, data) => { + if (err) { + console.log('disableLocation: err=' + JSON.stringify(err)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.getAddressesFromLocation +## geoLocationManager.disableLocation -getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; +disableLocation(): Promise<void> -调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 +关闭位置服务，使用Promise方式异步返回结果。 -**系统能力**：SystemCapability.Location.Location.Geocoder +**系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | +**系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理描述信息。 | + | Promise<void> | void | NA |返回错误码。 | **错误码**： @@ -1134,37 +266,37 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301300 | Reverse geocoding query failed. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; - geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { - console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + geoLocationManager.disableLocation().then((result) => { + console.log('promise, disableLocation succeed'); }) .catch((error) => { - console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error)); -}); + console.log('promise, disableLocation: error=' + JSON.stringify(error)); + }); ``` -## geoLocationManager.getAddressesFromLocationName +## geoLocationManager.isLocationPrivacyConfirmed -getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void +isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>): void; -调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 -**系统能力**：SystemCapability.Location.Location.Geocoder +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | - | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收地理编码结果的回调函数。 | + | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 | **错误码**： @@ -1172,44 +304,44 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301400 | Geocoding query failed. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; - geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { + geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => { if (err) { - console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); + console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err)); } - if (data) { - console.log('getAddressesFromLocationName: data=' + JSON.stringify(data)); + if (result) { + console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result)); } }); ``` -## geoLocationManager.getAddressesFromLocationName +## geoLocationManager.isLocationPrivacyConfirmed -getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> +isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise<boolean>; -调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 -**系统能力**：SystemCapability.Location.Location.Geocoder +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理编码查询结果。 | + | Promise<boolean> |boolean| NA | 表示用户是否同意定位服务隐私申明。 | **错误码**： @@ -1217,71 +349,37 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301400 | Geocoding query failed. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; - geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => { - console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); - }) - .catch((error) => { - console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error)); + geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => { + console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result)); }); ``` -## geoLocationManager.isGeocoderAvailable - -isGeocoderAvailable(): boolean; - -判断（逆）地理编码服务状态。 - -**系统能力**：SystemCapability.Location.Location.Geocoder - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | boolean | boolean | NA | 返回（逆）地理编码服务是否可用。 | - -**错误码**： - -以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 - -| 错误码ID | 错误信息 | -| -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | - -**示例** - - ```ts - import geoLocationManager from '@ohos.geoLocationManager'; - try { - var isAvailable = geoLocationManager.isGeocoderAvailable(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } - ``` +## geoLocationManager.setLocationPrivacyConfirmStatus -## geoLocationManager.getCachedGnssLocationsSize +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<void>): void; -getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 -获取GNSS芯片缓存位置的个数。 +**系统API**：此接口为系统接口，三方应用不支持调用。 -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS -**系统能力**：SystemCapability.Location.Location.Gnss +**系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | + | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | callback | AsyncCallback<void> | 是 | 接收错误码信息。 | **错误码**： @@ -1289,39 +387,44 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCachedGnssLocationsSize((err, size) => { + geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => { if (err) { - console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err)); - } - if (size) { - console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size)); + console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err)); } }); ``` -## geoLocationManager.getCachedGnssLocationsSize +## geoLocationManager.setLocationPrivacyConfirmStatus -getCachedGnssLocationsSize(): Promise<number>; +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise<void>; -获取GNSS芯片缓存位置的个数。 +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION +**系统API**：此接口为系统接口，三方应用不支持调用。 -**系统能力**：SystemCapability.Location.Location.Gnss +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<number> | number | NA | 返回GNSS缓存位置的个数。 | + | Promise<void> |void|NA| 接收错误码。 | **错误码**： @@ -1329,37 +432,34 @@ getCachedGnssLocationsSize(): Promise<number>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCachedGnssLocationsSize().then((result) => { - console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result)); - }) + geoLocationManager.setLocationPrivacyConfirmStatus(1, true).then((result) => { + console.log('promise, setLocationPrivacyConfirmStatus succeed'); + }) .catch((error) => { - console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error)); + console.log('promise, disableLocation: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.flushCachedGnssLocations - -flushCachedGnssLocations(callback: AsyncCallback<void>): void; +## geoLocationManager.getCountryCode -读取并清空GNSS芯片所有缓存位置。 +getCountryCode(callback: AsyncCallback<CountryCode>): void; -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION +查询当前的国家码。 -**系统能力**：SystemCapability.Location.Location.Gnss +**系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 | + | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | **错误码**： @@ -1367,37 +467,37 @@ flushCachedGnssLocations(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | +|3301000 | Location service is unavailable. | +|3301500 | Failed to query the area information.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.flushCachedGnssLocations((err, result) => { + geoLocationManager.getCountryCode((err, result) => { if (err) { - console.log('flushCachedGnssLocations: err=' + JSON.stringify(err)); + console.log('getCountryCode: err=' + JSON.stringify(err)); + } + if (result) { + console.log('getCountryCode: result=' + JSON.stringify(result)); } }); ``` -## geoLocationManager.flushCachedGnssLocations - -flushCachedGnssLocations(): Promise<void>; +## geoLocationManager.getCountryCode -读取并清空GNSS芯片所有缓存位置。 +getCountryCode(): Promise<CountryCode>; -**需要权限**：ohos.permission.APPROXIMATELY_LOCATION +查询当前的国家码。 -**系统能力**：SystemCapability.Location.Location.Gnss +**系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void | NA | 接收错误码。 | + | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 | **错误码**： @@ -1405,37 +505,38 @@ flushCachedGnssLocations(): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301200 | Failed to obtain the geographical location. | +|3301000 | Location service is unavailable. | +|3301500 | Failed to query the area information.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.flushCachedGnssLocations().then((result) => { - console.log('promise, flushCachedGnssLocations success'); + geoLocationManager.getCountryCode() + .then((result) => { + console.log('promise, getCountryCode: result=' + JSON.stringify(result)); }) .catch((error) => { - console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error)); + console.log('promise, getCountryCode: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.sendCommand +## geoLocationManager.enableLocationMock -sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void; +enableLocationMock(callback: AsyncCallback<void>): void; -给位置服务子系统的各个部件发送扩展命令。 +使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core +**系统API**：此接口为系统接口，三方应用不支持调用。 + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | - | callback | AsyncCallback<void> | 是 | 用来接收错误码。 | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1443,40 +544,35 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var requestInfo = {'scenario': 0x301, 'command': "command_1"}; - geoLocationManager.sendCommand(requestInfo, (err, result) => { + geoLocationManager.enableLocationMock((err, result) => { if (err) { - console.log('sendCommand: err=' + JSON.stringify(err)); + console.log('enableLocationMock: err=' + JSON.stringify(err)); } }); ``` +## geoLocationManager.enableLocationMock -## geoLocationManager.sendCommand - -sendCommand(command: LocationCommand): Promise<void>; +enableLocationMock(): Promise<void>; -给位置服务子系统的各个部件发送扩展命令。 +使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | +**系统API**：此接口为系统接口，三方应用不支持调用。 **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void | NA | 接收错误码。 | + | Promise<void> | void|NA|用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1485,34 +581,39 @@ sendCommand(command: LocationCommand): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var requestInfo = {'scenario': 0x301, 'command': "command_1"}; - geoLocationManager.sendCommand(requestInfo).then((result) => { - console.log('promise, sendCommand success'); - }) + geoLocationManager.enableLocationMock() + .then((result) => { + console.log('promise, enableLocationMock: succeed'); + }) .catch((error) => { - console.log('promise, sendCommand: error=' + JSON.stringify(error)); + if (error) { + console.log('promise, enableLocationMock: error=' + JSON.stringify(error)); + } }); ``` -## geoLocationManager.getCountryCode +## geoLocationManager.disableLocationMock -getCountryCode(callback: AsyncCallback<CountryCode>): void; +disableLocationMock(callback: AsyncCallback<void>): void; -查询当前的国家码。 +去使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core +**系统API**：此接口为系统接口，三方应用不支持调用。 + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1521,36 +622,35 @@ getCountryCode(callback: AsyncCallback<CountryCode>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCountryCode((err, result) => { + geoLocationManager.disableLocationMock((err, result) => { if (err) { - console.log('getCountryCode: err=' + JSON.stringify(err)); - } - if (result) { - console.log('getCountryCode: result=' + JSON.stringify(result)); + console.log('disableLocationMock: err=' + JSON.stringify(err)); } }); ``` -## geoLocationManager.getCountryCode +## geoLocationManager.disableLocationMock -getCountryCode(): Promise<CountryCode>; +disableLocationMock(): Promise<void>; -查询当前的国家码。 +去使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core +**系统API**：此接口为系统接口，三方应用不支持调用。 + **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 | + | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1559,32 +659,41 @@ getCountryCode(): Promise<CountryCode>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCountryCode() + geoLocationManager.disableLocationMock() .then((result) => { - console.log('promise, getCountryCode: result=' + JSON.stringify(result)); + console.log('promise, disableLocationMock succeed'); }) .catch((error) => { - console.log('promise, getCountryCode: error=' + JSON.stringify(error)); + if (error) { + console.log('promise, disableLocationMock: error=' + JSON.stringify(error)); + } }); ``` -## geoLocationManager.enableLocationMock +## geoLocationManager.setMockedLocations -enableLocationMock(): void; +setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void>): void; -使能位置模拟功能。 +设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -1598,24 +707,43 @@ enableLocationMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.enableLocationMock(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + 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}; + geoLocationManager.setMockedLocations(config, (err, data) => { + if (err) { + console.log('setMockedLocations: err=' + JSON.stringify(err)); + } + }); ``` +## geoLocationManager.setMockedLocations -## geoLocationManager.disableLocationMock - -disableLocationMock(): void; +setMockedLocations(config: LocationMockConfig): Promise<void>; -去使能位置模拟功能。 +设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -1629,19 +757,31 @@ disableLocationMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.disableLocationMock(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + 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}; + geoLocationManager.setMockedLocations(config) + .then((result) => { + console.log('promise, setMockedLocations succeed'); + }) + .catch((error) => { + if (error) { + console.log('promise, setMockedLocations: error=' + JSON.stringify(error)); + } + }); ``` -## geoLocationManager.setMockedLocations +## geoLocationManager.enableReverseGeocodingMock -setMockedLocations(config: LocationMockConfig): void; +enableReverseGeocodingMock(callback: AsyncCallback<void>): void; -设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 +使能逆地理编码模拟功能。 **系统能力**：SystemCapability.Location.Location.Core @@ -1651,7 +791,7 @@ setMockedLocations(config: LocationMockConfig): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1660,31 +800,22 @@ setMockedLocations(config: LocationMockConfig): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| **示例** ```ts 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 { - geoLocationManager.setMockedLocations(config); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + geoLocationManager.enableReverseGeocodingMock((err, data) => { + if (err) { + console.log('enableReverseGeocodingMock: err=' + JSON.stringify(err)); + } + }); ``` ## geoLocationManager.enableReverseGeocodingMock -enableReverseGeocodingMock(): void; +enableReverseGeocodingMock(): Promise<void>; 使能逆地理编码模拟功能。 @@ -1692,6 +823,12 @@ enableReverseGeocodingMock(): void; **系统API**：此接口为系统接口，三方应用不支持调用。 +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void|NA|用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -1704,17 +841,21 @@ enableReverseGeocodingMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.enableReverseGeocodingMock(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + geoLocationManager.enableReverseGeocodingMock() + .then((result) => { + console.log('promise, enableReverseGeocodingMock succeed'); + }) + .catch((error) => { + if (error) { + console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error)); + } + }); ``` ## geoLocationManager.disableReverseGeocodingMock -disableReverseGeocodingMock(): void; +disableReverseGeocodingMock(callback: AsyncCallback<void>): void; 去使能逆地理编码模拟功能。 @@ -1722,6 +863,12 @@ disableReverseGeocodingMock(): void; **系统API**：此接口为系统接口，三方应用不支持调用。 +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -1734,29 +881,29 @@ disableReverseGeocodingMock(): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.disableReverseGeocodingMock(); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + geoLocationManager.disableReverseGeocodingMock((err, result) => { + if (err) { + console.log('disableReverseGeocodingMock: err=' + JSON.stringify(err)); + } + }); ``` -## geoLocationManager.setReverseGeocodingMockInfo +## geoLocationManager.disableReverseGeocodingMock -setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void; +disableReverseGeocodingMock(): Promise<void>; -设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 +去使能逆地理编码模拟功能。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： +**返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | + | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1770,42 +917,34 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): v ```ts 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 { - geoLocationManager.setReverseGeocodingMockInfo(mockInfos); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + geoLocationManager.disableReverseGeocodingMock() + .then((result) => { + console.log('promise, disableReverseGeocodingMock succeed'); + }) + .catch((error) => { + if (error) { + console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error)); + } + }); ``` -## geoLocationManager.isLocationPrivacyConfirmed - -isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; +## geoLocationManager.setReverseGeocodingMockInfo -查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 +setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, callback: AsyncCallback<void>): void; -**系统API**：此接口为系统接口，三方应用不支持调用。 +设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 **系统能力**：SystemCapability.Location.Location.Core -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | +**系统API**：此接口为系统接口，三方应用不支持调用。 -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 | + | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | + | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1819,32 +958,42 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + 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}}, + ]; + geoLocationManager.setReverseGeocodingMockInfo(mockInfos, (err, data) => { + if (err) { + console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err)); + } + }); ``` -## geoLocationManager.setLocationPrivacyConfirmStatus +## geoLocationManager.setReverseGeocodingMockInfo -setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void; +setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): Promise<void>; -设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 +设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 + +**系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**参数**： -**系统能力**：SystemCapability.Location.Location.Core + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 | -**参数**： +**返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | Promise<void> | void | NA | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -1858,11 +1007,22 @@ setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean) ```ts import geoLocationManager from '@ohos.geoLocationManager'; - try { - geoLocationManager.setLocationPrivacyConfirmStatus(1, true); - } catch (err) { - console.error("errCode:" + err.code + ",errMessage:" + err.message); - } + 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}}, + ]; + geoLocationManager.setReverseGeocodingMockInfo(mockInfos) + .then((result) => { + console.log('promise, setReverseGeocodingMockInfo succeed'); + }) + .catch((error) => { + if (error) { + console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error)); + } + }); ``` @@ -2035,8 +1195,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | -| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示位置信息优先级。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | +| geofence | [Geofence](#geofence) | 是 | 是 | 表示围栏信息。 | ## LocationPrivacyType diff --git a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md index ea6287ba8c..5269a4e3f0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md @@ -4,7 +4,36 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 + + +## 申请权限 + +应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 + +系统提供的定位权限有： +- ohos.permission.LOCATION + +- ohos.permission.APPROXIMATELY_LOCATION + +- ohos.permission.LOCATION_IN_BACKGROUND + +访问设备的位置信息，必须申请权限，并且获得用户授权。 + +API9之前的版本，申请ohos.permission.LOCATION即可。 + +API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。 + +| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 | +| -------- | -------- | -------- | -------- | +| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | +| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 | +| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 | +| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | + +如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。 + +开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../../security/accesstoken-guidelines.md)。 + ## 导入模块 @@ -12,15 +41,12 @@ import geolocation from '@ohos.geolocation'; ``` -## geolocation.on('locationChange')(deprecated) +## geolocation.on('locationChange') on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void 开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -47,15 +73,12 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback<Locat ``` -## geolocation.off('locationChange')(deprecated) +## geolocation.off('locationChange') off(type: 'locationChange', callback?: Callback<Location>): void 关闭位置变化订阅，并删除对应的定位请求。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -81,15 +104,12 @@ off(type: 'locationChange', callback?: Callback<Location>): void ``` -## geolocation.on('locationServiceState')(deprecated) +## geolocation.on('locationServiceState') on(type: 'locationServiceState', callback: Callback<boolean>): void 订阅位置服务状态变化。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationenabledchange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -113,15 +133,12 @@ on(type: 'locationServiceState', callback: Callback<boolean>): void ``` -## geolocation.off('locationServiceState')(deprecated) +## geolocation.off('locationServiceState') off(type: 'locationServiceState', callback?: Callback<boolean>): void; 取消订阅位置服务状态变化。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationenabledchange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -146,16 +163,12 @@ off(type: 'locationServiceState', callback?: Callback<boolean>): void; ``` -## geolocation.on('cachedGnssLocationsReporting')(deprecated) +## geolocation.on('cachedGnssLocationsReporting')8+ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void; 订阅缓存GNSS定位结果上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.on('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroncachedgnsslocationschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -181,16 +194,12 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ``` -## geolocation.off('cachedGnssLocationsReporting')(deprecated) +## geolocation.off('cachedGnssLocationsReporting')8+ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>): void; 取消订阅缓存GNSS定位结果上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.off('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroffcachedgnsslocationschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -216,16 +225,12 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Locati ``` -## geolocation.on('gnssStatusChange')(deprecated) +## geolocation.on('gnssStatusChange')8+ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): void; 订阅GNSS卫星状态信息上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.on('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageronsatellitestatuschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -249,16 +254,12 @@ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): voi ``` -## geolocation.off('gnssStatusChange')(deprecated) +## geolocation.off('gnssStatusChange')8+ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): void; 取消订阅GNSS卫星状态信息上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.off('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffsatellitestatuschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -282,16 +283,12 @@ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): v ``` -## geolocation.on('nmeaMessageChange')(deprecated) +## geolocation.on('nmeaMessageChange')8+ on(type: 'nmeaMessageChange', callback: Callback<string>): void; 订阅GNSS NMEA信息上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.on('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageronnmeamessage)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -315,16 +312,12 @@ on(type: 'nmeaMessageChange', callback: Callback<string>): void; ``` -## geolocation.off('nmeaMessageChange')(deprecated) +## geolocation.off('nmeaMessageChange')8+ off(type: 'nmeaMessageChange', callback?: Callback<string>): void; 取消订阅GNSS NMEA信息上报事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.off('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageroffnmeamessage)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -349,16 +342,12 @@ off(type: 'nmeaMessageChange', callback?: Callback<string>): void; ``` -## geolocation.on('fenceStatusChange')(deprecated) +## geolocation.on('fenceStatusChange')8+ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; 添加一个围栏，并订阅地理围栏事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.on('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanagerongnssfencestatuschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -398,16 +387,12 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ``` -## geolocation.off('fenceStatusChange')(deprecated) +## geolocation.off('fenceStatusChange')8+ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; 删除一个围栏，并取消订阅该围栏事件。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.off('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffgnssfencestatuschange)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -447,14 +432,12 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ``` -## geolocation.getCurrentLocation(deprecated) +## geolocation.getCurrentLocation getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void -获取当前位置，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 +获取当前位置，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION @@ -485,14 +468,12 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L ``` -## geolocation.getCurrentLocation(deprecated) +## geolocation.getCurrentLocation getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> -获取当前位置，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation-2)替代。 +获取当前位置，使用Promise方式异步返回结果。 **需要权限**：ohos.permission.LOCATION @@ -506,9 +487,9 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<[Location](#location)> | 返回位置信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<[Location](#location)> |[Location](#location)|NA| 返回位置信息。 | **示例** @@ -522,15 +503,12 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> ``` -## geolocation.getLastLocation(deprecated) +## geolocation.getLastLocation getLastLocation(callback: AsyncCallback<Location>): void 获取上一次位置，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -557,24 +535,21 @@ getLastLocation(callback: AsyncCallback<Location>): void ``` -## geolocation.getLastLocation(deprecated) +## geolocation.getLastLocation getLastLocation(): Promise<Location> 获取上一次位置，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<[Location](#location)> | 返回上次位置信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<[Location](#location)> | [Location](#location)|NA|返回上次位置信息。 | **示例** @@ -587,14 +562,12 @@ getLastLocation(): Promise<Location> ``` -## geolocation.isLocationEnabled(deprecated) +## geolocation.isLocationEnabled isLocationEnabled(callback: AsyncCallback<boolean>): void -判断位置服务是否已经打开，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 +判断位置服务是否已经打开，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION @@ -621,24 +594,21 @@ isLocationEnabled(callback: AsyncCallback<boolean>): void ``` -## geolocation.isLocationEnabled(deprecated) +## geolocation.isLocationEnabled isLocationEnabled(): Promise<boolean> 判断位置服务是否已经开启，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回位置服务是否可用的状态。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> | boolean|NA|返回位置服务是否可用的状态。 | **示例** @@ -650,14 +620,12 @@ isLocationEnabled(): Promise<boolean> ``` -## geolocation.requestEnableLocation(deprecated) +## geolocation.requestEnableLocation requestEnableLocation(callback: AsyncCallback<boolean>): void -请求打开位置服务，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。 +请求打开位置服务，使用callback回调异步返回结果。 **需要权限**：ohos.permission.LOCATION @@ -684,24 +652,21 @@ requestEnableLocation(callback: AsyncCallback<boolean>): void ``` -## geolocation.requestEnableLocation(deprecated) +## geolocation.requestEnableLocation requestEnableLocation(): Promise<boolean> 请求打开位置服务，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回位置服务是否可用。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> | boolean|NA|返回位置服务是否可用。 | **示例** @@ -713,15 +678,132 @@ requestEnableLocation(): Promise<boolean> ``` -## geolocation.isGeoServiceAvailable(deprecated) +## geolocation.enableLocation + +enableLocation(callback: AsyncCallback<boolean>): void; + +打开位置服务，使用callback回调异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + +**示例** + + ```ts + import geolocation from '@ohos.geolocation'; + geolocation.enableLocation((err, data) => { + if (err) { + console.log('enableLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('enableLocation: data=' + JSON.stringify(data)); + } + }); + ``` + + +## geolocation.enableLocation + +enableLocation(): Promise<boolean> + +打开位置服务，使用Promise方式异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> | boolean|NA|返回位置服务是否可用。 | + +**示例** + + ```ts + import geolocation from '@ohos.geolocation'; + geolocation.enableLocation().then((result) => { + console.log('promise, enableLocation: ' + JSON.stringify(result)); + }); + ``` + +## geolocation.disableLocation + +disableLocation(callback: AsyncCallback<boolean>): void; + +关闭位置服务，使用callback回调异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + +**示例** + + ```ts + import geolocation from '@ohos.geolocation'; + geolocation.disableLocation((err, data) => { + if (err) { + console.log('disableLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('disableLocation: data=' + JSON.stringify(data)); + } + }); + ``` + + +## geolocation.disableLocation + +disableLocation(): Promise<boolean> + +关闭位置服务，使用Promise方式异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> | boolean|NA|返回位置服务是否可用。 | + +**示例** + + ```ts + import geolocation from '@ohos.geolocation'; + geolocation.disableLocation().then((result) => { + console.log('promise, disableLocation: ' + JSON.stringify(result)); + }); + ``` + +## geolocation.isGeoServiceAvailable isGeoServiceAvailable(callback: AsyncCallback<boolean>): void 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -747,24 +829,21 @@ isGeoServiceAvailable(callback: AsyncCallback<boolean>): void ``` -## geolocation.isGeoServiceAvailable(deprecated) +## geolocation.isGeoServiceAvailable isGeoServiceAvailable(): Promise<boolean> 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<boolean> | 返回地理编码服务是否可用的状态。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> |boolean|NA| 返回地理编码服务是否可用的状态。 | **示例** @@ -776,15 +855,12 @@ isGeoServiceAvailable(): Promise<boolean> ``` -## geolocation.getAddressesFromLocation(deprecated) +## geolocation.getAddressesFromLocation getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -812,15 +888,12 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ``` -## geolocation.getAddressesFromLocation(deprecated) +## geolocation.getAddressesFromLocation getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation-1)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -833,9 +906,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | 返回地理描述信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)>|NA|返回地理描述信息。 | **示例** @@ -848,15 +921,12 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge ``` -## geolocation.getAddressesFromLocationName(deprecated) +## geolocation.getAddressesFromLocationName getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -884,15 +954,12 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< ``` -## geolocation.getAddressesFromLocationName(deprecated) +## geolocation.getAddressesFromLocationName getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname-1)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -905,9 +972,9 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<Array<[GeoAddress](#geoaddress)>> | 设置接收地理编码请求的回调参数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)>|NA|设置接收地理编码请求的回调参数。 | **示例** @@ -920,16 +987,12 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd ``` -## geolocation.getCachedGnssLocationsSize(deprecated) +## geolocation.getCachedGnssLocationsSize8+ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; 获取GNSS芯片缓存位置的个数。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -955,25 +1018,21 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; ``` -## geolocation.getCachedGnssLocationsSize(deprecated) +## geolocation.getCachedGnssLocationsSize8+ getCachedGnssLocationsSize(): Promise<number>; 获取GNSS芯片缓存位置的个数。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize-1)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<number> | 返回GNSS缓存位置的个数。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<number> | number|NA|返回GNSS缓存位置的个数。 | **示例** @@ -985,16 +1044,12 @@ getCachedGnssLocationsSize(): Promise<number>; ``` -## geolocation.flushCachedGnssLocations(deprecated) +## geolocation.flushCachedGnssLocations8+ flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; 读取并清空GNSS芯片所有缓存位置。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -1020,25 +1075,21 @@ flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; ``` -## geolocation.flushCachedGnssLocations(deprecated) +## geolocation.flushCachedGnssLocations8+ flushCachedGnssLocations(): Promise<boolean>; 读取并清空GNSS芯片所有缓存位置。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations-1)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<boolean> | 清空所有GNSS缓存位置是否成功。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> |boolean|NA| 清空所有GNSS缓存位置是否成功。 | **示例** @@ -1050,16 +1101,12 @@ flushCachedGnssLocations(): Promise<boolean>; ``` -## geolocation.sendCommand(deprecated) +## geolocation.sendCommand8+ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): void; 给位置服务子系统的各个部件发送扩展命令。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1087,16 +1134,12 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): v ``` -## geolocation.sendCommand(deprecated) +## geolocation.sendCommand8+ sendCommand(command: LocationCommand): Promise<boolean>; 给位置服务子系统的各个部件发送扩展命令。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1109,9 +1152,9 @@ sendCommand(command: LocationCommand): Promise<boolean>; **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<boolean> | 表示命令发送成功或失败。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> |boolean|NA| 表示命令发送成功或失败。 | **示例** @@ -1124,12 +1167,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; ``` -## LocationRequestPriority(deprecated) -位置请求中位置信息优先级设置。 +## LocationRequestPriority -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。 +位置请求中位置信息优先级设置。 **需要权限**：ohos.permission.LOCATION @@ -1143,13 +1184,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | -## LocationRequestScenario(deprecated) +## LocationRequestScenario 位置请求中定位场景设置。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1164,13 +1202,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | -## GeoLocationErrorCode(deprecated) +## GeoLocationErrorCode 位置服务中的错误码信息。 -> **说明：**
-> 从API version 9开始废弃。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1186,13 +1221,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | LOCATION_REQUEST_TIMEOUT_ERROR7+ | 107 | 表示单次定位，没有在指定时间内返回位置。 | -## ReverseGeoCodeRequest(deprecated) +## ReverseGeoCodeRequest 逆地理编码请求接口。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1205,13 +1237,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 | -## GeoCodeRequest(deprecated) +## GeoCodeRequest 地理编码请求接口。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.GeoCodeRequest](js-apis-geoLocationManager.md#geocoderequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1227,13 +1256,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxLongitude | number | 是 | 是 | 表示最大经度信息。 | -## GeoAddress(deprecated) +## GeoAddress 地理编码类型。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.GeoAddress](js-apis-geoLocationManager.md#geoaddress)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1260,13 +1286,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | descriptionsSize7+ | number | 是 | 否 | 表示附加的描述信息数量。 | -## LocationRequest(deprecated) +## LocationRequest 位置信息请求类型。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequest](js-apis-geoLocationManager.md#locationrequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1280,13 +1303,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | -## CurrentLocationRequest(deprecated) +## CurrentLocationRequest 当前位置信息请求类型。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.CurrentLocationRequest](js-apis-geoLocationManager.md#currentlocationrequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1299,14 +1319,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | -## SatelliteStatusInfo(deprecated) +## SatelliteStatusInfo8+ 卫星状态信息。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.SatelliteStatusInfo](js-apis-geoLocationManager.md#satellitestatusinfo)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -1321,14 +1337,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 | -## CachedGnssLocationsRequest(deprecated) +## CachedGnssLocationsRequest8+ 请求订阅GNSS缓存位置上报功能接口的配置参数。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.CachedGnssLocationsRequest](js-apis-geoLocationManager.md#cachedgnsslocationsrequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -1339,14 +1351,10 @@ sendCommand(command: LocationCommand): Promise<boolean>; | wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | -## Geofence(deprecated) +## Geofence8+ GNSS围栏的配置参数。目前只支持圆形围栏。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.Geofence](js-apis-geoLocationManager.md#geofence)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -1359,14 +1367,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | expiration | number | 是 | 是 | 围栏存活的时间，单位是毫秒。 | -## GeofenceRequest(deprecated) +## GeofenceRequest8+ 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.GeofenceRequest](js-apis-geoLocationManager.md#geofencerequest)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -1378,14 +1382,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | -## LocationPrivacyType(deprecated) +## LocationPrivacyType8+ 定位服务隐私协议类型。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1397,14 +1397,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | -## LocationCommand(deprecated) +## LocationCommand8+ 扩展命令结构体。 -> **说明：**
-> 从API version 8开始支持。 -> 从API version 9开始废弃，建议使用[geoLocationManager.LocationCommand](js-apis-geoLocationManager.md#locationcommand)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1415,13 +1411,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | command | string | 是 | 是 | 扩展命令字符串。 | -## Location(deprecated) +## Location 位置信息类型。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.Location](js-apis-geoLocationManager.md#location)替代。 - **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-location.md b/zh-cn/application-dev/reference/apis/js-apis-system-location.md index 83b262dc2a..2443d76cea 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-location.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-location.md @@ -1,8 +1,9 @@ # 地理位置 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> - 从API Version 7 开始，该接口不再维护，推荐使用新接口[`@ohos.geolocation`](js-apis-geolocation.md)。 +> > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 ## 导入模块 @@ -18,15 +19,12 @@ import geolocation from '@system.geolocation'; ohos.permission.LOCATION -## geolocation.getLocation(deprecated) +## geolocation.getLocation getLocation(Object): void 获取设备的地理位置。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 - **系统能力：** SystemCapability.Location.Location.Lite **参数:** @@ -77,15 +75,12 @@ export default { ``` -## geolocation.getLocationType(deprecated) +## geolocation.getLocationType getLocationType(Object): void 获取当前设备支持的定位类型。 -> **说明：**
-> 从API version 9开始废弃。 - **系统能力：** SystemCapability.Location.Location.Lite **参数：** @@ -120,15 +115,12 @@ export default { ``` -## geolocation.subscribe(deprecated) +## geolocation.subscribe subscribe(Object): void 订阅设备的地理位置信息。多次调用的话，只有最后一次的调用生效。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。 - **系统能力：** SystemCapability.Location.Location.Lite **参数：** @@ -175,15 +167,12 @@ export default { ``` -## geolocation.unsubscribe(deprecated) +## geolocation.unsubscribe unsubscribe(): void 取消订阅设备的地理位置信息。 -> **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。 - **系统能力：** SystemCapability.Location.Location.Lite **示例：** @@ -197,15 +186,12 @@ export default { ``` -## geolocation.getSupportedCoordTypes(deprecated) +## geolocation.getSupportedCoordTypes getSupportedCoordTypes(): Array<string> 获取设备支持的坐标系类型。 -> **说明：**
-> 从API version 9开始废弃。 - **系统能力：** SystemCapability.Location.Location.Lite **返回值：** -- GitLab