提交 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;
设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。 设置用户勾选定位服务隐私申明的状态,记录用户是否同意启用定位服务。只有系统应用才能调用。
......
# 地理位置 # 地理位置
> ![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.
先完成此消息的编辑!
想要评论请 注册