From 3a8d8a7b31dbd4d6ef2daa876aeba0337160bd4c Mon Sep 17 00:00:00 2001 From: yuyaozhi Date: Thu, 23 Jun 2022 11:46:02 +0800 Subject: [PATCH] Add module description of ability Signed-off-by: yuyaozhi --- zh-cn/application-dev/reference/apis/js-apis-Context.md | 2 ++ .../reference/apis/js-apis-DataUriUtils.md | 2 ++ .../reference/apis/js-apis-ability-context.md | 6 ++++-- .../reference/apis/js-apis-ability-errorCode.md | 4 ++++ .../reference/apis/js-apis-ability-wantConstant.md | 2 ++ .../reference/apis/js-apis-abilityDelegatorRegistry.md | 2 ++ .../reference/apis/js-apis-abilityManager.md | 2 -- .../reference/apis/js-apis-abilityrunninginfo.md | 4 ++-- .../reference/apis/js-apis-abilitystagecontext.md | 6 ++++-- .../reference/apis/js-apis-application-StartOptions.md | 5 +---- .../reference/apis/js-apis-application-Want.md | 6 +++--- .../reference/apis/js-apis-application-ability.md | 9 +++++++-- .../apis/js-apis-application-abilityConstant.md | 7 +++---- .../apis/js-apis-application-abilityDelegator.md | 2 ++ .../apis/js-apis-application-abilityDelegatorArgs.md | 2 ++ .../apis/js-apis-application-abilityLifecycleCallback.md | 4 ++-- .../reference/apis/js-apis-application-abilityMonitor.md | 2 ++ .../reference/apis/js-apis-application-abilitystage.md | 6 ++++-- .../apis/js-apis-application-applicationContext.md | 4 ++-- .../reference/apis/js-apis-application-context.md | 2 ++ .../reference/apis/js-apis-application-shellCmdResult.md | 2 ++ ...-apis-application-staticSubscriberExtensionAbility.md | 2 ++ .../application-dev/reference/apis/js-apis-appmanager.md | 6 ++---- .../reference/apis/js-apis-configuration.md | 4 ++-- .../reference/apis/js-apis-configurationconstant.md | 7 ++----- zh-cn/application-dev/reference/apis/js-apis-eventhub.md | 4 ++-- .../reference/apis/js-apis-extension-context.md | 7 ++++--- .../reference/apis/js-apis-extensionrunninginfo.md | 3 ++- .../reference/apis/js-apis-featureAbility.md | 2 ++ zh-cn/application-dev/reference/apis/js-apis-formInfo.md | 4 ++-- .../reference/apis/js-apis-formbindingdata.md | 2 ++ .../application-dev/reference/apis/js-apis-formerror.md | 4 ++-- .../reference/apis/js-apis-formextension.md | 4 ++-- .../reference/apis/js-apis-formextensioncontext.md | 6 ++++-- zh-cn/application-dev/reference/apis/js-apis-formhost.md | 4 ++-- .../reference/apis/js-apis-formprovider.md | 4 ++-- .../reference/apis/js-apis-missionManager.md | 3 +-- .../reference/apis/js-apis-particleAbility.md | 2 ++ .../reference/apis/js-apis-permissionrequestresult.md | 4 ++-- .../reference/apis/js-apis-processrunninginfo.md | 4 ++-- .../reference/apis/js-apis-service-extension-ability.md | 4 ++-- .../reference/apis/js-apis-service-extension-context.md | 6 ++++-- .../application-dev/reference/apis/js-apis-testRunner.md | 4 ++++ .../reference/apis/js-apis-uripermissionmanager.md | 5 ++--- .../application-dev/reference/apis/js-apis-wantAgent.md | 2 ++ 45 files changed, 109 insertions(+), 69 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 0a5358b993..e764ac7212 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -1,5 +1,7 @@ # Context模块 +Context模块提供了ability或application的上下文的能力，包括允许访问特定于应用程序的资源、请求和验证权限等并且只能通过ability获得。 + > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md index 571e280078..97cf4b2138 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md +++ b/zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md @@ -1,5 +1,7 @@ # DataUriUtils模块 +DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径组件末尾的ID。 + > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index a6b0403166..4d83cbafe3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -1,12 +1,14 @@ # AbilityContext +AbilityContext是Ability的上下文环境，继承自Context。 + +AbilityContext模块提供允许访问特定于ability的资源的能力，包括对Ability的启动、停止的设置、获取caller通信接口、拉起弹窗请求用户授权等。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -Ability的上下文环境，继承自Context。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md index f885474971..3ac842d69c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md @@ -1,5 +1,9 @@ # ErrorCode +ErrorCode是定义启动功能时使用的错误代码。 + +本模块提供使用的错误代码的能力，包括没有错误，无效的参数等。 + > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 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 2cc1e5e69d..7d398275e4 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 @@ -1,5 +1,7 @@ # wantConstant +wantConstant模块提供want中action和entity的权限列表的能力，包括系统公共事件宏，系统公共事件名称等。 + > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md index de2754e56a..99ab605979 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md @@ -1,5 +1,7 @@ # AbilityDelegatorRegistry +AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md index b34141cb8f..a28fee592d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityManager.md @@ -19,8 +19,6 @@ Ability的状态信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core -**系统API**: 此接口为系统接口，三方应用不支持调用。 - | 名称 | 值 | 说明 | | -------- | -------- | -------- | | INITIAL | 0 | 表示ability为initial状态。| diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md index 55065f1521..d3e9d1618b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md @@ -1,11 +1,11 @@ # AbilityRunningInfo +AbilityRunningInfo模块提供对Ability运行的相关信息和状态进行设置和查询的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -Ability运行相关信息。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md index 708756b586..17a9f31170 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md @@ -1,12 +1,14 @@ # AbilityStageContext +AbilityStageContext是AbilityStage的上下文环境，继承自[Context](js-apis-application-context.md)。 + +AbilityStageContext提供允许访问特定于abilityStage的资源的能力，包括获取AbilityStage对应的ModuleInfo对象、环境变化对象。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -AbilityStage的上下文环境，继承自[Context](js-apis-application-context.md)。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md index 6bcc3415bd..5f5a79c9b1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-StartOptions.md @@ -1,15 +1,12 @@ # StartOptions -- [导入模块](#导入模块) -- [属性](#属性) +StartOptions模块对系统的基本通信组件进行查询和设置的能力。 > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -StartOptions是系统的基本通信组件。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md index 3de25db179..a85af4fa07 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md @@ -1,11 +1,11 @@ # Want +Want模块提供系统的基本通信组件的能力。 + > **说明：** > > 本模块首批接口从API version 8 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -Want是系统的基本通信组件。 - ## 导入模块 ``` @@ -27,4 +27,4 @@ import Want from '@ohos.application.Want'; | action | 只读 | string | 否 | 表示action选项描述。 | | parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | | entities | 只读 | Array\ | 否 | 表示entities相关描述。 | -| moduleName9+ | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。同一应用的不同hap的组件可能重名，仅通过BundleName和AbilityName无法区分时，可以通过设置moduleName加以区分，以匹配到指定的Ability。 | | + diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md index e8677abf2c..5934a0a89c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-ability.md @@ -1,12 +1,17 @@ # Ability +Ability模块提供对Ability生命周期、上下文环境等调用管理的能力，包括Ability创建、销毁、转储客户端信息等。 + +该模块提供以下Ability相关的常用功能： + +- [Caller](#caller)：通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。 +- [Callee](#callee)：通用组件服务端注册和解除客户端caller通知送信的callback接口。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -Ability模块，提供对Ability生命周期、上下文环境等调用管理。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index e3c9b905b3..312d3b9386 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -1,15 +1,14 @@ # AbilityConstant -- [导入模块](#导入模块) -- [属性](#属性) +AbilityConstant是启动参数的接口。 + +AbilityConstant提供启动参数的接口的能力，包括设置初次开始原因的类型、上次退出原因的类型、继续结果的类型。 > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -启动参数的接口. - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md index cfe0dda023..c71b0bd271 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -1,5 +1,7 @@ # AbilityDelegator +AbilityDelegator提供添加用于监视指定能力的生命周期状态更改的AbilityMonitor对象的能力，包括对AbilityMonitor实例的添加、删除、等待ability到达OnCreate生命周期、设置等待时间等、获取指定ability的生命周期状态、获取当前应用顶部ability、启动指定ability等。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 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 20fa357327..27983fe5f4 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 @@ -1,5 +1,7 @@ # AbilityDelegatorArgs +AbilityDelegatorArgs模块提供在应用程序启动期间，用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md index 98136d532e..f220273cbf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityLifecycleCallback.md @@ -1,13 +1,13 @@ # AbilityLifecycleCallback +AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onAbilityWindowStageCreate、onAbilityWindowStageDestroy等方法。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -应用上下文ApplicationContext的生命周期监听方法的回调类，里面提供了onAbilityCreate、onAbilityWindowStageCreate、onAbilityWindowStageDestroy等方法。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md index ca264b1398..4e811b1b27 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md @@ -1,5 +1,7 @@ # AbilityMonitor +AbilityMonitor模块提供匹配满足指定条件的受监视能力对象的方法的能力，最近匹配的能力对象将保存在AbilityMonitor对象中。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md index 1a8740cdec..ec0580c1d1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md @@ -1,12 +1,14 @@ # AbilityStage +AbilityStage是HAP包的运行时类。 + +AbilityStage模块提供在HAP加载的时候，通知开发者，可以在此进行该HAP的初始化（如资源预加载，线程创建等）能力。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -AbilityStage是HAP包的运行时类。在HAP加载的时候，通知开发者，开发者可以在此进行该HAP的初始化（如资源预加载，线程创建等）。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md index 52898ec84e..b47dbf1b74 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-applicationContext.md @@ -1,12 +1,12 @@ # ApplicationContext +ApplicationContext模块提供开发者应用级别的的上下文的能力，包括提供注册及取消注册应用内组件生命周期的监听接口。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -提供开发者应用级别的的上下文，提供注册及取消注册应用内组件生命周期的监听接口。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-application-context.md index 237747baf4..127a5e04cb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-context.md @@ -1,5 +1,7 @@ # Context +Context模块提供开发者运行代码的上下文环境的能力，包括查询和设置应用信息、ResourceManager等信息。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md index e3be6cf969..18be172e57 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-shellCmdResult.md @@ -1,5 +1,7 @@ # ShellCmdResult +ShellCmdResult模块提供Shell命令执行结果的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md index 1fbc5bcd17..ed6dfecf14 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md @@ -1,5 +1,7 @@ # StaticSubscriberExtensionAbility +StaticSubscriberExtensionAbility模块提供静态订阅者扩展能力的类别的能力。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 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 4be5fc422d..73327837e7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -1,21 +1,19 @@ # appManager +appManager模块提供服务功能的能力，包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。 + > **说明：** > > 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - App管理。 - ## 导入模块 - ```js import app from '@ohos.application.appManager'; ``` - ## appManager.isRunningInStabilityTest8+ static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void diff --git a/zh-cn/application-dev/reference/apis/js-apis-configuration.md b/zh-cn/application-dev/reference/apis/js-apis-configuration.md index 3ddc76ed75..1889e753e1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configuration.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configuration.md @@ -1,11 +1,11 @@ # Configuration +Configuration模块提供环境变化信息的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -环境变化信息。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md b/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md index f5c6a9e41b..32a553012a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md @@ -1,13 +1,11 @@ # ConfigurationConstant +ConfigurationConstant模块提供配置信息枚举值定义的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - -配置信息枚举值定义。 - - ## 导入模块 @@ -15,7 +13,6 @@ import ConfigurationConstant from '@ohos.application.ConfigurationConstant'; ``` - ## ConfigurationConstant.ColorMode 使用时通过ConfigurationConstant.ColorMode获取。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md index 4d96c6a111..276f5a7ec4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md @@ -1,12 +1,12 @@ # EventHub +EventHub模块提供了事件中心，提供订阅、取消订阅、触发事件的能力。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -事件中心，提供订阅、取消订阅、触发事件能力。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md index b102db8c88..3ee6646e61 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -1,5 +1,9 @@ # ExtensionContext +ExtensionContext是Extension的上下文环境，继承自Context。 + +ExtensionContext模块提供扩展的上下文的能力，包括允许访问特定于扩展的资源。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -10,9 +14,6 @@ ```js import FormExtension from '@ohos.application.FormExtension'; ``` -## 使用说明 - -Extension的上下文环境，继承自Context。 ## 属性 diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md index e23d2739ab..015ddd4750 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -1,10 +1,11 @@ # ExtensionRunningInfo +ExtensionRunningInfo模块提供对Extension运行的相关信息和类型进行设置和查询的能力。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -Extension运行相关信息。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md index 91d7aff2e0..749d2431d1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md @@ -1,5 +1,7 @@ # FeatureAbility模块(JS端SDK接口) +FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。 + > **说明：** > > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md index b7fcb689d5..e8d857b2e2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formInfo.md @@ -1,11 +1,11 @@ # FormInfo +FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -卡片信息。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md index 95a6f2ff06..1d4badb7a5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md @@ -1,5 +1,7 @@ # 卡片数据绑定类 +卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-formerror.md b/zh-cn/application-dev/reference/apis/js-apis-formerror.md index cecf53ce06..cc9e3ac840 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formerror.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formerror.md @@ -1,11 +1,11 @@ # FormError +FormError模块提供获取卡片错误码的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -卡片错误码。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextension.md b/zh-cn/application-dev/reference/apis/js-apis-formextension.md index ea8536cab2..6ebe0ec6f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextension.md @@ -1,12 +1,12 @@ # FormExtension +FormExtension模块提供了FormExtension卡片扩展相关接口。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -提供FormExtension卡片扩展相关接口。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md index 1db36f4ca7..fe4eb89ce3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md @@ -1,12 +1,14 @@ # FormExtensionContext +FormExtensionContext模块是FormExtension的上下文环境，继承自ExtensionContext。 + +FormExtensionContext模块提供FormExtension具有的接口和能力。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -FormExtension的上下文环境，提供FormExtension具有的能力和接口，继承自ExtensionContext。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-formhost.md b/zh-cn/application-dev/reference/apis/js-apis-formhost.md index 4224dab456..8ba53b77d3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formhost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formhost.md @@ -1,11 +1,11 @@ # FormHost +FormHost模块提供了卡片使用方相关接口的能力，包括删除、释放、请求更新卡片，发送通知到指定卡片，获取卡片信息、状态等。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -卡片使用方相关接口。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md index 20a1e119be..473efe7ecf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-formprovider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-formprovider.md @@ -1,11 +1,11 @@ # FormProvider +FormProvider模块提供了卡片提供方相关接口的能力，包括更新卡片，设置卡片更新时间，获取卡片信息，请求发布卡片等。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -卡片提供方相关接口。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md index e0c9b43a29..06738b4d53 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-missionManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-missionManager.md @@ -1,12 +1,11 @@ # missionManager +missionManager模块提供系统任务管理能力，包括对系统任务执行锁定、解锁、清理、切换到前台等操作。 > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -missionManager模块提供系统任务管理能力，开发者可以对系统任务执行锁定、解锁、清理、切换到前台等操作。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md index 5d9e82cd85..bfea0a61c6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md @@ -1,5 +1,7 @@ # particleAbility模块 +particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。 + > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md index 090c55389a..47ab7b437f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md @@ -1,12 +1,12 @@ # PermissionRequestResult +PermissionRequestResult模块提供了权限请求结果的能力。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -权限请求结果。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md index 875f6a46e7..52d89a799d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md @@ -1,11 +1,11 @@ # ProcessRunningInfo +ProcessRunningInfo模块提供对进程运行信息进行设置和查询的能力。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -进程运行信息。 - ## 导入模块 ```js diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md index cb43935a59..ea3d2a2db3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-ability.md @@ -1,12 +1,12 @@ # ServiceExtensionAbility +ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -提供ServiceExtension服务扩展相关接口。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md index d6a4bcad0d..9fb036aae8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md @@ -1,12 +1,14 @@ # ServiceExtensionContext +ServiceExtensionContext模块是ServiceExtension的上下文环境，继承自ExtensionContext。 + +ServiceExtensionContext模块提供ServiceExtension具有的能力和接口，包括启动、停止、绑定、解绑Ability。 + > **说明：** > > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块接口仅可在Stage模型下使用。 -ServiceExtension的上下文环境，提供ServiceExtension具有的能力和接口，继承自ExtensionContext。 - ## 导入模块 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md index d37d6b6f75..16af31809b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-testRunner.md +++ b/zh-cn/application-dev/reference/apis/js-apis-testRunner.md @@ -1,5 +1,9 @@ # TestRunner +TestRunner模块提供了框架测试的能力。包括准备单元测试环境、运行测试用例。 + +如果您想实现自己的单元测试框架，您必须继承这个类并覆盖它的所有方法。 + > **说明：** > > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md index 23577bbd71..c1691d1bae 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md @@ -1,13 +1,12 @@ # uriPermissionManager +uriPermissionManager模块提供了Uri权限管理的能力。 + > **说明：** > > 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -Uri权限管理。 - - ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md index b7e67a75d2..46a353349b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wantAgent.md @@ -1,5 +1,7 @@ # WantAgent模块 +WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力，包括创建WantAgent实例、获取实例的用户ID、获取want信息等。 + > **说明：** > > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -- GitLab