Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 c64e311a 编写于 作者: X xsz233
浏览文件
操作

add appControl docs(modified) 

Signed-off-by: Nxsz233 <xushizhe@huawei.com>
上级 19f0559e
隐藏空白更改
内联 并排
Showing with 81 addition and 91 deletion
zh-cn/application-dev/reference/apis/js-apis-bundle-appControl.md
浏览文件 @ c64e311a
# 应用拦截管理 # appControl模块
本模块提供应用拦截能力。 本模块提供应用拦截能力。应用被禁止运行后，用户点击桌面图标时，会根据应用的处置状态，跳转到对应的页面。本模块支持对应用的处置状态进行设置、获取、删除。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口为系统接口。
## 导入模块 ## 导入模块
``` ```
...@@ -16,53 +18,50 @@ import appControl from '@ohos.bundle.appControl' ...@@ -16,53 +18,50 @@ import appControl from '@ohos.bundle.appControl'
**function** setDisposedStatus(appId: **string**, disposedWant: **Want**): Promise\<**void**> **function** setDisposedStatus(appId: **string**, disposedWant: **Want**): Promise\<**void**>
以异步方法设置应用的处置，使用Promise形式返回结果，成功返回null，失败返回对应错误信息。 以异步方法设置应用的处置状态。使用Promise异步回调。成功返回null，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
**系统能力：** SystemCapability.BundleManager.BundleFramework.AppControl **系统能力：** SystemCapability.BundleManager.BundleFramework.AppControl
**系统API：** 此接口为系统接口，三方应用不支持调用 **系统API：** 此接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| appId | string | 是 | 需要设置处置的应用的appId | | appId | string | 是 | 需要设置处置状态的应用的appId。 |
| disposedWant | Want(js-apis-application-Want.md) | 是 | 对应用的处置 | | disposedWant | Want | 是 | 对应用的处置意图。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<void> | Promise形式返回设置的结果，成功返回null，失败返回对应错误信息 | | Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var addId = 'com.example.myapplication_xxxxx';
var want = {bundleName: 'com.example.myapplication'};
var addId = "xxx";
var want = {bundleName: "xxxx"};
try { try {
appControl.setDisposedStatus(appId, want) appControl.setDisposedStatus(appId, want)
.then( () => { .then(() => {
console.log("setDisposedStatus success"); console.info('setDisposedStatus success');
}, error => { }).catch((error) => {
console.error("setDisposedStatus failed" + error.code + " " + error.message); console.error('setDisposedStatus failed ' + error.message);
}); });
} catch (error) { } catch (error) {
console.error("param check failed" + error.code + " " + error.message); console.error('setDisposedStatus failed ' + error.message);
} }
``` ```
...@@ -70,7 +69,7 @@ try { ...@@ -70,7 +69,7 @@ try {
**function** setDisposedStatus(appId: **string**, disposedWant: **Want**, callback: AsyncCallback\<**void**>): **void**; **function** setDisposedStatus(appId: **string**, disposedWant: **Want**, callback: AsyncCallback\<**void**>): **void**;
以异步方法设置应用的处置，使用callback形式返回结果，成功返回null，失败返回对应错误信息。 以异步方法设置应用的处置状态。使用callback异步回调。成功返回null，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
...@@ -83,35 +82,33 @@ try { ...@@ -83,35 +82,33 @@ try {
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------------- | ---- | --------------------------------------- | | ----------- | ------------------------------- | ---- | --------------------------------------- |
| appId | string | 是 | 需要设置处置的应用的appId | | appId | string | 是 | 需要设置处置的应用的appId |
| disposedWant | Want(js-apis-application-Want.md) | 是 | 对应用的处置 | | disposedWant | Want | 是 | 对应用的处置意图。 |
| callback | AsyncCallback\<void> | 是 | 程序启动作为入参的回调函数 | | callback | AsyncCallback\<void> | 是 | 回调函数，当设置处置状态成功，err为undefined，否则为错误对象。 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var addId = 'com.example.myapplication_xxxxx';
var want = {bundleName: 'com.example.myapplication'};
var addId = "xxx";
try { try {
appControl.setDisposedStatus(appId, want, (err, data) => { appControl.setDisposedStatus(appId, want, (err, data) => {
if (err) { if (err) {
console.error("setDisposedStatus failed" + error.code + " " + error.message); console.error('setDisposedStatus failed ' + error.message);
return; return;
} }
console.log("setDisposedStatus success"); console.info('setDisposedStatus success');
}); });
} catch (error) { } catch (error) {
console.error("param check error" + error.code + " " + error.message); console.error('setDisposedStatus failed ' + error.message);
} }
``` ```
...@@ -119,7 +116,7 @@ try { ...@@ -119,7 +116,7 @@ try {
**function** getDisposedStatus(appId: **string**): Promise\<**Want**>; **function** getDisposedStatus(appId: **string**): Promise\<**Want**>;
以异步方法获取指定应用已设置的处置，使用Promise形式返回结果，成功返回对应用的处置，失败返回对应错误信息。 以异步方法获取指定应用已设置的处置状态。使用Promise异步回调，成功返回应用的处置状态，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
...@@ -137,34 +134,30 @@ try { ...@@ -137,34 +134,30 @@ try {
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<[Want](js-apis-application-Want.md)> | Promise形式返回对应用的处置。 | | Promise\<Want> | Promise对象，返回应用的处置状态。 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var appId = 'com.example.myapplication_xxxxx';
var addId = "xxx";
try { try {
appControl.getDisposedStatus(appId) appControl.getDisposedStatus(appId)
.then((data) => { .then((data) => {
console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data)); console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data));
}) }).catch((error) => {
.catch((error) => { console.error('getDisposedStatus failed ' + error.message);
console.error('getDisposedStatus failed' + error.code + " " + error.message); });
});
} catch (error) { } catch (error) {
console.error("param check error" + error.code + " " + error.message) console.error('getDisposedStatus failed ' + error.message);
} }
``` ```
...@@ -172,7 +165,7 @@ try { ...@@ -172,7 +165,7 @@ try {
**function** getDisposedStatus(appId: **string**, callback: AsyncCallback\<**Want**>): **void**; **function** getDisposedStatus(appId: **string**, callback: AsyncCallback\<**Want**>): **void**;
以异步方法获取指定应用已设置的处置，使用Promise形式返回结果，成功返回对应用的处置，失败返回对应错误信息。 以异步方法获取指定应用的处置状态。使用callback异步回调，成功返回应用的处置状态，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
...@@ -185,42 +178,39 @@ try { ...@@ -185,42 +178,39 @@ try {
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| appId | string | 是 | 要查询的应用的appId | | appId | string | 是 | 要查询的应用的appId |
| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是 | 程序启动作为入参的回调函数 | | callback | AsyncCallback\<Want> | 是 | 回调函数。当获取应用的处置状态成功时，err为undefined，data为获取到的处置状态；否则为错误对象。 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var appId = 'com.example.myapplication_xxxxx';
var addId = "xxx";
try { try {
appControl.getDisposedStatus(appId, (err, data) => { appControl.getDisposedStatus(appId, (err, data) => {
if (err) { if (err) {
console.error('getDisposedStatus failed' + error.code + " " + error.message); console.error('getDisposedStatus failed ' + error.message);
return; return;
} }
console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data)); console.info('getDisposedStatus success. DisposedStatus: ' + JSON.stringify(data));
}); });
} catch (error) { } catch (error) {
console.error("param check error" + error.code + " " + error.message) console.error('getDisposedStatus failed ' + error.message);
} }
``` ```
## appControl.deleteDisposedStatus ## appControl.deleteDisposedStatus
**function** deleteDisposedStatus(appId: **string**, callback: AsyncCallback\<**void**>) : **void** **function** deleteDisposedStatus(appId: **string**): Promise\<**void**>
以异步方法删除对应用的处置，使用callback形式返回结果，成功返回null，失败返回对应错误信息。 以异步方法删除应用的处置状态。使用promise异步回调，成功返回null，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
...@@ -232,44 +222,44 @@ try { ...@@ -232,44 +222,44 @@ try {
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| appId | string | 是 | 要查询的应用的appId。 | | appId | string | 是 | 要删除处置状态的应用的appId | |
| callback | AsyncCallback\<[void]> | 是 | 程序启动作为入参的回调函数，返回删除结果。 |
**返回值：**
| 类型 | 说明 |
| ------------------------- | ------------------ |
| Promise\<void> | Promise对象，无返回结果的Promise对象 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var appId = 'com.example.myapplication_xxxxx';
var addId = "xxx";
try { try {
appControl.deleteDisposedStatus(appId, (err, data) => { appControl.deleteDisposedStatus(appId)
if (err) { .then(() => {
console.error("deleteDisposedStatus failed" + error.code + " " + error.message); console.info('deleteDisposedStatus success');
return; }).catch((error) => {
} console.error('deleteDisposedStatus failed ' + error.message);
console.log("deleteDisposedStatus success"); });
});
} catch (error) { } catch (error) {
console.error("param check error" + error.code + " " + error.message); console.error('deleteDisposedStatus failed ' + error.message);
} }
``` ```
## appControl.deleteDisposedStatus ## appControl.deleteDisposedStatus
**function** deleteDisposedStatus(appId: **string**): Promise\<**void**> **function** deleteDisposedStatus(appId: **string**, callback: AsyncCallback\<**void**>) : **void**
以异步方法删除对应用的处置，以promise的形式返回结果，成功返回null，失败返回对应错误信息。 以异步方法删除应用的处置状态。使用callback异步回调，成功返回null，失败返回对应错误信息。
**需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS **需要权限：** ohos.permission.MANAGE_DISPOSED_APP_STATUS
...@@ -281,32 +271,32 @@ try { ...@@ -281,32 +271,32 @@ try {
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| appId | string | 是 | 要删除处置的应用的appId | | | appId | string | 是 | 要查询的应用的appId。 |
| callback | AsyncCallback\<void> | 是 | 回调函数，当设置处置状态成功，err为undefined，否则为错误对象。 |
**相关错误码** **相关错误码**
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errcode-bundle.md)。
| 错误码 | 错误信息 | | 错误码 | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 201 | Permission denied. |
| 401 | The parameter check failed. |
| 801 | Capacity not supported. |
| 17700005 | The specified appId was not found. | | 17700005 | The specified appId was not found. |
**示例：** **示例：**
```js ```js
import appControl from '@ohos.bundle.appControl' var appId = 'com.example.myapplication_xxxxx';
var addId = "xxx";
try { try {
appControl.deleteDisposedStatus(appId) appControl.deleteDisposedStatus(appId, (err, data) => {
.then( () => { if (err) {
console.log("deleteDisposedStatus success"); console.error('deleteDisposedStatus failed ' + error.message);
}, error => { return;
console.error("deleteDisposedStatus failed" + error.code + " " + error.message); }
console.info('deleteDisposedStatus success');
}); });
} catch (error) { } catch (error) {
console.error("param check error" + error.code + " " + error.message); console.error('deleteDisposedStatus failed ' + error.message);
} }
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或