提交 451c5c34 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 d775f1bd
......@@ -16,19 +16,19 @@
- [@ohos.app.ability.StartOptions (StartOptions)](js-apis-app-ability-startOptions.md)
- [@ohos.app.ability.UIAbility (UIAbility)](js-apis-app-ability-uiAbility.md)
- [@ohos.app.form.FormExtensionAbility (FormExtensionAbility)](js-apis-app-form-formExtensionAbility.md)
- [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-dataShareExtensionAbility.md)
- [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
- Stage模型能力的接口(待停用)
- [@ohos.application.Ability (Ability)](js-apis-application-ability.md)
- [@ohos.application.AbilityConstant (AbilityConstant)](js-apis-application-abilityConstant.md)
- [@ohos.application.AbilityLifecycleCallback (AbilityLifecycleCallback)](js-apis-application-abilityLifecycleCallback.md)
- [@ohos.application.AbilityStage (AbilityStage)](js-apis-application-abilityStage.md)
- [@ohos.application.context (Context)](js-apis-application-context.md)
- [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-dataShareExtensionAbility.md)
- [@ohos.application.EnvironmentCallback (EnvironmentCallback)](js-apis-application-environmentCallback.md)
- [@ohos.application.ExtensionAbility (ExtensionAbility)](js-apis-application-extensionAbility.md)
- [@ohos.application.FormExtension (FormExtension)](js-apis-application-formExtension.md)
- [@ohos.application.ServiceExtensionAbility (ServiceExtensionAbility)](js-apis-application-serviceExtensionAbility.md)
- [@ohos.application.StartOptions (StartOptions)](js-apis-application-startOptions.md)
- [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
- FA模型能力的接口
- [@ohos.ability.ability (Ability)](js-apis-ability-ability.md)
- [@ohos.ability.featureAbility (FeatureAbility模块)](js-apis-ability-featureAbility.md)
......
# Ability
# @ohos.ability.ability (Ability)
Ability模块将二级模块API组织在一起方便开发者进行导出。
......
# DataUriUtils模块
# @ohos.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力,包括获取,添加,更新给定uri的路径组件末尾的ID。本模块将被app.ability.dataUriUtils模块,建议优先使用[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)模块。
......
# ErrorCode
# @ohos.ability.errorCode (ErrorCode)
ErrorCode是定义启动功能时使用的错误代码。
......
# FeatureAbility模块(JS端SDK接口)
# @ohos.ability.featureAbility (FeatureAbility模块)
FeatureAbility模块提供带有UI设计与用户交互的能力,包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口,连接服务等。
......
# particleAbility模块
# @ohos.ability.particleAbility (ParticleAbility模块)
particleAbility模块提供了Service类型Ability的能力,包括启动、停止指定的particleAbility,获取dataAbilityHelper,连接、断开当前Ability与指定ServiceAbility等。
......
# wantConstant
# @ohos.ability.wantConstant (wantConstant)
wantConstant模块提供want中操作want常数和解释Flags说明的能力。
......
# Ability
# @ohos.app.ability.Ability (Ability基类)
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
......
# AbilityConstant
# @ohos.app.ability.AbilityConstant (AbilityConstant)
AbilityConstant是启动参数的接口。
......
# AbilityDelegatorRegistry
# @ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力,包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。
......
# AbilityLifecycleCallback
# @ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)
AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力,包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法。
......
# AbilityManager
# @ohos.app.ability.abilityManager (AbilityManager)
AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。
......
# AbilityStage
# @ohos.app.ability.AbilityStage (AbilityStage)
AbilityStage是HAP包的运行时类。
......
# appManager
# @ohos.app.ability.appManager (appManager)
appManager模块提供App管理的能力,包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。
......
# appRecovery
# @ohos.app.ability.appRecovery (appRecovery)
appRecovery模块提供了应用在故障状态下的恢复能力。
......
# Common
# @ohos.app.ability.common (应用上下文Context)
Common模块将二级模块API组织在一起方便开发者进行导出。
......
# Configuration
# @ohos.app.ability.Configuration (Configuration)
定义环境变化信息。
......
# ConfigurationConstant
# @ohos.app.ability.ConfigurationConstant (ConfigurationConstant)
ConfigurationConstant模块提供配置信息枚举值定义的能力。
......
# ContextConstant
# @ohos.app.ability.contextConstant (ContextConstant)
ContextConstant模块提供数据加密等级定义的能力。
......
# DataUriUtils模块
# ohos.app.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力,包括获取,添加,更新给定uri的路径末尾的ID。
......
# EnvironmentCallback
# @ohos.app.ability.EnvironmentCallback (EnvironmentCallback)
EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境变化监听回调的能力,包括onConfigurationUpdated方法。
......
# ErrorManager
# @ohos.app.ability.errorManager (ErrorManager)
ErrorManager模块提供对错误观察器的注册和注销的能力。
......
# ExtensionAbility
# @ohos.app.ability.ExtensionAbility (扩展能力基类)
ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力,包括ExtensionAbility创建、销毁、转储客户端信息等。
......
# missionManager
# @ohos.app.ability.missionManager (missionManager)
missionManager模块提供系统任务管理能力,包括对系统任务执行锁定、解锁、清理、切换到前台等操作。
......
# quickFixManager
# @ohos.app.ability.quickFixManager (quickFixManager)
quickFixManager模块提供快速修复的能力,快速修复是OpenHarmony提供给开发者的一种技术手段,支持开发者以远快于(小时级、分钟级)应用升级的方式进行缺陷修复。
......
# ServiceExtensionAbility
# @ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)
ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。
......
# StartOptions
# @ohos.app.ability.StartOptions (StartOptions)
StartOptions模块对系统的基本通信组件进行查询和设置的能力。
......
# Ability
# @ohos.app.ability.UIAbility (UIAbility)
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
......
# Want
# @ohos.app.ability.Want (Want)
Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
......
# app.ability.WantAgent模块
# @ohos.app.ability.wantAgent (WantAgent模块)
app.ability.WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力,包括创建WantAgent实例、获取实例的用户ID、获取want信息等。该模块将会取代[@ohos.wantAgent](js-apis-wantAgent.md)模块,建议优先使用本模块。
......
# wantConstant
# @ohos.app.ability.wantConstant (wantConstant)
wantConstant模块提供want中操作want常数和解释Flags说明的能力。
......
# 卡片数据绑定类
# @ohos.app.form.formBindingData (卡片数据绑定类)
卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。
......
# FormExtensionAbility
# @ohos.app.form.FormExtensionAbility (FormExtensionAbility)
FormExtensionAbility模块提供了卡片扩展相关接口。
......
# FormHost
# @ohos.app.form.formHost (FormHost)
FormHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新、获取卡片信息、状态等操作。
......
# FormInfo
# @ohos.app.form.formInfo (FormInfo)
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。
......
# FormProvider
# @ohos.app.form.formProvider (FormProvider)
FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。
......
# Ability
# @ohos.application.Ability (Ability)
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
......
# AbilityConstant
# @ohos.application.AbilityConstant (AbilityConstant)
AbilityConstant是启动参数的接口。
......
# AbilityDelegatorRegistry
# @ohos.application.abilityDelegatorRegistry (AbilityDelegatorRegistry)
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力,包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。
......
# AbilityLifecycleCallback
# @ohos.application.AbilityLifecycleCallback (AbilityLifecycleCallback)
AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力,包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法。
......
# AbilityManager
# @ohos.application.abilityManager (AbilityManager)
AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。
......
# AbilityStage
# @ohos.application.AbilityStage (AbilityStage)
AbilityStage是HAP包的运行时类。
......
# appManager
# @ohos.application.appManager (appManager)
appManager模块提供App管理的能力,包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。
......
# Configuration
# @ohos.application.Configuration (Configuration)
定义环境变化信息。
......
# ConfigurationConstant
# @ohos.application.ConfigurationConstant (ConfigurationConstant)
ConfigurationConstant模块提供配置信息枚举值定义的能力。
......
# Context
# @ohos.application.context (Context)
Context模块将二级模块API组织在一起方便开发者进行导出。
......
# 数据共享扩展能力
# @ohos.application.DataShareExtensionAbility (数据共享扩展能力)
**DataShareExtensionAbility**基于ExtensionAbility框架,提供支持数据共享业务的能力。
......
# EnvironmentCallback
# @ohos.application.EnvironmentCallback (EnvironmentCallback)
EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境变化监听回调的能力,包括onConfigurationUpdated方法。
......
# ErrorManager
# @ohos.application.errorManager (ErrorManager)
ErrorManager模块提供对错误观察器的注册和注销的能力。
......
# ExtensionAbility
# @ohos.application.ExtensionAbility (ExtensionAbility)
ExtensionAbility模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力,包括ExtensionAbility创建、销毁、转储客户端信息等。
......
# 卡片数据绑定类
# @ohos.application.formBindingData (卡片数据绑定类)
卡片数据绑定模块提供卡片数据绑定的能力。包括FormBindingData对象的创建、相关信息的描述。
......
# FormError
# @ohos.application.formError (FormError)
FormError模块提供获取卡片错误码的能力。
......
# FormExtension
# @ohos.application.FormExtension (FormExtension)
FormExtension模块提供了FormExtension卡片扩展相关接口。
......
# FormHost
# @ohos.application.formHost (FormHost)
FormHost模块提供了卡片使用方相关接口的能力,包括对使用方同一用户下安装的卡片进行删除、释放、请求更新,获取信息、状态等操作。
......
# FormInfo
# @ohos.application.formInfo (FormInfo)
FormInfo模块提供对卡片的相关卡片信息和状态进行设置和查询的能力。
......
# FormProvider
# @ohos.application.formProvider (FormProvider)
FormProvider模块提供了卡片提供方相关接口的能力,开发者在开发卡片时,可通过该模块提供接口实现更新卡片,设置卡片更新时间,获取卡片信息,请求发布卡片等。
......
# missionManager
# @ohos.application.missionManager (missionManager)
missionManager模块提供系统任务管理能力,包括对系统任务执行锁定、解锁、清理、切换到前台等操作。
......
# ServiceExtensionAbility
# @ohos.application.ServiceExtensionAbility (ServiceExtensionAbility)
ServiceExtensionAbility模块提供ServiceExtension服务扩展相关接口的能力。
......
# StartOptions
# @ohos.application.StartOptions (StartOptions)
StartOptions模块对系统的基本通信组件进行查询和设置的能力。
......
# StaticSubscriberExtensionAbility
# @ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)
StaticSubscriberExtensionAbility模块提供静态订阅者ExtensionAbility的类别的能力。
......
# Want
# @ohos.application.Want (Want)
Want是对象间信息传递的载体, 可以用于应用组件间的信息传递。 Want的使用场景之一是作为startAbility的参数, 其包含了指定的启动目标, 以及启动时需携带的相关数据, 如bundleName和abilityName字段分别指明目标Ability所在应用的包名以及对应包内的Ability名称。当Ability A需要启动Ability B并传入一些数据时, 可使用Want作为载体将这些数据传递给Ability B。
......
# 公共事件模块
# @ohos.commonEvent (公共事件模块)
本模块提供了公共事件的能力,包括公共事件的权限列表,发布公共事件,订阅或取消订阅公共事件,获取或修改公共事件结果代码、结果数据等。
......
# 公共事件模块
# @ohos.commonEventManager (公共事件模块)
本模块提供了公共事件的能力,包括公共事件的权限列表,发布公共事件,订阅或取消订阅公共事件,获取或修改公共事件结果代码、结果数据等。
......
# continuationManager
# @ohos.continuation.continuationManager (continuationManager)
continuationManager模块提供了流转/协同入口管理服务能力,包括连接/取消流转管理服务,注册/解注册设备连接变化监听,拉起设备选择模块,更新连接状态。
......
# Emitter
# @ohos.events.emitter (Emitter)
本模块提供发送和处理进程内事件的能力,包括对持续订阅事件或单次订阅事件的处理,取消订阅事件,发送事件到事件队列。
......
# AbilityResult<sup>7+</sup>
# AbilityResult
定义ability拉起、销毁之后返回的结果码和数据。
......
# DataAbilityHelper模块(JS端SDK接口)
# DataAbilityHelper
> **说明:**
>
......
## DataAbilityResult
# DataAbilityResult
定义dataAbility数据操作结果。
......
# AppVersionInfo<sup>7+</sup>
# AppVersionInfo
定义应用版本信息。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
# Context模块
# Context
Context模块提供了ability或application的上下文的能力,包括允许访问特定于应用程序的资源、请求和验证权限等。
......
# ProcessInfo<sup>7+</sup>
# ProcessInfo
定义进程信息。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
# ProcessRunningInfo<sup>(deprecated)</sup>
# ProcessRunningInfo
本模块提供对进程运行信息进行设置和查询的能力。
......
# ProcessRunningInformation<sup>9+</sup>
# ProcessRunningInformation
ProcessRunningInformation模块提供对进程运行信息进行设置和查询的能力。
......
# Notification模块
# @ohos.notification (Notification模块)
本模块提供通知管理的能力,包括发布、取消发布通知,创建、获取、移除通知通道,订阅、取消订阅通知,获取通知的使能状态、角标使能状态,获取通知的相关信息等。
......
# NotificationManager模块
# @ohos.notificationManager (NotificationManager模块)
本模块提供通知管理的能力,包括发布、取消发布通知,创建、获取、移除通知通道,获取通知的使能状态、角标使能状态,获取通知的相关信息等。
......
# NotificationSubscribe模块
# @ohos.notificationSubscribe (NotificationSubscribe模块)
本模块提供通知订阅、取消订阅、通知移除等,一般情况下,只有系统应用具有这些操作权限。
......
# WantAgent模块
# @ohos.wantAgent (WantAgent模块)
WantAgent模块提供了触发、取消、比较WantAgent实例和获取bundle名称的能力,包括创建WantAgent实例、获取实例的用户ID、获取want信息等。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册