Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
592f8f8d
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
592f8f8d
编写于
3月 15, 2023
作者:
O
openharmony_ci
提交者:
Gitee
3月 15, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16120 [文档描述优化]主线挑单至Release
Merge pull request !16120 from zhongjianfei/rr0315
上级
f0baf0a4
a6896e09
变更
8
隐藏空白更改
内联
并排
Showing
8 changed file
with
144 addition
and
157 deletion
+144
-157
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
...dev/reference/apis/js-apis-app-ability-abilityConstant.md
+7
-7
zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md
...lication-dev/reference/apis/js-apis-app-ability-common.md
+14
-26
zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md
...dev/reference/apis/js-apis-app-ability-contextConstant.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md
...ev/reference/apis/js-apis-app-ability-extensionAbility.md
+3
-2
zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md
...rence/apis/js-apis-app-ability-serviceExtensionAbility.md
+28
-28
zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
...on-dev/reference/apis/js-apis-app-ability-startOptions.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
...ation-dev/reference/apis/js-apis-app-ability-uiAbility.md
+83
-85
zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
...v/reference/apis/js-apis-app-form-formExtensionAbility.md
+4
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @
592f8f8d
...
...
@@ -23,8 +23,8 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason |
[
LaunchReason
](
#abilityconstantlaunchreason
)
| 是 | 是 |
指
示启动原因。 |
| lastExitReason |
[
LastExitReason
](
#abilityconstantlastexitreason
)
| 是 | 是 | 表示最后退出原因。 |
| launchReason |
[
LaunchReason
](
#abilityconstantlaunchreason
)
| 是 | 是 |
枚举类型,表
示启动原因。 |
| lastExitReason |
[
LastExitReason
](
#abilityconstantlastexitreason
)
| 是 | 是 |
枚举类型,
表示最后退出原因。 |
## AbilityConstant.LaunchReason
...
...
@@ -35,8 +35,8 @@ Ability初次启动原因,该类型为枚举,可配合[Ability](js-apis-app-
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知原因。 |
| START_ABILITY | 1 | 通过
[
startAbility
](
js-apis-
ability-context.md#
abilitycontextstartability
)
接口启动ability。 |
| CALL | 2 | 通过
[
startAbilityByCall
](
js-apis-
ability-context.md#
abilitycontextstartabilitybycall
)
接口启动ability。 |
| START_ABILITY | 1 | 通过
[
startAbility
](
js-apis-
inner-application-uiAbilityContext.md#ui
abilitycontextstartability
)
接口启动ability。 |
| CALL | 2 | 通过
[
startAbilityByCall
](
js-apis-
inner-application-uiAbilityContext.md#ui
abilitycontextstartabilitybycall
)
接口启动ability。 |
| CONTINUATION | 3 | 跨端设备迁移启动ability。 |
| APP_RECOVERY | 4 | 设置应用恢复后,应用故障时自动恢复启动ability。 |
...
...
@@ -124,8 +124,8 @@ class MyAbility extends UIAbility {
```
ts
let
want
=
{
bundleName
:
'
com.
test.example
'
,
abilityName
:
'
Main
Ability
'
bundleName
:
'
com.
example.myapplication
'
,
abilityName
:
'
Entry
Ability
'
};
let
option
=
{
windowMode
:
AbilityConstant
.
WindowMode
.
WINDOW_MODE_FULLSCREEN
...
...
@@ -135,7 +135,7 @@ let option = {
this
.
context
.
startAbility
(
want
,
option
).
then
(()
=>
{
console
.
log
(
'
Succeed to start ability.
'
);
}).
catch
((
error
)
=>
{
console
.
log
(
'
Failed to start ability with error:
'
+
JSON
.
stringify
(
error
)
);
console
.
error
(
'
Failed to start ability with error: ${JSON.stringify(error)}
'
);
});
```
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md
浏览文件 @
592f8f8d
...
...
@@ -15,20 +15,20 @@ import common from '@ohos.app.ability.common';
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 类型 |
必填 |
说明 |
| ----------- | -------------------- | ----
| ----
-------------------------------------------------------- |
| UIAbilityContext |
[
UIAbilityContext
](
js-apis-inner-application-uiAbilityContext.md
)
|
否 |
UIAbilityContext二级模块。 |
| AbilityStageContext |
[
AbilityStageContext
](
js-apis-inner-application-abilityStageContext.md
)
|
否 |
AbilityStageContext二级模块。 |
| ApplicationContext |
[
ApplicationContext
](
js-apis-inner-application-applicationContext.md
)
|
否 |
ApplicationContext二级模块。 |
| BaseContext |
[
BaseContext
](
js-apis-inner-application-baseContext.md
)
|
否 |
BaseContext二级模块。 |
| Context |
[
Context
](
js-apis-inner-application-context.md
)
|
否 |
Context二级模块。 |
| ExtensionContext |
[
ExtensionContext
](
js-apis-inner-application-extensionContext.md
)
|
否 |
ExtensionContext二级模块。 |
| FormExtensionContext |
[
FormExtensionContext
](
js-apis-inner-application-formExtensionContext.md
)
|
否 |
FormExtensionContext二级模块。 |
|
EventHub |
[
EventHub
](
js-apis-inner-application-eventHub.md
)
| 否 | EventHub
二级模块。 |
|
PermissionRequestResult |
[
PermissionRequestResult
](
js-apis-inner-application-permissionRequestResult.md
)
| 否 | PermissionRequestResult
二级模块。 |
| PacMap |
[
PacMap
](
js-apis-inner-ability-dataAbilityHelper.md#PacMap
)
|
否 |
PacMap二级模块。 |
| AbilityResult |
[
AbilityResult
](
js-apis-inner-ability-abilityResult.md
)
|
否 |
AbilityResult二级模块。 |
| ConnectOptions |
[
ConnectOptions
](
js-apis-inner-ability-connectOptions.md
)
|
否 |
ConnectOptions二级模块。 |
| 名称 | 类型 | 说明 |
| ----------- | -------------------- | ------------------------------------------------------------ |
| UIAbilityContext |
[
UIAbilityContext
](
js-apis-inner-application-uiAbilityContext.md
)
| UIAbilityContext二级模块。 |
| AbilityStageContext |
[
AbilityStageContext
](
js-apis-inner-application-abilityStageContext.md
)
| AbilityStageContext二级模块。 |
| ApplicationContext |
[
ApplicationContext
](
js-apis-inner-application-applicationContext.md
)
| ApplicationContext二级模块。 |
| BaseContext |
[
BaseContext
](
js-apis-inner-application-baseContext.md
)
| BaseContext二级模块。 |
| Context |
[
Context
](
js-apis-inner-application-context.md
)
| Context二级模块。 |
| ExtensionContext |
[
ExtensionContext
](
js-apis-inner-application-extensionContext.md
)
| ExtensionContext二级模块。 |
| FormExtensionContext |
[
FormExtensionContext
](
js-apis-inner-application-formExtensionContext.md
)
| FormExtensionContext二级模块。 |
|
ServiceExtensionContext |
[
ServiceExtensionContext
](
js-apis-inner-application-serviceExtensionContext.md
)
| ServiceExtensionContext
二级模块。 |
|
EventHub |
[
EventHub
](
js-apis-inner-application-eventHub.md
)
| EventHub
二级模块。 |
| PacMap |
[
PacMap
](
js-apis-inner-ability-dataAbilityHelper.md#PacMap
)
| PacMap二级模块。 |
| AbilityResult |
[
AbilityResult
](
js-apis-inner-ability-abilityResult.md
)
| AbilityResult二级模块。 |
| ConnectOptions |
[
ConnectOptions
](
js-apis-inner-ability-connectOptions.md
)
| ConnectOptions二级模块。 |
**示例:**
```
ts
...
...
@@ -42,19 +42,7 @@ let context: common.Context;
let
extensionContext
:
common
.
ExtensionContext
;
let
formExtensionContext
:
common
.
FormExtensionContext
;
let
eventHub
:
common
.
EventHub
;
let
permissionRequestResult
:
common
.
PermissionRequestResult
;
let
pacMap
:
common
.
PacMap
;
let
abilityResult
:
common
.
AbilityResult
;
let
connectOptions
:
common
.
ConnectOptions
;
```
## AreaMode
访问的文件分区,每个文件分区有对应自己的内容。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| --------------- | ---- | --------------- |
| EL1 | 0 | 设备级加密区。 |
| EL2 | 1 | 用户凭据加密区。默认为EL2。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-contextConstant.md
浏览文件 @
592f8f8d
# @ohos.app.ability.contextConstant (ContextConstant)
ContextConstant
模块提供数据加密等级定义的能力
。
ContextConstant
提供Context相关的枚举,当前仅包含数据加密等级的枚举
。
> **说明:**
>
...
...
@@ -19,7 +19,7 @@ import contextConstant from '@ohos.app.ability.contextConstant';
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| EL1 | 0 | 设备级加密区
。 |
| EL2 | 1 | 用户
凭据加密区。 |
| EL1 | 0 | 设备级加密区
,设备开机后可访问的数据区。 |
| EL2 | 1 | 用户
级加密区,设备开机,首次输入密码后才能够访问的数据区。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-extensionAbility.md
浏览文件 @
592f8f8d
# @ohos.app.ability.ExtensionAbility (扩展能力基类)
ExtensionAbility
模块提供对ExtensionAbility生命周期、上下文环境等调用管理的能力,包括ExtensionAbility创建、销毁、转储客户端信息等
。
ExtensionAbility
是特定场景扩展能力的基类,提供系统配置更新回调和系统内存调整回调。
。
> **说明:**
>
...
...
@@ -16,7 +16,7 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility';
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
ts
class
MyExtensionAbility
extends
ExtensionAbility
{
onConfigurationUpdated
(
config
)
{
...
...
@@ -28,3 +28,4 @@ import ExtensionAbility from '@ohos.app.ability.ExtensionAbility';
}
}
```
zh-cn/application-dev/reference/apis/js-apis-app-ability-serviceExtensionAbility.md
浏览文件 @
592f8f8d
# @ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)
ServiceExtensionAbility模块提供
ServiceExtension服务扩展相关接口的能力
。
ServiceExtensionAbility模块提供
后台服务相关扩展能力,提供后台服务创建、销毁、连接、断开等生命周期回调
。
> **说明:**
>
...
...
@@ -23,9 +23,9 @@ import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
**系统API**
: 此接口为系统接口,三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
ServiceExtensionContext
](
js-apis-inner-application-serviceExtensionContext.md
)
| 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
| context |
[
ServiceExtensionContext
](
js-apis-inner-application-serviceExtensionContext.md
)
| 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
## ServiceExtensionAbility.onCreate
...
...
@@ -40,9 +40,9 @@ Extension生命周期回调,在创建时回调,执行初始化业务逻辑
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
...
...
@@ -88,10 +88,10 @@ Extension生命周期回调,如果是startAbility或者startServiceExtensionAb
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
**示例:**
...
...
@@ -116,15 +116,15 @@ Extension生命周期回调,如果是connectAbility拉起的服务,会在onC
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 |
| 类型 | 说明 |
| -------- | -------- |
| rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 |
**示例:**
...
...
@@ -158,9 +158,9 @@ Extension的生命周期,断开服务连接时回调。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
...
...
@@ -184,9 +184,9 @@ onReconnect(want: Want): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
...
...
@@ -210,9 +210,9 @@ onConfigurationUpdate(newConfig: Configuration): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| newConfig |
[
Configuration
](
js-apis-app-ability-configuration.md
)
| 是 | 表示需要更新的配置信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| newConfig |
[
Configuration
](
js-apis-app-ability-configuration.md
)
| 是 | 表示需要更新的配置信息。 |
**示例:**
...
...
@@ -236,9 +236,9 @@ onDump(params: Array\<string>): Array\<string>;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array
\<
string> | 是 | 表示命令形式的参数。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array
\<
string> | 是 | 表示命令形式的参数。|
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
浏览文件 @
592f8f8d
# @ohos.app.ability.StartOptions (StartOptions)
StartOptions
模块对系统的基本通信组件进行查询和设置的能力
。
StartOptions
可以作为
[
startAbility
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability-1
)
的入参,用于指定目标Ability的窗口模式
。
> **说明:**
>
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @
592f8f8d
# @ohos.app.ability.UIAbility (UIAbility)
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
UIAbility是包含UI界面的应用组件,提供组件创建、销毁、前后台切换等生命周期回调,同时也具备组件协同的能力,组件协同主要提供如下常用功能:
该模块提供以下Ability相关的常用功能:
-
[
Caller
](
#caller
)
:通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
-
[
Callee
](
#callee
)
:通用组件服务端注册和解除客户端caller通知送信的callback接口。
-
[
Caller
](
#caller
)
:由
[
startAbilityByCall
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilitybycall
)
接口返回,CallerAbility(调用者)可使用Caller与CalleeAbility(被调用者)进行通信。
-
[
Callee
](
#callee
)
:UIAbility的内部对象,CalleeAbility(被调用者)可以通过Callee与Caller进行通信。
> **说明:**
>
...
...
@@ -22,14 +20,14 @@ import Ability from '@ohos.app.ability.UIAbility';
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
UIAbilityContext
](
js-apis-inner-application-uiAbilityContext.md
)
| 是 | 否 | 上下文。 |
| launchWant |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 否 |
Ability启动时的参数。 |
| lastRequestWant |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 否 |
Ability最后请求时的参数。|
| callee |
[
Callee
](
#callee
)
| 是 | 否 | 调用Stub(桩)服务对象。|
| context |
[
UIAbilityContext
](
js-apis-inner-application-uiAbilityContext.md
)
| 是 | 否 | 上下文。 |
| launchWant |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 否 |
UIAbility启动时的参数。 |
| lastRequestWant |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 否 |
UIAbility最后请求时的参数。 |
| callee |
[
Callee
](
#callee
)
| 是 | 否 | 调用Stub(桩)服务对象。|
## Ability.onCreate
##
UI
Ability.onCreate
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
...
...
@@ -39,10 +37,10 @@ Ability创建时回调,执行初始化业务逻辑操作。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Ability的Want类型信息,包括ability名称、bundle名称等。 |
| param |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | 创建
a
bility、上次异常退出的原因信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前UIAbility的Want类型信息,包括ability名称、bundle名称等。 |
| param |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | 创建UIA
bility、上次异常退出的原因信息。 |
**示例:**
...
...
@@ -55,7 +53,7 @@ Ability创建时回调,执行初始化业务逻辑操作。
```
## Ability.onWindowStageCreate
##
UI
Ability.onWindowStageCreate
onWindowStageCreate(windowStage: window.WindowStage): void
...
...
@@ -65,9 +63,9 @@ onWindowStageCreate(windowStage: window.WindowStage): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
**示例:**
...
...
@@ -80,7 +78,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void
```
## Ability.onWindowStageDestroy
##
UI
Ability.onWindowStageDestroy
onWindowStageDestroy(): void
...
...
@@ -99,7 +97,7 @@ onWindowStageDestroy(): void
```
## Ability.onWindowStageRestore
##
UI
Ability.onWindowStageRestore
onWindowStageRestore(windowStage: window.WindowStage): void
...
...
@@ -109,9 +107,9 @@ onWindowStageRestore(windowStage: window.WindowStage): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage |
[
window.WindowStage
](
js-apis-window.md#windowstage9
)
| 是 | WindowStage相关信息。 |
**示例:**
...
...
@@ -124,7 +122,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void
```
## Ability.onDestroy
##
UI
Ability.onDestroy
onDestroy(): void | Promise
<
void
>
;
...
...
@@ -143,7 +141,7 @@ Ability生命周期回调,在销毁时回调,执行资源清理等操作。
```
## Ability.onForeground
##
UI
Ability.onForeground
onForeground(): void;
...
...
@@ -162,7 +160,7 @@ Ability生命周期回调,当应用从后台转到前台时触发。
```
## Ability.onBackground
##
UI
Ability.onBackground
onBackground(): void;
...
...
@@ -181,7 +179,7 @@ Ability生命周期回调,当应用从前台转到后台时触发。
```
## Ability.onContinue
##
UI
Ability.onContinue
onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResult;
...
...
@@ -191,15 +189,15 @@ onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResu
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
AbilityConstant.OnContinueResult
](
js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult
)
| 继续的结果。 |
| 类型 | 说明 |
| -------- | -------- |
|
[
AbilityConstant.OnContinueResult
](
js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult
)
| 继续的结果。 |
**示例:**
...
...
@@ -215,7 +213,7 @@ onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResu
```
## Ability.onNewWant
##
UI
Ability.onNewWant
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
...
...
@@ -225,10 +223,10 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | Want类型参数,如ability名称,包名等。 |
| launchParams |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | Want类型参数,如ability名称,包名等。 |
| launchParams |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
**示例:**
...
...
@@ -241,7 +239,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
}
```
## Ability.onDump
##
UI
Ability.onDump
onDump(params: Array
\<
string>): Array
\<
string>;
...
...
@@ -251,9 +249,9 @@ onDump(params: Array\<string>): Array\<string>;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array
\<
string> | 是 | 表示命令形式的参数。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| params | Array
\<
string> | 是 | 表示命令形式的参数。|
**示例:**
...
...
@@ -267,7 +265,7 @@ onDump(params: Array\<string>): Array\<string>;
```
## Ability.onSaveState
##
UI
Ability.onSaveState
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Object}): AbilityConstant.OnSaveResult;
...
...
@@ -277,16 +275,16 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Objec
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason |
[
AbilityConstant.StateType
](
js-apis-application-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason |
[
AbilityConstant.StateType
](
js-apis-application-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 |
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 |
**示例:**
...
...
@@ -318,16 +316,16 @@ call(method: string, data: rpc.Parcelable): Promise<void>;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise形式返回应答。 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise形式返回应答。 |
**错误码:**
...
...
@@ -398,16 +396,16 @@ callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageParc
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)
>
| Promise形式返回通用组件服务端应答数据。 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)
>
| Promise形式返回通用组件服务端应答数据。 |
**错误码:**
...
...
@@ -476,7 +474,7 @@ release(): void;
主动释放通用组件服务端的通信接口。
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**错误码:**
...
...
@@ -523,9 +521,9 @@ release(): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback |
[
OnReleaseCallback
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback |
[
OnReleaseCallback
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
**示例:**
...
...
@@ -565,10 +563,10 @@ release(): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件,固定为'release'。 |
| callback |
[
OnReleaseCallback
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件,固定为'release'。 |
| callback |
[
OnReleaseCallback
](
#onreleasecallback
)
| 是 | 返回onRelease回调结果。 |
**错误码:**
...
...
@@ -722,10 +720,10 @@ on(method: string, callback: CalleeCallback): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback |
[
CalleeCallback
](
#calleecallback
)
| 是 | 一个
[
rpc.MessageParcel
](
js-apis-rpc.md#sequenceabledeprecated
)
类型入参的js通知同步回调函数,
回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)数据对象,
其他视为函数执行错误。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback |
[
CalleeCallback
](
#calleecallback
)
| 是 | 一个
[
rpc.MessageParcel
](
js-apis-rpc.md#sequenceabledeprecated
)
类型入参的js通知同步回调函数,
回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)数据对象,
其他视为函数执行错误。 |
**错误码:**
...
...
@@ -784,13 +782,13 @@ off(method: string): void;
解除通用组件服务端注册消息通知callback。
**系统能力**
:SystemCapability.
Ability.AbilityRuntime.
AbilityCore
**系统能力**
:SystemCapability.
UIAbility.UIAbilityRuntime.UI
AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 已注册的通知事件字符串。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 已注册的通知事件字符串。 |
**错误码:**
...
...
@@ -823,9 +821,9 @@ off(method: string): void;
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 |
| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 |
## CalleeCallback
...
...
@@ -833,6 +831,6 @@ off(method: string): void;
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata:
[
rpc.MessageParcel
](
js-apis-rpc.md#sequenceabledeprecated
)
) | 是 | 否 |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 被调用方注册的消息侦听器函数接口的原型。 |
| (indata:
[
rpc.MessageParcel
](
js-apis-rpc.md#sequenceabledeprecated
)
) | 是 | 否 |
[
rpc.Parcelable
](
js-apis-rpc.md#parcelabledeprecated
)
| 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-app-form-formExtensionAbility.md
浏览文件 @
592f8f8d
# @ohos.app.form.FormExtensionAbility (FormExtensionAbility)
FormExtensionAbility
模块提供了卡片扩展相关接口
。
FormExtensionAbility
为卡片扩展模块,提供卡片创建、销毁、刷新等生命周期回调
。
> **说明:**
>
...
...
@@ -17,9 +17,9 @@ import FormExtensionAbility from '@ohos.app.form.FormExtensionAbility';
**系统能力**
:SystemCapability.Ability.Form
| 名称 | 类型
| 可读 | 可写 | 说明
|
| ------- | -------------------------------------------------------
| ---- | ---- |
--------------------------------------------------- |
| context |
[
FormExtensionContext
](
js-apis-inner-application-formExtensionContext.md
)
| 是 | 否 | FormExtensionAbility的上下文环境,继承自
ExtensionContext
。 |
| 名称 | 类型
| 可读 | 可写 | 说明
|
| ------- | -------------------------------------------------------
----- | ---- | ---- | ---------
--------------------------------------------------- |
| context |
[
FormExtensionContext
](
js-apis-inner-application-formExtensionContext.md
)
| 是 | 否 | FormExtensionAbility的上下文环境,继承自
[
ExtensionContext
](
js-apis-inner-application-extensionContext.md
)
。 |
## onAddForm
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录