From ec323a5b2486cb74bfc3f6c5e16b081fe30a539a Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Mon, 26 Sep 2022 15:22:08 +0800 Subject: [PATCH] Fix docunment code specification of ability Signed-off-by: yuyaozhi --- .../apis/js-apis-ability-wantConstant.md | 6 +- ...s-apis-application-abilityDelegatorArgs.md | 2 +- .../js-apis-application-quickFixManager.md | 186 ++++++++++++++++++ .../reference/apis/js-apis-appmanager.md | 4 +- 4 files changed, 192 insertions(+), 6 deletions(-) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md index 230abe9053..9c07fb33ce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -8,8 +8,8 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。 ## 导入模块 -``` -import wantConstant from '@ohos.ability.wantConstant' +```js +import wantConstant from '@ohos.ability.wantConstant'; ``` ## wantConstant.Action @@ -26,7 +26,7 @@ want操作的常数。 | ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。 | | ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 指示启动管理已安装应用程序的页面功能的操作。 | | ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 指示启动显示指定应用程序详细信息的页面功能的操作。 | -| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操做作。 | +| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操作。 | | ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 指示启动显示所有警报的页面功能的操作时钟。 | | ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 指示启动用于使闹钟睡眠的页面功能的操作。 | | ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 指示启动删除闹钟的页面功能的操作。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md index 4d3076f97c..5cbff5c086 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md @@ -11,7 +11,7 @@ AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注 通过AbilityDelegatorRegistry中getArguments方法获取。 ```js -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; var args = AbilityDelegatorRegistry.getArguments(); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md b/zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md new file mode 100644 index 0000000000..b3d8a7364e --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-application-quickFixManager.md @@ -0,0 +1,186 @@ +# quickFixManager + +quickFixManager模块提供快速修复的能力，快速修复是鸿蒙提供给开发者的一种技术手段，支持开发者以远快于（小时级、分钟级）应用升级的方式进行缺陷修复。 + +> **说明：** +> +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +``` +import quickFixManager from '@ohos.application.quickFixManager'; +``` + +## HapModuleQuickFixInfo + +hap级别的快速修复信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | +| moduleName | 只读 | string | 是 | hap包的名称。 | +| originHapHash | 只读 | string | 是 | 指示hap的哈希值。 | +| quickFixFilePath | 只读 | string | 是 | 指示快速修复文件的安装路径。 | + +## ApplicationQuickFixInfo + +应用级别的快速修复信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +| 名称 | 读写属性 | 类型 | 必填 | 描述 | +| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | +| bundleName | 只读 | string | 是 | 应用的包名。 | +| bundleVersionCode | 只读 | number | 是 | 应用的版本号。 | +| bundleVersionName | 只读 | string | 是 | 应用版本号的文字描述。 | +| quickFixVersionCode | 只读 | number | 是 | 快速修复补丁包的版本号。 | +| quickFixVersionName | 只读 | string | 是 | 快速修复补丁包版本号的文字描述。 | +| hapModuleQuickFixInfo | 只读 | Array\<[HapModuleQuickFixInfo](#hapmodulequickfixinfo)> | 是 | hap级别的快速修复信息。 | + +## quickFixManager.applyQuickFix + +applyQuickFix(hapModuleQuickFixFiles: Array\, callback: AsyncCallback\): void; + +快速修复的补丁安装接口。 + +**需要权限**: ohos.permission.INSTALL_BUNDLE + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | hapModuleQuickFixFiles | Array\ | 否 | 快速修复补丁文件（补丁文件需包含有效的文件路径）。 | + | callback | AsyncCallback\ | 否 | 表示指定的回调方法。 | + +**示例：** + +```js + import quickFixManager from '@ohos.application.quickFixManager' + + let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] + quickFixManager.applyQuickFix(hapModuleQuickFixFiles, (error) => { + if (error) { + console.info( `applyQuickFix failed with error + ${error}`) + } else { + console.info( 'applyQuickFix success') + } + }) +``` + +## quickFixManager.applyQuickFix + +applyQuickFix(hapModuleQuickFixFiles: Array\): Promise\; + +快速修复的补丁安装接口。 + +**需要权限**: ohos.permission.INSTALL_BUNDLE + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | hapModuleQuickFixFiles | Array\ | 否 | 快速修复补丁文件（补丁文件需包含有效的文件路径）。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise\ | 返回相应结果。 | + +**示例：** + +```js + import quickFixManager from '@ohos.application.quickFixManager' + + let hapModuleQuickFixFiles = ["/data/storage/el2/base/entry.hqf"] + quickFixManager.applyQuickFix(hapModuleQuickFixFiles).then(() => { + console.info('applyQuickFix success') + }).catch((error) => { + console.info(`applyQuickFix err: + ${error}`) + }) +``` + +## quickFixManager.getApplicationQuickFixInfo + +getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\): void; + +获取应用的快速修复信息。 + +**需要权限**: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 否 |应用的包名。 | + | callback | AsyncCallback\<[ApplicationQuickFixInfo](#applicationquickfixinfo)> | 否 | 应用的快速修复信息。 | + +**示例：** + +```js + import quickFixManager from '@ohos.application.quickFixManager' + + let bundleName = "bundleName" + quickFixManager.getApplicationQuickFixInfo(bundleName, (error, data) => { + if (error) { + console.info(`getApplicationQuickFixInfo error: + ${error}`) + } else { + console.info(`getApplicationQuickFixInfo success: + ${data}`) + } + }) +``` + +## quickFixManager.getApplicationQuickFixInfo + +getApplicationQuickFixInfo(bundleName: string): Promise\; + +获取应用的快速修复信息。 + +**需要权限**: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.QuickFix + +**系统API**: 此接口为系统接口，三方应用不支持调用。 + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | bundleName | string | 否 | 应用的包名。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise\<[ApplicationQuickFixInfo](#applicationquickfixinfo)> | 返回应用的快速修复信息。 | + +**示例：** + + ```js + import quickFixManager from '@ohos.application.quickFixManager' + + let bundleName = "bundleName" + quickFixManager.getApplicationQuickFixInfo(bundleName).then((data) => { + console.info(`getApplicationQuickFixInfo success: + ${data}`) + }).catch((error) => { + console.info(`getApplicationQuickFixInfo err: + ${error}`) + }) +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index 818145a800..3e5748355f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -822,8 +822,8 @@ console.log('-------- processDiedInfo: ---------', processDiedInfo); | pid8+ | number | 是 | 否 | 进程ID。 | | bundleName8+ | string | 是 | 否 | 应用包名。 | | uid8+ | number | 是 | 否 | 用户ID。 | - - +| isContinuousTask9+ | boolean | 是 | 否 | 判断过程是否为连续任务。 | +| isKeepAlive9+ | boolean | 是 | 否 | 判断该过程是否保持活跃。 | ## ProcessRunningInfo -- GitLab