diff --git a/zh-cn/application-dev/device/device-location-geocoding.md b/zh-cn/application-dev/device/device-location-geocoding.md index 823b6641190be0e6d640ed112ceb831ab86294b0..2a5b0f843aa260a130a458fdca803863e777e024 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-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,31 +32,30 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 -1. 导入geolocation模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 +1. 导入geoLocationManager模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 - ``` - import geolocation from '@ohos.geolocation'; + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; ``` 2. 查询geoCoder服务是否可用。 - 调用isGeoServiceAvailable查询geoCoder服务是否可用，如果服务可用再继续进行步骤3。 - ``` - geolocation.isGeoServiceAvailable((err, data) => { - if (err) { - console.log('isGeoServiceAvailable err: ' + JSON.stringify(err)); - } else { - console.log('isGeoServiceAvailable data: ' + JSON.stringify(data)); - } - }); + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var isAvailable = geoLocationManager.isGeocoderAvailable(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` 3. 获取转化结果。 - 调用getAddressesFromLocation，坐标转化地理位置信息。 - ``` + ```ts var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; - geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocation err: ' + JSON.stringify(err)); } else { @@ -66,12 +64,12 @@ }); ``` - 参考接口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) => { + geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { console.log('getAddressesFromLocationName err: ' + JSON.stringify(err)); } else { @@ -80,6 +78,6 @@ }); ``` - 参考接口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 784be0bb006f4b631bf89be401c102b06fae3f32..10f006b399671f5c5047299dd3f6e2a72925d20f 100644 --- a/zh-cn/application-dev/device/device-location-info.md +++ b/zh-cn/application-dev/device/device-location-info.md @@ -10,68 +10,42 @@ ## 接口说明 -获取设备的位置信息，所使用的接口说明如下。 - - **表1** 获取位置信息API功能介绍 - -| 接口名 | 功能描述 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void | 开启位置变化订阅，并发起定位请求。 | -| off(type: 'locationChange', callback?: Callback<Location>) : void | 关闭位置变化订阅，并删除对应的定位请求。 | -| on(type: 'locationServiceState', callback: Callback<boolean>) : void | 订阅位置服务状态变化。 | -| off(type: 'locationServiceState', callback: Callback<boolean>) : void | 取消订阅位置服务状态变化。 | -| on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>) : void; | 订阅缓存GNSS位置上报。 | -| off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; | 取消订阅缓存GNSS位置上报。 | -| on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; | 订阅卫星状态信息更新事件。 | -| off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; | 取消订阅卫星状态信息更新事件。 | -| on(type: 'nmeaMessageChange', callback: Callback<string>) : void; | 订阅GNSS NMEA信息上报。 | -| off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; | 取消订阅GNSS NMEA信息上报。 | -| on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 添加围栏，并订阅该围栏事件上报。 | -| off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 删除围栏，并取消订阅该围栏事件。 | -| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void | 获取当前位置，使用callback回调异步返回结果。 | -| getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> | 获取当前位置，使用Promise方式异步返回结果。 | -| getLastLocation(callback: AsyncCallback<Location>) : void | 获取上一次位置，使用callback回调异步返回结果。 | -| getLastLocation() : Promise<Location> | 获取上一次位置，使用Promise方式异步返回结果。 | -| isLocationEnabled(callback: AsyncCallback<boolean>) : void | 判断位置服务是否已经打开，使用callback回调异步返回结果。 | -| isLocationEnabled() : Promise<boolean> | 判断位置服务是否已经开启，使用Promise方式异步返回结果。 | -| requestEnableLocation(callback: AsyncCallback<boolean>) : void | 请求打开位置服务，使用callback回调异步返回结果。 | -| requestEnableLocation() : Promise<boolean> | 请求打开位置服务，使用Promise方式异步返回结果。 | -| enableLocation(callback: AsyncCallback<boolean>) : void | 打开位置服务，使用callback回调异步返回结果。 | -| enableLocation() : Promise<boolean> | 打开位置服务，使用Promise方式异步返回结果。 | -| disableLocation(callback: AsyncCallback<boolean>) : void | 关闭位置服务，使用callback回调异步返回结果。 | -| disableLocation() : Promise<boolean> | 关闭位置服务，使用Promise方式异步返回结果。 | -| getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; | 获取缓存GNSS位置的个数，使用callback回调异步返回结果。 | -| getCachedGnssLocationsSize() : Promise<number>; | 获取缓存GNSS位置的个数，使用Promise方式异步返回结果。 | -| flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用callback回调异步返回结果。 | -| flushCachedGnssLocations() : Promise<boolean>; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用Promise方式异步返回结果。 | -| sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; | 给位置服务子系统发送扩展命令，使用callback回调异步返回结果。 | -| sendCommand(command: LocationCommand) : Promise<boolean>; | 给位置服务子系统发送扩展命令，使用Promise方式异步返回结果。 | -| isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; | 查询用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 | -| isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; | 查询用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 | -| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean, callback: AsyncCallback<boolean>) : void; | 设置并记录用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 | -| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; | 设置并记录用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 | +获取设备的位置信息，所使用的接口说明参见：[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 ## 开发步骤 -如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geolocation.md)。 +如需要获取设备位置相关接口信息，请参考[位置服务](../reference/apis/js-apis-geoLocationManager.md)。 1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 系统提供的定位权限有： - ohos.permission.LOCATION + - ohos.permission.APPROXIMATELY_LOCATION + - ohos.permission.LOCATION_IN_BACKGROUND - 访问设备的位置信息，必须申请ohos.permission.LOCATION权限，并且获得用户授权。 + 访问设备的位置信息，必须申请权限，并且获得用户授权。 + + API9之前的版本，申请ohos.permission.LOCATION即可。 + + API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。 + + | target API level | 申请位置权限 | 申请结果 | 位置的精确度 | + | -------- | -------- | -------- | -------- | + | 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | + | 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 | + | 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 | + | 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | 如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。 开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../security/accesstoken-guidelines.md)。 -2. 导入geolocation模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 +2. 导入geoLocationManager模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 - ``` - import geolocation from '@ohos.geolocation'; + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; ``` 3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。
@@ -80,7 +54,7 @@ 为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。 - ``` + ```ts export enum LocationRequestScenario { UNSET = 0x300, NAVIGATION, @@ -104,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}; ``` **方式二：** @@ -113,7 +87,7 @@ 如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。 - ``` + ```ts export enum LocationRequestPriority { UNSET = 0x200, ACCURACY, @@ -133,14 +107,14 @@ 以定位精度优先策略为例，实例化方式如下： - ``` - var requestInfo = {'priority': geolocation.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ```ts + var requestInfo = {'priority': geoLocationManager.LocationRequestPriority.ACCURACY, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; ``` 4. 实例化Callback对象，用于向系统提供位置上报的途径。 应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。 - ``` + ```ts var locationChange = (location) => { console.log('locationChanger: data: ' + JSON.stringify(location)); }; @@ -148,26 +122,25 @@ 5. 启动定位。 - ``` - geolocation.on('locationChange', requestInfo, locationChange); + ```ts + geoLocationManager.on('locationChange', requestInfo, locationChange); ``` 6. （可选）结束定位。 - ``` - geolocation.off('locationChange', locationChange); + ```ts + geoLocationManager.off('locationChange', locationChange); ``` 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 - ``` - geolocation.getLastLocation((err, data) => { - if (err) { - console.log('getLastLocation: err: ' + JSON.stringify(err)); - } else { - console.log('getLastLocation: data: ' + JSON.stringify(data)); - } - }); + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var location = geoLocationManager.getLastLocation(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 \ No newline at end of file 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 d0adea3309443672c71022cc2ef19f7db53b4262..7f46f13cb22bfa0731e00c2eb2ee997eb64e7ac0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-geoLocationManager.md @@ -5,6 +5,34 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +## 申请权限 + +应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考下文。 + +系统提供的定位权限有： +- ohos.permission.LOCATION + +- ohos.permission.APPROXIMATELY_LOCATION + +- ohos.permission.LOCATION_IN_BACKGROUND + +访问设备的位置信息，必须申请权限，并且获得用户授权。 + +API9之前的版本，申请ohos.permission.LOCATION即可。 + +API9及之后的版本，需要申请ohos.permission.APPROXIMATELY_LOCATION或者同时申请ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION；无法单独申请ohos.permission.LOCATION。 + +| 使用的API版本 | 申请位置权限 | 申请结果 | 位置的精确度 | +| -------- | -------- | -------- | -------- | +| 小于9 | ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | +| 大于等于9 | ohos.permission.LOCATION | 失败 | 无法获取位置。 | +| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION | 成功 | 获取到模糊位置，精确度为5公里。 | +| 大于等于9 | ohos.permission.APPROXIMATELY_LOCATION和ohos.permission.LOCATION | 成功 | 获取到精准位置，精准度在米级别。 | + +如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。 + +开发者可以在应用配置文件中声明所需要的权限，具体可参考[授权申请指导](../../security/accesstoken-guidelines.md)。 + ## 导入模块 @@ -13,11 +41,735 @@ import geoLocationManager from '@ohos.geoLocationManager'; ``` -## geoLocationManager.on('countryCodeChange') +## geoLocationManager.on('locationChange') + +on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void + +开启位置变化订阅，并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报， + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | request | [LocationRequest](#locationrequest) | 是 | 设置位置请求参数。 | + | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + try { + geoLocationManager.on('locationChange', requestInfo, locationChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + + ``` + + +## geoLocationManager.off('locationChange') + +off(type: 'locationChange', callback?: Callback<Location>): void + +关闭位置变化订阅，并删除对应的定位请求。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | callback | Callback<[Location](#location)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + try { + geoLocationManager.on('locationChange', requestInfo, locationChange); + geoLocationManager.off('locationChange', locationChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.on('locationEnabledChange') + +on(type: 'locationEnabledChange', callback: Callback<boolean>): void + +订阅位置服务状态变化。 + +**系统能力**：SystemCapability.Location.Location.Core + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | + | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var locationEnabledChange = (state) => { + console.log('locationEnabledChange: ' + JSON.stringify(state)); + } + try { + geoLocationManager.on('locationEnabledChange', locationEnabledChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.off('locationEnabledChange') + +off(type: 'locationEnabledChange', callback?: Callback<boolean>): void; + +取消订阅位置服务状态变化。 + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationEnabledChange”，表示位置服务状态。 | + | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var locationEnabledChange = (state) => { + console.log('locationEnabledChange: state: ' + JSON.stringify(state)); + } + try { + geoLocationManager.on('locationEnabledChange', locationEnabledChange); + geoLocationManager.off('locationEnabledChange', locationEnabledChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.on('cachedGnssLocationsChange') + +on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void; + +订阅缓存GNSS定位结果上报事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | + | request | [CachedGnssLocationsRequest](#cachedgnsslocationsrequest) | 是 | GNSS缓存功能配置参数 | + | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + try { + geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.off('cachedGnssLocationsChange') + +off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void; + +取消订阅缓存GNSS定位结果上报事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsChange”，表示GNSS缓存定位结果上报。 | + | callback | Callback<boolean> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsChange: locations: ' + JSON.stringify(locations)); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + try { + geoLocationManager.on('cachedGnssLocationsChange', requestInfo, cachedLocationsCb); + geoLocationManager.off('cachedGnssLocationsChange'); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.on('satelliteStatusChange') + +on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void; + +订阅GNSS卫星状态信息上报事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 是 | 接收GNSS卫星状态信息上报。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); + } + + try { + geoLocationManager.on('satelliteStatusChange', gnssStatusCb); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.off('satelliteStatusChange') + +off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void; + +取消订阅GNSS卫星状态信息上报事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“satelliteStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<[SatelliteStatusInfo](#satellitestatusinfo)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('satelliteStatusChange: ' + JSON.stringify(satelliteStatusInfo)); + } + try { + geoLocationManager.on('satelliteStatusChange', gnssStatusCb); + geoLocationManager.off('satelliteStatusChange', gnssStatusCb); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.on('nmeaMessage') + +on(type: 'nmeaMessage', callback: Callback<string>): void; + +订阅GNSS NMEA信息上报事件。 + +**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var nmeaCb = (str) => { + console.log('nmeaMessage: ' + JSON.stringify(str)); + } + + try { + geoLocationManager.on('nmeaMessage', nmeaCb ); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.off('nmeaMessage') + +off(type: 'nmeaMessage', callback?: Callback<string>): void; + +取消订阅GNSS NMEA信息上报事件。 + +**需要权限**：ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“nmeaMessage”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | + + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var nmeaCb = (str) => { + console.log('nmeaMessage: ' + JSON.stringify(str)); + } + + try { + geoLocationManager.on('nmeaMessage', nmeaCb); + geoLocationManager.off('nmeaMessage', nmeaCb); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.on('gnssFenceStatusChange') + +on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; + +添加一个围栏，并订阅地理围栏事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Geofence + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | + | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301600 | Failed to operate the geofence. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + import wantAgent from '@ohos.wantAgent'; + + let wantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "com.example.myapplication.MainAbility", + action: "action1", + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG], + }; + + wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + try { + geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + }); + ``` + + +## geoLocationManager.off('gnssFenceStatusChange') + +off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void; + +删除一个围栏，并取消订阅该围栏事件。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Geofence + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“gnssFenceStatusChange”，表示订阅围栏事件上报。 | + | request | [GeofenceRequest](#geofencerequest) | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301600 | Failed to operate the geofence. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + import wantAgent from '@ohos.wantAgent'; + + let wantAgentInfo = { + wants: [ + { + bundleName: "com.example.myapplication", + abilityName: "com.example.myapplication.MainAbility", + action: "action1", + } + ], + operationType: wantAgent.OperationType.START_ABILITY, + requestCode: 0, + wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG] + }; + + wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + try { + geoLocationManager.on('gnssFenceStatusChange', requestInfo, wantAgentObj); + geoLocationManager.off('gnssFenceStatusChange', requestInfo, wantAgentObj); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + }); + ``` + + +## geoLocationManager.on('countryCodeChange') + +on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; + +订阅国家码信息变化事件。 + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301500 | Failed to query the area information. | + + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var callback = (code) => { + console.log('countryCodeChange: ' + JSON.stringify(code)); + } + + try { + geoLocationManager.on('countryCodeChange', callback); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.off('countryCodeChange') + +off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; + +取消订阅国家码变化事件。 + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | + | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301500 | Failed to query the area information. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var callback = (code) => { + console.log('countryCodeChange: ' + JSON.stringify(code)); + } + + try { + geoLocationManager.on('countryCodeChange', callback); + geoLocationManager.off('countryCodeChange', callback); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + + +## geoLocationManager.getCurrentLocation + +getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void + +获取当前位置，使用callback回调异步返回结果。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | 是 | 设置位置请求参数。 | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + var locationChange = (err, location) => { + if (err) { + console.log('locationChanger: err=' + JSON.stringify(err)); + } + if (location) { + console.log('locationChanger: location=' + JSON.stringify(location)); + } + }; + + try { + geoLocationManager.getCurrentLocation(requestInfo, locationChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + +## geoLocationManager.getCurrentLocation + +getCurrentLocation(callback: AsyncCallback<Location>): void; + +获取当前位置，通过callback方式异步返回结果。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 | Failed to obtain the geographical location. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + var locationChange = (err, location) => { + if (err) { + console.log('locationChanger: err=' + JSON.stringify(err)); + } + if (location) { + console.log('locationChanger: location=' + JSON.stringify(location)); + } + }; + + try { + geoLocationManager.getCurrentLocation(locationChange); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + +## geoLocationManager.getCurrentLocation + +getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> -on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; +获取当前位置，使用Promise方式异步返回结果。 -订阅国家码信息变化事件。 +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION **系统能力**：SystemCapability.Location.Location.Core @@ -25,8 +777,13 @@ on(type: 'countryCodeChange', callback: Callback<CountryCode>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 是 | 接收国家码信息上报。 | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<[Location](#location)> | [Location](#location) | NA | 返回位置信息。 | **错误码**： @@ -36,34 +793,73 @@ 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 requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + geoLocationManager.getCurrentLocation(requestInfo).then((result) => { + console.log('current location: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getCurrentLocation: error=' + JSON.stringify(error)); + }); + ``` + + +## geoLocationManager.getLastLocation + +getLastLocation(): Location + +获取上一次位置。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Location | [Location](#location) | NA | 位置信息。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301100 | The location switch is off. | +|3301200 |Failed to obtain the geographical location. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); + try { + var location = geoLocationManager.getLastLocation(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); } - geoLocationManager.on('countryCodeChange', callback); ``` -## geoLocationManager.off('countryCodeChange') +## geoLocationManager.isLocationEnabled -off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; +isLocationEnabled(): boolean -取消订阅国家码变化事件。 +判断位置服务是否已经使能。 **系统能力**：SystemCapability.Location.Location.Core -**参数**： +**返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | string | 是 | 设置事件类型。type为“countryCodeChange”，表示取消订阅国家码信息变化事件。 | - | callback | Callback<[CountryCode](#countrycode)> | 否 | 需要取消订阅的回调函数。若无此参数，则取消当前类型的所有订阅。 | + | boolean | boolean | NA | 位置服务是否已经使能。 | **错误码**： @@ -71,19 +867,95 @@ off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off. | -|3301500 | Failed to query the area information. | +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - var callback = (code) => { - console.log('countryCodeChange: ' + JSON.stringify(code)); + try { + var locationEnabled = geoLocationManager.isLocationEnabled(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); } - geoLocationManager.on('countryCodeChange', callback); - geoLocationManager.off('countryCodeChange', callback); + ``` + + +## geoLocationManager.requestEnableLocation + +requestEnableLocation(callback: AsyncCallback<boolean>): void + +请求使能位置服务，使用callback回调异步返回结果。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | callback返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301700 | No response to the request. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + geoLocationManager.requestEnableLocation((err, data) => { + if (err) { + console.log('requestEnableLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('requestEnableLocation: data=' + JSON.stringify(data)); + } + }); + ``` + + +## geoLocationManager.requestEnableLocation + +requestEnableLocation(): Promise<boolean> + +请求使能位置服务，使用Promise方式异步返回结果。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Core + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<boolean> | boolean | NA | 返回true表示用户同意使能位置服务，false表示用户不同意使能位置服务。 | + +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | +|3301700 | No response to the request. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + geoLocationManager.requestEnableLocation().then((result) => { + console.log('promise, requestEnableLocation: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, requestEnableLocation: error=' + JSON.stringify(error)); + }); ``` @@ -139,9 +1011,9 @@ enableLocation(): Promise<void> **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 返回错误码信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void | NA | 返回错误码信息。 | **错误码**： @@ -175,9 +1047,41 @@ disableLocation(): void; **系统能力**：SystemCapability.Location.Location.Core +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + geoLocationManager.disableLocation(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + + +## geoLocationManager.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void + +调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 + +**系统能力**：SystemCapability.Location.Location.Geocoder + **参数**： -无 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 接收逆地理编码结果的回调函数。 | **错误码**： @@ -185,41 +1089,44 @@ disableLocation(): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | +|3301000 | Location service is unavailable. | +|3301300 | Reverse geocoding query failed. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.disableLocation((err, data) => { + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { if (err) { - console.log('disableLocation: err=' + JSON.stringify(err)); + console.log('getAddressesFromLocation: err=' + JSON.stringify(err)); + } + if (data) { + console.log('getAddressesFromLocation: data=' + JSON.stringify(data)); } }); ``` -## geoLocationManager.isLocationPrivacyConfirmed - -isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; +## geoLocationManager.getAddressesFromLocation -查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 +getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; -**系统API**：此接口为系统接口，三方应用不支持调用。 +调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 -**系统能力**：SystemCapability.Location.Location.Core +**系统能力**：SystemCapability.Location.Location.Geocoder **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | **返回值**： -| 类型 | 说明 | -| ------ | ---------------- | -| boolean | 表示用户是否同意定位服务隐私申明。。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理描述信息。 | **错误码**： @@ -227,42 +1134,82 @@ isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | +|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}; + geoLocationManager.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }) + .catch((error) => { + console.log('promise, getAddressesFromLocation: error=' + JSON.stringify(error)); +}); + ``` + + +## 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'; - geoLocationManager.isLocationPrivacyConfirmed(1, (err, result) => { + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + geoLocationManager.getAddressesFromLocationName(geocodeRequest, (err, data) => { if (err) { - console.log('isLocationPrivacyConfirmed: err=' + JSON.stringify(err)); + console.log('getAddressesFromLocationName: err=' + JSON.stringify(err)); } - if (result) { - console.log('isLocationPrivacyConfirmed: result=' + JSON.stringify(result)); + if (data) { + console.log('getAddressesFromLocationName: data=' + JSON.stringify(data)); } }); ``` -## geoLocationManager.setLocationPrivacyConfirmStatus +## geoLocationManager.getAddressesFromLocationName -setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void; +getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> -设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 +调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**系统能力**：SystemCapability.Location.Location.Geocoder -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS +**参数**： -**系统能力**：SystemCapability.Location.Location.Core + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | -**参数**： +**返回值**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | - | callback | AsyncCallback<void> | 是 | 接收错误码信息。 | + | Promise<Array<[GeoAddress](#geoaddress)>> | Array<[GeoAddress](#geoaddress)> | NA | 返回地理编码查询结果。 | **错误码**： @@ -270,44 +1217,111 @@ setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean) | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | +|3301000 | Location service is unavailable. | +|3301400 | Geocoding query failed. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.setLocationPrivacyConfirmStatus(1, true, (err, result) => { - if (err) { - console.log('setLocationPrivacyConfirmStatus: err=' + JSON.stringify(err)); - } + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + geoLocationManager.getAddressesFromLocationName(geocodeRequest).then((result) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); + }) + .catch((error) => { + console.log('promise, getAddressesFromLocationName: error=' + JSON.stringify(error)); }); ``` +## geoLocationManager.isGeocoderAvailable -## geoLocationManager.setLocationPrivacyConfirmStatus +isGeocoderAvailable(): boolean; -setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean): Promise<void>; +判断（逆）地理编码服务状态。 -设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 +**系统能力**：SystemCapability.Location.Location.Geocoder -**系统API**：此接口为系统接口，三方应用不支持调用。 +**返回值**： -**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | boolean | boolean | NA | 返回（逆）地理编码服务是否可用。 | -**系统能力**：SystemCapability.Location.Location.Core +**错误码**： + +以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +|3301000 | Location service is unavailable. | + +**示例** + + ```ts + import geoLocationManager from '@ohos.geoLocationManager'; + try { + var isAvailable = geoLocationManager.isGeocoderAvailable(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } + ``` + + +## geoLocationManager.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; + +获取GNSS芯片缓存位置的个数。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | - | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | 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'; + geoLocationManager.getCachedGnssLocationsSize((err, size) => { + if (err) { + console.log('getCachedGnssLocationsSize: err=' + JSON.stringify(err)); + } + if (size) { + console.log('getCachedGnssLocationsSize: size=' + JSON.stringify(size)); + } + }); + ``` + + +## geoLocationManager.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(): Promise<number>; + +获取GNSS芯片缓存位置的个数。 + +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 接收错误码。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<number> | number | NA | 返回GNSS缓存位置的个数。 | **错误码**： @@ -315,34 +1329,37 @@ setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolea | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | +|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'); - }) + geoLocationManager.getCachedGnssLocationsSize().then((result) => { + console.log('promise, getCachedGnssLocationsSize: ' + JSON.stringify(result)); + }) .catch((error) => { - console.log('promise, disableLocation: error=' + JSON.stringify(error)); + console.log('promise, getCachedGnssLocationsSize: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.getCountryCode +## geoLocationManager.flushCachedGnssLocations -getCountryCode(callback: AsyncCallback<CountryCode>): void; +flushCachedGnssLocations(callback: AsyncCallback<void>): void; -查询当前的国家码。 +读取并清空GNSS芯片所有缓存位置。 -**系统能力**：SystemCapability.Location.Location.Core +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION + +**系统能力**：SystemCapability.Location.Location.Gnss **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | + | callback | AsyncCallback<void> | 是 | 用来接收错误码信息。 | **错误码**： @@ -350,41 +1367,37 @@ getCountryCode(callback: AsyncCallback<CountryCode>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|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.getCountryCode((err, result) => { + geoLocationManager.flushCachedGnssLocations((err, result) => { if (err) { - console.log('getCountryCode: err=' + JSON.stringify(err)); - } - if (result) { - console.log('getCountryCode: result=' + JSON.stringify(result)); + console.log('flushCachedGnssLocations: err=' + JSON.stringify(err)); } }); ``` -## geoLocationManager.getCountryCode - -getCountryCode(): Promise<CountryCode>; +## geoLocationManager.flushCachedGnssLocations -查询当前的国家码。 +flushCachedGnssLocations(): Promise<void>; -**系统能力**：SystemCapability.Location.Location.Core +读取并清空GNSS芯片所有缓存位置。 -**参数**： +**需要权限**：ohos.permission.APPROXIMATELY_LOCATION -无 +**系统能力**：SystemCapability.Location.Location.Gnss **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<[CountryCode](#countrycode)> | 返回国家码。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void | NA | 接收错误码。 | **错误码**： @@ -392,38 +1405,37 @@ getCountryCode(): Promise<CountryCode>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301500 | Failed to query the area information.| +|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.getCountryCode() - .then((result) => { - console.log('promise, getCountryCode: result=' + JSON.stringify(result)); + geoLocationManager.flushCachedGnssLocations().then((result) => { + console.log('promise, flushCachedGnssLocations success'); }) .catch((error) => { - console.log('promise, getCountryCode: error=' + JSON.stringify(error)); + console.log('promise, flushCachedGnssLocations: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.enableLocationMock +## geoLocationManager.sendCommand -enableLocationMock(callback: AsyncCallback<void>): void; +sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void; -使能位置模拟功能。 +给位置服务子系统的各个部件发送扩展命令。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + | callback | AsyncCallback<void> | 是 | 用来接收错误码。 | **错误码**： @@ -431,39 +1443,40 @@ enableLocationMock(callback: AsyncCallback<void>): void; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -|3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| +|3301000 | Location service is unavailable. | **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocationMock((err, result) => { + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geoLocationManager.sendCommand(requestInfo, (err, result) => { if (err) { - console.log('enableLocationMock: err=' + JSON.stringify(err)); + console.log('sendCommand: err=' + JSON.stringify(err)); } }); ``` -## geoLocationManager.enableLocationMock -enableLocationMock(): Promise<void>; +## geoLocationManager.sendCommand -使能位置模拟功能。 +sendCommand(command: LocationCommand): Promise<void>; -**系统能力**：SystemCapability.Location.Location.Core +给位置服务子系统的各个部件发送扩展命令。 -**系统API**：此接口为系统接口，三方应用不支持调用。 +**系统能力**：SystemCapability.Location.Location.Core **参数**： -无 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | command | [LocationCommand](#locationcommand) | 是 | 指定目标场景，和将要发送的命令（字符串）。 | **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<void> | void | NA | 接收错误码。 | **错误码**： @@ -472,39 +1485,34 @@ enableLocationMock(): Promise<void>; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | |3301000 | Location service is unavailable. | -|3301100 | The location switch is off.| **示例** ```ts import geoLocationManager from '@ohos.geoLocationManager'; - geoLocationManager.enableLocationMock() - .then((result) => { - console.log('promise, enableLocationMock: succeed'); - }) + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geoLocationManager.sendCommand(requestInfo).then((result) => { + console.log('promise, sendCommand success'); + }) .catch((error) => { - if (error) { - console.log('promise, enableLocationMock: error=' + JSON.stringify(error)); - } + console.log('promise, sendCommand: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.disableLocationMock +## geoLocationManager.getCountryCode -disableLocationMock(callback: AsyncCallback<void>): void; +getCountryCode(callback: AsyncCallback<CountryCode>): void; -去使能位置模拟功能。 +查询当前的国家码。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | callback | AsyncCallback<[CountryCode](#countrycode)> | 是 | 用来接收国家码。 | **错误码**： @@ -513,39 +1521,36 @@ disableLocationMock(callback: AsyncCallback<void>): 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'; - geoLocationManager.disableLocationMock((err, result) => { + geoLocationManager.getCountryCode((err, result) => { if (err) { - console.log('disableLocationMock: err=' + JSON.stringify(err)); + console.log('getCountryCode: err=' + JSON.stringify(err)); + } + if (result) { + console.log('getCountryCode: result=' + JSON.stringify(result)); } }); ``` -## geoLocationManager.disableLocationMock +## geoLocationManager.getCountryCode -disableLocationMock(): Promise<void>; +getCountryCode(): Promise<CountryCode>; -去使能位置模拟功能。 +查询当前的国家码。 **系统能力**：SystemCapability.Location.Location.Core -**系统API**：此接口为系统接口，三方应用不支持调用。 - -**参数**： - -无 - **返回值**： - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | Promise<[CountryCode](#countrycode)> | [CountryCode](#countrycode) | NA | 用来接收国家码。 | **错误码**： @@ -554,41 +1559,32 @@ disableLocationMock(): 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'; - geoLocationManager.disableLocationMock() + geoLocationManager.getCountryCode() .then((result) => { - console.log('promise, disableLocationMock succeed'); + console.log('promise, getCountryCode: result=' + JSON.stringify(result)); }) .catch((error) => { - if (error) { - console.log('promise, disableLocationMock: error=' + JSON.stringify(error)); - } + console.log('promise, getCountryCode: error=' + JSON.stringify(error)); }); ``` -## geoLocationManager.setMockedLocations +## geoLocationManager.enableLocationMock -setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void>): void; +enableLocationMock(): void; -设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 +使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -602,43 +1598,24 @@ setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void&g ```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.enableLocationMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setMockedLocations -setMockedLocations(config: LocationMockConfig): Promise<void>; +## geoLocationManager.disableLocationMock -设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 +disableLocationMock(): void; + +去使能位置模拟功能。 **系统能力**：SystemCapability.Location.Location.Core **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | - -**返回值**： - - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -652,31 +1629,19 @@ setMockedLocations(config: LocationMockConfig): Promise<void>; ```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.disableLocationMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.enableReverseGeocodingMock +## geoLocationManager.setMockedLocations -enableReverseGeocodingMock(callback: AsyncCallback<void>): void; +setMockedLocations(config: LocationMockConfig): void; -使能逆地理编码模拟功能。 +设置模拟的位置信息，后面会以该接口中携带的时间间隔上报模拟位置。 **系统能力**：SystemCapability.Location.Location.Core @@ -686,7 +1651,7 @@ enableReverseGeocodingMock(callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | config | [LocationMockConfig](#locationmockconfig) | 是 | 指示位置模拟的配置参数，包含模拟位置上报的时间间隔和模拟位置数组。 | **错误码**： @@ -695,22 +1660,31 @@ 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)); - } - }); + var locations = [ + {"latitude": 30.12, "longitude": 120.11, "altitude": 123, "accuracy": 1, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 1000000000, "additionSize": 0, "isFromMock": true}, + {"latitude": 31.13, "longitude": 121.11, "altitude": 123, "accuracy": 2, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 2000000000, "additionSize": 0, "isFromMock": true}, + {"latitude": 32.14, "longitude": 122.11, "altitude": 123, "accuracy": 3, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 3000000000, "additionSize": 0, "isFromMock": true}, + {"latitude": 33.15, "longitude": 123.11, "altitude": 123, "accuracy": 4, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 4000000000, "additionSize": 0, "isFromMock": true}, + {"latitude": 34.16, "longitude": 124.11, "altitude": 123, "accuracy": 5, "speed": 5.2, "timeStamp": 16594326109, "direction": 123.11, "timeSinceBoot": 5000000000, "additionSize": 0, "isFromMock": true} + ]; + var config = {"timeInterval": 5, "locations": locations}; + try { + geoLocationManager.setMockedLocations(config); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` ## geoLocationManager.enableReverseGeocodingMock -enableReverseGeocodingMock(): Promise<void>; +enableReverseGeocodingMock(): void; 使能逆地理编码模拟功能。 @@ -718,16 +1692,6 @@ enableReverseGeocodingMock(): Promise<void>; **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： - -无 - -**返回值**： - - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -740,21 +1704,17 @@ enableReverseGeocodingMock(): Promise<void>; ```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)); - } - }); + try { + geoLocationManager.enableReverseGeocodingMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` ## geoLocationManager.disableReverseGeocodingMock -disableReverseGeocodingMock(callback: AsyncCallback<void>): void; +disableReverseGeocodingMock(): void; 去使能逆地理编码模拟功能。 @@ -762,12 +1722,6 @@ disableReverseGeocodingMock(callback: AsyncCallback<void>): void; **系统API**：此接口为系统接口，三方应用不支持调用。 -**参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | - **错误码**： 以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)。 @@ -780,19 +1734,19 @@ 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.disableReverseGeocodingMock(); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.disableReverseGeocodingMock +## geoLocationManager.setReverseGeocodingMockInfo -disableReverseGeocodingMock(): Promise<void>; +setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void; -去使能逆地理编码模拟功能。 +设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 **系统能力**：SystemCapability.Location.Location.Core @@ -800,13 +1754,9 @@ disableReverseGeocodingMock(): Promise<void>; **参数**： -无 - -**返回值**： - - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | **错误码**： @@ -820,34 +1770,42 @@ 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)); - } - }); + var mockInfos = [ + {"location": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 30.12, "longitude": 120.11, "maxItems": 1, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 31.12, "longitude": 121.11, "maxItems": 1, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 32.12, "longitude": 122.11, "maxItems": 1, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 33.12, "longitude": 123.11, "maxItems": 1, "isFromMock": true}}, + {"location": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1}, "geoAddress": {"locale": "zh", "latitude": 34.12, "longitude": 124.11, "maxItems": 1, "isFromMock": true}}, + ]; + try { + geoLocationManager.setReverseGeocodingMockInfo(mockInfos); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setReverseGeocodingMockInfo - -setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, callback: AsyncCallback<void>): void; +## geoLocationManager.isLocationPrivacyConfirmed -设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 +isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean; -**系统能力**：SystemCapability.Location.Location.Core +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 **系统API**：此接口为系统接口，三方应用不支持调用。 +**系统能力**：SystemCapability.Location.Location.Core + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置参数数组。逆地理编码模拟功能的配置参数包含了一个位置和一个地名。 | - | callback | AsyncCallback<void> | 是 | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + +**返回值**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | boolean | boolean | NA | 表示用户是否同意定位服务隐私申明。 | **错误码**： @@ -861,42 +1819,32 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, ca ```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, (err, data) => { - if (err) { - console.log('promise, setReverseGeocodingMockInfo, err:' + JSON.stringify(err)); - } - }); + try { + var isConfirmed = geoLocationManager.isLocationPrivacyConfirmed(1); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` -## geoLocationManager.setReverseGeocodingMockInfo - -setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): Promise<void>; +## geoLocationManager.setLocationPrivacyConfirmStatus -设置逆地理编码模拟功能的配置信息，包含了位置和地名的对应关系，后续进行逆地理编码查询时如果位置信息位于配置信息中，就返回对应的地名。 +setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void; -**系统能力**：SystemCapability.Location.Location.Core +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 **系统API**：此接口为系统接口，三方应用不支持调用。 +**需要权限**：ohos.permission.MANAGE_SECURE_SETTINGS + +**系统能力**：SystemCapability.Location.Location.Core + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | mockInfos | Array<[ReverseGeocodingMockInfo](#reversegeocodingmockinfo)> | 是 | 指示逆地理编码模拟功能的配置信息数组。逆地理编码模拟功能的配置信息包含了一个位置和一个地名。 | - -**返回值**： - - | 参数名 | 说明 | - | -------- | -------- | - | Promise<void> | 用来接收执行结果，如果执行成功就返回nullptr，否则就返回错误信息。 | + | type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | **错误码**： @@ -910,22 +1858,11 @@ 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 { + geoLocationManager.setLocationPrivacyConfirmStatus(1, true); + } catch (err) { + console.error("errCode:" + err.code + ",errMessage:" + err.message); + } ``` @@ -935,7 +1872,7 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x200 | 表示未设置优先级。 | | ACCURACY | 0x201 | 表示精度优先。 | @@ -949,7 +1886,7 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x300 | 表示未设置场景信息。 | | NAVIGATION | 0x301 | 表示导航场景。 | @@ -965,12 +1902,12 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | -| maxItems | number | 否 | 指定返回位置信息的最大个数。 | +| locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 | +| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 | ## GeoCodeRequest @@ -979,15 +1916,15 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | -| maxItems | number | 否 | 表示返回位置信息的最大个数。 | -| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | -| minLongitude | number | 否 | 表示最小经度信息。 | -| maxLatitude | number | 否 | 表示最大纬度信息。 | -| maxLongitude | number | 否 | 表示最大经度信息。 | +| locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| description | number | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | +| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 | +| minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | +| minLongitude | number | 是 | 是 | 表示最小经度信息。 | +| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 | +| maxLongitude | number | 是 | 是 | 表示最大经度信息。 | ## GeoAddress @@ -996,27 +1933,27 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | -| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| placeName | string | 否 | 表示地区信息。 | -| countryCode | string | 否 | 表示国家码信息。 | -| countryName | string | 否 | 表示国家信息。 | -| administrativeArea | string | 否 | 表示省份区域信息。 | -| subAdministrativeArea | string | 否 | 表示表示子区域信息。 | -| locality | string | 否 | 表示城市信息。 | -| subLocality | string | 否 | 表示子城市信息。 | -| roadName | string | 否 | 表示路名信息。 | -| subRoadName | string | 否 | 表示子路名信息。 | -| premises | string | 否 | 表示门牌号信息。 | -| postalCode | string | 否 | 表示邮政编码信息。 | -| phoneNumber | string | 否 | 表示联系方式信息。 | -| addressUrl | string | 否 | 表示位置信息附件的网址信息。 | -| descriptions | Array<string> | 否 | 表示附加的描述信息。 | -| descriptionsSize | number | 否 | 表示附加的描述信息数量。 | -| isFromMock | Boolean | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 | +| latitude | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| locale | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| placeName | string | 是 | 否 | 表示地区信息。 | +| countryCode | string | 是 | 否 | 表示国家码信息。 | +| countryName | string| 是 | 否 | 表示国家信息。 | +| administrativeArea | string | 是 | 否 | 表示省份区域信息。 | +| subAdministrativeArea | string | 是 | 否 | 表示表示子区域信息。 | +| locality | string | 是 | 否 | 表示城市信息。 | +| subLocality | string | 是 | 否 | 表示子城市信息。 | +| roadName | string | 是 | 否 |表示路名信息。 | +| subRoadName | string | 是 | 否 | 表示子路名信息。 | +| premises | string| 是 | 否|表示门牌号信息。 | +| postalCode | string | 是 | 否 | 表示邮政编码信息。 | +| phoneNumber | string | 是 | 否 | 表示联系方式信息。 | +| addressUrl | string | 是 | 否 | 表示位置信息附件的网址信息。 | +| descriptions | Array<string> | 是 | 否 | 表示附加的描述信息。 | +| descriptionsSize | number | 是 | 否 | 表示附加的描述信息数量。 | +| isFromMock | Boolean | 是 | 否 | 表示地名信息是否来自于逆地理编码模拟功能。 | ## LocationRequest @@ -1025,13 +1962,13 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | -| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | -| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | -| maxAccuracy | number | 否 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 | +| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 | +| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 | +| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | ## CurrentLocationRequest @@ -1040,12 +1977,12 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | -| maxAccuracy | number | 否 | 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | -| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 | +| maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | +| timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | ## SatelliteStatusInfo @@ -1054,14 +1991,14 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Gnss -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| satellitesNumber | number | 是 | 表示卫星个数。 | -| satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | -| carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | -| altitudes | Array<number> | 是 | 表示高程信息。 | -| azimuths | Array<number> | 是 | 表示方位角。 | -| carrierFrequencies | Array<number> | 是 | 表示载波频率。 | +| satellitesNumber | number | 是 | 否 | 表示卫星个数。 | +| satelliteIds | Array<number> | 是 | 否 | 表示每个卫星的ID，数组类型。 | +| carrierToNoiseDensitys | Array<number> | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 | +| altitudes | Array<number> | 是 | 否 | 表示高程信息。 | +| azimuths | Array<number> | 是 | 否 | 表示方位角。 | +| carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 | ## CachedGnssLocationsRequest @@ -1070,10 +2007,10 @@ setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): P **系统能力**：SystemCapability.Location.Location.Gnss -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | -| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | +| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | +| wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | ## Geofence @@ -1096,11 +2033,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Geofence -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 表示位置信息优先级。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | -| geofence | [Geofence](#geofence) | 是 | 表示围栏信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | +| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | ## LocationPrivacyType @@ -1109,7 +2045,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | OTHERS | 0 | 其他场景。 | | STARTUP | 1 | 开机向导场景下的隐私协议。 | @@ -1122,10 +2058,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | -| command | string | 是 | 扩展命令字符串。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | +| command | string | 是 | 是 | 扩展命令字符串。 | ## Location @@ -1134,19 +2070,19 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | -| altitude | number | 是 | 表示高度信息，单位米。 | -| accuracy | number | 是 | 表示精度信息，单位米。 | -| speed | number | 是 | 表示速度信息，单位米每秒。 | -| timeStamp | number | 是 | 表示位置时间戳，UTC格式。 | -| direction | number | 是 | 表示航向信息。 | -| timeSinceBoot | number | 是 | 表示位置时间戳，开机时间格式。 | -| additions | Array<string> | 否 | 附加信息。 | -| additionSize | number | 否 | 附加信息数量。 | -| isFromMock | Boolean | 否 | 表示位置信息是否来自于位置模拟功能。 | +| latitude | number| 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number| 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| altitude | number | 是 | 否 | 表示高度信息，单位米。 | +| accuracy | number | 是 | 否 | 表示精度信息，单位米。 | +| speed | number | 是 | 否 |表示速度信息，单位米每秒。 | +| timeStamp | number | 是 | 否 | 表示位置时间戳，UTC格式。 | +| direction | number | 是 | 否 | 表示航向信息。 | +| timeSinceBoot | number | 是 | 否 | 表示位置时间戳，开机时间格式。 | +| additions | Array<string> | 是 | 否 | 附加信息。 | +| additionSize | number | 是 | 否 | 附加信息数量。 | +| isFromMock | Boolean | 是 | 否 | 表示位置信息是否来自于位置模拟功能。 | ## ReverseGeocodingMockInfo @@ -1157,10 +2093,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 表示经纬度信息。 | -| geoAddress | [GeoAddress](#geoaddress) | 是 | 表示地名信息。 | +| location | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 是 | 表示经纬度信息。 | +| geoAddress | [GeoAddress](#geoaddress) | 是 | 是 |表示地名信息。 | ## LocationMockConfig @@ -1171,10 +2107,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统API**：此接口为系统接口，三方应用不支持调用。 -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| timeInterval | number | 是 | 表示模拟位置上报的时间间隔，单位是秒。 | -| locations | Array<Location> | 是 | 表示模拟位置数组。 | +| timeInterval | number | 是 | 是 | 表示模拟位置上报的时间间隔，单位是秒。 | +| locations | Array<Location> | 是 | 是 | 表示模拟位置数组。 | ## CountryCode @@ -1183,10 +2119,10 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| country | string | 是 | 表示国家码字符串。 | -| type | [CountryCodeType](#countrycodetype)| 是 | 表示国家码信息来源。 | +| country | string | 是 | 否 | 表示国家码字符串。 | +| type | [CountryCodeType](#countrycodetype) | 是 | 否 | 表示国家码信息来源。 | ## CountryCodeType @@ -1195,7 +2131,7 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | COUNTRY_CODE_FROM_LOCALE | 1 | 从全球化模块的语言配置信息中获取到的国家码。 | | COUNTRY_CODE_FROM_SIM | 2 | 从SIM卡中获取到的国家码。 | 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 7762b8b7339abc5f6488d3546c9399defe5120b7..ea6287ba8cc7ad3feffb90d36fd2d8b7f5836b59 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开始，该接口不再维护，推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。 +> 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 ## 导入模块 @@ -12,14 +12,14 @@ 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(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。 **需要权限**：ohos.permission.LOCATION @@ -47,14 +47,14 @@ 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(type: 'locationChange', callback?: Callback<Location>): void9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。 **需要权限**：ohos.permission.LOCATION @@ -81,14 +81,14 @@ 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(type: 'locationEnabledChange', callback: Callback): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationenabledchange)替代。 **需要权限**：ohos.permission.LOCATION @@ -113,14 +113,14 @@ 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(type: 'locationEnabledChange', callback: Callback): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationEnabledChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationenabledchange)替代。 **需要权限**：ohos.permission.LOCATION @@ -146,14 +146,15 @@ 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 9开始废弃，建议使用[geoLocationManager.on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback>): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroncachedgnsslocationschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -180,14 +181,15 @@ 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 9开始废弃，建议使用[geoLocationManager.off(type: 'cachedGnssLocationsChange', callback?: Callback>): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('cachedGnssLocationsChange')](js-apis-geoLocationManager.md#geolocationmanageroffcachedgnsslocationschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -214,14 +216,15 @@ 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 9开始废弃，建议使用[geoLocationManager.on(type: 'satelliteStatusChange', callback: Callback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageronsatellitestatuschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -246,14 +249,15 @@ 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 9开始废弃，建议使用[geoLocationManager.off(type: 'satelliteStatusChange', callback?: Callback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('satelliteStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffsatellitestatuschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -278,14 +282,15 @@ 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 9开始废弃，建议使用[geoLocationManager.on(type: 'nmeaMessage', callback: Callback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageronnmeamessage)替代。 **需要权限**：ohos.permission.LOCATION @@ -310,14 +315,15 @@ 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 9开始废弃，建议使用[geoLocationManager.off(type: 'nmeaMessage', callback?: Callback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('nmeaMessage')](js-apis-geoLocationManager.md#geolocationmanageroffnmeamessage)替代。 **需要权限**：ohos.permission.LOCATION @@ -343,14 +349,15 @@ 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 9开始废弃，建议使用[geoLocationManager.on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanagerongnssfencestatuschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -391,14 +398,15 @@ 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 9开始废弃，建议使用[geoLocationManager.off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('gnssFenceStatusChange')](js-apis-geoLocationManager.md#geolocationmanageroffgnssfencestatuschange)替代。 **需要权限**：ohos.permission.LOCATION @@ -439,14 +447,14 @@ 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(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 **需要权限**：ohos.permission.LOCATION @@ -477,14 +485,14 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<L ``` -## geolocation.getCurrentLocation +## geolocation.getCurrentLocation(deprecated) getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> 获取当前位置，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation(request?: CurrentLocationRequest): Promise<Location>9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation-2)替代。 **需要权限**：ohos.permission.LOCATION @@ -514,14 +522,14 @@ getCurrentLocation(request?: CurrentLocationRequest): Promise<Location> ``` -## geolocation.getLastLocation +## geolocation.getLastLocation(deprecated) getLastLocation(callback: AsyncCallback<Location>): void 获取上一次位置，使用callback回调异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation(): Location;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 **需要权限**：ohos.permission.LOCATION @@ -549,14 +557,14 @@ getLastLocation(callback: AsyncCallback<Location>): void ``` -## geolocation.getLastLocation +## geolocation.getLastLocation(deprecated) getLastLocation(): Promise<Location> 获取上一次位置，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation(): Location;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getLastLocation](js-apis-geoLocationManager.md#geolocationmanagergetlastlocation)替代。 **需要权限**：ohos.permission.LOCATION @@ -579,14 +587,14 @@ getLastLocation(): Promise<Location> ``` -## geolocation.isLocationEnabled +## geolocation.isLocationEnabled(deprecated) isLocationEnabled(callback: AsyncCallback<boolean>): void 判断位置服务是否已经打开，使用callback回调异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled(): boolean;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 **需要权限**：ohos.permission.LOCATION @@ -613,14 +621,14 @@ isLocationEnabled(callback: AsyncCallback<boolean>): void ``` -## geolocation.isLocationEnabled +## geolocation.isLocationEnabled(deprecated) isLocationEnabled(): Promise<boolean> 判断位置服务是否已经开启，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled(): boolean;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.isLocationEnabled](js-apis-geoLocationManager.md#geolocationmanagerislocationenabled)替代。 **需要权限**：ohos.permission.LOCATION @@ -642,14 +650,14 @@ isLocationEnabled(): Promise<boolean> ``` -## geolocation.requestEnableLocation +## geolocation.requestEnableLocation(deprecated) requestEnableLocation(callback: AsyncCallback<boolean>): void 请求打开位置服务，使用callback回调异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation(callback: AsyncCallback): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation)替代。 **需要权限**：ohos.permission.LOCATION @@ -676,14 +684,14 @@ requestEnableLocation(callback: AsyncCallback<boolean>): void ``` -## geolocation.requestEnableLocation +## geolocation.requestEnableLocation(deprecated) requestEnableLocation(): Promise<boolean> 请求打开位置服务，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation(): Promise;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.requestEnableLocation](js-apis-geoLocationManager.md#geolocationmanagerrequestenablelocation-1)替代。 **需要权限**：ohos.permission.LOCATION @@ -705,14 +713,14 @@ requestEnableLocation(): Promise<boolean> ``` -## geolocation.isGeoServiceAvailable +## geolocation.isGeoServiceAvailable(deprecated) isGeoServiceAvailable(callback: AsyncCallback<boolean>): void 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable(): boolean;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 **需要权限**：ohos.permission.LOCATION @@ -739,14 +747,14 @@ isGeoServiceAvailable(callback: AsyncCallback<boolean>): void ``` -## geolocation.isGeoServiceAvailable +## geolocation.isGeoServiceAvailable(deprecated) isGeoServiceAvailable(): Promise<boolean> 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable(): boolean;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.isGeocoderAvailable](js-apis-geoLocationManager.md#geolocationmanagerisgeocoderavailable)替代。 **需要权限**：ohos.permission.LOCATION @@ -768,14 +776,14 @@ isGeoServiceAvailable(): Promise<boolean> ``` -## geolocation.getAddressesFromLocation +## geolocation.getAddressesFromLocation(deprecated) getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback>): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation)替代。 **需要权限**：ohos.permission.LOCATION @@ -804,14 +812,14 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ``` -## geolocation.getAddressesFromLocation +## geolocation.getAddressesFromLocation(deprecated) getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>; 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise>;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocation](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocation-1)替代。 **需要权限**：ohos.permission.LOCATION @@ -840,14 +848,14 @@ 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(request: GeoCodeRequest, callback: AsyncCallback>): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname)替代。 **需要权限**：ohos.permission.LOCATION @@ -876,14 +884,14 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback< ``` -## geolocation.getAddressesFromLocationName +## geolocation.getAddressesFromLocationName(deprecated) getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>> 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest): Promise>;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getAddressesFromLocationName](js-apis-geoLocationManager.md#geolocationmanagergetaddressesfromlocationname-1)替代。 **需要权限**：ohos.permission.LOCATION @@ -912,14 +920,15 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAd ``` -## geolocation.getCachedGnssLocationsSize8+ +## geolocation.getCachedGnssLocationsSize(deprecated) getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; 获取GNSS芯片缓存位置的个数。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize(callback: AsyncCallback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize)替代。 **需要权限**：ohos.permission.LOCATION @@ -946,14 +955,15 @@ getCachedGnssLocationsSize(callback: AsyncCallback<number>): void; ``` -## geolocation.getCachedGnssLocationsSize8+ +## geolocation.getCachedGnssLocationsSize(deprecated) getCachedGnssLocationsSize(): Promise<number>; 获取GNSS芯片缓存位置的个数。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize(): Promise;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getCachedGnssLocationsSize](js-apis-geoLocationManager.md#geolocationmanagergetcachedgnsslocationssize-1)替代。 **需要权限**：ohos.permission.LOCATION @@ -975,14 +985,15 @@ getCachedGnssLocationsSize(): Promise<number>; ``` -## geolocation.flushCachedGnssLocations8+ +## geolocation.flushCachedGnssLocations(deprecated) flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; 读取并清空GNSS芯片所有缓存位置。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations(callback: AsyncCallback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations)替代。 **需要权限**：ohos.permission.LOCATION @@ -1009,14 +1020,15 @@ flushCachedGnssLocations(callback: AsyncCallback<boolean>): void; ``` -## geolocation.flushCachedGnssLocations8+ +## geolocation.flushCachedGnssLocations(deprecated) flushCachedGnssLocations(): Promise<boolean>; 读取并清空GNSS芯片所有缓存位置。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations(): Promise;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.flushCachedGnssLocations](js-apis-geoLocationManager.md#geolocationmanagerflushcachedgnsslocations-1)替代。 **需要权限**：ohos.permission.LOCATION @@ -1038,14 +1050,15 @@ flushCachedGnssLocations(): Promise<boolean>; ``` -## geolocation.sendCommand8+ +## geolocation.sendCommand(deprecated) sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): void; 给位置服务子系统的各个部件发送扩展命令。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand(command: LocationCommand, callback: AsyncCallback): void;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。 **需要权限**：ohos.permission.LOCATION @@ -1074,14 +1087,15 @@ sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): v ``` -## geolocation.sendCommand8+ +## geolocation.sendCommand(deprecated) sendCommand(command: LocationCommand): Promise<boolean>; 给位置服务子系统的各个部件发送扩展命令。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand(command: LocationCommand): Promise;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.sendCommand](js-apis-geoLocationManager.md#geolocationmanagersendcommand)替代。 **需要权限**：ohos.permission.LOCATION @@ -1110,18 +1124,18 @@ sendCommand(command: LocationCommand): Promise<boolean>; ``` -## LocationRequestPriority +## LocationRequestPriority(deprecated) 位置请求中位置信息优先级设置。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestPriority](js-apis-geoLocationManager.md#locationrequestpriority)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x200 | 表示未设置优先级。 | | ACCURACY | 0x201 | 表示精度优先。 | @@ -1129,18 +1143,18 @@ sendCommand(command: LocationCommand): Promise<boolean>; | FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | -## LocationRequestScenario +## LocationRequestScenario(deprecated) 位置请求中定位场景设置。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequestScenario](js-apis-geoLocationManager.md#locationrequestscenario)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | UNSET | 0x300 | 表示未设置场景信息。 | | NAVIGATION | 0x301 | 表示导航场景。 | @@ -1150,7 +1164,7 @@ sendCommand(command: LocationCommand): Promise<boolean>; | NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | -## GeoLocationErrorCode +## GeoLocationErrorCode(deprecated) 位置服务中的错误码信息。 @@ -1161,7 +1175,7 @@ sendCommand(command: LocationCommand): Promise<boolean>; **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | INPUT_PARAMS_ERROR7+ | 101 | 表示输入参数错误。 | | REVERSE_GEOCODE_ERROR7+ | 102 | 表示逆地理编码接口调用失败。 | @@ -1172,249 +1186,255 @@ sendCommand(command: LocationCommand): Promise<boolean>; | LOCATION_REQUEST_TIMEOUT_ERROR7+ | 107 | 表示单次定位，没有在指定时间内返回位置。 | -## ReverseGeoCodeRequest +## ReverseGeoCodeRequest(deprecated) 逆地理编码请求接口。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.ReverseGeoCodeRequest;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.ReverseGeoCodeRequest](js-apis-geoLocationManager.md#reversegeocoderequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | -| maxItems | number | 否 | 指定返回位置信息的最大个数。 | +| locale | string | 是 | 是 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| latitude | number | 是 | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 是 | 表示经度信息，正值表示东经，负值表示西经。 | +| maxItems | number | 是 | 是 | 指定返回位置信息的最大个数。 | -## GeoCodeRequest +## GeoCodeRequest(deprecated) 地理编码请求接口。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.GeoCodeRequest;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.GeoCodeRequest](js-apis-geoLocationManager.md#geocoderequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | -| maxItems | number | 否 | 表示返回位置信息的最大个数。 | -| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | -| minLongitude | number | 否 | 表示最小经度信息。 | -| maxLatitude | number | 否 | 表示最大纬度信息。 | -| maxLongitude | number | 否 | 表示最大经度信息。 | +| locale | string | 是 | 是 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| description | number | 是 | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | +| maxItems | number | 是 | 是 | 表示返回位置信息的最大个数。 | +| minLatitude | number | 是 | 是 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | +| minLongitude | number | 是 | 是 | 表示最小经度信息。 | +| maxLatitude | number | 是 | 是 | 表示最大纬度信息。 | +| maxLongitude | number | 是 | 是 | 表示最大经度信息。 | -## GeoAddress +## GeoAddress(deprecated) 地理编码类型。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.GeoAddress;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.GeoAddress](js-apis-geoLocationManager.md#geoaddress)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geocoder -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| latitude7+ | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude7+ | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | -| locale7+ | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | -| placeName7+ | string | 否 | 表示地区信息。 | -| countryCode7+ | string | 否 | 表示国家码信息。 | -| countryName7+ | string | 否 | 表示国家信息。 | -| administrativeArea7+ | string | 否 | 表示省份区域信息。 | -| subAdministrativeArea7+ | string | 否 | 表示表示子区域信息。 | -| locality7+ | string | 否 | 表示城市信息。 | -| subLocality7+ | string | 否 | 表示子城市信息。 | -| roadName7+ | string | 否 | 表示路名信息。 | -| subRoadName7+ | string | 否 | 表示子路名信息。 | -| premises7+ | string | 否 | 表示门牌号信息。 | -| postalCode7+ | string | 否 | 表示邮政编码信息。 | -| phoneNumber7+ | string | 否 | 表示联系方式信息。 | -| addressUrl7+ | string | 否 | 表示位置信息附件的网址信息。 | -| descriptions7+ | Array<string> | 否 | 表示附加的描述信息。 | -| descriptionsSize7+ | number | 否 | 表示附加的描述信息数量。 | - - -## LocationRequest +| latitude7+ | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude7+ | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| locale7+ | string | 是 | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| placeName7+ | string | 是 | 否 | 表示地区信息。 | +| countryCode7+ | string | 是 | 否 | 表示国家码信息。 | +| countryName7+ | string | 是 | 否 | 表示国家信息。 | +| administrativeArea7+ | string | 是 | 否 | 表示省份区域信息。 | +| subAdministrativeArea7+ | string | 是 | 否 | 表示表示子区域信息。 | +| locality7+ | string | 是 | 否 | 表示城市信息。 | +| subLocality7+ | string | 是 | 否 | 表示子城市信息。 | +| roadName7+ | string | 是 | 否 | 表示路名信息。 | +| subRoadName7+ | string | 是 | 否 | 表示子路名信息。 | +| premises7+ | string | 是 | 否 | 表示门牌号信息。 | +| postalCode7+ | string | 是 | 否 | 表示邮政编码信息。 | +| phoneNumber7+ | string | 是 | 否| 表示联系方式信息。 | +| addressUrl7+ | string | 是 | 否 | 表示位置信息附件的网址信息。 | +| descriptions7+ | Array<string> | 是 | 否 | 表示附加的描述信息。 | +| descriptionsSize7+ | number | 是 | 否 | 表示附加的描述信息数量。 | + + +## LocationRequest(deprecated) 位置信息请求类型。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequest;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationRequest](js-apis-geoLocationManager.md#locationrequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | -| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | -| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | -| maxAccuracy | number | 否 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 | +| timeInterval | number | 是 | 是 | 表示上报位置信息的时间间隔。 | +| distanceInterval | number | 是 | 是 | 表示上报位置信息的距离间隔。 | +| maxAccuracy | number | 是 | 是 | 表示精度信息。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | -## CurrentLocationRequest +## CurrentLocationRequest(deprecated) 当前位置信息请求类型。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.CurrentLocationRequest;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.CurrentLocationRequest](js-apis-geoLocationManager.md#currentlocationrequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | -| maxAccuracy | number | 否 | 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | -| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示场景信息。 | +| maxAccuracy | number | 是 | 是| 表示精度信息，单位是米。仅在精确位置功能场景下有效，模糊位置功能生效场景下该字段无意义。 | +| timeoutMs | number | 是 | 是 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | -## SatelliteStatusInfo8+ +## SatelliteStatusInfo(deprecated) 卫星状态信息。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.SatelliteStatusInfo;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.SatelliteStatusInfo](js-apis-geoLocationManager.md#satellitestatusinfo)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| satellitesNumber | number | 是 | 表示卫星个数。 | -| satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | -| carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | -| altitudes | Array<number> | 是 | 表示高程信息。 | -| azimuths | Array<number> | 是 | 表示方位角。 | -| carrierFrequencies | Array<number> | 是 | 表示载波频率。 | +| satellitesNumber | number | 是 | 否 | 表示卫星个数。 | +| satelliteIds | Array<number> | 是 | 否 | 表示每个卫星的ID，数组类型。 | +| carrierToNoiseDensitys | Array<number> | 是 | 否 | 表示载波噪声功率谱密度比，即cn0。 | +| altitudes | Array<number> | 是 | 否 | 表示高程信息。 | +| azimuths | Array<number> | 是 | 否 | 表示方位角。 | +| carrierFrequencies | Array<number> | 是 | 否 | 表示载波频率。 | -## CachedGnssLocationsRequest8+ +## CachedGnssLocationsRequest(deprecated) 请求订阅GNSS缓存位置上报功能接口的配置参数。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.CachedGnssLocationsRequest;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.CachedGnssLocationsRequest](js-apis-geoLocationManager.md#cachedgnsslocationsrequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Gnss -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | -| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | +| reportingPeriodSec | number | 是 | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | +| wakeUpCacheQueueFull | boolean | 是 | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | -## Geofence8+ +## Geofence(deprecated) GNSS围栏的配置参数。目前只支持圆形围栏。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.Geofence;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.Geofence](js-apis-geoLocationManager.md#geofence)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| latitude | number | 是 | 表示纬度。 | -| longitude | number | 是 | 表示经度。 | -| radius | number | 是 | 表示圆形围栏的半径。 | -| expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | +| latitude | number | 是 | 是 | 表示纬度。 | +| longitude | number | 是 | 是 | 表示经度。 | +| radius | number | 是 | 是 | 表示圆形围栏的半径。 | +| expiration | number | 是 | 是 | 围栏存活的时间，单位是毫秒。 | -## GeofenceRequest8+ +## GeofenceRequest(deprecated) 请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.GeofenceRequest;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.GeofenceRequest](js-apis-geoLocationManager.md#geofencerequest)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Geofence -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 表示位置信息优先级。 | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | -| geofence | [Geofence](#geofence)| 是 | 表示围栏信息。 | +| priority | [LocationRequestPriority](#locationrequestpriority) | 是 | 是 | 表示位置信息优先级。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | +| geofence | [Geofence](#geofence)| 是 | 是 | 表示围栏信息。 | -## LocationPrivacyType8+ +## LocationPrivacyType(deprecated) 定位服务隐私协议类型。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationPrivacyType](js-apis-geoLocationManager.md#locationprivacytype)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | -------- | -------- | -------- | | OTHERS | 0 | 其他场景。 | | STARTUP | 1 | 开机向导场景下的隐私协议。 | | CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | -## LocationCommand8+ +## LocationCommand(deprecated) 扩展命令结构体。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.LocationCommand;9+](#)替代。 +> 从API version 8开始支持。 +> 从API version 9开始废弃，建议使用[geoLocationManager.LocationCommand](js-apis-geoLocationManager.md#locationcommand)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示定位场景。 | -| command | string | 是 | 扩展命令字符串。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 是 | 表示定位场景。 | +| command | string | 是 | 是 | 扩展命令字符串。 | -## Location +## Location(deprecated) 位置信息类型。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.Location;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.Location](js-apis-geoLocationManager.md#location)替代。 **需要权限**：ohos.permission.LOCATION **系统能力**：SystemCapability.Location.Location.Core -| 名称 | 参数类型 | 必填 | 说明 | +| 名称 | 类型 | 可读|可写 | 说明 | | -------- | -------- | -------- | -------- | -| latitude7+ | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | -| longitude7+ | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | -| altitude7+ | number | 是 | 表示高度信息，单位米。 | -| accuracy7+ | number | 是 | 表示精度信息，单位米。 | -| speed7+ | number | 是 | 表示速度信息，单位米每秒。 | -| timeStamp7+ | number | 是 | 表示位置时间戳，UTC格式。 | -| direction7+ | number | 是 | 表示航向信息。 | -| timeSinceBoot7+ | number | 是 | 表示位置时间戳，开机时间格式。 | -| additions7+ | Array<string> | 否 | 附加信息。 | -| additionSize7+ | number | 否 | 附加信息数量。 | \ No newline at end of file +| latitude7+ | number | 是 | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude7+ | number | 是 | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| altitude7+ | number | 是 | 否 | 表示高度信息，单位米。 | +| accuracy7+ | number | 是 | 否 | 表示精度信息，单位米。 | +| speed7+ | number | 是 | 否 | 表示速度信息，单位米每秒。 | +| timeStamp7+ | number | 是 | 否 | 表示位置时间戳，UTC格式。 | +| direction7+ | number | 是 | 否 | 表示航向信息。 | +| timeSinceBoot7+ | number | 是 | 否 | 表示位置时间戳，开机时间格式。 | +| additions7+ | Array<string> | 是 | 否 | 附加信息。 | +| additionSize7+ | number | 是 | 否 | 附加信息数量。 | \ No newline at end of file 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 ce97c26320553a70a9be7be37829009cb50d8dc7..83b262dc2a9bfce4615c4bd94011ed0a31bda858 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 @@ # 地理位置 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> - 从API Version 9开始，该接口不再维护，推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。 -> > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 从API Version 9开始，该接口不再维护，推荐使用新接口[geoLocationManager](js-apis-geoLocationManager.md)。 ## 导入模块 @@ -19,14 +18,14 @@ import geolocation from '@system.geolocation'; ohos.permission.LOCATION -## geolocation.getLocation +## geolocation.getLocation(deprecated) getLocation(Object): void 获取设备的地理位置。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.getCurrentLocation](js-apis-geoLocationManager.md#geolocationmanagergetcurrentlocation)替代。 **系统能力：** SystemCapability.Location.Location.Lite @@ -78,7 +77,7 @@ export default { ``` -## geolocation.getLocationType +## geolocation.getLocationType(deprecated) getLocationType(Object): void @@ -121,14 +120,14 @@ export default { ``` -## geolocation.subscribe +## geolocation.subscribe(deprecated) subscribe(Object): void 订阅设备的地理位置信息。多次调用的话，只有最后一次的调用生效。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback): void;9+](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.on('locationChange')](js-apis-geoLocationManager.md#geolocationmanageronlocationchange)替代。 **系统能力：** SystemCapability.Location.Location.Lite @@ -176,14 +175,14 @@ export default { ``` -## geolocation.unsubscribe +## geolocation.unsubscribe(deprecated) unsubscribe(): void 取消订阅设备的地理位置信息。 > **说明：**
-> 从API version 9开始废弃，建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback): void;](#)替代。 +> 从API version 9开始废弃，建议使用[geoLocationManager.off('locationChange')](js-apis-geoLocationManager.md#geolocationmanagerofflocationchange)替代。 **系统能力：** SystemCapability.Location.Location.Lite @@ -198,7 +197,7 @@ export default { ``` -## geolocation.getSupportedCoordTypes +## geolocation.getSupportedCoordTypes(deprecated) getSupportedCoordTypes(): Array<string>