@ohos.app.ability.quickFixManager (quickFixManager) (System API)
The quickFixManager module provides APIs for quick fix. With quick fix, you can fix bugs in your application by applying patches, which is more efficient than by updating the entire application.
NOTE
The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs of this module are system APIs and cannot be called by third-party applications.
Modules to Import
import { quickFixManager } from '@kit.AbilityKit';
HapModuleQuickFixInfo
Defines the quick fix information at the HAP file level.
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
| Name | Type | Read-only | Optional | Description |
|---|---|---|---|---|
| moduleName | string | Yes | No | Name of the HAP file. |
| originHapHash | string | Yes | No | Hash value of the HAP file. |
| quickFixFilePath | string | Yes | No | Installation path of the quick fix patch file. |
ApplicationQuickFixInfo
Defines the quick fix information at the application level.
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
| Name | Type | Read-only | Optional | Description |
|---|---|---|---|---|
| bundleName | string | Yes | No | Bundle name. |
| bundleVersionCode | number | Yes | No | Internal version number of the application. |
| bundleVersionName | string | Yes | No | Version number of the application that is shown to users. |
| quickFixVersionCode | number | Yes | No | Version code of the quick fix patch package. |
| quickFixVersionName | string | Yes | No | Text description of the version number of the quick fix patch package. |
| hapModuleQuickFixInfo | Array<HapModuleQuickFixInfo> | Yes | No | Quick fix information at the HAP file level. |
quickFixManager.applyQuickFix
applyQuickFix(hapModuleQuickFixFiles: Array<string>, callback: AsyncCallback<void>): void;
Applies a quick fix patch. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.INSTALL_BUNDLE
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| hapModuleQuickFixFiles | Array<string> | Yes | Quick fix patch files, each of which must contain a valid file path. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the quick fix patch is installed, err is undefined. Otherwise, err is an error object. |
Error codes
If an error occurs during patch installation, the error code and message are returned through the common event COMMON_EVENT_QUICK_FIX_APPLY_RESULT.
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 202 | Not system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500002 | Invalid patch package. |
| 18500008 | Internal error. |
NOTE
The file path passed in the API must be an application sandbox path. For details about how to obtain the sandbox path, see Obtaining the Sandbox Path. The path mapped to the device is /proc/<applicationProcessId>/root/sandboxPath.
Example
import { quickFixManager } from '@kit.AbilityKit';
try {
let hapModuleQuickFixFiles = ['/data/storage/el2/base/entry.hqf'];
quickFixManager.applyQuickFix(hapModuleQuickFixFiles, (error) => {
if (error) {
console.error( `applyQuickFix failed with error: ${error}`);
} else {
console.info(`applyQuickFix success`);
}
});
} catch (paramError) {
console.error(`error.code: ${paramError.code}, error.message: ${paramError.message}`);
}
quickFixManager.applyQuickFix
applyQuickFix(hapModuleQuickFixFiles: Array<string>): Promise<void>;
Applies a quick fix patch. This API uses a promise to return the result.
Required permissions: ohos.permission.INSTALL_BUNDLE
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| hapModuleQuickFixFiles | Array<string> | Yes | Quick fix patch files, each of which must contain a valid file path. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. |
Error codes
If an error occurs during patch installation, the error code and message are returned through the common event COMMON_EVENT_QUICK_FIX_APPLY_RESULT.
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 202 | Not system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500002 | Invalid patch package. |
| 18500008 | Internal error. |
Example
import { quickFixManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let hapModuleQuickFixFiles = ['/data/storage/el2/base/entry.hqf'];
try {
quickFixManager.applyQuickFix(hapModuleQuickFixFiles).then(() => {
console.info(`applyQuickFix success`);
}).catch((error: BusinessError) => {
console.error(`applyQuickFix err: ${error}`);
});
} catch (paramError) {
console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
}
quickFixManager.getApplicationQuickFixInfo
getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback<ApplicationQuickFixInfo>): void;
Obtains the quick fix information of the application. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
| callback | AsyncCallback<ApplicationQuickFixInfo> | Yes | Callback used to return the quick fix information. |
Error codes
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 202 | Not system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500001 | The bundle does not exist or no patch has been applied. |
| 18500008 | Internal error. |
Example
import { quickFixManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
let bundleName = 'bundleName';
quickFixManager.getApplicationQuickFixInfo(bundleName, (error, data) => {
if (error) {
console.error(`getApplicationQuickFixInfo error: ${error}`);
} else {
console.info(`getApplicationQuickFixInfo success: ${data}`);
}
});
} catch (paramError) {
console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
}
quickFixManager.getApplicationQuickFixInfo
getApplicationQuickFixInfo(bundleName: string): Promise<ApplicationQuickFixInfo>;
Obtains the quick fix information of the application. This API uses a promise to return the result.
Required permissions: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Bundle name. |
Return value
| Type | Description |
|---|---|
| Promise<ApplicationQuickFixInfo> | Promise used to return the quick fix information. |
Error codes
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | Permission denied. |
| 202 | Not system application. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500001 | The bundle does not exist or no patch has been applied. |
| 18500008 | Internal error. |
Example
import { quickFixManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
try {
let bundleName = 'bundleName';
quickFixManager.getApplicationQuickFixInfo(bundleName).then((data) => {
console.info(`getApplicationQuickFixInfo success: ${data}`);
}).catch((error: BusinessError) => {
console.error(`getApplicationQuickFixInfo err: ${error}`);
});
} catch (paramError) {
console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
}
quickFixManager.revokeQuickFix10+
revokeQuickFix(bundleName: string, callback: AsyncCallback<void>): void;
Revokes quick fix. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED and ohos.permission.INSTALL_BUNDLE
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Name of the bundle for which the patch needs to be revoked. |
| callback | AsyncCallback<void> | Yes | Callback used to return the result. If quick fix is revoked, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | The application does not have permission to call the interface. |
| 202 | The application is not system-app, can not use system-api. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500001 | The bundle does not exist or no patch has been applied. |
| 18500009 | The application has an ongoing quick fix task. |
If an error occurs during patch installation, the error code and message are returned through the common event COMMON_EVENT_QUICK_FIX_REVOKE_RESULT.
Example
import { quickFixManager } from '@kit.AbilityKit';
let bundleName = 'com.example.myapplication';
quickFixManager.revokeQuickFix(bundleName, (err) => {
if (err.code) {
console.error(`revokeQuickFix ${bundleName} failed, err code: ${err.code}, err msg: ${err.message}.`);
}
});
quickFixManager.revokeQuickFix10+
revokeQuickFix(bundleName: string): Promise<void>;
Revokes quick fix. This API uses a promise to return the result.
Required permissions: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED and ohos.permission.INSTALL_BUNDLE
System capability: SystemCapability.Ability.AbilityRuntime.QuickFix
System API: This is a system API.
Parameters
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| bundleName | string | Yes | Name of the bundle for which the patch needs to be revoked. |
Return value
| Type | Description |
|---|---|
| Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Universal Error Codes and Ability Error Codes.
| ID | Error Message |
|---|---|
| 201 | The application does not have permission to call the interface. |
| 202 | The application is not system-app, can not use system-api. |
| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
| 18500001 | The bundle does not exist or no patch has been applied. |
| 18500009 | The application has an ongoing quick fix task. |
If an error occurs during patch installation, the error code and message are returned through the common event COMMON_EVENT_QUICK_FIX_REVOKE_RESULT. The table below lists the possible error codes and messages.
Example
import { quickFixManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
let bundleName = 'com.example.myapplication';
quickFixManager.revokeQuickFix(bundleName).then(() => {
console.info(`revokeQuickFix ${bundleName} success.`);
}).catch((err: BusinessError) => {
console.error(`revokeQuickFix ${bundleName} failed, err code: ${err.code}, err msg: ${err.message}.`);
});