diff --git a/zh-cn/application-dev/device/device-location-geocoding.md b/zh-cn/application-dev/device/device-location-geocoding.md index 6a6eaf336b6706dc91692714ef2b62368023b117..ac7f6ebc509ade083fa2f99d773b1d49598a8b0d 100644 --- a/zh-cn/application-dev/device/device-location-geocoding.md +++ b/zh-cn/application-dev/device/device-location-geocoding.md @@ -14,18 +14,17 @@ ## 接口说明 -进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geolocation.md)。 +进行坐标和地理编码信息的相互转化，所使用的接口说明如下，详细信息参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 **表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍 | 接口名 | 功能描述 | | -------- | -------- | -| 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方式异步返回结果。 | +| 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方式异步返回结果。 | ## 开发步骤 @@ -33,23 +32,22 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 -1. 导入geolocation模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 +1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 ```ts - import geolocation from '@ohos.geolocation'; + import geoLocationManager from '@ohos.geoLocationManager'; ``` 2. 查询geoCoder服务是否可用。 - 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。 ```ts - geolocation.isGeoServiceAvailable((err, data) => { - if (err) { - console.log('isGeoServiceAvailable err: ' + JSON.stringify(err)); - } else { - console.log('isGeoServiceAvailable data: ' + JSON.stringify(data)); - } - }); + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var isAvailable = geoLocationManager.isGeocoderAvailable(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` 3. 获取转化结果。 @@ -57,29 +55,37 @@ ```ts var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; - geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { - if (err) { - console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); - } else { - console.log('getAddressesFromLocation data: ' + JSON.stringify(data)); - } - }); + try { + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + if (err) { + console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); + } else { + console.log('getAddressesFromLocation data: ' + JSON.stringify(data)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` - 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 + 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.md)，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 - 调用getAddressesFromLocationName位置描述转化坐标。 ```ts var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; - geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { - if (err) { - console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); - } else { - console.log('getAddressesFromLocationName data: ' + JSON.stringify(data)); - } - }); + try { + geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { + if (err) { + console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); + } else { + console.log('getAddressesFromLocationName data: ' + JSON.stringify(data)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` - 参考接口API说明[位置服务](../reference/apis/js-apis-geolocation.md)，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 + 参考接口API说明[位置服务](../reference/apis/js-apis-geoLocationManager.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 6a1954e0b7e5b1cfdd19b88cbdc354e835b5a4e3..10f006b399671f5c5047299dd3f6e2a72925d20f 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-geolocation.md)。 +获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 ## 开发步骤 -如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geolocation.md)。 +如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 系统提供的定位权限有： @@ -42,10 +42,10 @@ 开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。 -2. 导入geolocation模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 +2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 - ``` - import geolocation from '@ohos.geolocation'; + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; ``` 3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。
@@ -78,8 +78,8 @@ 以导航场景为例，实例化方式如下： - ``` - var requestInfo = {'scenario': geolocation.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ```ts + var requestInfo = {'scenario': geoLocationManager.LocationRequestScenario.NAVIGATION, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` **方式二：** @@ -108,7 +108,7 @@ 以定位精度优先策略为例，实例化方式如下： ```ts - var requestInfo = {'priority': geolocation.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` 4. 实例化Callback对象，用于向系统提供位置上报的途径。 @@ -123,25 +123,24 @@ 5. 启动定位。 ```ts - geolocation.on('locationChange', requestInfo, locationChange); + geoLocationManager.on('locationChange', requestInfo, locationChange); ``` 6. （可选）结束定位。 ```ts - geolocation.off('locationChange', locationChange); + geoLocationManager.off('locationChange', locationChange); ``` 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 ```ts - geolocation.getLastLocation((err, data) => { - if (err) { - console.log('getLastLocation: err: ' + JSON.stringify(err)); - } else { - console.log('getLastLocation: data: ' + JSON.stringify(data)); - } - }); + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var location = geoLocationManager.getLastLocation(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 \ No newline at end of file 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 6538426575e8b9012e5938a20fb0f97d63085f89..ebd83ea63a87ed9bfc00b730421b48aa1c9722a0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md @@ -42,20 +42,23 @@ import geoLocationManager from '@ohos.geoLocationManager'; ``` -## geoLocationManager.on('countryCodeChange') +## geoLocationManager.on('locationChange') -on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; +on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void -订阅国家码信息变化事件。 +开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **系统能力**：SystemCapability.Location.Location.Core -**参数**： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 | + | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | **错误码**： @@ -65,39 +68,41 @@ on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | |3301100 | The location switch is off. | -|3301500 | Failed to query the area information. | - +|3301200 | Failed to obtain the geographical location. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); - } - + 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('countryCodeChange', callback); + geoLocationManager.on('locationChange', requestInfo, locationChange); } catch (err) { console.error("errCode:" + err.code + ",errMessage:" + err.message); } + ``` -## geoLocationManager.off('countryCodeChange') +## geoLocationManager.off('locationChange') -off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; +off(type: 'locationChange', callback?: Callback<Location>): void -取消订阅国家码变化事件。 +关闭位置变化订阅，并删除对应的定位请求。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **系统能力**：SystemCapability.Location.Location.Core -**参数**： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -107,41 +112,39 @@ off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | |3301100 | The location switch is off. | -|3301500 | Failed to query the area information. | +|3301200 | Failed to obtain the geographical location. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); - } + 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('countryCodeChange', callback); - geoLocationManager.off('countryCodeChange', callback); + geoLocationManager.on('locationChange', requestInfo, locationChange); + geoLocationManager.off('locationChange', locationChange); } catch (err) { console.error("errCode:" + err.code + ",errMessage:" + err.message); } ``` -## geoLocationManager.enableLocation - -enableLocation(callback: AsyncCallback<void>): void; - -打开位置服务，使用callback回调异步返回结果。 +## geoLocationManager.on('locationEnabledChange') -**系统API**：此接口为系统接口，三方应用不支持调用。 +on(type: 'locationEnabledChange', callback: Callback<boolean>): void -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +订阅位置服务状态变化。 **系统能力**：SystemCapability.Location.Location.Core -**参数**： +**参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 | + | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | + | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | **错误码**： @@ -155,31 +158,31 @@ enableLocation(callback: AsyncCallback<void>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocation((err, data) => { - if (err) { - console.log('enableLocation: err=' + JSON.stringify(err)); - } - }); + 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.enableLocation - -enableLocation(): Promise<void> - -打开位置服务，使用Promise方式异步返回结果。 +## geoLocationManager.off('locationEnabledChange') -**系统API**：此接口为系统接口，三方应用不支持调用。 +off(type: 'locationEnabledChange', callback?: Callback<boolean>): void; -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +取消订阅位置服务状态变化。 **系统能力**：SystemCapability.Location.Location.Core -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void | NA | 返回错误码信息。 | + | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | + | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -193,31 +196,35 @@ enableLocation(): Promise<void> ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocation().then((result) => { - console.log('promise, enableLocation succeed'); - }) - .catch((error) => { - console.log('promise, enableLocation: error=' + JSON.stringify(error)); - }); + 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.disableLocation -disableLocation(callback: AsyncCallback<void>): void; +## geoLocationManager.on('cachedGnssLocationsChange') -关闭位置服务，使用callback回调异步返回结果。 +on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void; -**系统API**：此接口为系统接口，三方应用不支持调用。 +订阅缓存GNSS定位结果上报事件。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收错误码的回调。 | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | + | request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 | + | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | **错误码**： @@ -226,40 +233,41 @@ disableLocation(callback: AsyncCallback<void>): void; | 错误码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.disableLocation((err, data) => { - if (err) { - console.log('disableLocation: err=' + JSON.stringify(err)); - } - }); + geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); } catch (err) { console.error("errCode:" + err.code + ",errMessage:" + err.message); } ``` -## geoLocationManager.disableLocation - -disableLocation(): Promise<void> +## geoLocationManager.off('cachedGnssLocationsChange') -关闭位置服务，使用Promise方式异步返回结果。 +off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void; -**系统API**：此接口为系统接口，三方应用不支持调用。 +取消订阅缓存GNSS定位结果上报事件。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void | NA |返回错误码。 | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | + | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -268,36 +276,42 @@ disableLocation(): Promise<void> | 错误码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'; - geoLocationManager.disableLocation().then((result) => { - console.log('promise, disableLocation succeed'); - }) - .catch((error) => { - console.log('promise, disableLocation: error=' + JSON.stringify(error)); - }); + 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.isLocationPrivacyConfirmed +## geoLocationManager.on('satelliteStatusChange') -isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>): void; +on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void; -查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 +订阅GNSS卫星状态信息上报事件。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 | + | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 接收GNSS卫星状态信息上报。 | **错误码**： @@ -306,43 +320,40 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => { - if (err) { - console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err)); - } - if (result) { - console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result)); - } - }); + 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.isLocationPrivacyConfirmed +## geoLocationManager.off('satelliteStatusChange') -isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise<boolean>; +off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void; -查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 +取消订阅GNSS卫星状态信息上报事件。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Promise<boolean> |boolean| NA | 表示用户是否同意定位服务隐私申明。 | + | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -351,36 +362,41 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise<boolean>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => { - console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result)); - }); + 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.setLocationPrivacyConfirmStatus - -setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<void>): void; +## geoLocationManager.on('nmeaMessage') -设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 +on(type: 'nmeaMessage', callback: Callback<string>): void; -**系统API**：此接口为系统接口，三方应用不支持调用。 +订阅GNSS NMEA信息上报事件。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | - | callback | AsyncCallback<void> | 是 | 接收错误码信息。 | + | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | **错误码**： @@ -389,43 +405,41 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => { - if (err) { - console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err)); - } - }); - ``` + 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.setLocationPrivacyConfirmStatus -setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise<void>; +## geoLocationManager.off('nmeaMessage') -设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 +off(type: 'nmeaMessage', callback?: Callback<string>): void; -**系统API**：此接口为系统接口，三方应用不支持调用。 +取消订阅GNSS NMEA信息上报事件。 -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | - -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Promise<void> |void|NA| 接收错误码。 | + | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -434,33 +448,43 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.setLocationPrivacyConfirmStatus(1, true).then((result) => { - console.log('promise, setLocationPrivacyConfirmStatus succeed'); - }) - .catch((error) => { - console.log('promise, disableLocation: error=' + JSON.stringify(error)); - }); + 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.getCountryCode +## geoLocationManager.on('gnssFenceStatusChange') -getCountryCode(callback: AsyncCallback<CountryCode>): void; +on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; -查询当前的国家码。 +添加一个围栏，并订阅地理围栏事件。 -**系统能力**：SystemCapability.Location.Location.Core +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Geofence **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | + | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | + | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | **错误码**： @@ -469,36 +493,56 @@ getCountryCode(callback: AsyncCallback<CountryCode>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|3301100 | The location switch is off. | +|3301600 | Failed to operate the geofence. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCountryCode((err, result) => { - if (err) { - console.log('getCountryCode: err=' + JSON.stringify(err)); - } - if (result) { - console.log('getCountryCode: result=' + JSON.stringify(result)); - } + 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.getCountryCode +## geoLocationManager.off('gnssFenceStatusChange') -getCountryCode(): Promise<CountryCode>; +off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; -查询当前的国家码。 +删除一个围栏，并取消订阅该围栏事件。 -**系统能力**：SystemCapability.Location.Location.Core +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -**返回值**： +**系统能力**：SystemCapability.Location.Location.Geofence + +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 | + | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | + | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | **错误码**： @@ -507,37 +551,54 @@ getCountryCode(): Promise<CountryCode>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|3301100 | The location switch is off. | +|3301600 | Failed to operate the geofence. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.getCountryCode() - .then((result) => { - console.log('promise, getCountryCode: result=' + JSON.stringify(result)); - }) - .catch((error) => { - console.log('promise, getCountryCode: error=' + JSON.stringify(error)); + 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.enableLocationMock +## geoLocationManager.on('countryCodeChange') -enableLocationMock(callback: AsyncCallback<void>): void; +on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; -使能位置模拟功能。 +订阅国家码信息变化事件。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | **错误码**： @@ -546,34 +607,40 @@ enableLocationMock(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| +|3301100 | The location switch is off. | +|3301500 | Failed to query the area information. | + **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocationMock((err, result) => { - if (err) { - console.log('enableLocationMock: err=' + JSON.stringify(err)); - } - }); + 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.enableLocationMock -enableLocationMock(): Promise<void>; +## geoLocationManager.off('countryCodeChange') -使能位置模拟功能。 +off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; -**系统能力**：SystemCapability.Location.Location.Core +取消订阅国家码变化事件。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**系统能力**：SystemCapability.Location.Location.Core -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void|NA|用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | **错误码**： @@ -582,39 +649,43 @@ enableLocationMock(): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| +|3301100 | The location switch is off. | +|3301500 | Failed to query the area information. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocationMock() - .then((result) => { - console.log('promise, enableLocationMock: succeed'); - }) - .catch((error) => { - if (error) { - console.log('promise, enableLocationMock: error=' + JSON.stringify(error)); - } - }); + 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.disableLocationMock -disableLocationMock(callback: AsyncCallback<void>): void; +## geoLocationManager.getCurrentLocation -去使能位置模拟功能。 +getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void -**系统能力**：SystemCapability.Location.Location.Core +获取当前位置，使用callback回调异步返回结果。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | **错误码**： @@ -623,35 +694,846 @@ disableLocationMock(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.disableLocationMock((err, result) => { + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + var locationChange = (err, location) => { if (err) { - console.log('disableLocationMock: err=' + JSON.stringify(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> + +获取当前位置，使用Promise方式异步返回结果。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<[Location](#location)> | [Location](#location) | NA | 返回位置信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + try { + geoLocationManager.getCurrentLocation(requestInfo).then((result) => { + console.log('current location: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getCurrentLocation: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getLastLocation + +getLastLocation(): Location + +获取上一次位置。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Location | [Location](#location) | NA | 位置信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 |Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var location = geoLocationManager.getLastLocation(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.isLocationEnabled + +isLocationEnabled(): boolean + +判断位置服务是否已经使能。 + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | boolean | boolean | NA | 位置服务是否已经使能。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var locationEnabled = geoLocationManager.isLocationEnabled(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.requestEnableLocation + +requestEnableLocation(callback: AsyncCallback<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'; + try { + geoLocationManager.requestEnableLocation((err, data) => { + if (err) { + console.log('requestEnableLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('requestEnableLocation: data=' + JSON.stringify(data)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## 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'; + try { + geoLocationManager.requestEnableLocation().then((result) => { + console.log('promise, requestEnableLocation: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, requestEnableLocation: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.enableLocation + +enableLocation(callback: AsyncCallback<void>): void; + +打开位置服务，使用callback回调异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.enableLocation((err, data) => { + if (err) { + console.log('enableLocation: err=' + JSON.stringify(err)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.enableLocation + +enableLocation(): Promise<void> + +打开位置服务，使用Promise方式异步返回结果。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void | NA | 返回错误码信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.enableLocation().then((result) => { + console.log('promise, enableLocation succeed'); + }) + .catch((error) => { + console.log('promise, enableLocation: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + +## geoLocationManager.disableLocation + +disableLocation(): void; + +关闭位置服务。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：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)>> | 是 | 接收逆地理编码结果的回调函数。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301300 | Reverse geocoding query failed. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + try { + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + if (err) { + console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('getAddressesFromLocation: data=' + JSON.stringify(data)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; + +调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 + +**系统能力**：SystemCapability.Location.Location.Geocoder + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理描述信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301300 | Reverse geocoding query failed. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + try { + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }) + .catch((error) => { + console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void + +调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 + +**系统能力**：SystemCapability.Location.Location.Geocoder + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收地理编码结果的回调函数。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301400 | Geocoding query failed. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + try { + geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { + if (err) { + console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); + } + if (data) { + console.log('getAddressesFromLocationName: data=' + JSON.stringify(data)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> + +调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 + +**系统能力**：SystemCapability.Location.Location.Geocoder + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理编码查询结果。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301400 | Geocoding query failed. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + try { + geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + +## 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.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; + +获取GNSS芯片缓存位置的个数。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.getCachedGnssLocationsSize((err, size) => { + if (err) { + console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err)); + } + if (size) { + console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(): Promise<number>; + +获取GNSS芯片缓存位置的个数。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<number> | number | NA | 返回GNSS缓存位置的个数。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.getCachedGnssLocationsSize().then((result) => { + console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.flushCachedGnssLocations + +flushCachedGnssLocations(callback: AsyncCallback<void>): void; + +读取并清空GNSS芯片所有缓存位置。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.flushCachedGnssLocations((err, result) => { + if (err) { + console.log('flushCachedGnssLocations: err=' + JSON.stringify(err)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.flushCachedGnssLocations + +flushCachedGnssLocations(): Promise<void>; + +读取并清空GNSS芯片所有缓存位置。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void | NA | 接收错误码。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.flushCachedGnssLocations().then((result) => { + console.log('promise, flushCachedGnssLocations success'); + }) + .catch((error) => { + console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.sendCommand + +sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void; + +给位置服务子系统的各个部件发送扩展命令。 + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + | callback | AsyncCallback<void> | 是 | 用来接收错误码。 | -## geoLocationManager.disableLocationMock +**错误码**： -disableLocationMock(): Promise<void>; +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 -去使能位置模拟功能。 +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + try { + geoLocationManager.sendCommand(requestInfo, (err, result) => { + if (err) { + console.log('sendCommand: err=' + JSON.stringify(err)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.sendCommand + +sendCommand(command: LocationCommand): Promise<void>; + +给位置服务子系统的各个部件发送扩展命令。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | Promise<void> | void | NA | 接收错误码。 | **错误码**： @@ -660,40 +1542,38 @@ disableLocationMock(): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.disableLocationMock() - .then((result) => { - console.log('promise, disableLocationMock succeed'); - }) - .catch((error) => { - if (error) { - console.log('promise, disableLocationMock: error=' + JSON.stringify(error)); - } - }); + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + try { + geoLocationManager.sendCommand(requestInfo).then((result) => { + console.log('promise, sendCommand success'); + }) + .catch((error) => { + console.log('promise, sendCommand: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setMockedLocations +## geoLocationManager.getCountryCode -setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void>): void; +getCountryCode(callback: AsyncCallback<CountryCode>): void; -设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 +查询当前的国家码。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | **错误码**： @@ -702,48 +1582,40 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void&g | 错误码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 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)); - } - }); + try { + geoLocationManager.getCountryCode((err, result) => { + if (err) { + console.log('getCountryCode: err=' + JSON.stringify(err)); + } + if (result) { + console.log('getCountryCode: result=' + JSON.stringify(result)); + } + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setMockedLocations - -setMockedLocations(config: LocationMockConfig): Promise<void>; - -设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 -**系统能力**：SystemCapability.Location.Location.Core +## geoLocationManager.getCountryCode -**系统API**：此接口为系统接口，三方应用不支持调用。 +getCountryCode(): Promise<CountryCode>; -**参数**： +查询当前的国家码。 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | +**系统能力**：SystemCapability.Location.Location.Core **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 | **错误码**： @@ -752,47 +1624,66 @@ setMockedLocations(config: LocationMockConfig): Promise<void>; | 错误码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 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)); - } - }); + try { + geoLocationManager.getCountryCode() + .then((result) => { + console.log('promise, getCountryCode: result=' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getCountryCode: error=' + JSON.stringify(error)); + }); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.enableReverseGeocodingMock +## geoLocationManager.enableLocationMock -enableReverseGeocodingMock(callback: AsyncCallback<void>): void; +enableLocationMock(): void; -使能逆地理编码模拟功能。 +使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： +**错误码**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off.| + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.enableLocationMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.disableLocationMock + +disableLocationMock(): void; + +去使能位置模拟功能。 + +**系统能力**：SystemCapability.Location.Location.Core + +**系统API**：此接口为系统接口，三方应用不支持调用。 **错误码**： @@ -801,34 +1692,35 @@ enableReverseGeocodingMock(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableReverseGeocodingMock((err, data) => { - if (err) { - console.log('enableReverseGeocodingMock: err=' + JSON.stringify(err)); - } - }); + try { + geoLocationManager.disableLocationMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.enableReverseGeocodingMock +## geoLocationManager.setMockedLocations -enableReverseGeocodingMock(): Promise<void>; +setMockedLocations(config: LocationMockConfig): void; -使能逆地理编码模拟功能。 +设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**返回值**： +**参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void|NA|用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | **错误码**： @@ -837,39 +1729,38 @@ enableReverseGeocodingMock(): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | +|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableReverseGeocodingMock() - .then((result) => { - console.log('promise, enableReverseGeocodingMock succeed'); - }) - .catch((error) => { - if (error) { - console.log('promise, enableReverseGeocodingMock: error=' + JSON.stringify(error)); - } - }); + 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.disableReverseGeocodingMock +## geoLocationManager.enableReverseGeocodingMock -disableReverseGeocodingMock(callback: AsyncCallback<void>): void; +enableReverseGeocodingMock(): void; -去使能逆地理编码模拟功能。 +使能逆地理编码模拟功能。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -882,17 +1773,17 @@ disableReverseGeocodingMock(callback: AsyncCallback<void>): void; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.disableReverseGeocodingMock((err, result) => { - if (err) { - console.log('disableReverseGeocodingMock: err=' + JSON.stringify(err)); - } - }); + try { + geoLocationManager.enableReverseGeocodingMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` ## geoLocationManager.disableReverseGeocodingMock -disableReverseGeocodingMock(): Promise<void>; +disableReverseGeocodingMock(): void; 去使能逆地理编码模拟功能。 @@ -900,12 +1791,6 @@ disableReverseGeocodingMock(): Promise<void>; **系统API**：此接口为系统接口，三方应用不支持调用。 -**返回值**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | Promise<void> |void|NA| 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -918,21 +1803,17 @@ disableReverseGeocodingMock(): Promise<void>; ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.disableReverseGeocodingMock() - .then((result) => { - console.log('promise, disableReverseGeocodingMock succeed'); - }) - .catch((error) => { - if (error) { - console.log('promise, disableReverseGeocodingMock: error=' + JSON.stringify(error)); - } - }); + try { + geoLocationManager.disableReverseGeocodingMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` ## geoLocationManager.setReverseGeocodingMockInfo -setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, callback: AsyncCallback<void>): void; +setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void; 设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 @@ -945,7 +1826,6 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, ca | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | **错误码**： @@ -966,35 +1846,35 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, ca {"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)); - } - }); + try { + geoLocationManager.setReverseGeocodingMockInfo(mockInfos); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setReverseGeocodingMockInfo - -setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): Promise<void>; +## geoLocationManager.isLocationPrivacyConfirmed -设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 +isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; -**系统能力**：SystemCapability.Location.Location.Core +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 **系统API**：此接口为系统接口，三方应用不支持调用。 +**系统能力**：SystemCapability.Location.Location.Core + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 | + | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | **返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | Promise<void> | void | NA | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 | **错误码**： @@ -1008,22 +1888,50 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P ```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}}, - ]; - geoLocationManager.setReverseGeocodingMockInfo(mockInfos) - .then((result) => { - console.log('promise, setReverseGeocodingMockInfo succeed'); - }) - .catch((error) => { - if (error) { - console.log('promise, setReverseGeocodingMockInfo: error=' + JSON.stringify(error)); - } - }); + try { + var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.setLocationPrivacyConfirmStatus + +setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void; + +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 + +**系统API**：此接口为系统接口，三方应用不支持调用。 + +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.setLocationPrivacyConfirmStatus(1, true); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` @@ -1196,9 +2104,8 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示位置信息优先级。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | -| geofence | [Geofence](#geofence) | 是 | 是 | 表示围栏信息。 | +| 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 e29dfe7203561eb31a7973a589edf922441cf9ce..ee2f81b52a13ff7fe750a7d92720a0bc26115cf4 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,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - +> 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 ## 申请权限 @@ -41,12 +41,15 @@ API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或 import geolocation from '@ohos.geolocation'; ``` -## geolocation.on('locationChange') +## geolocation.on('locationChange')(deprecated) 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 @@ -73,12 +76,15 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback<Locat ``` -## geolocation.off('locationChange') +## geolocation.off('locationChange')(deprecated) 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 @@ -104,12 +110,15 @@ off(type: 'locationChange', callback?: Callback<Location>): void ``` -## geolocation.on('locationServiceState') +## geolocation.on('locationServiceState')(deprecated) 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 @@ -133,12 +142,15 @@ on(type: 'locationServiceState', callback: Callback<boolean>): void ``` -## geolocation.off('locationServiceState') +## geolocation.off('locationServiceState')(deprecated) 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 @@ -163,12 +175,16 @@ off(type: 'locationServiceState', callback?: Callback<boolean>): void; ``` -## geolocation.on('cachedGnssLocationsReporting')8+ +## geolocation.on('cachedGnssLocationsReporting')(deprecated) 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 @@ -194,12 +210,16 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ``` -## geolocation.off('cachedGnssLocationsReporting')8+ +## geolocation.off('cachedGnssLocationsReporting')(deprecated) 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 @@ -225,12 +245,16 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Locati ``` -## geolocation.on('gnssStatusChange')8+ +## geolocation.on('gnssStatusChange')(deprecated) 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 @@ -254,12 +278,16 @@ on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): voi ``` -## geolocation.off('gnssStatusChange')8+ +## geolocation.off('gnssStatusChange')(deprecated) 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 @@ -283,12 +311,16 @@ off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): v ``` -## geolocation.on('nmeaMessageChange')8+ +## geolocation.on('nmeaMessageChange')(deprecated) 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 @@ -312,12 +344,16 @@ on(type: 'nmeaMessageChange', callback: Callback<string>): void; ``` -## geolocation.off('nmeaMessageChange')8+ +## geolocation.off('nmeaMessageChange')(deprecated) 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 @@ -342,12 +378,16 @@ off(type: 'nmeaMessageChange', callback?: Callback<string>): void; ``` -## geolocation.on('fenceStatusChange')8+ +## geolocation.on('fenceStatusChange')(deprecated) 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 @@ -387,12 +427,16 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ``` -## geolocation.off('fenceStatusChange')8+ +## geolocation.off('fenceStatusChange')(deprecated) 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 @@ -432,13 +476,15 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ``` -## geolocation.getCurrentLocation +## geolocation.getCurrentLocation(deprecated) getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void - 获取当前位置，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -467,13 +513,16 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L ``` -## geolocation.getCurrentLocation +## geolocation.getCurrentLocation(deprecated) getCurrentLocation(callback: AsyncCallback<Location>): void 获取当前位置，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -500,13 +549,15 @@ getCurrentLocation(callback: AsyncCallback<Location>): void ``` -## geolocation.getCurrentLocation +## geolocation.getCurrentLocation(deprecated) getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> - 获取当前位置，使用Promise方式异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation-2)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -535,12 +586,15 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> ``` -## geolocation.getLastLocation +## geolocation.getLastLocation(deprecated) getLastLocation(callback: AsyncCallback<Location>): void 获取上一次位置，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -567,12 +621,15 @@ getLastLocation(callback: AsyncCallback<Location>): void ``` -## geolocation.getLastLocation +## geolocation.getLastLocation(deprecated) getLastLocation(): Promise<Location> 获取上一次位置，使用Promise方式异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -594,13 +651,15 @@ getLastLocation(): Promise<Location> ``` -## geolocation.isLocationEnabled +## geolocation.isLocationEnabled(deprecated) isLocationEnabled(callback: AsyncCallback<boolean>): void - 判断位置服务是否已经打开，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -626,12 +685,15 @@ isLocationEnabled(callback: AsyncCallback<boolean>): void ``` -## geolocation.isLocationEnabled +## geolocation.isLocationEnabled(deprecated) isLocationEnabled(): Promise<boolean> 判断位置服务是否已经开启，使用Promise方式异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -652,13 +714,15 @@ isLocationEnabled(): Promise<boolean> ``` -## geolocation.requestEnableLocation +## geolocation.requestEnableLocation(deprecated) requestEnableLocation(callback: AsyncCallback<boolean>): void - 请求打开位置服务，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -684,12 +748,15 @@ requestEnableLocation(callback: AsyncCallback<boolean>): void ``` -## geolocation.requestEnableLocation +## geolocation.requestEnableLocation(deprecated) requestEnableLocation(): Promise<boolean> 请求打开位置服务，使用Promise方式异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -710,132 +777,15 @@ requestEnableLocation(): Promise<boolean> ``` -## 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 +## geolocation.isGeoServiceAvailable(deprecated) isGeoServiceAvailable(callback: AsyncCallback<boolean>): void 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -861,12 +811,15 @@ isGeoServiceAvailable(callback: AsyncCallback<boolean>): void ``` -## geolocation.isGeoServiceAvailable +## geolocation.isGeoServiceAvailable(deprecated) isGeoServiceAvailable(): Promise<boolean> 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -887,12 +840,15 @@ isGeoServiceAvailable(): Promise<boolean> ``` -## geolocation.getAddressesFromLocation +## geolocation.getAddressesFromLocation(deprecated) 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 @@ -920,12 +876,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ``` -## geolocation.getAddressesFromLocation +## geolocation.getAddressesFromLocation(deprecated) 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 @@ -953,12 +912,15 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<Ge ``` -## geolocation.getAddressesFromLocationName +## geolocation.getAddressesFromLocationName(deprecated) 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 @@ -986,12 +948,15 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< ``` -## geolocation.getAddressesFromLocationName +## geolocation.getAddressesFromLocationName(deprecated) 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 @@ -1019,12 +984,16 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd ``` -## geolocation.getCachedGnssLocationsSize8+ +## geolocation.getCachedGnssLocationsSize(deprecated) 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 @@ -1050,12 +1019,16 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; ``` -## geolocation.getCachedGnssLocationsSize8+ +## geolocation.getCachedGnssLocationsSize(deprecated) 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 @@ -1076,12 +1049,16 @@ getCachedGnssLocationsSize(): Promise<number>; ``` -## geolocation.flushCachedGnssLocations8+ +## geolocation.flushCachedGnssLocations(deprecated) 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 @@ -1107,12 +1084,16 @@ flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; ``` -## geolocation.flushCachedGnssLocations8+ +## geolocation.flushCachedGnssLocations(deprecated) 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 @@ -1133,12 +1114,16 @@ flushCachedGnssLocations(): Promise<boolean>; ``` -## geolocation.sendCommand8+ +## geolocation.sendCommand(deprecated) 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 @@ -1166,12 +1151,16 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): v ``` -## geolocation.sendCommand8+ +## geolocation.sendCommand(deprecated) 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 @@ -1199,11 +1188,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; ``` - -## LocationRequestPriority +## LocationRequestPriority(deprecated) 位置请求中位置信息优先级设置。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1216,10 +1207,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | -## LocationRequestScenario +## LocationRequestScenario(deprecated) 位置请求中定位场景设置。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1234,10 +1228,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | -## GeoLocationErrorCode +## GeoLocationErrorCode(deprecated) 位置服务中的错误码信息。 +> **说明：**
+> 从API version 9开始废弃。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1253,10 +1250,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | LOCATION_REQUEST_TIMEOUT_ERROR7+ | 107 | 表示单次定位，没有在指定时间内返回位置。 | -## ReverseGeoCodeRequest +## ReverseGeoCodeRequest(deprecated) 逆地理编码请求接口。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1269,10 +1269,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 | -## GeoCodeRequest +## GeoCodeRequest(deprecated) 地理编码请求接口。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.GeoCodeRequest](js-apis-geoLocationManager.md#geocoderequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1288,10 +1291,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxLongitude | number | 是 | 是 | 表示最大经度信息。 | -## GeoAddress +## GeoAddress(deprecated) 地理编码类型。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.GeoAddress](js-apis-geoLocationManager.md#geoaddress)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder @@ -1318,10 +1324,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | descriptionsSize7+ | number | 是 | 否 | 表示附加的描述信息数量。 | -## LocationRequest +## LocationRequest(deprecated) 位置信息请求类型。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequest](js-apis-geoLocationManager.md#locationrequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1335,10 +1344,13 @@ sendCommand(command: LocationCommand): Promise<boolean>; | maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | -## CurrentLocationRequest +## CurrentLocationRequest(deprecated) 当前位置信息请求类型。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.CurrentLocationRequest](js-apis-geoLocationManager.md#currentlocationrequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1351,10 +1363,14 @@ sendCommand(command: LocationCommand): Promise<boolean>; | timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | -## SatelliteStatusInfo8+ +## SatelliteStatusInfo(deprecated) 卫星状态信息。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.SatelliteStatusInfo](js-apis-geoLocationManager.md#satellitestatusinfo)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -1369,10 +1385,14 @@ sendCommand(command: LocationCommand): Promise<boolean>; | carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 | -## CachedGnssLocationsRequest8+ +## CachedGnssLocationsRequest(deprecated) 请求订阅GNSS缓存位置上报功能接口的配置参数。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.CachedGnssLocationsRequest](js-apis-geoLocationManager.md#cachedgnsslocationsrequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss @@ -1383,10 +1403,14 @@ sendCommand(command: LocationCommand): Promise<boolean>; | wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | -## Geofence8+ +## Geofence(deprecated) GNSS围栏的配置参数。目前只支持圆形围栏。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.Geofence](js-apis-geoLocationManager.md#geofence)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -1399,10 +1423,14 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | expiration | number | 是 | 是 | 围栏存活的时间，单位是毫秒。 | -## GeofenceRequest8+ +## GeofenceRequest(deprecated) 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.GeofenceRequest](js-apis-geoLocationManager.md#geofencerequest)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence @@ -1414,10 +1442,14 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | -## LocationPrivacyType8+ +## LocationPrivacyType(deprecated) 定位服务隐私协议类型。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1429,10 +1461,14 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | -## LocationCommand8+ +## LocationCommand(deprecated) 扩展命令结构体。 +> **说明：**
+> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationCommand](js-apis-geoLocationManager.md#locationcommand)替代。 + **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -1443,10 +1479,13 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 | command | string | 是 | 是 | 扩展命令字符串。 | -## Location +## Location(deprecated) 位置信息类型。 +> **说明：**
+> 从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 ef437b962d685e907c92334ed74b19bae90aa0cf..58634c22b219d7c455e3c4586fb6a3b79da80b08 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,9 +1,8 @@ # @system.geolocation (地理位置) > ![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)。 ## 导入模块 @@ -19,12 +18,15 @@ import geolocation from '@system.geolocation'; ohos.permission.LOCATION -## geolocation.getLocation +## geolocation.getLocation(deprecated) getLocation(Object): void 获取设备的地理位置。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 + **系统能力：** SystemCapability.Location.Location.Lite **参数:** @@ -75,12 +77,15 @@ export default { ``` -## geolocation.getLocationType +## geolocation.getLocationType(deprecated) getLocationType(Object): void 获取当前设备支持的定位类型。 +> **说明：**
+> 从API version 9开始废弃。 + **系统能力：** SystemCapability.Location.Location.Lite **参数：** @@ -115,12 +120,15 @@ export default { ``` -## geolocation.subscribe +## geolocation.subscribe(deprecated) subscribe(Object): void 订阅设备的地理位置信息。多次调用的话，只有最后一次的调用生效。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。 + **系统能力：** SystemCapability.Location.Location.Lite **参数：** @@ -167,12 +175,15 @@ export default { ``` -## geolocation.unsubscribe +## geolocation.unsubscribe(deprecated) unsubscribe(): void 取消订阅设备的地理位置信息。 +> **说明：**
+> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。 + **系统能力：** SystemCapability.Location.Location.Lite **示例：** @@ -186,12 +197,15 @@ export default { ``` -## geolocation.getSupportedCoordTypes +## geolocation.getSupportedCoordTypes(deprecated) getSupportedCoordTypes(): Array<string> 获取设备支持的坐标系类型。 +> **说明：**
+> 从API version 9开始废弃。 + **系统能力：** SystemCapability.Location.Location.Lite **返回值：**