Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4cc454f8
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看板
提交
4cc454f8
编写于
4月 25, 2023
作者:
X
xuzhihao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Feature: fix UIAbility description
Signed-off-by:
N
xuzhihao
<
xuzhihao16@huawei.com
>
上级
bd8a03aa
变更
3
展开全部
隐藏空白更改
内联
并排
Showing
3 changed file
with
143 addition
and
143 deletion
+143
-143
zh-cn/application-dev/application-models/uiability-intra-device-interaction.md
.../application-models/uiability-intra-device-interaction.md
+8
-8
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
...ation-dev/reference/apis/js-apis-app-ability-uiAbility.md
+42
-42
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
...erence/apis/js-apis-inner-application-uiAbilityContext.md
+93
-93
未找到文件。
zh-cn/application-dev/application-models/uiability-intra-device-interaction.md
浏览文件 @
4cc454f8
...
...
@@ -412,7 +412,7 @@ export default class FuncAbility extends UIAbility {
```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 当被调用方[Ability的启动模式](uiability-launch-type.md)设置为standard启动模式时,每次启动都会创建一个新的实例,那么[onNewWant()](../reference/apis/js-apis-app-ability-uiAbility.md#abilityonnewwant)回调就不会被用到。
> 当被调用方[
UI
Ability的启动模式](uiability-launch-type.md)设置为standard启动模式时,每次启动都会创建一个新的实例,那么[onNewWant()](../reference/apis/js-apis-app-ability-uiAbility.md#abilityonnewwant)回调就不会被用到。
## 通过Call调用实现UIAbility交互(仅对系统应用开放)
...
...
@@ -485,12 +485,12 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe
在Callee被调用端,需要实现指定方法的数据接收回调函数、数据的序列化及反序列化方法。在需要接收数据期间,通过on接口注册监听,无需接收数据时通过off接口解除监听。
1.
配置Ability的启动模式。
1.
配置
UI
Ability的启动模式。
配置module.json5,将CalleeAbility配置为单实例"singleton"。
| Json字段 | 字段说明 |
| -------- | -------- |
| "launchType" | Ability的启动模式,设置为"singleton"类型。 |
| "launchType" |
UI
Ability的启动模式,设置为"singleton"类型。 |
Ability配置标签示例如下:
...
...
@@ -510,7 +510,7 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe
2.
导入UIAbility模块。
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
```
3.
定义约定的序列化数据。
...
...
@@ -542,7 +542,7 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe
```
4.
实现Callee.on监听及Callee.off解除监听。
被调用端Callee的监听函数注册时机,取决于应用开发者。注册监听之前的数据不会被处理,取消监听之后的数据不会被处理。如下示例在Ability的onCreate注册'MSG_SEND_METHOD'监听,在onDestroy取消监听,收到序列化数据后作相应处理并返回,应用开发者根据实际需要做相应处理。具体示例代码如下:
被调用端Callee的监听函数注册时机,取决于应用开发者。注册监听之前的数据不会被处理,取消监听之后的数据不会被处理。如下示例在
UI
Ability的onCreate注册'MSG_SEND_METHOD'监听,在onDestroy取消监听,收到序列化数据后作相应处理并返回,应用开发者根据实际需要做相应处理。具体示例代码如下:
```
ts
...
...
@@ -562,7 +562,7 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe
return
new
MyParcelable
(
receivedData
.
num
+
1
,
`send
${
receivedData
.
str
}
succeed`
);
}
export
default
class
CalleeAbility
extends
Ability
{
export
default
class
CalleeAbility
extends
UI
Ability
{
onCreate
(
want
,
launchParam
)
{
try
{
this
.
callee
.
on
(
MSG_SEND_METHOD
,
sendMsgCallback
);
...
...
@@ -587,11 +587,11 @@ Call功能主要接口如下表所示。具体的API详见[接口文档](../refe
1.
导入UIAbility模块。
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
```
2.
获取Caller通信接口。
Ability的context属性实现了startAbilityByCall方法,用于获取指定通用组件的Caller通信接口。如下示例通过this.context获取
Ability实例的context属性,使用startAbilityByCall拉起Callee被调用端并获取Caller通信接口,注册Caller的onRelease监听。应用开发者根据实际需要做相应处理。
UIAbility的context属性实现了startAbilityByCall方法,用于获取指定通用组件的Caller通信接口。如下示例通过this.context获取UI
Ability实例的context属性,使用startAbilityByCall拉起Callee被调用端并获取Caller通信接口,注册Caller的onRelease监听。应用开发者根据实际需要做相应处理。
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @
4cc454f8
# @ohos.app.ability.UIAbility (UIAbility)
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
UI
Ability模块提供对Ability生命周期、上下文环境等调用管理的能力,包括Ability创建、销毁、转储客户端信息等。
该模块提供以下Ability相关的常用功能:
该模块提供以下
UI
Ability相关的常用功能:
-
[
Caller
](
#caller
)
:通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
-
[
Callee
](
#callee
)
:通用组件服务端注册和解除客户端caller通知送信的callback接口。
...
...
@@ -15,7 +15,7 @@ Ability模块提供对Ability生命周期、上下文环境等调用管理的能
## 导入模块
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
```
## 属性
...
...
@@ -29,11 +29,11 @@ import Ability from '@ohos.app.ability.UIAbility';
| lastRequestWant |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 否 | Ability最后请求时的参数。|
| callee |
[
Callee
](
#callee
)
| 是 | 否 | 调用Stub(桩)服务对象。|
## Ability.onCreate
##
UI
Ability.onCreate
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
Ability创建时回调,执行初始化业务逻辑操作。
UI
Ability创建时回调,执行初始化业务逻辑操作。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
...
...
@@ -41,13 +41,13 @@ Ability创建时回调,执行初始化业务逻辑操作。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前Ability的Want类型信息,包括ability名称、bundle名称等。 |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前
UI
Ability的Want类型信息,包括ability名称、bundle名称等。 |
| param |
[
AbilityConstant.LaunchParam
](
js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam
)
| 是 | 创建
ability、上次异常退出的原因信息。 |
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onCreate
(
want
,
param
)
{
console
.
log
(
'
onCreate, want:
'
+
want
.
abilityName
);
}
...
...
@@ -55,7 +55,7 @@ Ability创建时回调,执行初始化业务逻辑操作。
```
## Ability.onWindowStageCreate
##
UI
Ability.onWindowStageCreate
onWindowStageCreate(windowStage: window.WindowStage): void
...
...
@@ -72,7 +72,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
console
.
log
(
'
onWindowStageCreate
'
);
}
...
...
@@ -80,7 +80,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void
```
## Ability.onWindowStageDestroy
##
UI
Ability.onWindowStageDestroy
onWindowStageDestroy(): void
...
...
@@ -91,7 +91,7 @@ onWindowStageDestroy(): void
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onWindowStageDestroy
()
{
console
.
log
(
'
onWindowStageDestroy
'
);
}
...
...
@@ -99,7 +99,7 @@ onWindowStageDestroy(): void
```
## Ability.onWindowStageRestore
##
UI
Ability.onWindowStageRestore
onWindowStageRestore(windowStage: window.WindowStage): void
...
...
@@ -116,7 +116,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onWindowStageRestore
(
windowStage
)
{
console
.
log
(
'
onWindowStageRestore
'
);
}
...
...
@@ -124,18 +124,18 @@ onWindowStageRestore(windowStage: window.WindowStage): void
```
## Ability.onDestroy
##
UI
Ability.onDestroy
onDestroy(): void;
Ability生命周期回调,在销毁时回调,执行资源清理等操作。
UI
Ability生命周期回调,在销毁时回调,执行资源清理等操作。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onDestroy
()
{
console
.
log
(
'
onDestroy
'
);
}
...
...
@@ -143,18 +143,18 @@ Ability生命周期回调,在销毁时回调,执行资源清理等操作。
```
## Ability.onForeground
##
UI
Ability.onForeground
onForeground(): void;
Ability生命周期回调,当应用从后台转到前台时触发。
UI
Ability生命周期回调,当应用从后台转到前台时触发。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onForeground
()
{
console
.
log
(
'
onForeground
'
);
}
...
...
@@ -162,18 +162,18 @@ Ability生命周期回调,当应用从后台转到前台时触发。
```
## Ability.onBackground
##
UI
Ability.onBackground
onBackground(): void;
Ability生命周期回调,当应用从前台转到后台时触发。
UI
Ability生命周期回调,当应用从前台转到后台时触发。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onBackground
()
{
console
.
log
(
'
onBackground
'
);
}
...
...
@@ -181,7 +181,7 @@ Ability生命周期回调,当应用从前台转到后台时触发。
```
## Ability.onContinue
##
UI
Ability.onContinue
onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
...
...
@@ -215,7 +215,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
```
## Ability.onNewWant
##
UI
Ability.onNewWant
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
...
...
@@ -241,7 +241,7 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
}
```
## Ability.onDump
##
UI
Ability.onDump
onDump(params: Array
\<
string>): Array
\<
string>;
...
...
@@ -258,7 +258,7 @@ onDump(params: Array\<string>): Array\<string>;
**示例:**
```
ts
class
my
Ability
extends
Ability
{
class
my
UIAbility
extends
UI
Ability
{
onDump
(
params
)
{
console
.
log
(
'
dump, params:
'
+
JSON
.
stringify
(
params
));
return
[
'
params
'
];
...
...
@@ -267,11 +267,11 @@ onDump(params: Array\<string>): Array\<string>;
```
## Ability.onSaveState
##
UI
Ability.onSaveState
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult;
该API配合
[
appRecovery
](
js-apis-app-ability-appRecovery.md
)
使用。在应用故障时,如果使能了自动保存状态,框架将回调onSaveState保存Ability状态。
该API配合
[
appRecovery
](
js-apis-app-ability-appRecovery.md
)
使用。在应用故障时,如果使能了自动保存状态,框架将回调onSaveState保存
UI
Ability状态。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
...
...
@@ -286,7 +286,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any})
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnSaveResult | 是否同意保存当前Ability的状态。 |
| AbilityConstant.OnSaveResult | 是否同意保存当前
UI
Ability的状态。 |
**示例:**
...
...
@@ -339,7 +339,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>;
**示例:**
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
class
MyMessageAble
{
// 自定义的Parcelable数据结构
name
:
''
str
:
''
...
...
@@ -363,7 +363,7 @@ call(method: string, data: rpc.Sequenceable): Promise<void>;
};
let
method
=
'
call_Function
'
;
// 约定的通知消息字符串
let
caller
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
this
.
context
.
startAbilityByCall
({
bundleName
:
'
com.example.myservice
'
,
...
...
@@ -420,7 +420,7 @@ callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageSequ
**示例:**
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
class
MyMessageAble
{
name
:
''
str
:
''
...
...
@@ -444,7 +444,7 @@ callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageSequ
};
let
method
=
'
call_Function
'
;
let
caller
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
this
.
context
.
startAbilityByCall
({
bundleName
:
'
com.example.myservice
'
,
...
...
@@ -492,9 +492,9 @@ release(): void;
**示例:**
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
let
caller
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
this
.
context
.
startAbilityByCall
({
bundleName
:
'
com.example.myservice
'
,
...
...
@@ -533,9 +533,9 @@ release(): void;
**示例:**
```
ts
import
Ability
from
'
@ohos.application.Ability
'
;
import
UI
Ability
from
'
@ohos.application.Ability
'
;
let
caller
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
this
.
context
.
startAbilityByCall
({
bundleName
:
'
com.example.myservice
'
,
...
...
@@ -584,9 +584,9 @@ release(): void;
**示例:**
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
let
caller
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onWindowStageCreate
(
windowStage
)
{
this
.
context
.
startAbilityByCall
({
bundleName
:
'
com.example.myservice
'
,
...
...
@@ -742,7 +742,7 @@ on(method: string, callback: CalleeCallback): void;
**示例:**
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
import
UI
Ability
from
'
@ohos.app.ability.UIAbility
'
;
class
MyMessageAble
{
name
:
''
str
:
''
...
...
@@ -771,7 +771,7 @@ on(method: string, callback: CalleeCallback): void;
pdata
.
readParcelable
(
msg
);
return
new
MyMessageAble
(
'
test1
'
,
'
Callee test
'
);
}
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onCreate
(
want
,
launchParam
)
{
console
.
log
(
'
Callee onCreate is called
'
);
try
{
...
...
@@ -811,7 +811,7 @@ off(method: string): void;
```
ts
import
Ability
from
'
@ohos.app.ability.UIAbility
'
;
let
method
=
'
call_Function
'
;
export
default
class
Main
Ability
extends
Ability
{
export
default
class
Main
UIAbility
extends
UI
Ability
{
onCreate
(
want
,
launchParam
)
{
console
.
log
(
'
Callee onCreate is called
'
);
try
{
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
浏览文件 @
4cc454f8
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录