From 29462310040df648aa3dd5b6540de22ce8983177 Mon Sep 17 00:00:00 2001 From: zhongjianfei Date: Mon, 19 Dec 2022 16:55:23 +0800 Subject: [PATCH] fix docs bugs Signed-off-by: zhongjianfei Change-Id: I24d9902f0719b76207b65c684a9a2ec4f57028f5 --- .../reference/apis/js-apis-app-ability-ability.md | 2 +- .../apis/js-apis-bundleManager-abilityInfo.md | 2 +- .../apis/js-apis-bundleManager-applicationInfo.md | 2 +- .../apis/js-apis-bundleManager-bundleInfo.md | 2 +- .../js-apis-bundleManager-extensionAbilityInfo.md | 2 +- .../apis/js-apis-bundleManager-hapModuleInfo.md | 2 +- .../reference/apis/js-apis-bundleManager-metadata.md | 8 +++++--- .../apis/js-apis-bundleManager-shortcutInfo.md | 8 +++++--- .../js-apis-continuation-continuationExtraParams.md | 2 +- .../reference/apis/js-apis-inner-ability-want.md | 3 +++ .../apis/js-apis-inner-app-appVersionInfo.md | 12 ++++++------ .../apis/js-apis-inner-application-context.md | 2 +- .../js-apis-inner-application-missionSnapshot.md | 2 +- ...apis-inner-application-permissionRequestResult.md | 2 +- 14 files changed, 29 insertions(+), 22 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md index 8b24d684f3..c3869b472f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md @@ -1,6 +1,6 @@ # Ability基类 -Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 +[UIAbility](js-apis-app-ability-uiAbility.md)和[ExtensionAbility](js-apis-app-ability-extensionAbility.md)的基类，提供系统配置更新回调和系统内存调整回调。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md index fcccbf0b22..7eec5ec8d9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-abilityInfo.md @@ -3,7 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -Ability信息，未做特殊说明的属性，可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取，flag使用[GET_BUNDLE_INFO_WITH_ABILITY](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)。 +Ability信息，系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的Ability信息，三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的Ability信息，其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用GET_BUNDLE_INFO_WITH_ABILITY。 ## AbilityInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md index ce3cf9f315..5e29ca0192 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-applicationInfo.md @@ -3,7 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -应用程序信息，未做特殊说明的属性，可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取，flag使用[GET_BUNDLE_INFO_WITH_APPLICATION](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)。 +应用程序信息，系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的应用程序信息，三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的应用程序信息，其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用GET_BUNDLE_INFO_WITH_APPLICATION。 ## ApplicationInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md index 828aa1716c..649b5ae5e0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-bundleInfo.md @@ -2,7 +2,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -应用包的信息，未做特殊说明的属性，可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取。 +应用包信息，系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的应用包信息，三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的应用包信息，其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_DEFAULT。 ## BundleInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md index cc60e34bf8..15c3623554 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-extensionAbilityInfo.md @@ -2,7 +2,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -ExtensionAbility信息，未做特殊说明的属性，均通过[getBundleInfo](js-apis-bundleManager.md)获取，flag使用[GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY](js-apis-bundleManager.md#bundleflag)获取 +ExtensionAbility信息，系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的ExtensionAbility信息，三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的ExtensionAbility信息，其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY。 ## ExtensionAbilityInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md index e6e46915e3..8fccb9fb69 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-hapModuleInfo.md @@ -3,7 +3,7 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -HAP信息，未做特殊说明的属性，可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取，flag使用[GET_BUNDLE_INFO_WITH_HAP_MODULE ](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)。 +HAP信息，系统应用可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取自身或其他应用的HAP信息，三方应用可以通过[getBundleInfoForSelf](js-apis-bundleManager.md#bundlemanagergetbundleinfoforself)获取自身的HAP信息，其中入参[BundleFlag](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-bundleManager.md#bundleflag)需要使用 GET_BUNDLE_INFO_WITH_HAP_MODULE。 ## HapModuleInfo diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md index 6971539942..86bcc9dea2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-metadata.md @@ -1,8 +1,10 @@ # Metadata -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** + +元数据对象，可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取，此对象在[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)、[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)、[AbilityInfo](js-apis-bundleManager-abilityInfo.md)、[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)中均包含。 + +> **说明：** > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -描述的module、ability、extensionAbility配置信息，标签值为数组类型，该标签下的配置只对当前module、或者ability、或者extensionAbility生效。 -可以通过[getBundleInfo](js-apis-bundleManager.md#bundlemanagergetbundleinfo)获取，此对象在[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)、[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)、[AbilityInfo](js-apis-bundleManager-abilityInfo.md)、[ExtensionAbilityInfo](js-apis-bundleManager-extensionAbilityInfo.md)中均包含。 +描述的module、uiAbility、extensionAbility配置信息，标签值为数组类型，该标签下的配置只对当前module、uiAbility或者extensionAbility生效。 ## Metadata diff --git a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-shortcutInfo.md b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-shortcutInfo.md index 51becb503d..1dd857d129 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-shortcutInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-shortcutInfo.md @@ -1,9 +1,11 @@ # ShortcutInfo -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +应用配置文件中定义的快捷方式信息，可以通过[getShortcutInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetshortcutinfo9)获取。 -本应用配置文件中定义的快捷方式信息，可以通过[getShortcutInfo](js-apis-launcherBundleManager.md#launcherbundlemanagergetshortcutinfo9)获取，FA模型配置在[config.json文件中进行配置](../../quick-start/module-structure.md#表17-shortcuts对象的内部结构说明)，Stage模型配置参考[shortcuts对象内部结构](../../quick-start/module-configuration-file.md#shortcuts标签)。 +> **说明：** +> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> FA模型配置在[config.json文件中进行配置](../../quick-start/module-structure.md#%E8%A1%A817-shortcuts%E5%AF%B9%E8%B1%A1%E7%9A%84%E5%86%85%E9%83%A8%E7%BB%93%E6%9E%84%E8%AF%B4%E6%98%8E)，Stage模型配置参考[shortcuts对象内部结构](../../quick-start/module-configuration-file.md#shortcuts标签)。 ## ShortcutWant diff --git a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md index b29d5bc5ea..14b615cf20 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md +++ b/zh-cn/application-dev/reference/apis/js-apis-continuation-continuationExtraParams.md @@ -1,6 +1,6 @@ # ContinuationExtraParams -本模块提供流转管理入口中设备选择模块所需的过滤参数，可以作为[startContinuationDeviceManager](js-apis-continuation-continuationManager.md#continuationmanagerstartcontinuationdevicemanager9)的入参。 +流转管理入口中设备选择模块所需的过滤参数，可以作为[startContinuationDeviceManager](js-apis-continuation-continuationManager.md#continuationmanagerstartcontinuationdevicemanager9)的入参。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md index d4efa20acf..be9ed68779 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-ability-want.md @@ -65,4 +65,7 @@ Want是对象间信息传递的载体, 可以用于应用组件间的信息传 }) // ... ``` + +- 更多详细说明和示例请参见： [应用模型](../../application-models/Readme-CN.md)的信息传递载体Want + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md index 07a2b82d57..97f3298638 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-app-appVersionInfo.md @@ -1,6 +1,6 @@ # AppVersionInfo -定义应用版本信息，可以通过[getAppVersionInfo](js-apis-inner-app-context.md#contextgetappversioninfo7)获取当前应用的版本信息。 +应用版本信息，可以通过[getAppVersionInfo](js-apis-inner-app-context.md#contextgetappversioninfo7)获取当前应用的版本信息。 > **说明：** > @@ -8,9 +8,9 @@ **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ----------- | ------ | ---- | ---- | ------- | -| appName | string | 是 | 否 | 模块名称。 | -| versionCode | number | 是 | 否 | 模块描述信息。 | -| versionName | string | 是 | 否 | 描述信息ID。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ----------- | ------ | ---- | ---- | -------------- | +| appName | string | 是 | 否 | 应用名称。 | +| versionCode | number | 是 | 否 | 应用版本编码。 | +| versionName | string | 是 | 否 | 应用版本号。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md index 5654f7f258..8d7fc8d22e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md @@ -1,6 +1,6 @@ # Context -Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源等。 +Context模块提供了ability或application的上下文的能力，包括访问特定应用程序的资源等。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md index 0828bb0c09..6cfb665902 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-missionSnapshot.md @@ -1,6 +1,6 @@ # MissionSnapshot -MissionSnapshot模块提供设置与任务对应的任务快照的任务元素名称的能力，可以通过[getMissionSnapShot](js-apis-app-ability-missionManager.md#missionmanagergetmissionsnapshot)获取。 +一个任务的任务快照对象，可以通过[getMissionSnapShot](js-apis-app-ability-missionManager.md#missionmanagergetmissionsnapshot)获取。 > **说明：** > diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md index f386330444..06f2abdd90 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-permissionRequestResult.md @@ -1,6 +1,6 @@ # PermissionRequestResult -PermissionRequestResult模块提供了权限请求结果的能力，在调用[requestPermissionsFromUser](js-apis-inner-application-uiAbilityContext.md#abilitycontextrequestpermissionsfromuser)申请权限时返回此对象表明此次权限申请的结果。 +权限请求结果对象，在调用[requestPermissionsFromUser](js-apis-inner-application-uiAbilityContext.md#abilitycontextrequestpermissionsfromuser)申请权限时返回此对象表明此次权限申请的结果。 > **说明：** > -- GitLab