Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 fb3e28e8 编写于 作者: M mingxihua
浏览文件
操作

mingxihua@huawei.com.cn 

Signed-off-by: Nmingxihua <mingxihua@huawei.com>
上级 44bc92a8
展开全部 隐藏空白更改
内联 并排
Showing with 351 addition and 199 deletion
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ fb3e28e8
......@@ -30,8 +30,8 @@ class MainAbility extends Ability {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| abilityInfo | [AbilityInfo](js-apis-bundleManager-abilityInfo.md) | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | 当前hap包的信息 |
| config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 |
## AbilityContext.startAbility
......@@ -40,6 +40,11 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -89,6 +94,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -142,6 +152,11 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
启动Ability（promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -198,7 +213,12 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -248,7 +268,12 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -303,7 +328,12 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityResult&gt;;
启动Ability并在该Ability退出的时候返回执行结果（promise形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -363,6 +393,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 跨应用场景下，目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -375,7 +410,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncC
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID，详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)\> | 是 | 启动Ability的回调函数，返回Ability结果。 |
**错误码：**
......@@ -420,6 +455,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOp
启动一个Ability并在该Ability帐号销毁时返回执行结果（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -481,6 +521,11 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO
启动一个Ability并在该Ability帐号销毁时返回执行结果（promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -499,7 +544,7 @@ startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartO
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;AbilityResult&gt; | 返回一个Promise，包含Ability结果。 |
| Promise&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 返回一个Promise，包含Ability结果。 |
**错误码：**
......@@ -1034,7 +1079,7 @@ terminateSelf(): Promise&lt;void&gt;;
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1090,6 +1135,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#abilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1361,6 +1407,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
......@@ -1450,6 +1501,11 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
根据account启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1506,6 +1562,11 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca
根据account启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1566,6 +1627,11 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions):
根据account启动Ability（Promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1685,7 +1751,7 @@ setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
| icon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 在最近的任务中显示的ability图标。 |
| callback | AsyncCallback\<void> | 是 | 指定的回调函数的结果。 |
**示例：**
......@@ -1727,7 +1793,7 @@ setMissionIcon(icon: image.PixelMap): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
| icon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 在最近的任务中显示的ability图标。 |
**返回值：**
......
zh-cn/application-dev/reference/apis/js-apis-ability-dataUriUtils.md
浏览文件 @ fb3e28e8
# @ohos.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径组件末尾的ID。
DataUriUtils模块提供用于处理uri对象的能力，包括获取、绑定、删除和更新指定uri对象的路径末尾的ID。本模块将被app.ability.dataUriUtils模块替代，建议优先使用[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)模块。
> **说明：**
>
......@@ -16,7 +16,7 @@ import dataUriUtils from '@ohos.ability.dataUriUtils';
getId(uri: string): number
获取附加到给定uri的路径组件末尾的ID。
获取指定uri路径末尾的ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -24,18 +24,18 @@ getId(uri: string): number
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| uri | string | 是 | 表示uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到路径组件末尾的ID。 |
| number | 返回uri路径末尾的ID。 |
**示例：**
```ts
dataUriUtils.getId("com.example.dataUriUtils/1221")
let id = dataUriUtils.getId("com.example.dataUriUtils/1221");
```
......@@ -44,7 +44,7 @@ dataUriUtils.getId("com.example.dataUriUtils/1221")
attachId(uri: string, id: number): string
将给定ID附加到给定uri的路径组件的末尾。
将ID附加到uri的路径末尾。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -52,22 +52,22 @@ attachId(uri: string, id: number): string
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| id | number | 是 | 指示要附加的ID。 |
| uri | string | 是 | 表示uri对象。 |
| id | number | 是 | 表示要附加的ID。 |
**返回值：**
| 类型 | 说明 |
| ------ | --------------------- |
| string | 附加给定ID的uri对象。 |
| string | 返回附加ID之后的uri对象。 |
**示例：**
```ts
var idint = 1122;
dataUriUtils.attachId(
let id = 1122;
let uri = dataUriUtils.attachId(
"com.example.dataUriUtils",
idint,
id,
)
```
......@@ -77,7 +77,7 @@ dataUriUtils.attachId(
deleteId(uri: string): string
从给定uri的路径组件的末尾删除ID。
删除指定uri路径末尾的ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -85,18 +85,18 @@ deleteId(uri: string): string
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
| uri | string | 是 | 表示要从中删除ID的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
| string | 返回删除ID之后的uri对象。 |
**示例：**
```ts
dataUriUtils.deleteId("com.example.dataUriUtils/1221")
let uri = dataUriUtils.deleteId("com.example.dataUriUtils/1221")
```
......@@ -113,22 +113,22 @@ updateId(uri: string, id: number): string
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象 |
| id | number | 是 | 指示新ID |
| uri | string | 是 | 表示uri对象 |
| id | number | 是 | 表示要更新的ID |
**返回值：**
| 类型 | 说明 |
| ------ | --------------- |
| string | 更新的uri对象。 |
| string | 返回更新ID之后的uri对象。 |
**示例：**
```ts
var idint = 1122;
dataUriUtils.updateId(
"com.example.dataUriUtils",
idint
let id = 1122;
let uri = dataUriUtils.updateId(
"com.example.dataUriUtils/1221",
id
)
```
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @ fb3e28e8
# @ohos.ability.errorCode (ErrorCode)
ErrorCode是定义启动功能时使用的错误代码。
本模块提供使用的错误代码的能力，包括没有错误，无效的参数等。
ErrorCode定义启动Ability时返回的错误码，包括无效的参数、权限拒绝等。
> **说明：**
>
......@@ -16,13 +14,13 @@ import errorCode from '@ohos.ability.errorCode'
## ErrorCode
定义启动功能时使用的错误代码。
定义启动Ability时返回的错误码。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR | 0 | 没有错误。 |
| NO_ERROR | 0 | 没有异常。 |
| INVALID_PARAMETER | -1 | 无效的参数。 |
| ABILITY_NOT_FOUND | -2 | 找不到ABILITY。 |
| PERMISSION_DENY | -3 | 拒绝许可。 |
\ No newline at end of file
| PERMISSION_DENY | -3 | 权限拒绝。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
浏览文件 @ fb3e28e8
# @ohos.ability.particleAbility (ParticleAbility模块)
particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。
particleAbility模块提供了操作Service类型的Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断连指定的ServiceAbility等。
> **说明：**
>
......@@ -21,7 +21,12 @@ import particleAbility from '@ohos.ability.particleAbility'
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>): void
使用此方法启动指定的particleAbility（callback形式）。
启动指定的particleAbility（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -29,8 +34,8 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>):
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示启动的ability |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回启动Ability的结果 |
**示例：**
......@@ -62,7 +67,12 @@ particleAbility.startAbility(
startAbility(parameter: StartAbilityParameter): Promise\<void>;
使用此方法启动指定的particleAbility（Promise形式）。
启动指定的particleAbility（Promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（FA模型）](../../application-models/component-startup-rules-fa.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -70,13 +80,13 @@ startAbility(parameter: StartAbilityParameter): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ----------------------------------------------- | ---- | ----------------- |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 指示启动的ability |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示启动的ability |
**返回值：**
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | Promise形式返回启动Ability的结果。 |
**示例：**
......@@ -107,7 +117,7 @@ particleAbility.startAbility(
terminateSelf(callback: AsyncCallback\<void>): void
终止particleAbility（callback形式）。
销毁当前particleAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -115,7 +125,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回停止当前Ability结果 |
**示例：**
......@@ -133,7 +143,7 @@ particleAbility.terminateSelf(
terminateSelf(): Promise\<void>
终止particleAbility（Promise形式）。
销毁当前particleAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -141,7 +151,7 @@ terminateSelf(): Promise\<void>
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回停止当前Ability结果。 |
**示例：**
......@@ -159,7 +169,7 @@ particleAbility.terminateSelf().then((data) => {
acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
获取dataAbilityHelper对象。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -167,13 +177,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
| 参数名 | 类型 | 必填 | 说明 |
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| uri | string | 是 | 表示要打开的文件的路径。 |
**返回值：**
| 类型 | 说明 |
| ----------------- | -------------------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
| [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：**
......@@ -270,7 +280,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回启动长时任务的结果。 |
**示例**：
......@@ -326,7 +336,7 @@ cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回取消长时任务的结果 |
**示例**：
......@@ -357,7 +367,7 @@ cancelBackgroundRunning(): Promise&lt;void&gt;;
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回取消长时任务的结果。 |
**示例**：
......@@ -376,7 +386,7 @@ particleAbility.cancelBackgroundRunning().then(() => {
connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。
将当前ability与指定的ServiceAbility进行连接（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -385,22 +395,13 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- |
| request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 连接回调方法。 |
**ConnectOptions类型说明：**
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 必填 | 说明 |
| ------------ | -------- | ---- | ------------------------- |
| onConnect | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | function | 是 | 连接失败时的回调函数。 |
| onFailed | function | 是 | ConnectAbility调用失败时的回调函数。 |
**示例**：
```ts
import particleAbility from '@ohos.ability.particleAbility'
import rpc from '@ohos.rpc'
function onConnectCallback(element, remote) {
......@@ -438,7 +439,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
将功能与服务功能断开连接。
断开当前ability与指定ServiceAbility的连接（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -451,7 +452,8 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
**示例**：
```ts
import rpc from '@ohos.rpc'
import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc';
function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
......@@ -488,7 +490,7 @@ particleAbility.disconnectAbility(connId, (err) => {
disconnectAbility(connection: number): Promise\<void>;
将功能与服务功能断开连接。
断开当前ability与指定ServiceAbility的连接（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -501,7 +503,8 @@ disconnectAbility(connection: number): Promise\<void>;
**示例**：
```ts
import rpc from '@ohos.rpc'
import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc';
function onConnectCallback(element, remote) {
console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
......@@ -537,7 +540,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
## ErrorCode
获取错误代码。
表示错误码。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @ fb3e28e8
......@@ -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
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @ fb3e28e8
......@@ -588,7 +588,7 @@ try {
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取当前所有前台应用的信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -608,7 +608,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | 以Promise方式返回接口运行结果及应用状态数据数组，可进行错误处理或其他自定义处理。 |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | 以Callback方式返回接口运行结果及应用状态数据数组，可进行错误处理或其他自定义处理。 |
**示例：**
......@@ -633,7 +633,7 @@ try {
getForegroundApplications(): Promise\<Array\<AppStateData>>;
获取当前所有前台应用的信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -645,7 +645,7 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 返回前台进程应用程序的数组。 |
| Promise\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 以Promise形式返回所有当前处于前台的应用信息。 |
**错误码**：
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @ fb3e28e8
......@@ -32,7 +32,7 @@ on(type:"mission", listener: MissionListener): number;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listener | MissionListener | 是 | 系统任务监听方法。 |
| listener | [MissionListener](js-apis-inner-application-missionListener.md) | 是 | 系统任务监听方法。 |
**返回值：**
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @ fb3e28e8
......@@ -42,7 +42,7 @@ Ability创建时回调，执行初始化业务逻辑操作。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-app-ability-want.md) | 是 | 当前Ability的Want类型信息，包括ability名称、bundle名称等。 |
| param | AbilityConstant.LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
| param | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
**示例：**
......@@ -67,7 +67,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -111,7 +111,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -199,13 +199,13 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
| 类型 | 说明 |
| -------- | -------- |
| AbilityConstant.OnContinueResult | 继续的结果。 |
| [AbilityConstant.OnContinueResult](js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult) | 继续的结果。 |
**示例：**
```ts
import AbilityConstant from "@ohos.application.AbilityConstant"
class myAbility extends Ability {
import AbilityConstant from "@ohos.app.ability.AbilityConstant"
class MyUIAbility extends UIAbility {
onContinue(wantParams) {
console.log('onContinue');
wantParams["myData"] = "my1234567";
......@@ -219,7 +219,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
当ability的启动模式设置为单例时回调会被调用。
当传入新的Want，ability再次被拉起时会回调执行该方法。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
......@@ -227,17 +227,18 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | Want类型参数，如ability名称，包名等。 |
| launchParams | AbilityConstant.LaunchParam | 是 | Ability启动的原因、上次异常退出的原因信息。 |
| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 |
| launchParams | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
**示例：**
```ts
class myAbility extends Ability {
onNewWant(want) {
class MyUIAbility extends UIAbility {
onNewWant(want, launchParams) {
console.log('onNewWant, want:' + want.abilityName);
}
}
console.log('onNewWant, launchParams:' + JSON.stringify(launchParams));
}
}
```
## Ability.onDump
......@@ -290,9 +291,9 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any})
**示例：**
```ts
import AbilityConstant from '@ohos.application.AbilityConstant'
import AbilityConstant from '@ohos.app.ability.AbilityConstant'
class myAbility extends Ability {
class MyUIAbility extends UIAbility {
onSaveState(reason, wantParam) {
console.log('onSaveState');
wantParam["myData"] = "my1234567";
......@@ -320,7 +321,7 @@ call(method: string, data: rpc.Sequenceable): Promise&lt;void&gt;;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
| data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值：**
......@@ -401,13 +402,13 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise&lt;rpc.MessagePa
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
| data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;rpc.MessageParcel&gt; | Promise形式返回通用组件服务端应答数据。 |
| Promise&lt;[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)&gt; | Promise形式返回通用组件服务端应答数据。 |
**错误码：**
......@@ -527,7 +528,7 @@ release(): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 |
| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 |
**示例：**
......@@ -571,7 +572,7 @@ release(): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件，固定为'release'。 |
| callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 |
| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 |
**错误码：**
......@@ -627,7 +628,7 @@ on(method: string, callback: CalleeCallback): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的rpc.Sequenceable数据对象,&nbsp;其他视为函数执行错误。 |
| callback | [CalleeCallback](#calleecallback) | 是 | 一个[rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)数据对象,&nbsp;其他视为函数执行错误。 |
**错误码：**
......@@ -739,4 +740,4 @@ off(method: string): void;
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 |
| (indata: [rpc.MessageParcel](js-apis-rpc.md#sequenceabledeprecated)) | 是 | 否 | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
浏览文件 @ fb3e28e8
......@@ -85,7 +85,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------------- | ---- | ------------- |
| info | WantAgentInfo | 是 | WantAgent信息。 |
| info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 |
**返回值：**
......@@ -451,7 +451,7 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| callback | AsyncCallback\<Want\> | 是 | 获取WantAgent对象want的回调方法。 |
| callback | AsyncCallback\<[Want](js-apis-app-ability-want.md)\> | 是 | 获取WantAgent对象want的回调方法。 |
**示例：**
......@@ -752,7 +752,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co
| ----------- | ----------------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| triggerInfo | TriggerInfo | 是 | TriggerInfo对象。 |
| callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 |
| callback | AsyncCallback\<[CompleteData](#completedata)\> | 否 | 主动激发WantAgent实例的回调方法。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ fb3e28e8
......@@ -67,7 +67,7 @@ onWindowStageCreate(windowStage: window.WindowStage): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -111,7 +111,7 @@ onWindowStageRestore(windowStage: window.WindowStage): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -219,7 +219,7 @@ onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
当ability的启动模式设置为单例时回调会被调用。
当传入新的Want，ability再次被拉起时会回调执行该方法。
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
......@@ -234,8 +234,9 @@ onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
```ts
class myAbility extends Ability {
onNewWant(want) {
onNewWant(want, launchParams) {
console.log('onNewWant, want:' + want.abilityName);
console.log('onNewWant, launchParams:' + JSON.stringify(launchParams));
}
}
```
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md
浏览文件 @ fb3e28e8
......@@ -21,8 +21,8 @@ import AbilityConstant from '@ohos.application.AbilityConstant';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 |
| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 指示启动原因。 |
| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 表示最后退出原因。 |
## AbilityConstant.LaunchReason
......
zh-cn/application-dev/reference/apis/js-apis-application-abilityManager.md
浏览文件 @ fb3e28e8
......@@ -112,7 +112,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -138,7 +138,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -167,7 +167,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -201,7 +201,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -229,7 +229,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -253,7 +253,7 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<ElementName>| 返回执行结果。 |
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 返回执行结果。 |
**示例**：
......
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @ fb3e28e8
......@@ -31,7 +31,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ---------------------------------------- | ---- | ---- | ---------- |
| eventType | [accessibility.EventType](js-apis-accessibility.md#EventType) \| [accessibility.WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](#touchguidetype) \| [GestureType](#gesturetype) \| [PageUpdateType](#pageupdatetype) | 是 | 否 | 具体事件类型。 |
| target | AccessibilityElement | 是 | 否 | 发生事件的目标组件。 |
| target | [AccessibilityElement](js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9) | 是 | 否 | 发生事件的目标组件。 |
| timeStamp | number | 是 | 否 | 事件时间戳。 |
## GestureType
......
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
浏览文件 @ fb3e28e8
......@@ -171,7 +171,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 |
| Promise\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 获取有关运行进程的信息。 |
**示例：**
......@@ -199,7 +199,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 是 | 获取有关运行进程的信息。 |
| callback | AsyncCallback\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 是 | 获取有关运行进程的信息。 |
**示例：**
......@@ -420,8 +420,8 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -432,7 +432,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | callback形式返回所有当前处于前台的应用信息。 |
**示例：**
......@@ -451,7 +451,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
getForegroundApplications(): Promise\<Array\<AppStateData>>;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -463,7 +463,7 @@ getForegroundApplications(): Promise\<Array\<AppStateData>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 返回进程运行信息的数组。 |
| Promise\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | Promise形式返回所有当前处于前台的应用信息。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-serviceExtensionContext.md
浏览文件 @ fb3e28e8
......@@ -245,6 +245,11 @@ startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<
根据account启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
......@@ -316,6 +321,11 @@ startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, ca
根据account启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
......@@ -392,6 +402,11 @@ startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions):
根据account启动Ability（Promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口，三方应用不支持调用。
......@@ -1300,6 +1315,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**系统API**：此接口为系统接口，三方应用不支持调用。
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
浏览文件 @ fb3e28e8
......@@ -25,6 +25,11 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -91,6 +96,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
启动Ability（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -161,6 +171,11 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
启动Ability（promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......@@ -234,7 +249,12 @@ startAbility(want: Want, options?: StartOptions): Promise&lt;void&gt;;
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -301,7 +321,12 @@ startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -373,7 +398,12 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise&lt;AbilityResult&gt;;
启动Ability并在该Ability退出的时候返回执行结果（promise形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（promise形式）。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1251,7 +1281,7 @@ terminateSelf(): Promise&lt;void&gt;;
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（callback形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1310,7 +1340,7 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;voi
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
停止Ability，配合startAbilityForResult使用，返回给接口调用方AbilityResult信息（promise形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1607,6 +1637,11 @@ startAbilityByCall(want: Want): Promise&lt;Caller&gt;;
启动指定Ability至前台或后台，同时获取其Caller通信接口，调用方可使用Caller与被启动的Ability进行通信。
使用规则：
- 调用方应用位于后台时，使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
- 目标Ability的visible属性若配置为false，调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
- 组件启动规则详见：[组件启动规则（Stage模型）](../../application-models/component-startup-rules.md)
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
**参数：**
......
zh-cn/application-dev/tools/aa-tool.md
浏览文件 @ fb3e28e8
......@@ -68,7 +68,7 @@ Ability assistant（Ability助手，简称为aa），是实现应用及测试用
| -------- | -------- | -------- |
| -h/--help | - | 帮助信息。 |
| -a/--all | - | 打印所有mission内的应用组件信息。 |
| -l/--mission-list | type（缺省打印全部） | 打印任务栈信息。<br/>可取值：<br/>-&nbsp;NORMAL<br/>-&nbsp;DEFAULT_STANDARD<br/>-&nbsp;DEFAULT_SINGLE<br/>-&nbsp;LAUNCHER |
| -l/--mission-list | type（缺省打印全部） | 服务侧为了方便管理任务链，内部维护了4种类型的任务链。<br/>可取值：<br/>-&nbsp;NORMAL: 正常启动的任务链(比如A拉起B拉起C, 则对应的任务链是A->B->C)<br/>-&nbsp;DEFAULT_STANDARD: 已经被破坏的任务链中的任务, 启动模式为standard的任务被放到该任务链中, 这里面的任务之间没有关联关系<br/>-&nbsp;DEFAULT_SINGLE: 已经被破坏的任务链中的任务, 启动模式为singleton的任务被放到该任务链中, 这里面的任务之间没有关联关系<br/>-&nbsp;LAUNCHER: launcher的任务链 |
| -e/--extension | elementName | 打印扩展组件信息。 |
| -u/--userId | UserId | 打印指定UserId的栈信息，需要和其他参数组合使用，例如aa&nbsp;dump&nbsp;-a&nbsp;-u&nbsp;100、aa&nbsp;dump&nbsp;-d&nbsp;-u&nbsp;100。 |
| -d/--data | - | 打印DataAbility相关信息。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或