From a5fef2843243b784a2c10d56d536b65d831e2083 Mon Sep 17 00:00:00 2001 From: xinking129 Date: Sat, 6 May 2023 20:24:52 +0800 Subject: [PATCH] add revoke quick fix to doc file Signed-off-by: xinking129 --- .../apis/commonEventManager-definitions.md | 5 + .../js-apis-app-ability-quickFixManager.md | 101 +++++++++++++++++- 2 files changed, 105 insertions(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md b/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md index 9ede0140ce..3e26acc318 100644 --- a/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md +++ b/zh-cn/application-dev/reference/apis/commonEventManager-definitions.md @@ -788,6 +788,11 @@ Wi-Fi P2P群组信息已更改。 - 值： usual.event.QUICK_FIX_APPLY_RESULT - 订阅者所需权限： 无 +## COMMON_EVENT_QUICK_FIX_REVOKE_RESULT 9+ +表示撤销快速修复应用补丁的动作结果。 +- 值： usual.event.QUICK_FIX_REVOKE_RESULT +- 订阅者所需权限： 无 + ## COMMON_EVENT_HTTP_PROXY_CHANGE10+ 表示HTTP代理的配置信息发生变化。 - 值：usual.event.HTTP_PROXY_CHANGE diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md index 0b908a0bd4..75d2661727 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md @@ -249,4 +249,103 @@ getApplicationQuickFixInfo(bundleName: string): Promise\): void; + +撤销快速修复的补丁接口。 + +**需要权限**: ohos.permission.INSTALL_BUNDLE 与 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 需要撤销补丁的应用Bundle名称。 | + | callback | AsyncCallback\ | 是 | 表示指定的回调方法。 | + +**错误码**： + +| 错误码ID | 错误信息 | +| ------- | -------- | +| 18500001 | The bundle is not exist or no patch has applied. | +| 18500009 | The application has a apply quick fix task that is being processed. | + +在撤销补丁过程中发生的错误，其错误码及错误信息通过公共事件[COMMON_EVENT_QUICK_FIX_REVOKE_RESULT](commonEventManager-definitions.md#common_event_quick_fix_revoke_result9)的参数返回给应用开发者。这部分错误码及错误信息如下： + +| 错误码ID | 错误信息 | +| ------- | -------- | +| 18500004 | Switch hqf failed. | +| 18500005 | Delete hqf failed. | +| 18500007 | Unload patch failed. | + +以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)。 + +> 说明：调用revokeQuickFix接口时。 + +**示例：** + +```ts + let bundleName = "com.example.myapplication"; + quickFixManager.revokeQuickFix(bundleName, (err) => { + console.info("revokeQuickFix " + bundleName + " " + JSON.stringify(err)); + }); +``` + +## quickFixManager.revokeQuickFix + +revokeQuickFix(bundleName: string): Promise\; + +撤销快速修复的补丁接口。 + +**需要权限**: ohos.permission.INSTALL_BUNDLE 与 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 是 | 需要撤销补丁的应用Bundle名称。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise\ | 返回相应结果。 | + +**错误码**： + +| 错误码ID | 错误信息 | +| ------- | -------- | +| 18500001 | The bundle is not exist or no patch has applied. | +| 18500009 | The application has a apply quick fix task that is being processed. | + +在撤销补丁过程中发生的错误，其错误码及错误信息通过公共事件[COMMON_EVENT_QUICK_FIX_REVOKE_RESULT](commonEventManager-definitions.md#common_event_quick_fix_revoke_result9)的参数返回给应用开发者。这部分错误码及错误信息如下： + +| 错误码ID | 错误信息 | +| ------- | -------- | +| 18500004 | Switch hqf failed. | +| 18500005 | Delete hqf failed. | +| 18500007 | Unload patch failed. | + +以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)。 + +**示例：** + +```ts + let bundleName = "com.example.myapplication"; + quickFixManager.revokeQuickFix(bundleName).then(() => { + console.info("revokeQuickFix " + bundleName +" ok"); + }).catch((err) => { + console.info("revokeQuickFix " + bundleName +" failed, error code is ", JSON.stringify((err))); + }); +``` \ No newline at end of file -- GitLab