Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 0b983fde 编写于 作者: D donglin
浏览文件
操作

Merge branch 'master' of gitee.com:openharmony/docs into master 

Signed-off-by: Ndonglin <donglin9@huawei.com>
Change-Id: I13afc47e656add798e7c754f86123b925374cd27
上级 8284f25e aff5925e
展开全部 隐藏空白更改
内联 并排
Showing with 406 addition and 261 deletion
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @ 0b983fde
......@@ -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&lt;void&gt;;
startAbilityForResult(want: Want, callback: AsyncCallback&lt;AbilityResult&gt;): void;
启动Ability并在该Ability退出的时候返回执行结果（callback形式）。
启动一个Ability。Ability被启动后，正常情况下可通过调用[terminateSelfWithResult](#abilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者（callback形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -248,7 +248,7 @@ 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形式）。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
......@@ -303,7 +303,7 @@ 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形式）。
**系统能力**：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结果。 |
**错误码：**
......@@ -1058,7 +1058,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
......@@ -1114,6 +1114,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
......@@ -1709,7 +1710,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> | 是 | 指定的回调函数的结果。 |
**示例：**
......@@ -1751,7 +1752,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
浏览文件 @ 0b983fde
# @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
浏览文件 @ 0b983fde
# @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
浏览文件 @ 0b983fde
# @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
浏览文件 @ 0b983fde
......@@ -15,6 +15,10 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
## 属性
## AbilityConstant.LaunchParam
启动参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md
浏览文件 @ 0b983fde
......@@ -29,7 +29,7 @@ Ability生命周期状态，该类型为枚举，可配合[AbilityDelegator](js-
## AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): [AbilityDelegator](js-apis-inner-application-abilityDelegator.md)
getAbilityDelegator(): AbilityDelegator
获取应用程序的[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)对象，该对象能够使用调度测试框架的相关功能。
......@@ -64,7 +64,7 @@ abilityDelegator.startAbility(want, (err)=>{
## AbilityDelegatorRegistry.getArguments
getArguments(): [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)
getArguments(): AbilityDelegatorArgs
获取单元测试参数[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md
浏览文件 @ 0b983fde
......@@ -17,7 +17,7 @@ import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback
## AbilityLifecycleCallback.onAbilityCreate
onAbilityCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
onAbilityCreate(ability: UIAbility): void;
注册监听应用上下文的生命周期后，在ability创建时触发回调。
......@@ -32,7 +32,7 @@ onAbilityCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
## AbilityLifecycleCallback.onWindowStageCreate
onWindowStageCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void;
注册监听应用上下文的生命周期后，在windowStage创建时触发回调。
......@@ -48,7 +48,7 @@ onWindowStageCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md), wind
## AbilityLifecycleCallback.onWindowStageActive
onWindowStageActive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void;
注册监听应用上下文的生命周期后，在windowStage获焦时触发回调。
......@@ -64,7 +64,7 @@ onWindowStageActive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), wind
## AbilityLifecycleCallback.onWindowStageInactive
onWindowStageInactive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void;
注册监听应用上下文的生命周期后，在windowStage失焦时触发回调。
......@@ -80,7 +80,7 @@ onWindowStageInactive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), wi
## AbilityLifecycleCallback.onWindowStageDestroy
onWindowStageDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void;
注册监听应用上下文的生命周期后，在windowStage销毁时触发回调。
......@@ -96,7 +96,7 @@ onWindowStageDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md), win
## AbilityLifecycleCallback.onAbilityDestroy
onAbilityDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
onAbilityDestroy(ability: UIAbility): void;
注册监听应用上下文的生命周期后，在ability销毁时触发回调。
......@@ -111,7 +111,7 @@ onAbilityDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
## AbilityLifecycleCallback.onAbilityForeground
onAbilityForeground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
onAbilityForeground(ability: UIAbility): void;
注册监听应用上下文的生命周期后，在ability的状态从后台转到前台时触发回调。
......@@ -126,7 +126,7 @@ onAbilityForeground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): voi
## AbilityLifecycleCallback.onAbilityBackground
onAbilityBackground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
onAbilityBackground(ability: UIAbility): void;
注册监听应用上下文的生命周期后，在ability的状态从前台转到后台时触发回调。
......@@ -141,7 +141,7 @@ onAbilityBackground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): voi
## AbilityLifecycleCallback.onAbilityContinue
onAbilityContinue(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
onAbilityContinue(ability: UIAbility): void;
注册监听应用上下文的生命周期后，在ability迁移时触发回调。
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @ 0b983fde
......@@ -31,7 +31,7 @@ Ability的状态，该类型为枚举，可配合[AbilityRunningInfo](js-apis-in
## updateConfiguration
updateConfiguration(config: [Configuration](js-apis-app-ability-configuration.md), callback: AsyncCallback\<void>): void
updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
通过传入修改的配置项来更新配置（callback形式）。
......@@ -74,7 +74,7 @@ try {
## updateConfiguration
updateConfiguration(config: [Configuration](js-apis-app-ability-configuration.md)): Promise\<void>
updateConfiguration(config: Configuration): Promise\<void>
通过修改配置来更新配置（Promise形式）。
......@@ -120,7 +120,7 @@ try {
## getAbilityRunningInfos
getAbilityRunningInfos(callback: AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>): void
getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
获取Ability运行相关信息（callback形式）。
......@@ -153,7 +153,7 @@ try {
## getAbilityRunningInfos
getAbilityRunningInfos(): Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>
getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
获取Ability运行相关信息（Promise形式）。
......@@ -184,7 +184,7 @@ try {
## getExtensionRunningInfos
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>>): void
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void
获取关于运行扩展能力的信息（callback形式）。
......@@ -220,7 +220,7 @@ try {
## getExtensionRunningInfos
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>>
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>>
获取关于运行扩展能力的信息（Promise形式）。
......@@ -259,7 +259,7 @@ try {
## getTopAbility<sup>9+</sup>
getTopAbility(callback: AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)>): void;
getTopAbility(callback: AsyncCallback\<ElementName>): void;
获取窗口焦点的ability接口（callback形式）。
......@@ -285,7 +285,7 @@ abilityManager.getTopAbility((err,data) => {
## getTopAbility
getTopAbility(): Promise\<[ElementName](js-apis-bundleManager-elementName.md)>;
getTopAbility(): Promise\<ElementName>;
获取窗口焦点的ability接口（Promise形式）。
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md
浏览文件 @ 0b983fde
......@@ -36,7 +36,7 @@ class MyAbilityStage extends AbilityStage {
## AbilityStage.onAcceptWant
onAcceptWant(want: [Want](js-apis-app-ability-want.md)): string;
onAcceptWant(want: Want): string;
启动一个specified ability时触发的事件。
......@@ -68,7 +68,7 @@ class MyAbilityStage extends AbilityStage {
## AbilityStage.onConfigurationUpdate
onConfigurationUpdate(newConfig: [Configuration](js-apis-app-ability-configuration.md)): void;
onConfigurationUpdate(newConfig: Configuration): void;
环境变化通知接口，发生全局配置变更时回调。
......@@ -92,7 +92,7 @@ class MyAbilityStage extends AbilityStage {
## AbilityStage.onMemoryLevel
onMemoryLevel(level: [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel)): void;
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。
......@@ -116,7 +116,7 @@ class MyAbilityStage extends AbilityStage {
## AbilityStage.context
context: [AbilityStageContext](js-apis-inner-application-abilityStageContext.md);
context: AbilityStageContext;
指示AbilityStage的上下文。
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @ 0b983fde
......@@ -166,7 +166,7 @@ appManager.getAppMemorySize((err, data) => {
## appManager.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(): Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>>;
getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
获取有关运行进程的信息。
......@@ -194,7 +194,7 @@ appManager.getProcessRunningInformation().then((data) => {
## appManager.getProcessRunningInformation<sup>9+</sup>
getProcessRunningInformation(callback: AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>>): void;
getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void;
获取有关运行进程的信息。
......@@ -224,7 +224,7 @@ appManager.getProcessRunningInformation((err, data) => {
## appManager.on
on(type: "applicationState", observer: [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md)): number;
on(type: "applicationState", observer: ApplicationStateObserver): number;
注册全部应用程序的状态观测器。
......@@ -277,7 +277,7 @@ try {
## appManager.on
on(type: "applicationState", observer: [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md), bundleNameList: Array\<string>): number;
on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: Array\<string>): number;
注册指定应用程序的状态观测器。
......@@ -412,9 +412,9 @@ try {
## appManager.getForegroundApplications
getForegroundApplications(callback: AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>>): void;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -447,9 +447,9 @@ try {
## appManager.getForegroundApplications
getForegroundApplications(callback: AsyncCallback\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>>): void;
getForegroundApplications(callback: AsyncCallback\<Array\<AppStateData>>): void;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......@@ -482,9 +482,9 @@ try {
## appManager.getForegroundApplications
getForegroundApplications(): Promise\<Array\<[AppStateData](js-apis-inner-application-appStateData.md)>>;
getForegroundApplications(): Promise\<Array\<AppStateData>>;
获取前台进程的应用程序。
获取所有当前处于前台的应用信息。该应用信息由[AppStateData](js-apis-inner-application-appStateData.md)定义。
**需要权限**：ohos.permission.GET_RUNNING_INFO
......
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
# 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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
浏览文件 @ 0b983fde
......@@ -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,8 +419,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
......@@ -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
浏览文件 @ 0b983fde
......@@ -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
......
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @ 0b983fde
......@@ -266,7 +266,7 @@ try {
## screenlock.sendScreenLockEvent<sup>9+</sup>
sendScreenLockEvent(event: String, parameter: number, callback: AsyncCallback&lt;boolean&gt;): void
sendScreenLockEvent(event: string, parameter: number, callback: AsyncCallback&lt;boolean&gt;): void
应用发送事件到锁屏服务。使用callback异步回调。
......@@ -278,7 +278,7 @@ sendScreenLockEvent(event: String, parameter: number, callback: AsyncCallback&lt
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------ | ---- | -------------------- |
| event | String | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "lockScreenResult"，表示锁屏结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
| event | string | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "lockScreenResult"，表示锁屏结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
| parameter | number | 是 | 事件结果。<br/>- parameter为0，表示成功。例如解锁成功或锁屏成功。<br/>- parameter为1，表示失败。例如解锁失败或锁屏失败。<br/>- parameter为2，表示取消。例如锁屏取消或解锁取消。 |
| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示发送事件成功；返回false表示发送事件失败。 |
......@@ -304,7 +304,7 @@ screenlock.sendScreenLockEvent('unlockScreenResult', 0, (err, result) => {
## screenlock.sendScreenLockEvent<sup>9+</sup>
sendScreenLockEvent(event: String, parameter: number): Promise&lt;boolean&gt;
sendScreenLockEvent(event: string, parameter: number): Promise&lt;boolean&gt;
应用发送事件到锁屏服务。使用Promise异步回调。
......@@ -316,7 +316,7 @@ sendScreenLockEvent(event: String, parameter: number): Promise&lt;boolean&gt;
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | --------------------------------------- |
| event | String | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "lockScreenResult"，表示锁屏结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
| event | string | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "lockScreenResult"，表示锁屏结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
| parameter | number | 是 | 事件结果。<br/>- parameter为0，表示成功。例如解锁成功或锁屏成功。<br/>- parameter为1，表示失败。例如解锁失败或锁屏失败。<br/>- parameter为2，表示取消。例如锁屏取消或解锁取消。 |
**返回值：**
......
zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.1/changelogs-ability.md
浏览文件 @ 0b983fde
......@@ -44,4 +44,97 @@ onWindowStageCreate() {
console.error('Failed to start ability', err.code);
})
}
```
\ No newline at end of file
```
## cl.ability.2 删除标记为废弃的API9接口
[元能力异常处理整改](../OpenHarmony_3.2.8.3/changelogs-ability.md)将部分API9接口标记为了废弃，根据OpenHarmony接口规范，需要删除标记为废弃的API9接口。
**变更影响**
基于此前版本开发的应用，需要将被删除的接口替换为新接口，否则会影响应用编译。
**关键接口/组件变更**
接口文件被删除：
| 被删除接口 | 新接口 |
| ----------------------------------------------- | ----------------------------------------------- |
| @ohos.application.Ability.d.ts | @ohos.app.ability.UIAbility.d.ts |
| @ohos.application.AbilityConstant.d.ts | @ohos.app.ability.AbilityConstant.d.ts |
| @ohos.application.AbilityLifecycleCallback.d.ts | @ohos.app.ability.AbilityLifecycleCallback.d.ts |
| @ohos.application.AbilityStage.d.ts | @ohos.app.ability.AbilityStage.d.ts |
| @ohos.application.EnvironmentCallback.d.ts | @ohos.app.ability.EnvironmentCallback.d.ts |
| @ohos.application.ExtensionAbility.d.ts | @ohos.app.ability.ExtensionAbility.d.ts |
| @ohos.application.FormExtension.d.ts | @ohos.app.form.FormExtensionAbility.d.ts |
| @ohos.application.ServiceExtensionAbility.d.ts | @ohos.app.ability.ServiceExtensionAbility.d.ts |
| @ohos.application.StartOptions.d.ts | @ohos.app.ability.StartOptions.d.ts |
| @ohos.application.context.d.ts | @ohos.app.ability.common.d.ts |
| @ohos.application.errorManager.d.ts | @ohos.app.ability.errorManager.d.ts |
接口、属性被删除：
- @ohos.application.Configuration.d.ts
- Configuration 的 direction、screenDensity、displayId、hasPointerDevice 被删除。可以使用 @ohos.app.ability.Configuration.d.ts 的 Configuration替换。
- @ohos.application.ConfigurationConstant.d.ts
- 枚举 Direction 和 ScreenDensity 被删除。可以使用 @ohos.app.ability.ConfigurationConstant.d.ts 的枚举 Direction 和 ScreenDensity 替换。
- @ohos.application.abilityManager.d.ts
- 方法 getExtensionRunningInfos 和 getTopAbility 被删除。可以使用 @ohos.app.ability.abilityManager.d.ts 的同名方法替换。
- @ohos.application.appManager.d.ts
- 枚举 ApplicationState 和 ProcessState 被删除。可以使用 @ohos.app.ability.appManager.d.ts 的枚举 ApplicationState 和 ProcessState 替换。
- 方法 registerApplicationStateObserver 和 getProcessRunningInformation被删除。可以使用 @ohos.app.ability.appManager.d.ts 的同名方法替换。
- @ohos.application.formHost.d.ts
- 方法 shareForm 和 notifyFormsPrivacyProtected 被删除。可以使用 @ohos.app.form.formHost.d.ts 的同名方法替换。
- @ohos.application.formInfo.d.ts
- 枚举 FormType 的 eTS 被删除，可以使用 @ohos.app.form.formInfo.d.ts 的 FormType 中的 eTS 替换。
- 枚举 FormParam 的 IDENTITY_KEY、BUNDLE_NAME_KEY、ABILITY_NAME_KEY、DEVICE_ID_KEY 被删除，可以使用 @ohos.app.form.formInfo.d.ts 的 FormParam 中的同名枚举替换。
- 接口 FormInfoFilter 被删除。可以使用 @ohos.app.form.formInfo.d.ts 的 FormInfoFilter 替换。
- 枚举 FormDimension 被删除。可以使用 @ohos.app.form.formInfo.d.ts 的 FormDimension 替换。
- 枚举 VisibilityType 被删除。可以使用 @ohos.app.form.formInfo.d.ts 的 VisibilityType 替换。
- @ohos.wantAgent.d.ts
- 方法 trigger 和 getOperationType 被删除。可以使用 @ohos.app.ability.wantAgent.d.ts 的同名方法替换。
- application/ApplicationContext.d.ts
- 方法 registerAbilityLifecycleCallback、unregisterAbilityLifecycleCallback、registerEnvironmentCallback、unregisterEnvironmentCallback 被删除。可以使用 on、off 替换。
- application/ServiceExtensionContext.d.ts
- 方法 connectAbility、connectAbilityWithAccount、disconnectAbility 被删除。可以使用 connectServiceExtensionAbility、connectServiceExtensionAbilityWithAccount、disconnectServiceExtensionAbility 替换。
- @ohos.application.ExtensionAbility.d.ts
- 生命周期onCreate、onCastToNormal、onUpdate、onVisibilityChange、onEvent、onDestroy、onAcquireFormState、onShare 被删除。可以使用@ohos.app.form.FormExtensionAbility.d.ts的onAddForm、onCastToNormalForm、onUpdateForm、onChangeFormVisibility、onFormEvent、onRemoveForm、onAcquireFormState、onShareForm
- @ohos.application.abilityDelegatorRegistry.d.ts
- 导出类 AbilityDelegator、AbilityDelegatorArgs、AbilityMonitor、ShellCmdResult 被删除。可以使用@ohos.app.ability.abilityDelegatorRegistry.d.ts中的同名导出类替换。
- @ohos.application.abilityManager.d.ts
- 导出类 AbilityRunningInfo、ExtensionRunningInfo 被删除。可以使用@ohos.app.ability.abilityManager.d.ts中的同名导出类替换。
- @ohos.application.appManager.d.ts
- 导出类 AbilityStateData、AppStateData、ApplicationStateObserver、ProcessRunningInfo、ProcessRunningInformation 被删除。可以使用@ohos.app.ability.appManager.d.ts中的同名导出类替换。
- @ohos.application.missionManager.d.ts
- 导出类 MissionInfo、MissionListener、MissionSnapshot 被删除。可以使用@ohos.app.ability.missionManager.d.ts中的同名导出类替换。
- @ohos.wantAgent.d.ts
- 导出类 TriggerInfo、WantAgentInfo 被删除。可以使用@ohos.app.ability.wantAgent.d.ts中的同名导出类替换。
**适配指导**
如上所述，仅少数接口修改了接口名的如注册回调函数（registerAbilityLifecycleCallback、unregisterAbilityLifecycleCallback、registerEnvironmentCallback、unregisterEnvironmentCallback）和连接断开 ServiceExtensionAbility（connectAbility、connectAbilityWithAccount、disconnectAbility），卡片生命周期等需要替换成新的接口名。
绝大多数接口平移到了新的namespace中，所以可以通过修改import来解决适配问题：
如原先接口使用了@ohos.application.Ability
```js
import Ability from '@ohos.application.Ability';
```
可以通过直接修改import，来切换到新的namespace上：
```js
import Ability from '@ohos.app.ability.UIAbility';
```
此外还需要适配异常处理，具体参考新接口的接口文档。
zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.1/changelogs-notification.md 0 → 100644
浏览文件 @ 0b983fde
# 事件通知子系统ChangeLog
## cl.notification.1 删除标记为废弃的API9接口
[事件通知异常处理整改](../OpenHarmony_3.2.8.3/changelogs-notification.md)将部分API9接口标记为了废弃，根据OpenHarmony接口规范，需要删除标记为废弃的API9接口。
**变更影响**
基于此前版本开发的应用，需要将被删除的接口替换为新接口，否则会影响应用编译。
**关键接口/组件变更**
原接口中标记为废弃的API9接口将被删除，可以使用新接口中的同名接口替换。
| 原接口 | 新接口 |
| ----------------------- | -------------------------------- |
| @ohos.commonEvent.d.ts | @ohos.commonEventManager.d.ts |
| @ohos.notification.d.ts | @ohos.notificationManager.d.ts |
| @ohos.notification.d.ts | @ohos.notificationSubscribe.d.ts |
接口、属性被删除：
- @ohos.notification.d.ts
- 接口 publishAsBundle、cancelAsBundle、isNotificationSlotEnabled、setSyncNotificationEnabledWithoutApp、getSyncNotificationEnabledWithoutApp 被删除。可以使用 api/@ohos.notificationManager.d.ts 的同名接口替换。
- 接口 enableNotificationSlot 被删除。可以使用 api/@ohos.notificationManager.d.ts 的接口 setNotificationEnableSlot 替换。
- 导出类 NotificationActionButton、NotificationBasicContent、NotificationContent、NotificationLongTextContent、NotificationMultiLineContent、NotificationPictureContent、NotificationFlags、NotificationFlagStatus、NotificationRequest、DistributedOptions、NotificationSlot、NotificationSorting、NotificationTemplate、NotificationUserInput 被删除。可以使用 api/@ohos.notificationManager.d.ts 的同名导出类替换。
- 导出类 NotificationSubscribeInfo、NotificationSubscriber、SubscribeCallbackData、EnabledNotificationCallbackData 被删除。可以使用 api/@ohos.notificationSubscribe.d.ts 的同名导出类替换。
**适配指导**
如上所述，仅将老接口平移到了新的namespace中，所以可以通过修改import来解决适配问题：
如原先接口使用了@ohos.commonEvent
```js
import commonEvent from '@ohos.commonEvent';
```
可以通过直接修改import，来切换到新的namespace上：
```js
import commonEvent from '@ohos.commonEventManager';
```
@ohos.notification拆分成了两个namespace，需要根据接口情况选择需要的新namespace进行适配。
此外还需要适配异常处理，具体参考新接口的接口文档。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或