Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

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

提交 e2765fed 编写于 作者: D donglin 提交者： MacroYuan
浏览文件
操作

doc optimize 

Signed-off-by: Ndonglin <donglin9@huawei.com>
Change-Id: I29a634d8b0b31ede41d853660f31c84dbd9bc5ef
上级 28f2d6d5
展开全部 隐藏空白更改
内联 并排
Showing with 610 addition and 487 deletion
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @ e2765fed
...@@ -19,40 +19,66 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ...@@ -19,40 +19,66 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| launchReason | LaunchReason| 是 | 是 | 指示启动原因。 | | launchReason | [LaunchReason](#abilityconstantlaunchreason)| 是 | 是 | 枚举类型，表示启动原因。 |
| lastExitReason | LastExitReason | 是 | 是 | 表示最后退出原因。 | | lastExitReason | [LastExitReason](#abilityconstantlastexitreason) | 是 | 是 | 枚举类型，表示最后退出原因。 |
## AbilityConstant.LaunchReason ## AbilityConstant.LaunchReason
初次启动原因。 Ability初次启动原因，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onCreate(want, launchParam)](js-apis-app-ability-uiAbility.md#uiabilityoncreate)方法根据launchParam.launchReason的不同类型执行相应操作。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 | | UNKNOWN | 0 | 未知原因。 |
| START_ABILITY | 1 | 启动能力。 | | START_ABILITY | 1 | 通过[startAbility](js-apis-ability-context.md#abilitycontextstartability)接口启动ability。 |
| CALL | 2 | 呼叫。 | | CALL | 2 | 通过[startAbilityByCall](js-apis-ability-context.md#abilitycontextstartabilitybycall)接口启动ability。 |
| CONTINUATION | 3 | 继续。 | | CONTINUATION | 3 | 跨端设备迁移启动ability。 |
| APP_RECOVERY | 4 | 状态恢复。 | | APP_RECOVERY | 4 | 设置应用恢复后，应用故障时自动恢复启动ability。 |
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onCreate(want, launchParam) {
if (launcherParam.launchReason == AbilityConstant.LaunchReason.START_ABILITY) {
console.log("The ability has been started by the way of startAbility.");
}
}
}
```
## AbilityConstant.LastExitReason ## AbilityConstant.LastExitReason
上次退出原因。 Ability上次退出原因，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onCreate(want, launchParam)](js-apis-app-ability-uiAbility.md#uiabilityoncreate)方法根据launchParam.lastExitReason的不同类型执行相应操作。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ----------------------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知的状态。 | | UNKNOWN | 0 | 未知原因。 |
| ABILITY_NOT_RESPONDING | 1 | 能力没有反应 | | ABILITY_NOT_RESPONDING | 1 | ability未响应。 |
| NORMAL | 2 | 正常的状态。 | | NORMAL | 2 | 正常退出。 |
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onCreate(want, launchParam) {
if (launcherParam.lastExitReason == AbilityConstant.LastExitReason.ABILITY_NOT_RESPONDING) {
console.log("The ability has exit last because the ability was not responding.");
}
}
}
```
## AbilityConstant.OnContinueResult ## AbilityConstant.OnContinueResult
迁移结果。 Ability迁移结果，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onContinue(wantParam)](js-apis-app-ability-uiAbility.md#uiabilityoncontinue)方法进完成相应的返回。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -62,9 +88,21 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ...@@ -62,9 +88,21 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
| REJECT | 1 | 拒绝。 | | REJECT | 1 | 拒绝。 |
| MISMATCH | 2 | 不匹配。| | MISMATCH | 2 | 不匹配。|
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onContinue(wantParam) {
return AbilityConstant.OnConinueResult.AGREE;
}
}
```
## AbilityConstant.WindowMode ## AbilityConstant.WindowMode
启动Ability时的窗口模式。 启动Ability时的窗口模式，该类型为枚举，可配合startAbility使用指定启动Ability的窗口模式。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -76,36 +114,81 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ...@@ -76,36 +114,81 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏多窗口次要模式。 | | WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏多窗口次要模式。 |
| WINDOW_MODE_FLOATING | 102 | 自由悬浮形式窗口模式。 | | WINDOW_MODE_FLOATING | 102 | 自由悬浮形式窗口模式。 |
**示例：**
```ts
let want = {
bundleName: "com.test.example",
abilityName: "MainAbility"
};
let option = {
windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FULLSCREEN
};
// 确保从上下文获取到context
this.context.startAbility(want, option).then(()={
console.log("Succeed to start ability.");
}).catch((error)=>{
console.log("Failed to start ability with error: " + JSON.stringify(error));
});
```
## AbilityConstant.MemoryLevel ## AbilityConstant.MemoryLevel
内存级别。 内存级别，该类型为枚举，可配合[Ability](js-apis-app-ability-ability.md)的[onMemoryLevel(level)](js-apis-app-ability-ability.md#abilityonmemorylevel)方法根据level执行不同内存级别的相应操作。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| --- | --- | --- | | --- | --- | --- |
| MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 | | MEMORY_LEVEL_MODERATE | 0 | 内存占用适中。 |
| MEMORY_LEVEL_LOW | 1 | 内存占用低。 | | MEMORY_LEVEL_LOW | 1 | 内存占用低。 |
| MEMORY_LEVEL_CRITICAL | 2 | 内存占用高。 | | MEMORY_LEVEL_CRITICAL | 2 | 内存占用高。 |
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onMemoryLevel(level) {
if (level == AbilityConstant.MemoryLevel.MEMORY_LEVEL_CRITICAL) {
console.log("The memory of device is critical, please release some memory.");
}
}
}
```
## AbilityConstant.OnSaveResult ## AbilityConstant.OnSaveResult
保存应用数据的结果。 保存应用数据的结果，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onSaveState(reason, wantParam)](js-apis-app-ability-uiAbility.md#uiabilityonsavestate)方法完成相应的返回。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ | | ----------------------------- | ---- | ------------------------------------------------------------ |
| ALL_AGREE | 0 | 同意保存状态。 | | ALL_AGREE | 0 | 总是同意保存状态。 |
| CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 | | CONTINUATION_REJECT | 1 | 拒绝迁移保存状态。 |
| CONTINUATION_MISMATCH | 2 | 迁移不匹配。| | CONTINUATION_MISMATCH | 2 | 迁移不匹配。|
| RECOVERY_AGREE | 3 | 同意恢复保存状态。 | | RECOVERY_AGREE | 3 | 同意恢复保存状态。 |
| RECOVERY_REJECT | 4 | 拒绝恢复保存状态。| | RECOVERY_REJECT | 4 | 拒绝恢复保存状态。|
| ALL_REJECT | 5 | 拒绝保存状态。| | ALL_REJECT | 5 | 总是拒绝保存状态。|
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onSaveState(reason, wantParam) {
return AbilityConstant.OnSaveResult.ALL_AGREE;
}
}
```
## AbilityConstant.StateType ## AbilityConstant.StateType
保存应用数据场景原因。 保存应用数据场景原因，该类型为枚举，可配合[Ability](js-apis-app-ability-uiAbility.md)的[onSaveState(reason, wantParam)](js-apis-app-ability-uiAbility.md#uiabilityonsavestate)方法根据reason的不同类型执行相应操作。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -113,3 +196,18 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant'; ...@@ -113,3 +196,18 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
| ----------------------------- | ---- | ------------------------------------------------------------ | | ----------------------------- | ---- | ------------------------------------------------------------ |
| CONTINUATION | 0 | 迁移保存状态。 | | CONTINUATION | 0 | 迁移保存状态。 |
| APP_RECOVERY | 1 | 应用恢复保存状态。 | | APP_RECOVERY | 1 | 应用恢复保存状态。 |
**示例：**
```ts
import UIAbility form '@ohos.app.ability.UIAbility';
class MyAbility extends UIAbility {
onSaveState(reason, wantParam) {
if (reason == AbilityConstant.StateType.CONTINUATION) {
console.log("Save the ability data when the ability continuation.");
}
return AbilityConstant.OnSaveResult.ALL_AGREE;
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityDelegatorRegistry.md
浏览文件 @ e2765fed
# @ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry) # @ohos.app.ability.abilityDelegatorRegistry (AbilityDelegatorRegistry)
AbilityDelegatorRegistry模块提供用于存储已注册的AbilityDelegator和AbilityDelegatorArgs对象的全局寄存器的能力，包括获取应用程序的AbilityDelegator对象、获取单元测试参数AbilityDelegatorArgs对象。 AbilityDelegatorRegistry是[测试框架](../../ability-deprecated/ability-delegator.md)模块，该模块用于获取[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)和[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象，其中[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)对象提供添加用于监视指定ability的生命周期状态更改的AbilityMonitor对象的能力，[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象提供获取当前测试参数的能力。
> **说明：** > **说明：**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口仅可在测试框架中使用。
## 导入模块 ## 导入模块
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry' import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
``` ```
## AbilityLifecycleState ## AbilityLifecycleState
Ability生命周期状态。 Ability生命周期状态，该类型为枚举，可配合[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)的[getAbilityState(ability)](js-apis-inner-application-abilityDelegator.md#getabilitystate9)方法返回不同ability生命周期。
**系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力** ：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | ---- | --------------------------- | | ------------- | ---- | --------------------------- |
| UNINITIALIZED | 0 | 表示无效状态。 | | UNINITIALIZED | 0 | 表示Ability处于无效状态。 |
| CREATE | 1 | 表示Ability处于已创建状态。 | | CREATE | 1 | 表示Ability处于已创建状态。 |
| FOREGROUND | 2 | 表示Ability处于前台状态。 | | FOREGROUND | 2 | 表示Ability处于前台状态。 |
| BACKGROUND | 3 | 表示Ability处于后台状态。 | | BACKGROUND | 3 | 表示Ability处于后台状态。 |
...@@ -28,9 +29,9 @@ Ability生命周期状态。 ...@@ -28,9 +29,9 @@ Ability生命周期状态。
## AbilityDelegatorRegistry.getAbilityDelegator ## AbilityDelegatorRegistry.getAbilityDelegator
getAbilityDelegator(): AbilityDelegator getAbilityDelegator(): [AbilityDelegator](js-apis-inner-application-abilityDelegator.md)
获取应用程序的AbilityDelegator对象 获取应用程序的[AbilityDelegator](js-apis-inner-application-abilityDelegator.md)对象，该对象能够使用调度测试框架的相关功能。
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
...@@ -43,15 +44,29 @@ getAbilityDelegator(): AbilityDelegator ...@@ -43,15 +44,29 @@ getAbilityDelegator(): AbilityDelegator
**示例：** **示例：**
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
var abilityDelegator; var abilityDelegator;
abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator();
let want = {
bundleName: "com.ohos.example",
abilityName: "MainAbility"
}
abilityDelegator.startAbility(want, (err)=>{
if (err.code != 0) {
console.log("Success start ability.");
} else {
console.log("Failed start ability, error: " + JSON.stringify(err));
}
})
``` ```
## AbilityDelegatorRegistry.getArguments ## AbilityDelegatorRegistry.getArguments
getArguments(): AbilityDelegatorArgs getArguments(): [AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)
获取单元测试参数AbilityDelegatorArgs对象 获取单元测试参数[AbilityDelegatorArgs](js-apis-inner-application-abilityDelegatorArgs.md)对象。
**系统能力：** SystemCapability.Ability.AbilityRuntime.Core **系统能力：** SystemCapability.Ability.AbilityRuntime.Core
...@@ -64,8 +79,11 @@ getArguments(): AbilityDelegatorArgs ...@@ -64,8 +79,11 @@ getArguments(): AbilityDelegatorArgs
**示例：** **示例：**
```ts ```ts
import AbilityDelegatorRegistry from '@ohos.app.ability.abilityDelegatorRegistry';
var args = AbilityDelegatorRegistry.getArguments(); var args = AbilityDelegatorRegistry.getArguments();
console.info("getArguments bundleName:" + args.bundleName); console.info("getArguments bundleName:" + args.bundleName);
console.info("getArguments parameters:" + JSON.stringify(args.parameters));
console.info("getArguments testCaseNames:" + args.testCaseNames); console.info("getArguments testCaseNames:" + args.testCaseNames);
console.info("getArguments testRunnerClassName:" + args.testRunnerClassName); console.info("getArguments testRunnerClassName:" + args.testRunnerClassName);
``` ```
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityLifecycleCallback.md
浏览文件 @ e2765fed
# @ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback) # @ohos.app.ability.abilityLifecycleCallback (AbilityLifecycleCallback)
AbilityLifecycleCallback模块提供应用上下文ApplicationContext的生命周期监听方法的回调类的能力，包括onAbilityCreate、onWindowStageCreate、onWindowStageDestroy等方法。 AbilityLifecycleCallback模块提供应用上下文[ApplicationContext](js-apis-inner-application-applicationContext.md)的生命周期发生变化时触发相应回调的能力，包括[onAbilityCreate](#abilitylifecyclecallbackonabilitycreate)、[onWindowStageCreate](#abilitylifecyclecallbackonwindowstagecreate)、[onWindowStageActive](#abilitylifecyclecallbackonwindowstageactive)、[onWindowStageInactive](#abilitylifecyclecallbackonwindowstageinactive)、[onWindowStageDestroy](#abilitylifecyclecallbackonwindowstagedestroy)、[onAbilityDestroy](#abilitylifecyclecallbackonabilitydestroy)、[onAbilityForeground](#abilitylifecyclecallbackonabilityforeground)、[onAbilityBackground](#abilitylifecyclecallbackonabilitybackground)、[onAbilityContinue](#abilitylifecyclecallbackonabilitycontinue)方法。
> **说明：** > **说明：**
> >
...@@ -17,7 +17,7 @@ import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback ...@@ -17,7 +17,7 @@ import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback
## AbilityLifecycleCallback.onAbilityCreate ## AbilityLifecycleCallback.onAbilityCreate
onAbilityCreate(ability: UIAbility): void; onAbilityCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
注册监听应用上下文的生命周期后，在ability创建时触发回调。 注册监听应用上下文的生命周期后，在ability创建时触发回调。
...@@ -27,12 +27,12 @@ onAbilityCreate(ability: UIAbility): void; ...@@ -27,12 +27,12 @@ onAbilityCreate(ability: UIAbility): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
## AbilityLifecycleCallback.onWindowStageCreate ## AbilityLifecycleCallback.onWindowStageCreate
onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void; onWindowStageCreate(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
注册监听应用上下文的生命周期后，在windowStage创建时触发回调。 注册监听应用上下文的生命周期后，在windowStage创建时触发回调。
...@@ -42,13 +42,13 @@ onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void; ...@@ -42,13 +42,13 @@ onWindowStageCreate(ability: UIAbility, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageActive ## AbilityLifecycleCallback.onWindowStageActive
onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void; onWindowStageActive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
注册监听应用上下文的生命周期后，在windowStage获焦时触发回调。 注册监听应用上下文的生命周期后，在windowStage获焦时触发回调。
...@@ -58,13 +58,13 @@ onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void; ...@@ -58,13 +58,13 @@ onWindowStageActive(ability: UIAbility, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageInactive ## AbilityLifecycleCallback.onWindowStageInactive
onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void; onWindowStageInactive(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
注册监听应用上下文的生命周期后，在windowStage失焦时触发回调。 注册监听应用上下文的生命周期后，在windowStage失焦时触发回调。
...@@ -74,13 +74,13 @@ onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void ...@@ -74,13 +74,13 @@ onWindowStageInactive(ability: UIAbility, windowStage: window.WindowStage): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onWindowStageDestroy ## AbilityLifecycleCallback.onWindowStageDestroy
onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void; onWindowStageDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md), windowStage: [window.WindowStage](js-apis-window.md#windowstage9)): void;
注册监听应用上下文的生命周期后，在windowStage销毁时触发回调。 注册监听应用上下文的生命周期后，在windowStage销毁时触发回调。
...@@ -90,13 +90,13 @@ onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void; ...@@ -90,13 +90,13 @@ onWindowStageDestroy(ability: UIAbility, windowStage: window.WindowStage): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
| windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 | | windowStage | [window.WindowStage](js-apis-window.md#windowstage9) | 是 | 当前WindowStage对象 |
## AbilityLifecycleCallback.onAbilityDestroy ## AbilityLifecycleCallback.onAbilityDestroy
onAbilityDestroy(ability: UIAbility): void; onAbilityDestroy(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
注册监听应用上下文的生命周期后，在ability销毁时触发回调。 注册监听应用上下文的生命周期后，在ability销毁时触发回调。
...@@ -106,12 +106,12 @@ onAbilityDestroy(ability: UIAbility): void; ...@@ -106,12 +106,12 @@ onAbilityDestroy(ability: UIAbility): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
## AbilityLifecycleCallback.onAbilityForeground ## AbilityLifecycleCallback.onAbilityForeground
onAbilityForeground(ability: UIAbility): void; onAbilityForeground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
注册监听应用上下文的生命周期后，在ability的状态从后台转到前台时触发回调。 注册监听应用上下文的生命周期后，在ability的状态从后台转到前台时触发回调。
...@@ -121,12 +121,12 @@ onAbilityForeground(ability: UIAbility): void; ...@@ -121,12 +121,12 @@ onAbilityForeground(ability: UIAbility): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
## AbilityLifecycleCallback.onAbilityBackground ## AbilityLifecycleCallback.onAbilityBackground
onAbilityBackground(ability: UIAbility): void; onAbilityBackground(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
注册监听应用上下文的生命周期后，在ability的状态从前台转到后台时触发回调。 注册监听应用上下文的生命周期后，在ability的状态从前台转到后台时触发回调。
...@@ -136,12 +136,12 @@ onAbilityBackground(ability: UIAbility): void; ...@@ -136,12 +136,12 @@ onAbilityBackground(ability: UIAbility): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
## AbilityLifecycleCallback.onAbilityContinue ## AbilityLifecycleCallback.onAbilityContinue
onAbilityContinue(ability: UIAbility): void; onAbilityContinue(ability: [UIAbility](js-apis-app-ability-uiAbility.md)): void;
注册监听应用上下文的生命周期后，在ability迁移时触发回调。 注册监听应用上下文的生命周期后，在ability迁移时触发回调。
...@@ -151,61 +151,63 @@ onAbilityContinue(ability: UIAbility): void; ...@@ -151,61 +151,63 @@ onAbilityContinue(ability: UIAbility): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| ability | [UIAbility](js-apis-app-ability-uiAbility.md#Ability) | 是 | 当前Ability对象 | | ability | [UIAbility](js-apis-app-ability-uiAbility.md) | 是 | 当前Ability对象 |
**示例：** **示例：**
```ts
import AbilityLifecycleCallback from "@ohos.app.ability.AbilityLifecycleCallback";
```ts // 声明ability生命周期回调
import UIAbility from "@ohos.app.ability.UIAbility"; let abilityLifecycleCallback = {
onAbilityCreate(ability){
export default class MyAbility extends UIAbility { console.log("AbilityLifecycleCallback onAbilityCreate.");
onCreate() { },
console.log("MyAbility onCreate") onWindowStageCreate(ability, windowStage){
let AbilityLifecycleCallback = { console.log("AbilityLifecycleCallback onWindowStageCreate.");
onAbilityCreate(ability){ },
console.log("AbilityLifecycleCallback onAbilityCreate ability:" + JSON.stringify(ability)); onWindowStageActive(ability, windowStage){
}, console.log("AbilityLifecycleCallback onWindowStageActive.");
onWindowStageCreate(ability, windowStage){ },
console.log("AbilityLifecycleCallback onWindowStageCreate ability:" + JSON.stringify(ability)); onWindowStageInactive(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageCreate windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onWindowStageInactive.");
}, },
onWindowStageActive(ability, windowStage){ onWindowStageDestroy(ability, windowStage){
console.log("AbilityLifecycleCallback onWindowStageActive ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onWindowStageDestroy.");
console.log("AbilityLifecycleCallback onWindowStageActive windowStage:" + JSON.stringify(windowStage)); },
}, onAbilityDestroy(ability){
onWindowStageInactive(ability, windowStage){ console.log("AbilityLifecycleCallback onAbilityDestroy.");
console.log("AbilityLifecycleCallback onWindowStageInactive ability:" + JSON.stringify(ability)); },
console.log("AbilityLifecycleCallback onWindowStageInactive windowStage:" + JSON.stringify(windowStage)); onAbilityForeground(ability){
}, console.log("AbilityLifecycleCallback onAbilityForeground.");
onWindowStageDestroy(ability, windowStage){ },
console.log("AbilityLifecycleCallback onWindowStageDestroy ability:" + JSON.stringify(ability)); onAbilityBackground(ability){
console.log("AbilityLifecycleCallback onWindowStageDestroy windowStage:" + JSON.stringify(windowStage)); console.log("AbilityLifecycleCallback onAbilityBackground.");
}, },
onAbilityDestroy(ability){ onAbilityContinue(ability){
console.log("AbilityLifecycleCallback onAbilityDestroy ability:" + JSON.stringify(ability)); console.log("AbilityLifecycleCallback onAbilityContinue.");
}, }
onAbilityForeground(ability){ }
console.log("AbilityLifecycleCallback onAbilityForeground ability:" + JSON.stringify(ability));
}, export default class MyAbility extends UIAbility {
onAbilityBackground(ability){ onCreate() {
console.log("AbilityLifecycleCallback onAbilityBackground ability:" + JSON.stringify(ability)); console.log("MyAbility onCreate")
}, // 1.通过context属性获取applicationContext
onAbilityContinue(ability){ let applicationContext = this.context.getApplicationContext();
console.log("AbilityLifecycleCallback onAbilityContinue ability:" + JSON.stringify(ability)); // 2.通过applicationContext注册监听应用内生命周期
} globalThis.lifecycleid = applicationContext.on("abilityLifecycle", abilityLifecycleCallback);
} console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid));
// 1.通过context属性获取applicationContext },
let applicationContext = this.context.getApplicationContext(); onDestroy() {
// 2.通过applicationContext注册监听应用内生命周期 let applicationContext = this.context.getApplicationContext();
let lifecycleid = applicationContext.on("abilityLifecycle", AbilityLifecycleCallback); // 3.通过applicationContext注销监听应用内生命周期
console.log("registerAbilityLifecycleCallback number: " + JSON.stringify(lifecycleid)); applicationContext.off("abilityLifecycle", globalThis.lifecycleid, (error) => {
}, if (error != 0) {
onDestroy() { console,log("unregisterAbilityLifecycleCallback failed, error: " + JSON.stringify(error));
let applicationContext = this.context.getApplicationContext(); } else {
applicationContext.off("abilityLifecycle", lifecycleid, (error, data) => { console.log("unregisterAbilityLifecycleCallback success.");
console.log("unregisterAbilityLifecycleCallback success, err: " + JSON.stringify(error)); }
}); });
} }
} }
``` ```
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @ e2765fed
# @ohos.app.ability.abilityManager (AbilityManager) # @ohos.app.ability.abilityManager (AbilityManager)
AbilityManager模块提供对Ability相关信息和状态信息进行获取、新增、修改等能力。 AbilityManager模块提供获取、新增、修改Ability相关信息和状态信息进行的能力。
> **说明：** > **说明：**
> >
...@@ -15,7 +15,7 @@ import abilityManager from '@ohos.app.ability.abilityManager' ...@@ -15,7 +15,7 @@ import abilityManager from '@ohos.app.ability.abilityManager'
## AbilityState ## AbilityState
Ability的状态信息。 Ability的状态，该类型为枚举，可配合[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)返回Abiltiy的状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -23,17 +23,17 @@ Ability的状态信息。 ...@@ -23,17 +23,17 @@ Ability的状态信息。
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。| | INITIAL | 0 | 表示ability为初始化状态。|
| FOREGROUND | 9 | 表示ability为foreground状态。 | | FOREGROUND | 9 | 表示ability为前台状态。 |
| BACKGROUND | 10 | 表示ability为background状态。 | | BACKGROUND | 10 | 表示ability为后台状态。 |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 | | FOREGROUNDING | 11 | 表示ability为前台调度中状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 | | BACKGROUNDING | 12 | 表示ability为后台调度中状态。 |
## updateConfiguration ## updateConfiguration
updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void updateConfiguration(config: [Configuration](js-apis-app-ability-configuration.md), callback: AsyncCallback\<void>): void
通过修改配置来更新配置（callback形式）。 通过传入修改的配置项来更新配置（callback形式）。
**需要权限**: ohos.permission.UPDATE_CONFIGURATION **需要权限**: ohos.permission.UPDATE_CONFIGURATION
...@@ -43,29 +43,38 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void ...@@ -43,29 +43,38 @@ updateConfiguration(config: Configuration, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项，仅需配置需要更新的项。 |
| callback | AsyncCallback\<void> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<void> | 是 | 以回调方式返回接口运行结果，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
var config = { var config = {
language: 'chinese' language: 'chinese',
colorMode: COLOR_MODE_LIGHT,
direction: DIRECTION_VERTICAL,
screenDensity: SCREEN_DENSITY_SDPI,
displayId: 1,
hasPointerDevice: true,
} }
try { try {
abilityManager.updateConfiguration(config, () => { abilityManager.updateConfiguration(config, (err) => {
console.log('------------ updateConfiguration -----------'); if (err.code != 0) {
}) console.log("updateConfiguration fail, err: " + JSON.stringify(err));
} else {
console.log("updateConfiguration success.");
}
})
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## updateConfiguration ## updateConfiguration
updateConfiguration(config: Configuration): Promise\<void> updateConfiguration(config: [Configuration](js-apis-app-ability-configuration.md)): Promise\<void>
通过修改配置来更新配置（Promise形式）。 通过修改配置来更新配置（Promise形式）。
...@@ -77,36 +86,41 @@ updateConfiguration(config: Configuration): Promise\<void> ...@@ -77,36 +86,41 @@ updateConfiguration(config: Configuration): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项。 | | config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 新的配置项，仅需配置需要更新的项。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise\<void> | 返回执行结果。 | | Promise\<void> | 以Promise方式返回接口运行结果息，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
var config = { var config = {
language: 'chinese' language: 'chinese',
colorMode: COLOR_MODE_LIGHT,
direction: DIRECTION_VERTICAL,
screenDensity: SCREEN_DENSITY_SDPI,
displayId: 1,
hasPointerDevice: true,
} }
try { try {
abilityManager.updateConfiguration(config).then(() => { abilityManager.updateConfiguration(config).then(() => {
console.log('updateConfiguration success'); console.log('updateConfiguration success.');
}).catch((err) => { }).catch((err) => {
console.log('updateConfiguration fail'); console.log('updateConfiguration fail, err: ' + JSON.stringify(err));
}) })
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## getAbilityRunningInfos ## getAbilityRunningInfos
getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void getAbilityRunningInfos(callback: AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>): void
获取Ability运行相关信息（callback形式）。 获取Ability运行相关信息（callback形式）。
...@@ -118,24 +132,28 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo ...@@ -118,24 +132,28 @@ getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 是 | 以回调方式返回接口运行结果及运行中的ability信息，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
try { try {
abilityManager.getAbilityRunningInfos((err,data) => { abilityManager.getAbilityRunningInfos((err,data) => {
console.log("getAbilityRunningInfos err: " + err + " data: " + JSON.stringify(data)); if (err.code != 0) {
}); console.log("getAbilityRunningInfos fail, error: " + JSON.stringify(err));
} else {
console.log("getAbilityRunningInfos success, data: " + JSON.stringify(data));
}
});
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## getAbilityRunningInfos ## getAbilityRunningInfos
getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>> getAbilityRunningInfos(): Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>>
获取Ability运行相关信息（Promise形式）。 获取Ability运行相关信息（Promise形式）。
...@@ -147,26 +165,26 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>> ...@@ -147,26 +165,26 @@ getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 | | Promise\<Array\<[AbilityRunningInfo](js-apis-inner-application-abilityRunningInfo.md)>> | 以Promise方式返回接口运行结果及运行中的ability信息，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
try { try {
abilityManager.getAbilityRunningInfos().then((data) => { abilityManager.getAbilityRunningInfos().then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data)) console.log("getAbilityRunningInfos success, data: " + JSON.stringify(data))
}).catch((err) => { }).catch((err) => {
console.log("getAbilityRunningInfos err: " + err) console.log("getAbilityRunningInfos fail, err: " + JSON.stringify(err));
}); });
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## getExtensionRunningInfos ## getExtensionRunningInfos
getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<ExtensionRunningInfo>>): void getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>>): void
获取关于运行扩展能力的信息（callback形式）。 获取关于运行扩展能力的信息（callback形式）。
...@@ -179,7 +197,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext ...@@ -179,7 +197,7 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| upperLimit | number | 是 | 获取消息数量的最大限制。 | | upperLimit | number | 是 | 获取消息数量的最大限制。 |
| callback | AsyncCallback\<Array\<AbilityRunningInfo>> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 是 | 以回调方式返回接口运行结果及运行中的extension信息，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
...@@ -187,18 +205,22 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext ...@@ -187,18 +205,22 @@ getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback\<Array\<Ext
var upperLimit = 0; var upperLimit = 0;
try { try {
abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => {
console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); if (err.code != 0) {
}); console.log("getExtensionRunningInfos fail, err: " + JSON.stringify(err));
} else {
console.log("getExtensionRunningInfos success, data: " + JSON.stringify(data));
}
});
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## getExtensionRunningInfos ## getExtensionRunningInfos
getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningInfo>> getExtensionRunningInfos(upperLimit: number): Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>>
获取关于运行扩展能力的信息（Promise形式）。 获取关于运行扩展能力的信息（Promise形式）。
...@@ -216,7 +238,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn ...@@ -216,7 +238,7 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise\<Array\<AbilityRunningInfo>> | 返回执行结果。 | | Promise\<Array\<[ExtensionRunningInfo](js-apis-inner-application-extensionRunningInfo.md)>> | 以Promise方式返回接口运行结果及运行中的extension信息，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
...@@ -224,20 +246,20 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn ...@@ -224,20 +246,20 @@ getExtensionRunningInfos(upperLimit: number): Promise\<Array\<ExtensionRunningIn
var upperLimit = 0; var upperLimit = 0;
try { try {
abilityManager.getExtensionRunningInfos(upperLimit).then((data) => { abilityManager.getExtensionRunningInfos(upperLimit).then((data) => {
console.log("getAbilityRunningInfos data: " + JSON.stringify(data)); console.log("getExtensionRunningInfos success, data: " + JSON.stringify(data));
}).catch((err) => { }).catch((err) => {
console.log("getAbilityRunningInfos err: " + err); console.log("getExtensionRunningInfos fail, err: " + JSON.stringify(err));
}) })
} catch (paramError) { } catch (paramError) {
console.log('error.code: ' + JSON.stringify(paramError.code) + console.log('error.code: ' + JSON.stringify(paramError.code) +
' error.message: ' + JSON.stringify(paramError.message)); ' error.message: ' + JSON.stringify(paramError.message));
} }
``` ```
## getTopAbility<sup>9+</sup> ## getTopAbility<sup>9+</sup>
getTopAbility(callback: AsyncCallback\<ElementName>): void; getTopAbility(callback: AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)>): void;
获取窗口焦点的ability接口（callback形式）。 获取窗口焦点的ability接口（callback形式）。
...@@ -247,19 +269,23 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void; ...@@ -247,19 +269,23 @@ getTopAbility(callback: AsyncCallback\<ElementName>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- | | --------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<ElementName> | 是 | 被指定的回调方法。 | | callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是 | 以回调方式返回接口运行结果及应用名，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
abilityManager.getTopAbility((err,data) => { abilityManager.getTopAbility((err,data) => {
console.log("getTopAbility err: " + err + " data: " + JSON.stringify(data)); if (err.code != 0) {
console.log("getTopAbility fail, err: " + JSON.stringify(err));
} else {
console.log("getTopAbility success, data: " + JSON.stringify(data));
}
}); });
``` ```
## getTopAbility ## getTopAbility
getTopAbility(): Promise\<ElementName>; getTopAbility(): Promise\<[ElementName](js-apis-bundleManager-elementName.md)>;
获取窗口焦点的ability接口（Promise形式）。 获取窗口焦点的ability接口（Promise形式）。
...@@ -269,14 +295,14 @@ getTopAbility(): Promise\<ElementName>; ...@@ -269,14 +295,14 @@ getTopAbility(): Promise\<ElementName>;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise\<ElementName>| 返回执行结果。 | | Promise\<[ElementName](js-apis-bundleManager-elementName.md)>| 以Promise方式返回接口运行结果及应用名，可进行错误处理或其他自定义处理。 |
**示例**： **示例**：
```ts ```ts
abilityManager.getTopAbility().then((data) => { abilityManager.getTopAbility().then((data) => {
console.log("getTopAbility data: " + JSON.stringify(data)); console.log("getTopAbility success, data: " + JSON.stringify(data));
}).catch((err) => { }).catch((err) => {
console.log("getTopAbility err: " + err); console.log("getTopAbility fail, err: " + JSON.stringify(err));
}) })
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityStage.md
浏览文件 @ e2765fed
...@@ -25,18 +25,18 @@ onCreate(): void ...@@ -25,18 +25,18 @@ onCreate(): void
**示例：** **示例：**
```ts ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onCreate() { onCreate() {
console.log("MyAbilityStage.onCreate is called") console.log("MyAbilityStage.onCreate is called");
} }
} }
``` ```
## AbilityStage.onAcceptWant ## AbilityStage.onAcceptWant
onAcceptWant(want: Want): string; onAcceptWant(want: [Want](js-apis-app-ability-want.md)): string;
启动一个specified ability时触发的事件。 启动一个specified ability时触发的事件。
...@@ -56,19 +56,19 @@ onAcceptWant(want: Want): string; ...@@ -56,19 +56,19 @@ onAcceptWant(want: Want): string;
**示例：** **示例：**
```ts ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onAcceptWant(want) { onAcceptWant(want) {
console.log("MyAbilityStage.onAcceptWant called"); console.log("MyAbilityStage.onAcceptWant called");
return "com.example.test"; return "com.example.test";
} }
} }
``` ```
## AbilityStage.onConfigurationUpdate ## AbilityStage.onConfigurationUpdate
onConfigurationUpdate(newConfig: Configuration): void; onConfigurationUpdate(newConfig: [Configuration](js-apis-app-ability-configuration.md)): void;
环境变化通知接口，发生全局配置变更时回调。 环境变化通知接口，发生全局配置变更时回调。
...@@ -82,17 +82,17 @@ onConfigurationUpdate(newConfig: Configuration): void; ...@@ -82,17 +82,17 @@ onConfigurationUpdate(newConfig: Configuration): void;
**示例：** **示例：**
```ts ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onConfigurationUpdate(config) { onConfigurationUpdate(config) {
console.log('onConfigurationUpdate, language:' + config.language); console.log('onConfigurationUpdate, language:' + config.language);
} }
} }
``` ```
## AbilityStage.onMemoryLevel ## AbilityStage.onMemoryLevel
onMemoryLevel(level: AbilityConstant.MemoryLevel): void; onMemoryLevel(level: [AbilityConstant.MemoryLevel](js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel)): void;
当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。 当系统已决定调整内存时调用。例如，当该功能在后台运行时，没有足够的内存来运行尽可能多的后台进程时可以使用。
...@@ -106,22 +106,22 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; ...@@ -106,22 +106,22 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
**示例：** **示例：**
```ts ```ts
class MyAbilityStage extends AbilityStage { class MyAbilityStage extends AbilityStage {
onMemoryLevel(level) { onMemoryLevel(level) {
console.log('onMemoryLevel, level:' + JSON.stringify(level)); console.log('onMemoryLevel, level:' + JSON.stringify(level));
} }
} }
``` ```
## AbilityStage.context ## AbilityStage.context
context: AbilityStageContext; context: [AbilityStageContext](js-apis-inner-application-abilityStageContext.md);
指示有关上下文的配置信息。 指示AbilityStage的上下文，。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core **系统能力**：SystemCapability.Ability.AbilityRuntime.Core
| 属性名 | 类型 | 说明 | | 属性名 | 类型 | 说明 |
| ----------- | --------------------------- | ------------------------------------------------------------ | | ----------- | --------------------------- | ------------------------------------------------------------ |
| context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在启动能力阶段进行初始化时回调。 | | context | [AbilityStageContext](js-apis-inner-application-abilityStageContext.md) | 在Ability启动阶段进行初始化时回调，获取到该Ability的context值。 |
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
浏览文件 @ e2765fed
...@@ -14,7 +14,7 @@ import appRecovery from '@ohos.app.ability.appRecovery' ...@@ -14,7 +14,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
## appRecovery.RestartFlag ## appRecovery.RestartFlag
[enableAppRecovery](#apprecoveryenableapprecovery)接口重启选项参数。 应用重启标志，[enableAppRecovery](#apprecoveryenableapprecovery)接口重启选项参数，该类型为枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -28,7 +28,7 @@ import appRecovery from '@ohos.app.ability.appRecovery' ...@@ -28,7 +28,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
## appRecovery.SaveOccasionFlag ## appRecovery.SaveOccasionFlag
[enableAppRecovery](#apprecoveryenableapprecovery)接口状态保存时机选项参数。 保存条件标志，[enableAppRecovery](#apprecoveryenableapprecovery)接口状态保存时的选项参数，该类型为枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -39,7 +39,7 @@ import appRecovery from '@ohos.app.ability.appRecovery' ...@@ -39,7 +39,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
## appRecovery.SaveModeFlag ## appRecovery.SaveModeFlag
[enableAppRecovery](#apprecoveryenableapprecovery)接口状态保存方式的参数。 状态保存标志，[enableAppRecovery](#apprecoveryenableapprecovery)接口状态保存方式的参数，该类型为枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core **系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...@@ -50,7 +50,7 @@ import appRecovery from '@ohos.app.ability.appRecovery' ...@@ -50,7 +50,7 @@ import appRecovery from '@ohos.app.ability.appRecovery'
## appRecovery.enableAppRecovery ## appRecovery.enableAppRecovery
enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMode?: SaveModeFlag) : void; enableAppRecovery(restart?: [RestartFlag](#apprecoveryrestartflag), saveOccasion?: [SaveOccasionFlag](#apprecoverysaveoccasionflag), saveMode?: [SaveModeFlag](#apprecoverysavemodeflag)) : void;
使能应用恢复功能，参数按顺序填入。 使能应用恢复功能，参数按顺序填入。
...@@ -60,9 +60,9 @@ enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMo ...@@ -60,9 +60,9 @@ enableAppRecovery(restart?: RestartFlag, saveOccasion?: SaveOccasionFlag, saveMo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| restart | [RestartFlag](#apprecoveryrestartflag) | 否 | 发生对应故障时是否重启，默认为不重启。 | | restart | [RestartFlag](#apprecoveryrestartflag) | 否 | 枚举类型，发生对应故障时是否重启，默认为不重启。 |
| saveOccasion | [SaveOccasionFlag](#apprecoverysaveoccasionflag) | 否 | 状态保存时机，默认为故障时保存。 | | saveOccasion | [SaveOccasionFlag](#apprecoverysaveoccasionflag) | 否 | 枚举类型，状态保存时机，默认为故障时保存。 |
| saveMode | [SaveModeFlag](#apprecoverysavemodeflag) | 否 | 状态保存方式， 默认为文件缓存。 | | saveMode | [SaveModeFlag](#apprecoverysavemodeflag) | 否 | 枚举类型，状态保存方式， 默认为文件缓存。 |
**示例：** **示例：**
...@@ -94,7 +94,6 @@ var observer = { ...@@ -94,7 +94,6 @@ var observer = {
appRecovery.restartApp(); appRecovery.restartApp();
} }
} }
``` ```
## appRecovery.saveAppState ## appRecovery.saveAppState
...@@ -109,7 +108,7 @@ saveAppState(): boolean; ...@@ -109,7 +108,7 @@ saveAppState(): boolean;
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| boolean | 保存成功与否。 | | boolean | 保存成功与否。true：保存成功，false：保存失败。 |
**示例：** **示例：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或