提交 e5a2a215 编写于 作者: L liu-binjun

bugfix:Document delivery of error code requirements

Signed-off-by: Nliu-binjun <liubinjun@huawei.com>
上级 9f610cea
...@@ -165,9 +165,9 @@ enableLocation(): Promise&lt;void&gt; ...@@ -165,9 +165,9 @@ enableLocation(): Promise&lt;void&gt;
## geoLocationManager.disableLocation ## geoLocationManager.disableLocation
disableLocation(callback: AsyncCallback&lt;void&gt;): void; disableLocation(): void;
关闭位置服务,使用callback回调异步返回结果 关闭位置服务。
**系统API**:此接口为系统接口,三方应用不支持调用。 **系统API**:此接口为系统接口,三方应用不支持调用。
...@@ -177,9 +177,7 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -177,9 +177,7 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 用来接收错误码的回调。 |
**错误码** **错误码**
...@@ -201,48 +199,9 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void; ...@@ -201,48 +199,9 @@ disableLocation(callback: AsyncCallback&lt;void&gt;): void;
``` ```
## geoLocationManager.disableLocation
disableLocation(): Promise&lt;void&gt;
关闭位置服务,使用Promise方式异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回错误码。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.disableLocation().then((result) => {
console.log('promise, disableLocation succeed');
})
.catch((error) => {
console.log('promise, disableLocation: error=' + JSON.stringify(error));
});
```
## geoLocationManager.isLocationPrivacyConfirmed ## geoLocationManager.isLocationPrivacyConfirmed
isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&lt;boolean&gt;): void; isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。 查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
...@@ -255,7 +214,12 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l ...@@ -255,7 +214,12 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | | type | [LocationPrivacyType](#locationprivacytype)| 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 表示用户是否同意定位服务隐私申明。 |
**返回值**
| 类型 | 说明 |
| ------ | ---------------- |
| boolean | 表示用户是否同意定位服务隐私申明。。 |
**错误码** **错误码**
...@@ -280,49 +244,9 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l ...@@ -280,49 +244,9 @@ isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback&l
``` ```
## geoLocationManager.isLocationPrivacyConfirmed
isLocationPrivacyConfirmed(type : LocationPrivacyType,): Promise&lt;boolean&gt;;
查询用户是否同意定位服务隐私申明,是否同意启用定位服务。只有系统应用才能调用。
**系统API**:此接口为系统接口,三方应用不支持调用。
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | [LocationPrivacyType](#locationprivacytype) | 是 | 指定隐私申明场景,例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 |
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 表示用户是否同意定位服务隐私申明。 |
**错误码**
以下错误码的详细介绍请参见[位置服务子系统错误码](../errorcodes/errorcode-geoLocationManager.md)
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
|3301000 | Location service is unavailable. |
**示例**
```ts
import geoLocationManager from '@ohos.geoLocationManager';
geoLocationManager.isLocationPrivacyConfirmed(1).then((result) => {
console.log('promise, isLocationPrivacyConfirmed: ' + JSON.stringify(result));
});
```
## geoLocationManager.setLocationPrivacyConfirmStatus ## geoLocationManager.setLocationPrivacyConfirmStatus
setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback&lt;void&gt;): void; setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。 设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 从API Version 9开始,该接口不再维护,推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。
## 导入模块 ## 导入模块
...@@ -18,6 +18,9 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat ...@@ -18,6 +18,9 @@ on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Locat
开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报, 开启位置变化订阅,并发起定位请求。定位结果按照[LocationRequest](#locationrequest)的属性进行上报,
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -50,6 +53,9 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void ...@@ -50,6 +53,9 @@ off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void
关闭位置变化订阅,并删除对应的定位请求。 关闭位置变化订阅,并删除对应的定位请求。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -81,6 +87,9 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void ...@@ -81,6 +87,9 @@ on(type: 'locationServiceState', callback: Callback&lt;boolean&gt;): void
订阅位置服务状态变化。 订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -110,6 +119,9 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void; ...@@ -110,6 +119,9 @@ off(type: 'locationServiceState', callback?: Callback&lt;boolean&gt;): void;
取消订阅位置服务状态变化。 取消订阅位置服务状态变化。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationEnabledChange', callback: Callback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -140,6 +152,9 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca ...@@ -140,6 +152,9 @@ on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, ca
订阅缓存GNSS定位结果上报事件。 订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -171,6 +186,9 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati ...@@ -171,6 +186,9 @@ off(type: 'cachedGnssLocationsReporting', callback?: Callback&lt;Array&lt;Locati
取消订阅缓存GNSS定位结果上报事件。 取消订阅缓存GNSS定位结果上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -202,6 +220,9 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi ...@@ -202,6 +220,9 @@ on(type: 'gnssStatusChange', callback: Callback&lt;SatelliteStatusInfo&gt;): voi
订阅GNSS卫星状态信息上报事件。 订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -231,6 +252,9 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v ...@@ -231,6 +252,9 @@ off(type: 'gnssStatusChange', callback?: Callback&lt;SatelliteStatusInfo&gt;): v
取消订阅GNSS卫星状态信息上报事件。 取消订阅GNSS卫星状态信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -260,6 +284,9 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void; ...@@ -260,6 +284,9 @@ on(type: 'nmeaMessageChange', callback: Callback&lt;string&gt;): void;
订阅GNSS NMEA信息上报事件。 订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'nmeaMessage', callback: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -289,6 +316,9 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void; ...@@ -289,6 +316,9 @@ off(type: 'nmeaMessageChange', callback?: Callback&lt;string&gt;): void;
取消订阅GNSS NMEA信息上报事件。 取消订阅GNSS NMEA信息上报事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'nmeaMessage', callback?: Callback<string>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -319,6 +349,9 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -319,6 +349,9 @@ on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
添加一个围栏,并订阅地理围栏事件。 添加一个围栏,并订阅地理围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -364,6 +397,9 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -364,6 +397,9 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
删除一个围栏,并取消订阅该围栏事件。 删除一个围栏,并取消订阅该围栏事件。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -407,9 +443,11 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void; ...@@ -407,9 +443,11 @@ off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void
获取当前位置,使用callback回调异步返回结果。 获取当前位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;Location&gt;): void<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -443,9 +481,11 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L ...@@ -443,9 +481,11 @@ getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback&lt;L
getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt; getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;
获取当前位置,使用Promise方式异步返回结果。 获取当前位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation(request?: CurrentLocationRequest): Promise&lt;Location&gt;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -480,6 +520,9 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void ...@@ -480,6 +520,9 @@ getLastLocation(callback: AsyncCallback&lt;Location&gt;): void
获取上一次位置,使用callback回调异步返回结果。 获取上一次位置,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -512,6 +555,9 @@ getLastLocation(): Promise&lt;Location&gt; ...@@ -512,6 +555,9 @@ getLastLocation(): Promise&lt;Location&gt;
获取上一次位置,使用Promise方式异步返回结果。 获取上一次位置,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getLastLocation(): Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -537,9 +583,11 @@ getLastLocation(): Promise&lt;Location&gt; ...@@ -537,9 +583,11 @@ getLastLocation(): Promise&lt;Location&gt;
isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void isLocationEnabled(callback: AsyncCallback&lt;boolean&gt;): void
判断位置服务是否已经打开,使用callback回调异步返回结果。 判断位置服务是否已经打开,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -571,6 +619,9 @@ isLocationEnabled(): Promise&lt;boolean&gt; ...@@ -571,6 +619,9 @@ isLocationEnabled(): Promise&lt;boolean&gt;
判断位置服务是否已经开启,使用Promise方式异步返回结果。 判断位置服务是否已经开启,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isLocationEnabled(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -595,9 +646,11 @@ isLocationEnabled(): Promise&lt;boolean&gt; ...@@ -595,9 +646,11 @@ isLocationEnabled(): Promise&lt;boolean&gt;
requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void requestEnableLocation(callback: AsyncCallback&lt;boolean&gt;): void
请求打开位置服务,使用callback回调异步返回结果。 请求打开位置服务,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(callback: AsyncCallback<boolean>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -629,6 +682,9 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -629,6 +682,9 @@ requestEnableLocation(): Promise&lt;boolean&gt;
请求打开位置服务,使用Promise方式异步返回结果。 请求打开位置服务,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.requestEnableLocation(): Promise<boolean>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -649,132 +705,15 @@ requestEnableLocation(): Promise&lt;boolean&gt; ...@@ -649,132 +705,15 @@ requestEnableLocation(): Promise&lt;boolean&gt;
``` ```
## geolocation.enableLocation
enableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
打开位置服务,使用callback回调异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.enableLocation((err, data) => {
if (err) {
console.log('enableLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('enableLocation: data=' + JSON.stringify(data));
}
});
```
## geolocation.enableLocation
enableLocation(): Promise&lt;boolean&gt;
打开位置服务,使用Promise方式异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.enableLocation().then((result) => {
console.log('promise, enableLocation: ' + JSON.stringify(result));
});
```
## geolocation.disableLocation
disableLocation(callback: AsyncCallback&lt;boolean&gt;): void;
关闭位置服务,使用callback回调异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 用来接收位置服务状态的回调。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.disableLocation((err, data) => {
if (err) {
console.log('disableLocation: err=' + JSON.stringify(err));
}
if (data) {
console.log('disableLocation: data=' + JSON.stringify(data));
}
});
```
## geolocation.disableLocation
disableLocation(): Promise&lt;boolean&gt;
关闭位置服务,使用Promise方式异步返回结果。
**系统API**:此接口为系统接口,三方应用不支持调用。
**需要权限**:ohos.permission.MANAGE_SECURE_SETTINGS
**系统能力**:SystemCapability.Location.Location.Core
**返回值**
| 参数名 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | 返回位置服务是否可用。 |
**示例**
```ts
import geolocation from '@ohos.geolocation';
geolocation.disableLocation().then((result) => {
console.log('promise, disableLocation: ' + JSON.stringify(result));
});
```
## geolocation.isGeoServiceAvailable ## geolocation.isGeoServiceAvailable
isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void isGeoServiceAvailable(callback: AsyncCallback&lt;boolean&gt;): void
判断(逆)地理编码服务状态,使用callback回调异步返回结果。 判断(逆)地理编码服务状态,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -806,6 +745,9 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt; ...@@ -806,6 +745,9 @@ isGeoServiceAvailable(): Promise&lt;boolean&gt;
判断(逆)地理编码服务状态,使用Promise方式异步返回结果。 判断(逆)地理编码服务状态,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.isGeocoderAvailable(): boolean;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -832,6 +774,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback ...@@ -832,6 +774,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback
调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。 调用逆地理编码服务,将坐标转换为地理描述,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -865,6 +810,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge ...@@ -865,6 +810,9 @@ getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise&lt;Array&lt;Ge
调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。 调用逆地理编码服务,将坐标转换为地理描述,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -898,6 +846,9 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt ...@@ -898,6 +846,9 @@ getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback&lt
调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。 调用地理编码服务,将地理描述转换为具体坐标,使用callback回调异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -931,6 +882,9 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd ...@@ -931,6 +882,9 @@ getAddressesFromLocationName(request: GeoCodeRequest): Promise&lt;Array&lt;GeoAd
调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。 调用地理编码服务,将地理描述转换为具体坐标,使用Promise方式异步返回结果。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -964,6 +918,9 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void; ...@@ -964,6 +918,9 @@ getCachedGnssLocationsSize(callback: AsyncCallback&lt;number&gt;): void;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -995,6 +952,9 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;; ...@@ -995,6 +952,9 @@ getCachedGnssLocationsSize(): Promise&lt;number&gt;;
获取GNSS芯片缓存位置的个数。 获取GNSS芯片缓存位置的个数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCachedGnssLocationsSize(): Promise<number>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1021,6 +981,9 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void; ...@@ -1021,6 +981,9 @@ flushCachedGnssLocations(callback: AsyncCallback&lt;boolean&gt;): void;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1052,6 +1015,9 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;; ...@@ -1052,6 +1015,9 @@ flushCachedGnssLocations(): Promise&lt;boolean&gt;;
读取并清空GNSS芯片所有缓存位置。 读取并清空GNSS芯片所有缓存位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.flushCachedGnssLocations(): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1078,6 +1044,9 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v ...@@ -1078,6 +1044,9 @@ sendCommand(command: LocationCommand, callback: AsyncCallback&lt;boolean&gt;): v
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1111,6 +1080,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1111,6 +1080,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
给位置服务子系统的各个部件发送扩展命令。 给位置服务子系统的各个部件发送扩展命令。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.sendCommand(command: LocationCommand): Promise<void>;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1138,11 +1110,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1138,11 +1110,13 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
``` ```
## LocationRequestPriority ## LocationRequestPriority
位置请求中位置信息优先级设置。 位置请求中位置信息优先级设置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestPriority;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1159,6 +1133,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1159,6 +1133,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置请求中定位场景设置。 位置请求中定位场景设置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequestScenario;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1177,6 +1154,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1177,6 +1154,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置服务中的错误码信息。 位置服务中的错误码信息。
> **说明:**<br/>
> 从API version 9开始废弃。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1196,6 +1176,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1196,6 +1176,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
逆地理编码请求接口。 逆地理编码请求接口。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.ReverseGeoCodeRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1212,6 +1195,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1212,6 +1195,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
地理编码请求接口。 地理编码请求接口。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoCodeRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1231,6 +1217,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1231,6 +1217,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
地理编码类型。 地理编码类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeoAddress;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geocoder **系统能力**:SystemCapability.Location.Location.Geocoder
...@@ -1261,6 +1250,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1261,6 +1250,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
位置信息请求类型。 位置信息请求类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1278,6 +1270,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1278,6 +1270,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
当前位置信息请求类型。 当前位置信息请求类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.CurrentLocationRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1294,6 +1289,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1294,6 +1289,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
卫星状态信息。 卫星状态信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.SatelliteStatusInfo;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1312,6 +1310,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1312,6 +1310,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
请求订阅GNSS缓存位置上报功能接口的配置参数。 请求订阅GNSS缓存位置上报功能接口的配置参数。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.CachedGnssLocationsRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Gnss **系统能力**:SystemCapability.Location.Location.Gnss
...@@ -1326,6 +1327,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;; ...@@ -1326,6 +1327,9 @@ sendCommand(command: LocationCommand): Promise&lt;boolean&gt;;
GNSS围栏的配置参数。目前只支持圆形围栏。 GNSS围栏的配置参数。目前只支持圆形围栏。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.Geofence;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -1342,6 +1346,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1342,6 +1346,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。 请求添加GNSS围栏消息中携带的参数,包括定位优先级、定位场景和围栏信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.GeofenceRequest;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Geofence **系统能力**:SystemCapability.Location.Location.Geofence
...@@ -1357,6 +1364,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1357,6 +1364,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
定位服务隐私协议类型。 定位服务隐私协议类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationPrivacyType;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1372,6 +1382,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1372,6 +1382,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
扩展命令结构体。 扩展命令结构体。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.LocationCommand;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
...@@ -1386,6 +1399,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。 ...@@ -1386,6 +1399,9 @@ GNSS围栏的配置参数。目前只支持圆形围栏。
位置信息类型。 位置信息类型。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.Location;<sup>9+</sup>](#)替代。
**需要权限**:ohos.permission.LOCATION **需要权限**:ohos.permission.LOCATION
**系统能力**:SystemCapability.Location.Location.Core **系统能力**:SystemCapability.Location.Location.Core
......
# 地理位置 # 地理位置
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - 从API Version 7 开始,该接口不再维护,推荐使用新接口[`@ohos.geolocation`](js-apis-geolocation.md)。 > - 从API Version 9开始,该接口不再维护,推荐使用新接口[`@ohos.geoLocationManager`](js-apis-geoLocationManager.md)。
> >
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...@@ -25,6 +25,9 @@ getLocation(Object): void ...@@ -25,6 +25,9 @@ getLocation(Object): void
获取设备的地理位置。 获取设备的地理位置。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.getCurrentLocation<sup>9+</sup>](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -81,6 +84,9 @@ getLocationType(Object): void ...@@ -81,6 +84,9 @@ getLocationType(Object): void
获取当前设备支持的定位类型。 获取当前设备支持的定位类型。
> **说明:**<br/>
> 从API version 9开始废弃。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -121,6 +127,9 @@ subscribe(Object): void ...@@ -121,6 +127,9 @@ subscribe(Object): void
订阅设备的地理位置信息。多次调用的话,只有最后一次的调用生效。 订阅设备的地理位置信息。多次调用的话,只有最后一次的调用生效。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void;<sup>9+</sup>](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**参数:** **参数:**
...@@ -173,6 +182,9 @@ unsubscribe(): void ...@@ -173,6 +182,9 @@ unsubscribe(): void
取消订阅设备的地理位置信息。 取消订阅设备的地理位置信息。
> **说明:**<br/>
> 从API version 9开始废弃,建议使用[geoLocationManager.off(type: 'locationChange', callback?: Callback<Location>): void;](#)替代。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**示例:** **示例:**
...@@ -192,6 +204,9 @@ getSupportedCoordTypes(): Array&lt;string&gt; ...@@ -192,6 +204,9 @@ getSupportedCoordTypes(): Array&lt;string&gt;
获取设备支持的坐标系类型。 获取设备支持的坐标系类型。
> **说明:**<br/>
> 从API version 9开始废弃。
**系统能力:** SystemCapability.Location.Location.Lite **系统能力:** SystemCapability.Location.Location.Lite
**返回值:** **返回值:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册