Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 436330dd 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12890 资料文档描述优化 

Merge pull request !12890 from mingxihua/master
上级 1fe6ca70 71871991
显示空白变更内容
内联 并排
Showing with 241 addition and 237 deletion
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ 436330dd
......@@ -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
......@@ -198,7 +198,7 @@ startAbility(want: Want, options?: StartOptions): Promise<void>;
startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -248,7 +248,7 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>):
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -303,7 +303,7 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>;
启动Ability并在该Ability退出的时候返回执行结果（promise形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -375,7 +375,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结果。 |
**错误码：**
......@@ -499,7 +499,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 +1034,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 +1090,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
......@@ -1685,7 +1686,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 +1728,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
浏览文件 @ 436330dd
# @ohos.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径组件末尾的ID。本模块将被app.ability.dataUriUtils模块，建议优先使用[@ohos.app.ability.dataUriUtils](js-apis-app-ability-dataUriUtils.md)模块。
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,13 +24,13 @@ getId(uri: string): number
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| uri | string | 是 | 表示uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到路径组件末尾的ID。 |
| number | 返回uri路径末尾的ID。 |
**示例：**
......@@ -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;
var id = 1122;
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,13 +85,13 @@ deleteId(uri: string): string
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
| uri | string | 是 | 表示要从中删除ID的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
| string | 返回删除ID之后的uri对象。 |
**示例：**
......@@ -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;
var id = 1122;
dataUriUtils.updateId(
"com.example.dataUriUtils",
idint
"com.example.dataUriUtils/1221",
id
)
```
zh-cn/application-dev/reference/apis/js-apis-ability-errorCode.md
浏览文件 @ 436330dd
# @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-featureAbility.md
浏览文件 @ 436330dd
# @ohos.ability.featureAbility (FeatureAbility模块)
FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动新的ability、获取dataAbilityHelper、设置此Page Ability、获取当前Ability对应的窗口，连接服务等。
FeatureAbility模块提供与用户进行交互的Ability的能力，包括启动新的Ability、停止Ability、获取dataAbilityHelper对象、获取当前Ability对应的窗口，连接断连Service等。
> **说明：**
>
......@@ -9,7 +9,7 @@ FeatureAbility模块提供带有UI设计与用户交互的能力，包括启动
## 使用限制
FeatureAbility模块的接口只能在Page类型的Ability调用
FeatureAbility模块的接口只能在Page类型的Ability中调用
## 导入模块
......@@ -21,7 +21,7 @@ import featureAbility from '@ohos.ability.featureAbility';
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
启动新的ability（callback形式）。
启动新的Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -30,7 +30,7 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>)
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<number> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<number> | 是 | 以callback的形式返回启动Ability的结果。 |
**示例：**
......@@ -64,7 +64,7 @@ featureAbility.startAbility(
startAbility(parameter: StartAbilityParameter): Promise\<number>
启动新的ability（Promise形式）。
启动新的Ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -74,6 +74,12 @@ startAbility(parameter: StartAbilityParameter): Promise\<number>
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<number> | Promise形式返回启动Ability结果。 |
**示例：**
```ts
......@@ -103,7 +109,7 @@ featureAbility.startAbility(
acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
获取dataAbilityHelper对象。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -111,13 +117,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| uri | string | 是 | 表示要打开的文件的路径。 |
**返回值：**
| 类型 | 说明 |
| ----------------- | ------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
| [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：**
......@@ -132,7 +138,7 @@ var dataAbilityHelper = featureAbility.acquireDataAbilityHelper(
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#featureabilityterminateselfwithresult7)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -141,7 +147,7 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](js-apis-inner-ability-startAbilityParameter.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 以callback的形式返回启动Ability结果。 |
**示例：**
......@@ -173,7 +179,7 @@ featureAbility.startAbilityForResult(
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#featureabilityterminateselfwithresult7)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -187,7 +193,7 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 返回执行结果。 |
| Promise\<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回启动Ability结果。 |
**示例：**
......@@ -229,7 +235,7 @@ featureAbility.startAbilityForResult(
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -237,8 +243,8 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | -------------- |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示停止Ability之后返回的结果。 |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回停止Ability结果。 |
**示例：**
......@@ -281,7 +287,7 @@ featureAbility.terminateSelfWithResult(
terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时会将结果返回给调用者，如果该Ability不是通过调用[startAbilityForResult](#featureabilitystartabilityforresult7)接口被拉起的，调用terminateSelfWithResult接口时不会有结果返回给调用者（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -289,13 +295,13 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示被启动的Ability |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 表示停止Ability之后返回的结果 |
**返回值：**
| 类型 | 说明 |
| -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 |
| Promise\<void> | 以Promise形式返回停止当前Ability结果。 |
**示例：**
......@@ -345,7 +351,7 @@ hasWindowFocus(callback: AsyncCallback\<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
| callback | AsyncCallback\<boolean> | 是 | 以callback的形式返回结果。<br>如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：**
......@@ -368,7 +374,7 @@ hasWindowFocus(): Promise\<boolean>
| 类型 | 说明 |
| ----------------- | ------------------------------------- |
| Promise\<boolean> | 如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
| Promise\<boolean> | Promise形式返回结果，如果此Ability当前具有视窗焦点，则返回true；否则返回false。 |
**示例：**
......@@ -383,7 +389,7 @@ featureAbility.hasWindowFocus().then((data) => {
getWant(callback: AsyncCallback\<Want>): void
获取从Ability发送的Want（callback形式）。
获取要拉起的Ability对应的Want（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -391,7 +397,7 @@ getWant(callback: AsyncCallback\<Want>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | --------- |
| callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<[Want](js-apis-application-want.md)> | 是 | 以callback的形式返回want。 |
**示例：**
......@@ -406,7 +412,7 @@ featureAbility.getWant((err, data) => {
getWant(): Promise\<Want>
获取从Ability发送的Want（Promise形式）。
获取要拉起的Ability对应的Want（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -414,7 +420,7 @@ getWant(): Promise\<Want>
| 类型 | 说明 |
| ----------------------- | ---------------- |
| Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回结果。 |
| Promise\<[Want](js-apis-application-want.md)> | 以Promise的形式返回want。 |
**示例：**
......@@ -453,7 +459,7 @@ context.getBundleName((err, data) => {
terminateSelf(callback: AsyncCallback\<void>): void
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。
停止当前的Ability（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -461,7 +467,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回停止当前Ability结果 |
**示例：**
......@@ -478,7 +484,7 @@ featureAbility.terminateSelf(
terminateSelf(): Promise\<void>
设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。
停止当前的Ability（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -486,7 +492,7 @@ terminateSelf(): Promise\<void>
| 类型 | 说明 |
| -------------- | ---------------- |
| Promise\<void> | 以Promise的形式返回结果。 |
| Promise\<void> | 以Promise的形式返回停止当前Ability结果。 |
**示例：**
......@@ -501,7 +507,7 @@ featureAbility.terminateSelf().then((data) => {
connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。
将当前Ability与指定的ServiceAbility进行连接。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -510,13 +516,13 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | --------------------- |
| request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 被指定的回调方法。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 表示连接回调函数。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------------------- |
| number | 连接的ServiceAbilityID。 |
| number | 连接的ServiceAbility的ID。 |
**示例：**
......@@ -558,8 +564,8 @@ disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------- | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法 |
| connection | number | 是 | 表示断开连接的ServiceAbility的ID |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回断开连接结果 |
**示例：**
......@@ -605,13 +611,13 @@ disconnectAbility(connection: number): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ----------------------- |
| connection | number | 是 | 指定断开连接的ServiceAbilityID |
| connection | number | 是 | 表示断开连接的ServiceAbility的ID |
**返回值：**
| 类型 | 说明 |
| -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 |
| Promise\<void> | 以Promise形式返回断开连接结果。 |
**示例：**
......@@ -659,7 +665,7 @@ getWindow(callback: AsyncCallback\<window.Window>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<window.Window> | 是 | 返回与当前Ability对应的窗口。 |
| callback | AsyncCallback\<[window.Window](js-apis-window.md#window)> | 是 | callback形式返回当前Ability对应的窗口。 |
**示例：**
......@@ -681,7 +687,7 @@ getWindow(): Promise\<window.Window>;
| 类型 | 说明 |
| ----------------------- | ----------------------------- |
| Promise\<window.Window> | 返回与当前Ability对应的窗口。 |
| Promise\<[window.Window](js-apis-window.md#window)> | Promise形式返回当前Ability对应的窗口。 |
**示例：**
......@@ -693,7 +699,7 @@ featureAbility.getWindow().then((data) => {
## AbilityWindowConfiguration
使用时通过featureAbility.AbilityWindowConfiguration获取。
表示当前Ability对应的窗口配置项，使用时通过featureAbility.AbilityWindowConfiguration获取。
**示例：**
......@@ -714,7 +720,7 @@ featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
## AbilityStartSetting
abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
表示当前Ability对应的窗口属性，abilityStartSetting属性是一个定义为[key: string]: any的对象，key对应设定类型为：AbilityStartSetting枚举类型，value对应设定类型为：AbilityWindowConfiguration枚举类型。
使用时通过featureAbility.AbilityStartSetting获取。
......@@ -734,7 +740,7 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
## ErrorCode
获取错误代码。
表示错误码。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -742,13 +748,13 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
| ------------------------------ | ---- | ---------------------------------------- |
| NO_ERROR<sup>7+</sup> | 0 | 没有错误。 |
| INVALID_PARAMETER<sup>7+</sup> | -1 | 无效的参数。 |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到能力。 |
| PERMISSION_DENY<sup>7+</sup> | -3 | 拒绝许可。 |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2 | 找不到ABILITY。 |
| PERMISSION_DENY<sup>7+</sup> | -3 | 权限拒绝。 |
## DataAbilityOperationType
指示数据的操作类型。
表示数据的操作类型。DataAbility批量操作数据时可以通过该枚举值指定操作类型
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -761,24 +767,26 @@ featureAbility.AbilityStartSetting.BOUNDS_KEY
## flags说明
表示处理Want的方式。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力。 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 |
| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 表示对URI执行读取操作的授权。 |
| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 表示对URI执行写入操作的授权。 |
| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 表示将结果返回给源Ability。 |
| FLAG_ABILITY_CONTINUATION | 0x00000008 | 表示是否可以将本地设备上的Ability迁移到远端设备。 |
| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 表示组件是否不属于OHOS。 |
| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 表示某个Ability是否已经启动。 |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 表示URI上可能持久化的授权。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 表示按照前缀匹配的方式验证URI权限。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 表示支持分布式调度系统中的多设备启动。 |
| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 表示无论宿主应用是否已启动，都将使用前台模式启动Ability。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是否是可反向的。 |
| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 表示如果未安装指定的Ability，将安装该Ability。 |
| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 表示如果未安装指定的Ability，将在后台安装该Ability。 |
| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 表示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)** 中**startAbility**方法的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 |
| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 表示在已有的任务栈上创建任务的操作。 |
| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 表示如果启动的Ability的现有实例已位于任务栈顶，则将重用该实例。否则，将创建一个新的Ability实例。 |
zh-cn/application-dev/reference/apis/js-apis-ability-particleAbility.md
浏览文件 @ 436330dd
# @ohos.ability.particleAbility (ParticleAbility模块)
particleAbility模块提供了Service类型Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断开当前Ability与指定ServiceAbility等。
particleAbility模块提供了操作Service类型的Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断连指定的ServiceAbility等。
> **说明：**
>
......@@ -21,7 +21,7 @@ import particleAbility from '@ohos.ability.particleAbility'
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<void>): void
使用此方法启动指定的particleAbility（callback形式）。
启动指定的particleAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -29,8 +29,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 +62,7 @@ particleAbility.startAbility(
startAbility(parameter: StartAbilityParameter): Promise\<void>;
使用此方法启动指定的particleAbility（Promise形式）。
启动指定的particleAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -70,13 +70,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 +107,7 @@ particleAbility.startAbility(
terminateSelf(callback: AsyncCallback\<void>): void
终止particleAbility（callback形式）。
销毁当前particleAbility（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -115,7 +115,7 @@ terminateSelf(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------- |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法 |
| callback | AsyncCallback\<void> | 是 | 以callback的形式返回停止当前Ability结果 |
**示例：**
......@@ -133,7 +133,7 @@ particleAbility.terminateSelf(
terminateSelf(): Promise\<void>
终止particleAbility（Promise形式）。
销毁当前particleAbility（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -141,7 +141,7 @@ terminateSelf(): Promise\<void>
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回停止当前Ability结果。 |
**示例：**
......@@ -159,7 +159,7 @@ particleAbility.terminateSelf().then((data) => {
acquireDataAbilityHelper(uri: string): DataAbilityHelper
获取dataAbilityHelper。
获取dataAbilityHelper对象。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -167,13 +167,13 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper
| 参数名 | 类型 | 必填 | 说明 |
| :--- | ------ | ---- | ------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| uri | string | 是 | 表示要打开的文件的路径。 |
**返回值：**
| 类型 | 说明 |
| ----------------- | -------------------------------------------- |
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
| [DataAbilityHelper](js-apis-inner-ability-dataAbilityHelper.md) | 用来协助其他Ability访问DataAbility的工具类。 |
**示例：**
......@@ -270,7 +270,7 @@ startBackgroundRunning(id: number, request: NotificationRequest): Promise&lt;voi
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回启动长时任务的结果。 |
**示例**：
......@@ -326,7 +326,7 @@ cancelBackgroundRunning(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回取消长时任务的结果 |
**示例**：
......@@ -357,7 +357,7 @@ cancelBackgroundRunning(): Promise&lt;void&gt;;
| 类型 | 说明 |
| -------------- | ------------------------- |
| Promise\<void> | 使用Promise形式返回结果。 |
| Promise\<void> | 使用Promise形式返回取消长时任务的结果。 |
**示例**：
......@@ -376,7 +376,7 @@ particleAbility.cancelBackgroundRunning().then(() => {
connectAbility(request: Want, options:ConnectOptions): number
将当前ability连接到指定ServiceAbility（callback形式）。
将当前ability与指定的ServiceAbility进行连接（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -385,18 +385,8 @@ connectAbility(request: Want, options:ConnectOptions): number
| 参数名 | 类型 | 必填 | 说明 |
| ------- | -------------- | ---- | ---------------------------- |
| request | [Want](js-apis-application-want.md) | 是 | 表示被连接的ServiceAbility。 |
| options | ConnectOptions | 是 | 被指定的回调方法。 |
**ConnectOptions类型说明：**
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 连接回调方法。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------ | -------- | ---- | ------------------------- |
| onConnect | function | 是 | 连接成功时的回调函数。 |
| onDisconnect | function | 是 | 连接失败时的回调函数。 |
| onFailed | function | 是 | ConnectAbility调用失败时的回调函数。 |
**示例**：
......@@ -439,7 +429,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void;
将功能与服务功能断开连接。
断开当前ability与指定ServiceAbility的连接（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -489,7 +479,7 @@ var result = particleAbility.disconnectAbility(connId).then((data) => {
disconnectAbility(connection: number): Promise\<void>;
将功能与服务功能断开连接。
断开当前ability与指定ServiceAbility的连接（Promise形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......@@ -538,7 +528,7 @@ particleAbility.disconnectAbility(connId).then((data) => {
## ErrorCode
获取错误代码。
表示错误码。
**系统能力**：SystemCapability.Ability.AbilityRuntime.FAModel
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @ 436330dd
......@@ -15,12 +15,16 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
## 属性
## AbilityConstant.LaunchParam
启动参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 |
| launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 指示启动原因。 |
| lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 表示最后退出原因。 |
## AbilityConstant.LaunchReason
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @ 436330dd
......@@ -118,7 +118,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -147,7 +147,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -179,7 +179,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -216,7 +216,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -247,7 +247,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -269,7 +269,7 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<ElementName>| 返回执行结果。 |
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 返回执行结果。 |
**示例**：
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @ 436330dd
......@@ -391,7 +391,7 @@ off(type: "applicationState", observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -403,7 +403,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | callback形式返回所有当前处于前台的应用信息。 |
**示例：**
......@@ -465,7 +465,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -477,7 +477,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | callback形式返回所有当前处于前台的应用信息。 |
**示例：**
......@@ -500,7 +500,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
getForegroundApplications(): Promise\<Array\<AppStateData>>;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -512,7 +512,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-app-ability-configuration.md
浏览文件 @ 436330dd
......@@ -18,8 +18,8 @@ import Configuration from '@ohos.app.ability.Configuration'
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode | [ColorMode](js-apis-app-ability-configurationConstant.md#configurationconstantcolormode) | 是 | 是 | 表示深浅色模式，取值范围：浅色模式（COLOR_MODE_LIGHT），深色模式（COLOR_MODE_DARK）。默认为浅色。 |
| direction | Direction | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| direction | [Direction](js-apis-app-ability-configurationConstant.md#configurationconstantdirection) | 是 | 否 | 表示屏幕方向，取值范围：水平方向（DIRECTION_HORIZONTAL），垂直方向（DIRECTION_VERTICAL）。 |
| screenDensity | [ScreenDensity](js-apis-app-ability-configurationConstant.md#configurationconstantscreendensity) | 是 | 否 | 表示屏幕分辨率，取值范围：SCREEN_DENSITY_SDPI（120）、SCREEN_DENSITY_MDPI（160）、SCREEN_DENSITY_LDPI（240）、SCREEN_DENSITY_XLDPI（320）、SCREEN_DENSITY_XXLDPI（480）、SCREEN_DENSITY_XXXLDPI（640）。 |
| displayId | number | 是 | 否 | 表示应用所在的物理屏幕Id。 |
| hasPointerDevice | boolean | 是 | 否 | 指示指针类型设备是否已连接，如键鼠、触控板等。 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
浏览文件 @ 436330dd
# ohos.app.ability.dataUriUtils (DataUriUtils模块)
# @ohos.app.ability.dataUriUtils (DataUriUtils模块)
DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径末尾的ID。
DataUriUtils模块提供用于处理uri对象的能力，包括获取、绑定、删除和更新指定uri对象的路径末尾的ID。
> **说明：**
>
......@@ -16,7 +16,7 @@ import dataUriUtils from '@ohos.app.ability.dataUriUtils';
getId(uri: string): number
获取附加到给定uri的路径末尾的ID。
获取指定uri路径末尾的ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -24,13 +24,13 @@ getId(uri: string): number
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
| uri | string | 是 | 表示uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到uri路径末尾的ID。 |
| number | 返回uri路径末尾的ID。 |
**示例：**
......@@ -49,7 +49,7 @@ try {
attachId(uri: string, id: number): string
将给定ID附加到给定uri的路径末尾。可用于生成新的uri。
将ID附加到uri的路径末尾。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -57,23 +57,23 @@ 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;
var id = 1122;
try {
var uri = dataUriUtils.attachId(
"com.example.dataUriUtils",
idint,
id,
)
console.info('attachId the uri is: ' + uri)
} catch (err) {
......@@ -88,7 +88,7 @@ try {
deleteId(uri: string): string
从给定uri的路径的末尾删除ID。
删除指定uri路径末尾的ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -96,13 +96,13 @@ deleteId(uri: string): string
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
| uri | string | 是 | 表示要从中删除ID的uri对象。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
| string | 返回删除ID之后的uri对象。 |
**示例：**
......@@ -130,24 +130,24 @@ updateId(uri: string, id: number): string
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 指示要更新的uri对象。 |
| id | number | 是 | 指示新ID。 |
| uri | string | 是 | 表示uri对象 |
| id | number | 是 | 表示要更新的ID |
**返回值：**
| 类型 | 说明 |
| ------ | --------------- |
| string | 更新的uri对象。 |
| string | 返回更新ID之后的uri对象。 |
**示例：**
```ts
try {
var idint = 1122;
var id = 1122;
var uri = dataUriUtils.updateId(
"com.example.dataUriUtils",
idint
"com.example.dataUriUtils/1221",
id
)
} catch (err) {
console.error('delete uri err, check the input uri' + err)
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @ 436330dd
......@@ -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
浏览文件 @ 436330dd
......@@ -18,7 +18,7 @@ import UIAbility from '@ohos.app.ability.UIAbility';
## 属性
**系统能力**：以下各项对应的系统能力均为SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
......@@ -29,18 +29,18 @@ import UIAbility from '@ohos.app.ability.UIAbility';
## UIAbility.onCreate
onCreate(want: Want, param: UIAbilityConstant.LaunchParam): void;
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
UIAbility创建时回调，执行初始化业务逻辑操作。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-app-ability-want.md) | 是 | 当前UIAbility的Want类型信息，包括ability名称、bundle名称等。 |
| param | UIAbilityConstant.LaunchParam | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
| param | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | 创建&nbsp;ability、上次异常退出的原因信息。 |
**示例：**
......@@ -59,13 +59,13 @@ onWindowStageCreate(windowStage: window.WindowStage): void
当WindowStage创建后调用。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -84,7 +84,7 @@ onWindowStageDestroy(): void
当WindowStage销毁后调用。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
......@@ -103,13 +103,13 @@ onWindowStageRestore(windowStage: window.WindowStage): void
当迁移多实例ability时，恢复WindowStage后调用。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | WindowStage相关信息。 |
**示例：**
......@@ -128,7 +128,7 @@ onDestroy(): void;
UIAbility生命周期回调，在销毁时回调，执行资源清理等操作。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
......@@ -147,7 +147,7 @@ onForeground(): void;
UIAbility生命周期回调，当应用从后台转到前台时触发。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
......@@ -166,7 +166,7 @@ onBackground(): void;
UIAbility生命周期回调，当应用从前台转到后台时触发。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例：**
......@@ -181,11 +181,11 @@ UIAbility生命周期回调，当应用从前台转到后台时触发。
## UIAbility.onContinue
onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult;
onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
当ability迁移准备迁移时触发，保存数据。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
......@@ -197,17 +197,17 @@ onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult
| 类型 | 说明 |
| -------- | -------- |
| UIAbilityConstant.OnContinueResult | 继续的结果。 |
| [AbilityConstant.OnContinueResult](js-apis-app-ability-abilityConstant.md#abilityconstantoncontinueresult) | 继续的结果。 |
**示例：**
```ts
import UIAbilityConstant from "@ohos.app.ability.UIAbilityConstant"
import AbilityConstant from "@ohos.app.ability.AbilityConstant"
class MyUIAbility extends UIAbility {
onContinue(wantParams) {
console.log('onContinue');
wantParams["myData"] = "my1234567";
return UIAbilityConstant.OnContinueResult.AGREE;
return AbilityConstant.OnContinueResult.AGREE;
}
}
```
......@@ -215,25 +215,26 @@ onContinue(wantParam : {[key: string]: any}): UIAbilityConstant.OnContinueResult
## UIAbility.onNewWant
onNewWant(want: Want, launchParams: UIAbilityConstant.LaunchParam): void;
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
当ability的启动模式设置为单例时回调会被调用。
启动模式为单例的ability再次被拉起时会回调执行该方法。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如Ability名称，Bundle名称等。 |
| launchParams | UIAbilityConstant.LaunchParam | 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
| want | [Want](js-apis-app-ability-want.md) | 是 | Want类型参数，如ability名称，包名等。 |
| launchParams | [AbilityConstant.LaunchParam](js-apis-app-ability-abilityConstant.md#abilityconstantlaunchparam) | 是 | UIAbility启动的原因、上次异常退出的原因信息。 |
**示例：**
```ts
class MyUIAbility extends UIAbility {
onNewWant(want) {
onNewWant(want, launchParams) {
console.log('onNewWant, want:' + want.abilityName);
console.log('onNewWant, launchParams:' + JSON.stringify(launchParams));
}
}
```
......@@ -244,7 +245,7 @@ onDump(params: Array\<string>): Array\<string>;
转储客户端信息时调用。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
......@@ -266,35 +267,35 @@ onDump(params: Array\<string>): Array\<string>;
## UIAbility.onSaveState
onSaveState(reason: UIAbilityConstant.StateType, wantParam : {[key: string]: any}): UIAbilityConstant.OnSaveResult;
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult;
该API配合[appRecovery](js-apis-app-ability-appRecovery.md)使用。在应用故障时，如果使能了自动保存状态，框架将回调onSaveState保存UIAbility状态。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reason | [UIAbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 |
| reason | [AbilityConstant.StateType](js-apis-app-ability-abilityConstant.md#abilityconstantstatetype) | 是 | 回调保存状态的原因。 |
| wantParam | {[key:&nbsp;string]:&nbsp;any} | 是 | want相关参数。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| UIAbilityConstant.OnSaveResult | 是否同意保存当前UIAbility的状态。 |
| [AbilityConstant.OnSaveResult](js-apis-app-ability-abilityConstant.md#abilityconstantonsaveresult) | 是否同意保存当前UIAbility的状态。 |
**示例：**
```ts
import UIAbilityConstant from '@ohos.app.ability.UIAbilityConstant'
import AbilityConstant from '@ohos.app.ability.AbilityConstant'
class MyUIAbility extends UIAbility {
onSaveState(reason, wantParam) {
console.log('onSaveState');
wantParam["myData"] = "my1234567";
return UIAbilityConstant.OnSaveResult.RECOVERY_AGREE;
return AbilityConstant.OnSaveResult.RECOVERY_AGREE;
}
}
```
......@@ -311,14 +312,14 @@ call(method: string, data: rpc.Sequenceable): Promise&lt;void&gt;;
向通用组件服务端发送约定序列化数据。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
| data | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 是 | 由开发者实现的Sequenceable可序列化数据。 |
**返回值：**
......@@ -391,20 +392,20 @@ callWithResult(method: string, data: rpc.Sequenceable): Promise&lt;rpc.MessagePa
向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| 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形式返回通用组件服务端应答数据。 |
**错误码：**
......@@ -473,7 +474,7 @@ release(): void;
主动释放通用组件服务端的通信接口。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**错误码：**
......@@ -516,13 +517,13 @@ release(): void;
注册通用组件服务端Stub（桩）断开监听通知。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | OnReleaseCallBack | 是 | 返回onRelease回调结果。 |
| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 |
**示例：**
......@@ -558,14 +559,14 @@ release(): void;
注册通用组件服务端Stub（桩）断开监听通知。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听releaseCall事件，固定为'release'。 |
| callback | OnReleaseCallback | 是 | 返回onRelease回调结果。 |
| callback | [OnReleaseCallBack](#onreleasecallback) | 是 | 返回onRelease回调结果。 |
**错误码：**
......@@ -613,14 +614,14 @@ on(method: string, callback: CalleeCallback): void;
通用组件服务端注册消息通知callback。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback | CalleeCallback | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的rpc.Sequenceable数据对象,&nbsp;其他视为函数执行错误。 |
| callback | [CalleeCallback](#calleecallback) | 是 | 一个[rpc.MessageParcel](js-apis-rpc.md#messageparceldeprecated)类型入参的js通知同步回调函数,&nbsp;回调函数至少要返回一个空的[rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated)数据对象,&nbsp;其他视为函数执行错误。 |
**错误码：**
......@@ -679,7 +680,7 @@ off(method: string): void;
解除通用组件服务端注册消息通知callback。
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数：**
......@@ -716,7 +717,7 @@ off(method: string): void;
(msg: string): void;
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
......@@ -726,8 +727,8 @@ off(method: string): void;
(indata: rpc.MessageParcel): rpc.Sequenceable;
**系统能力**：SystemCapability.UIAbility.UIAbilityRuntime.UIAbilityCore
**系统能力**：SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 可读 | 可写 | 类型 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| (indata: rpc.MessageParcel) | 是 | 否 | rpc.Sequenceable | 被调用方注册的消息侦听器函数接口的原型。 |
| (indata: [rpc.MessageParcel](js-apis-rpc.md#messageparceldeprecated)) | 是 | 否 | [rpc.Sequenceable](js-apis-rpc.md#sequenceabledeprecated) | 被调用方注册的消息侦听器函数接口的原型。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
浏览文件 @ 436330dd
......@@ -117,7 +117,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------------- | ---- | ------------- |
| info | WantAgentInfo | 是 | WantAgent信息。 |
| info | [WantAgentInfo](js-apis-inner-wantAgent-wantAgentInfo.md) | 是 | WantAgent信息。 |
**返回值：**
......@@ -632,7 +632,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的回调方法。 |
**错误码：**
|错误码ID |错误信息 |
......@@ -1056,7 +1056,7 @@ trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback\<Co
| ----------- | ----------------------------- | ---- | ------------------------------- |
| agent | WantAgent | 是 | WantAgent对象。 |
| triggerInfo | [TriggerInfo](js-apis-inner-wantAgent-triggerInfo.md) | 是 | TriggerInfo对象。 |
| callback | AsyncCallback\<CompleteData\> | 否 | 主动激发WantAgent实例的回调方法。 |
| callback | AsyncCallback\<[CompleteData](#completedata)\> | 否 | 主动激发WantAgent实例的回调方法。 |
**错误码：**
| 错误码ID | 错误信息 |
......
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @ 436330dd
......@@ -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的启动模式设置为单例时回调会被调用。
启动模式为单例的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
浏览文件 @ 436330dd
......@@ -19,8 +19,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
浏览文件 @ 436330dd
......@@ -108,7 +108,7 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -132,7 +132,7 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -159,7 +159,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -191,7 +191,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 |
| Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 返回执行结果。 |
**示例**：
......@@ -217,7 +217,7 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 |
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | 被指定的回调方法。 |
**示例**：
......@@ -239,7 +239,7 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise\<ElementName>| 返回执行结果。 |
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 返回执行结果。 |
**示例**：
......
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @ 436330dd
......@@ -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
浏览文件 @ 436330dd
......@@ -170,7 +170,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<ProcessRunningInfo>> | 获取有关运行进程的信息。 |
| Promise\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 获取有关运行进程的信息。 |
**示例：**
......@@ -198,7 +198,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<ProcessRunningInfo>> | 是 | 获取有关运行进程的信息。 |
| callback | AsyncCallback\<Array\<[ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)>> | 是 | 获取有关运行进程的信息。 |
**示例：**
......@@ -419,7 +419,7 @@ unregisterApplicationStateObserver(observerId: number): Promise\<void>;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -431,7 +431,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback\<Array\<AppStateData>> | 是 | 表示应用的状态数据。 |
| callback | AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>> | 是 | callback形式返回所有当前处于前台的应用信息。 |
**示例：**
......@@ -450,7 +450,7 @@ getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
getForegroundApplications(): Promise\<Array\<AppStateData>>;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -462,7 +462,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-uiAbilityContext.md
浏览文件 @ 436330dd
......@@ -233,7 +233,7 @@ 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形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -300,7 +300,8 @@ 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形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -372,7 +373,7 @@ 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形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -1264,7 +1265,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
......@@ -1323,7 +1324,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
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或