Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4cc454f8
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
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 {
```
>  **说明:**
> 当被调用方[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
...
...
@@ -15,7 +15,7 @@ UIAbilityContext模块提供允许访问特定UIAbility的资源的能力,包
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo |
[
AbilityInfo
](
js-apis-bundleManager-abilityInfo.md
)
| 是 | 否 | Abilityinfo相关信息 |
| abilityInfo |
[
AbilityInfo
](
js-apis-bundleManager-abilityInfo.md
)
| 是 | 否 |
UI
Abilityinfo相关信息 |
| currentHapModuleInfo |
[
HapModuleInfo
](
js-apis-bundleManager-hapModuleInfo.md
)
| 是 | 否 | 当前hap包的信息 |
| config |
[
Configuration
](
js-apis-app-ability-configuration.md
)
| 是 | 否 | 表示配置信息。 |
...
...
@@ -23,11 +23,11 @@ UIAbilityContext模块提供允许访问特定UIAbility的资源的能力,包
startAbility(want: Want, callback: AsyncCallback
<
void
>
): void;
启动Ability(callback形式)。
启动
UI
Ability(callback形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -36,7 +36,7 @@ startAbility(want: Want, callback: AsyncCallback<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**错误码:**
...
...
@@ -94,11 +94,11 @@ startAbility(want: Want, callback: AsyncCallback<void>): void;
startAbility(want: Want, options: StartOptions, callback: AsyncCallback
<
void
>
): void;
启动Ability(callback形式)。
启动
UI
Ability(callback形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -107,8 +107,8 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void&
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动
UI
Ability所携带的参数。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果。 |
**错误码:**
...
...
@@ -169,11 +169,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void&
startAbility(want: Want, options?: StartOptions): Promise
<
void
>
;
启动Ability(promise形式)。
启动
UI
Ability(promise形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -182,8 +182,8 @@ startAbility(want: Want, options?: StartOptions): Promise<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动
UI
Ability所携带的参数。 |
**返回值:**
...
...
@@ -249,14 +249,14 @@ startAbility(want: Want, options?: StartOptions): Promise<void>;
startAbilityForResult(want: Want, callback: AsyncCallback
<
AbilityResult
>
): void;
启动一个
Ability。
Ability被启动后,有如下情况(callback形式):
启动一个
UIAbility。UI
Ability被启动后,有如下情况(callback形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
-
异常情况下比如杀死
UI
Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
UIAbility模式是单实例模式, 不同应用多次调用该接口启动这个UIAbility,当这个UI
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -265,7 +265,7 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| callback | AsyncCallback
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| 是 | 执行结果回调函数。 |
**错误码:**
...
...
@@ -324,14 +324,14 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
<
AbilityResult
>
): void;
启动一个
Ability。
Ability被启动后,有如下情况(callback形式):
启动一个
UIAbility。UI
Ability被启动后,有如下情况(callback形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
-
异常情况下比如杀死
UI
Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
UIAbility模式是单实例模式, 不同应用多次调用该接口启动这个UIAbility,当这个UI
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -340,8 +340,8 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动
UI
Ability所携带的参数。 |
| callback | AsyncCallback
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| 是 | 执行结果回调函数。 |
**错误码:**
...
...
@@ -404,14 +404,14 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise
<
AbilityResult
>
;
启动一个
Ability。
Ability被启动后,有如下情况(promise形式):
启动一个
UIAbility。UI
Ability被启动后,有如下情况(promise形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
-
异常情况下比如杀死
UI
Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的
UIAbility模式是单实例模式, 不同应用多次调用该接口启动这个UIAbility,当这个UI
Ability调用
[
terminateSelfWithResult
](
#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -420,8 +420,8 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityRes
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动
UI
Ability所携带的参数。 |
**返回值:**
...
...
@@ -487,7 +487,7 @@ startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityRes
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback
\<
AbilityResult>): void;
启动一个
Ability并在该
Ability帐号销毁时返回执行结果(callback形式)。
启动一个
UIAbility并在该UI
Ability帐号销毁时返回执行结果(callback形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -499,9 +499,9 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| callback | AsyncCallback
\<
AbilityResult
\>
| 是 | 启动
Ability的回调函数,返回
Ability结果。 |
| callback | AsyncCallback
\<
AbilityResult
\>
| 是 | 启动
UIAbility的回调函数,返回UI
Ability结果。 |
**错误码:**
...
...
@@ -562,7 +562,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC
startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback
\<
void
\>
): void;
启动一个
Ability并在该
Ability帐号销毁时返回执行结果(callback形式)。
启动一个
UIAbility并在该UI
Ability帐号销毁时返回执行结果(callback形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -574,10 +574,10 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动
UI
Ability所携带的参数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -641,7 +641,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp
startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise
\<
AbilityResult
\>
;
启动一个
Ability并在该
Ability帐号销毁时返回执行结果(promise形式)。
启动一个
UIAbility并在该UI
Ability帐号销毁时返回执行结果(promise形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -653,15 +653,15 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动
UI
Ability所携带的参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
AbilityResult
>
| 返回一个Promise,包含Ability结果。 |
| Promise
<
AbilityResult
>
| 返回一个Promise,包含
UI
Ability结果。 |
**错误码:**
...
...
@@ -733,8 +733,8 @@ startServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -794,7 +794,7 @@ startServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
**错误码:**
...
...
@@ -856,9 +856,9 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -918,7 +918,7 @@ startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
**错误码:**
...
...
@@ -980,8 +980,8 @@ stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -1038,7 +1038,7 @@ stopServiceExtensionAbility(want: Want): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
**错误码:**
...
...
@@ -1097,9 +1097,9 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -1160,7 +1160,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
**错误码:**
...
...
@@ -1210,7 +1210,7 @@ stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<
terminateSelf(callback: AsyncCallback
<
void
>
): void;
停止Ability自身(callback形式)。
停止
UI
Ability自身(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1251,7 +1251,7 @@ terminateSelf(callback: AsyncCallback<void>): void;
terminateSelf(): Promise
<
void
>
;
停止Ability自身(promise形式)。
停止
UI
Ability自身(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1290,7 +1290,7 @@ terminateSelf(): Promise<void>;
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback
<
void
>
): void;
停止当前的
Ability。如果该Ability是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该
Ability不是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(callback形式)。
停止当前的
UIAbility。如果该UIAbility是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该UI
Ability不是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1349,7 +1349,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi
terminateSelfWithResult(parameter: AbilityResult): Promise
<
void
>
;
停止当前的
Ability。如果该Ability是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该
Ability不是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(promise形式)。
停止当前的
UIAbility。如果该UIAbility是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该UI
Ability不是通过调用
[
startAbilityForResult
](
#uiabilitycontextstartabilityforresult
)
接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1413,7 +1413,7 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>;
connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板将当前
Ability连接到一个
Ability。
使用AbilityInfo.AbilityType.SERVICE模板将当前
UIAbility连接到一个UI
Ability。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1421,14 +1421,14 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| options |
[
ConnectOptions
](
js-apis-inner-ability-connectOptions.md
)
| 否 | 远端对象实例。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
| number | 返回
UI
Ability连接的结果code。 |
**错误码:**
...
...
@@ -1471,7 +1471,7 @@ connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
使用AbilityInfo.AbilityType.SERVICE模板和account将当前
Ability连接到一个
Ability。
使用AbilityInfo.AbilityType.SERVICE模板和account将当前
UIAbility连接到一个UI
Ability。
**需要权限:**
ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -1483,7 +1483,7 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| options |
[
ConnectOptions
](
js-apis-inner-ability-connectOptions.md
)
| 否 | 远端对象实例。 |
...
...
@@ -1491,7 +1491,7 @@ connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options
| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |
| number | 返回
UI
Ability连接的结果code。 |
**错误码:**
...
...
@@ -1545,7 +1545,7 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的Ability的数字代码。 |
| connection | number | 是 | 连接的
UI
Ability的数字代码。 |
**返回值:**
...
...
@@ -1602,7 +1602,7 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 连接的Ability的数字代码。 |
| connection | number | 是 | 连接的
UI
Ability的数字代码。 |
| callback | AsyncCallback
\<
void> | 是 | 表示指定的回调方法。 |
**错误码:**
...
...
@@ -1644,11 +1644,11 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo
startAbilityByCall(want: Want): Promise
<
Caller
>
;
启动指定
Ability至前台或后台,同时获取其Caller通信接口,调用方可使用Caller与被启动的
Ability进行通信。
启动指定
UIAbility至前台或后台,同时获取其Caller通信接口,调用方可使用Caller与被启动的UI
Ability进行通信。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
调用方应用位于后台时,使用该接口启动
UI
Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
目标
UI
Ability的visible属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -1657,7 +1657,7 @@ startAbilityByCall(want: Want): Promise<Caller>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 传入需要启动的
Ability的信息,包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选),其中deviceId缺省或为空表示启动本地Ability,parameters缺省或为空表示后台启动
Ability。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 传入需要启动的
UIAbility的信息,包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选),其中deviceId缺省或为空表示启动本地UIAbility,parameters缺省或为空表示后台启动UI
Ability。 |
**返回值:**
...
...
@@ -1736,7 +1736,7 @@ startAbilityByCall(want: Want): Promise<Caller>;
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback
\<
void
\>
): void;
根据account启动Ability(callback形式)。
根据account启动
UI
Ability(callback形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -1748,9 +1748,9 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -1810,7 +1810,7 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback
\<
void
\>
): void;
根据account启动Ability(callback形式)。
根据account启动
UI
Ability(callback形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -1822,10 +1822,10 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。|
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动Ability的回调函数。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动
UI
Ability所携带的参数。 |
| callback | AsyncCallback
\<
void
\>
| 是 | 启动
UI
Ability的回调函数。 |
**错误码:**
...
...
@@ -1888,7 +1888,7 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise
\<
void
\>
;
根据account启动Ability(Promise形式)。
根据account启动
UI
Ability(Promise形式)。
**需要权限**
: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
...
...
@@ -1900,9 +1900,9 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动
UI
Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考
[
getCreatedOsAccountsCount
](
js-apis-osAccount.md#getosaccountlocalidfromprocess
)
。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动
UI
Ability所携带的参数。 |
**错误码:**
...
...
@@ -2023,7 +2023,7 @@ requestPermissionsFromUser(permissions: Array<string>) : Promise<Permis
setMissionLabel(label: string, callback:AsyncCallback
<
void
>
): void;
设置
a
bility在任务中显示的名称(callback形式)。
设置
UIA
bility在任务中显示的名称(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2047,7 +2047,7 @@ setMissionLabel(label: string, callback:AsyncCallback<void>): void;
setMissionLabel(label: string): Promise
<
void
>
;
设置
a
bility在任务中显示的名称(promise形式)。
设置
UIA
bility在任务中显示的名称(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2076,7 +2076,7 @@ setMissionLabel(label: string): Promise<void>;
setMissionIcon(icon: image.PixelMap, callback:AsyncCallback
\<
void>): void;
设置当前
a
bility在任务中显示的图标(callback形式)。
设置当前
UIA
bility在任务中显示的图标(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2086,7 +2086,7 @@ setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的
a
bility图标。 |
| icon | image.PixelMap | 是 | 在最近的任务中显示的
UIA
bility图标。 |
| callback | AsyncCallback
\<
void> | 是 | 指定的回调函数的结果。 |
**示例:**
...
...
@@ -2118,7 +2118,7 @@ setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
setMissionIcon(icon: image.PixelMap): Promise
\<
void>;
设置当前
a
bility在任务中显示的图标(promise形式)。
设置当前
UIA
bility在任务中显示的图标(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2128,7 +2128,7 @@ setMissionIcon(icon: image.PixelMap): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的
a
bility图标。 |
| icon | image.PixelMap | 是 | 在最近的任务中显示的
UIA
bility图标。 |
**返回值:**
...
...
@@ -2167,7 +2167,7 @@ setMissionIcon(icon: image.PixelMap): Promise\<void>;
restoreWindowStage(localStorage: LocalStorage) : void;
恢复
a
bility中的window stage数据。
恢复
UIA
bility中的window stage数据。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2188,7 +2188,7 @@ restoreWindowStage(localStorage: LocalStorage) : void;
isTerminating(): boolean;
查询
a
bility是否在terminating状态。
查询
UIA
bility是否在terminating状态。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -2196,7 +2196,7 @@ isTerminating(): boolean;
| 类型 | 说明 |
| -------- | -------- |
| bool | true:
a
bility当前处于terminating状态;false:不处于terminating状态。 |
| bool | true:
UIA
bility当前处于terminating状态;false:不处于terminating状态。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录