From cd0d0b5f2969cc5c5e957493266538c30622b73c Mon Sep 17 00:00:00 2001 From: RayShih Date: Fri, 25 Mar 2022 16:17:00 +0800 Subject: [PATCH] update api-references of Ability Signed-off-by: RayShih --- .../apis/js-apis-abilityDelegatorRegistry.md | 20 +++++++------ .../js-apis-application-abilityConstant.md | 4 +-- .../js-apis-application-abilityDelegator.md | 30 +++++++++---------- .../js-apis-application-abilityMonitor.md | 19 ++++++------ .../reference/apis/js-apis-appmanager.md | 6 ++-- 5 files changed, 41 insertions(+), 38 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md index 4be8ef319b..a9ab2b1b84 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityDelegatorRegistry.md @@ -14,15 +14,17 @@ import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry ## AbilityLifecycleState -Ability生命周期状态 +Ability生命周期状态。 -| 名称 | 值 | 说明 | -| ------------- | ---- | ------------------------------------------------------------ | -| UNINITIALIZED | 0 | 表示无效状态。
**系统能力** ：SystemCapability.Ability.AbilityRuntime.Core | -| CREATE | 1 | 表示Ability处于已创建状态。
**系统能力** ：SystemCapability.Ability.AbilityRuntime.Core | -| FOREGROUND | 2 | 表示Ability处于前台状态。
**系统能力** ：SystemCapability.Ability.AbilityRuntime.Core | -| BACKGROUND | 3 | 表示Ability处于后台状态。
**系统能力** ：SystemCapability.Ability.AbilityRuntime.Core | -| DESTROY | 4 | 表示Ability处于已销毁状态。
**系统能力** ：SystemCapability.Ability.AbilityRuntime.Core | +**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + +| 名称 | 值 | 说明 | +| ------------- | ---- | --------------------------- | +| UNINITIALIZED | 0 | 表示无效状态。 | +| CREATE | 1 | 表示Ability处于已创建状态。 | +| FOREGROUND | 2 | 表示Ability处于前台状态。 | +| BACKGROUND | 3 | 表示Ability处于后台状态。 | +| DESTROY | 4 | 表示Ability处于已销毁状态。 | @@ -38,7 +40,7 @@ getAbilityDelegator(): AbilityDelegator | 类型 | 说明 | | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator)对象。可有用来调度测试框架相关功能。 | +| [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator) | [AbilityDelegator](js-apis-application-abilityDelegator.md#AbilityDelegator)对象。可以用来调度测试框架相关功能。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md index 255d0b1762..ba0648207f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -13,7 +13,7 @@ ## 导入模块 - + ```js import AbilityConstant from '@ohos.application.AbilityConstant'; ``` @@ -42,7 +42,7 @@ import AbilityConstant from '@ohos.application.AbilityConstant'; | CONTINUATION | 3 | 继续。 | -## AbilityConstant.LaunchReason +## AbilityConstant.LastExitReason 上次退出原因的类型。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md index 477f8cebab..1050a4e155 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -20,7 +20,7 @@ addAbilityMonitor(monitor: AbilityMonitor, callback: AsyncCallback\): void 添加AbilityMonitor实例（callback形式） -**系统能力：**SystemCapability.Ability.AbilityRuntime.Core +**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **参数：** @@ -222,7 +222,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout: number, callback: AsyncCall | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | -| timeout | number | 是 | 最大等待时间，单位毫秒 | +| timeout | number | 是 | 最大等待时间，单位毫秒（ms） | | callback | AsyncCallback\<[Ability](js-apis-application-ability.md#Ability)> | 是 | 表示指定的回调方法 | **示例：** @@ -252,7 +252,7 @@ abilityDelegator.waitAbilityMonitor(monitor, timeout, (err, data) => { waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\ -等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（promise形式） +设置等待时间，等待与AbilityMonitor实例匹配的ability到达OnCreate生命周期，并返回ability实例（promise形式） **系统能力：** SystemCapability.Ability.AbilityRuntime.Core @@ -261,7 +261,7 @@ waitAbilityMonitor(monitor: AbilityMonitor, timeout?: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | monitor | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor) | 是 | [AbilityMonitor](js-apis-application-abilityMonitor.md#AbilityMonitor)实例 | -| timeout | number | 否 | 最大等待时间，单位毫秒 | +| timeout | number | 否 | 最大等待时间，单位毫秒（ms） | **返回值：** @@ -718,17 +718,17 @@ abilityDelegator.executeShellCommand(cmd, (err, data) => { executeShellCommand(cmd: string, timeoutSecs: number, callback: AsyncCallback\): void -执行指定的shell命令（callback形式） +指定超时时间，并执行指定的shell命令（callback形式） **系统能力：** SystemCapability.Ability.AbilityRuntime.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------------------------------------------------------------ | ---- | ------------------ | -| cmd | string | 是 | shell命令字符串 | -| timeoutSecs | number | 是 | 设定时间，单位秒 | -| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------------------------------------------------------------ | ---- | ----------------------------- | +| cmd | string | 是 | shell命令字符串 | +| timeoutSecs | number | 是 | 设定命令超时时间，单位秒（s） | +| callback | AsyncCallback\<[ShellCmdResult](js-apis-application-shellCmdResult.md#ShellCmdResult)> | 是 | 表示指定的回调方法 | **示例：** @@ -749,16 +749,16 @@ abilityDelegator.executeShellCommand(cmd, timeout, (err, data) => { executeShellCommand(cmd: string, timeoutSecs: number): Promise\ -执行指定的shell命令（promise形式） +指定超时时间，并执行指定的shell命令（promise形式） **系统能力：** SystemCapability.Ability.AbilityRuntime.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | ------ | ---- | ---------------- | -| cmd | string | 是 | shell命令字符串 | -| timeoutSecs | number | 否 | 设定时间，单位秒 | +| 参数名 | 类型 | 必填 | 说明 | +| ----------- | ------ | ---- | ----------------------------- | +| cmd | string | 是 | shell命令字符串 | +| timeoutSecs | number | 否 | 设定命令超时时间，单位秒（s） | **返回值：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md index 9b55fec58e..9557e0367f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-abilityMonitor.md @@ -16,15 +16,16 @@ import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry Ability监听器 +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core + | 名称 | 类型 | 可读 | 可写 | 说明 | | -------------------- | -------- | ---- | ---- | ------------------------------------------------------------ | -| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onAbilityCreate | function | 是 | 是 | ability被启动初始化时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onAbilityForeground | function | 是 | 是 | ability状态变成前台时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onAbilityBackground | function | 是 | 是 | ability状态变成后台时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onAbilityDestroy | function | 是 | 是 | ability被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onWindowStageCreate | function | 是 | 是 | window stage被创建时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onWindowStageRestore | function | 是 | 是 | window stage被重载时的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | -| onWindowStageDestroy | function | 是 | 是 | window stage被销毁前的回调函数
不设置该属性则不能收到该生命周期回调
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core | - +| abilityName | string | 是 | 是 | 当前AbilityMonitor绑定的ability名称。 | +| onAbilityCreate | function | 是 | 是 | ability被启动初始化时的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onAbilityForeground | function | 是 | 是 | ability状态变成前台时的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onAbilityBackground | function | 是 | 是 | ability状态变成后台时的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onAbilityDestroy | function | 是 | 是 | ability被销毁前的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onWindowStageCreate | function | 是 | 是 | window stage被创建时的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onWindowStageRestore | function | 是 | 是 | window stage被重载时的回调函数。
不设置该属性则不能收到该生命周期回调。 | +| onWindowStageDestroy | function | 是 | 是 | window stage被销毁前的回调函数。
不设置该属性则不能收到该生命周期回调。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md index 86c762a4e1..d0735c8324 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-appmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-appmanager.md @@ -9,7 +9,7 @@ App管理。 ## 导入模块 - + ```js import app from '@ohos.application.appManager'; ``` @@ -69,7 +69,7 @@ static isRunningInStabilityTest(): Promise<boolean> isRamConstrainedDevice(): Promise\; -它是ram受限设备吗。 +查询是否为ram受限设备。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core @@ -93,7 +93,7 @@ isRamConstrainedDevice(): Promise\; isRamConstrainedDevice(callback: AsyncCallback\): void; -它是ram受限设备吗。 +查询是否为ram受限设备。 **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -- GitLab