diff --git a/zh-cn/application-dev/reference/apis/js-apis-appControl.md b/zh-cn/application-dev/reference/apis/js-apis-appControl.md index 02da6d15a2c59a0ddd7465fdfc8d1a110ba54973..a0a7b55af9f4fd4e745d57d6d11bb97942db3ecb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appControl.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appControl.md @@ -81,7 +81,7 @@ setDisposedStatus(appId: string, disposedWant: Want, callback: AsyncCallback\ appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | +| appId | string | 是 | 需要设置处置的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | | disposedWant | Want | 是 | 对应用的处置意图。 | | callback | AsyncCallback\ | 是 | 回调函数,当设置处置状态成功,err为null,否则为错误对象。 | @@ -112,6 +112,49 @@ try { } ``` +## appControl.setDisposedStatusSync + +setDisposedStatusSync(appId: string, disposedWant: Want): void; + +以同步方法设置应用的处置状态。成功返回null,失败抛出对应异常。 + +**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力:** SystemCapability.BundleManager.BundleFramework.AppControl + +**系统API:** 此接口为系统接口。 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------------------------- | ---- | --------------------------------------- | +| appId | string | 是 | 需要设置处置的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | +| disposedWant | Want | 是 | 对应用的处置意图。 | + +**错误码:** + +以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。 + +| 错误码ID | 错误信息 | +| ------ | -------------------------------------- | +| 17700005 | The specified app ID is empty string. | + +**示例:** + +```ts +import appControl from '@ohos.bundle.appControl'; +import Want from '@ohos.app.ability.Want'; + +let appId: string = "com.example.myapplication_xxxxx"; +let want: Want = {bundleName: 'com.example.myapplication'}; + +try { + appControl.setDisposedStatusSync(appId, want); +} catch (error) { + console.error('setDisposedStatusSync failed ' + error.message); +} +``` + ## appControl.getDisposedStatus getDisposedStatus(appId: string): Promise\; @@ -128,7 +171,7 @@ getDisposedStatus(appId: string): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | --------------------------------------- | -| appId | string | 是 | 要查询的应用的appId
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | +| appId | string | 是 | 要查询的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | **返回值:** @@ -177,7 +220,7 @@ getDisposedStatus(appId: string, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | --------------------------------------- | -| appId | string | 是 | 要查询的应用的appId
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | +| appId | string | 是 | 要查询的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | | callback | AsyncCallback\ | 是 | 回调函数。当获取应用的处置状态成功时,err为null,data为获取到的处置状态;否则为错误对象。 | **错误码:** @@ -206,6 +249,54 @@ try { } ``` +## appControl.getDisposedStatusSync + +getDisposedStatusSync(appId: string): Want; + +以同步方法获取指定应用已设置的处置状态。成功返回应用的处置状态,失败抛出对应异常。 + +**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力:** SystemCapability.BundleManager.BundleFramework.AppControl + +**系统API:** 此接口为系统接口。 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- | --------------------------------------- | +| appId | string | 是 | 要查询的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------------- | ------------------ | +| Want | 返回应用的处置状态。 | + +**错误码:** + +以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。 + +| 错误码ID | 错误信息 | +| ------ | -------------------------------------- | +| 17700005 | The specified app ID is empty string. | + +**示例:** + +```ts +import appControl from '@ohos.bundle.appControl'; +import Want from '@ohos.app.ability.Want'; + +let appId: string = "com.example.myapplication_xxxxx"; +let want: Want; + +try { + want = appControl.getDisposedStatusSync(appId); +} catch (error) { + console.error('getDisposedStatusSync failed ' + error.message); +} +``` + ## appControl.deleteDisposedStatus deleteDisposedStatus(appId: string): Promise\ @@ -222,7 +313,7 @@ deleteDisposedStatus(appId: string): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ----------- | ------ | ---- | --------------------------------------- | -| appId | string | 是 | 要删除处置状态的应用的appId
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | +| appId | string | 是 | 要删除处置状态的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | **返回值:** @@ -299,6 +390,46 @@ try { } ``` +## appControl.deleteDisposedStatusSync + +deleteDisposedStatusSync(appId: string) : void + +以同步方法删除应用的处置状态。成功返回null,失败抛出对应异常。 + +**需要权限:** ohos.permission.MANAGE_DISPOSED_APP_STATUS + +**系统能力:** SystemCapability.BundleManager.BundleFramework.AppControl + +**系统API:** 此接口为系统接口。 + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- | --------------------------------------- | +| appId | string | 是 | 要查询的应用的appId。
appId是应用的唯一标识,由应用Bundle名称和签名信息决定,获取方法参见[获取应用的appId](#获取应用的appid)。 | + +**错误码:** + +以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)。 + +| 错误码ID | 错误信息 | +| ------ | -------------------------------------- | +| 17700005 | The specified app ID is empty string. | + +**示例:** + +```ts +import appControl from '@ohos.bundle.appControl'; + +let appId: string = "com.example.myapplication_xxxxx"; + +try { + appControl.deleteDisposedStatusSync(appId); +} catch (error) { + console.error('deleteDisposedStatusSync failed ' + error.message); +} +``` + ## 获取应用的appId appId是应用的唯一标识,由应用Bundle名称和签名信息决定,可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)接口获取。