From 1c93588564393fc85aa78ecaaa29bf608562277d Mon Sep 17 00:00:00 2001 From: wanchengzhen Date: Thu, 24 Feb 2022 23:16:19 +0800 Subject: [PATCH] Add js-apis-app-abilityManager.md Signed-off-by: wanchengzhen --- .../apis/js-apis-app-abilityManager.md | 238 ++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-app-abilityManager.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-abilityManager.md b/zh-cn/application-dev/reference/apis/js-apis-app-abilityManager.md new file mode 100644 index 00000000000..7b728dcb12a --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-app-abilityManager.md @@ -0,0 +1,238 @@ +# App.AbilityManager + +Ability运行相关信息。 + +## 导入模块 + +``` +import abilitymanager from '@ohos.app.abilitymanager'; +``` + +## getActiveProcessInfos + +getActiveProcessInfos(): Promise> + +返回当前所有进程的信息。 + +**参数：**无 + +**返回值**： + +| 类型 | 说明 | +| ------------------------------------------------------- | ----------------------------- | +| Promise> | Promise方式返回运行的进程信息 | + +**示例：** + +```js +abilitymanager.getActiveProcessInfos().then((data) => { + console.log("getActiveProcessInfos data: " + JSON.stringify(data)); +}); +``` + + +## getActiveProcessInfos + +getActiveProcessInfos(callback: AsyncCallback>): void + +返回当前所有进程的信息。 + +**参数：** + +| 参数名 | 类型 | 说明 | +| -------- | ------------------------------------------------------------ | ------------------ | +| callback | AsyncCallback> | 被指定的回调方法。 | + +**返回值**：无 + +**示例：** + +```js +abilitymanager.getActiveProcessInfos((error,data) => { + console.log("getActiveProcessInfos error: " + error.code + " data: " + JSON.stringify(data)); +}); +``` + +## getActiveAbilityMissionInfos + +getActiveAbilityMissionInfos(upperLimit: number): Promise> + +返回当前正在运行的任务信息。 + +**参数：** + +| 名称 | 类型 | 描述 | +| ---------- | ------ | ------------------------------ | +| upperLimit | number | 表示获取可见的任务列表的最大值 | + +**返回值**： + +| 类型 | 说明 | +| --------------------------------------------------------- | ----------------------------- | +| Promise> | Promise方式返回运行的任务信息 | + +**示例：** + +```js +var upperLimit = 10; +abilitymanager.getActiveAbilityMissionInfos(upperLimit).then((data) => { + console.log("getActiveAbilityMissionInfos data: " + JSON.stringify(data)); +}); +``` + +## getActiveAbilityMissionInfos + +getActiveAbilityMissionInfos(upperLimit: number, callback: AsyncCallback>): void + +返回当前正在运行的任务信息。 + +**参数：** + +| 参数名 | 类型 | 说明 | +| ---------- | ------------------------------------------------------------ | ------------------------------ | +| upperLimit | number | 表示获取可见的任务列表的最大值 | +| callback | AsyncCallback> | 获取运行Ability信息的回调 | + +**返回值**：无 + +**示例：** + +```js +var upperLimit = 10; +abilitymanager.getActiveAbilityMissionInfos(upperLimit, (error,data) => { + console.log("getActiveAbilityMissionInfos error: " + error.code + " data: " + JSON.stringify(data)); +}); +``` + + +## getPreviousAbilityMissionInfos + +getPreviousAbilityMissionInfos(upperLimit: number): Promise> + +返回当前最近任务列表信息。 + +**参数：** + +| 参数名 | 类型 | 说明 | +| ---------- | ------ | ------------------------ | +| upperLimit | number | 获取信息个数的最大限制值 | + +**返回值**： + +| 类型 | 说明 | +| --------------------------------------------------------- | ----------------------------------- | +| Promise> | Promise方式返回当前最近任务列表信息 | + +**示例：** + +```js +var upperLimit = 10; +abilitymanager.getPreviousAbilityMissionInfos(upperLimit).then((data) => { + console.log("getPreviousAbilityMissionInfos data: " + JSON.stringify(data)); +}); +``` + + +## getPreviousAbilityMissionInfos + +getPreviousAbilityMissionInfos(upperLimit: number, callback: AsyncCallback>): void + +返回当前最近任务列表信息。 + +**参数：** + +| 参数名 | 类型 | 说明 | +| ---------- | ------------------------------------------------------------ | ------------------------ | +| upperLimit | number | 获取信息个数的最大限制值 | +| callback | AsyncCallback> | 被指定的回调方法。 | + +**返回值**：无 + +**示例：** + +```js +var upperLimit = 10; +abilitymanager.getPreviousAbilityMissionInfos(upperLimit, (error,data) => { + console.log("getPreviousAbilityMissionInfos error: " + error.code + " data: " + JSON.stringify(data)); +}); +``` + +## deleteMissions + +deleteMissions(missionIds: Array): Promise + +通过missionIds删除指定的多个Misssion。 + +**参数：** + +| 参数名 | 必填 | 说明 | +| ---------- | ------------- | ------------------- | +| missionIds | Array | 要删除的mission的id | + +**返回值**： + +| 类型 | 说明 | +| ------------- | --------------------------------- | +| Promise | 返回一个Promise，包含接口的结果。 | + +**示例：** + +``` +var missionIds = [1,3]; +abilitymanager.deleteMissions(missionIds).then((data) => { + console.log("deleteMissions data: " + JSON.stringify(data)); +}); +``` + +## deleteMissions + +deleteMissions(missionIds: Array, callback: AsyncCallback): void; + +通过missionIds删除指定的多个Misssion。 + +**参数：** + +| 参数名 | 必填 | 说明 | +| ---------- | ------------------- | ------------------- | +| missionIds | Array | 要删除的mission的id | +| callback | AsyncCallback | 被指定的回调方法。 | + +**返回值**：无 + +**示例：** + +``` +var missionIds = [1,3]; +abilitymanager.deleteMissions(missionIds, (error,data) => { + console.log("deleteMissions error: " + error.code + " data: " + JSON.stringify(data)); +}); +``` + +## ActiveProcessInfo说明 + +| 名称 | 类型 | 描述 | +| ----------- | ------------- | ---------------------------------- | +| pid | number | 表示进程id | +| processName | string | 表示进程的名称 | +| bundleNames | Array | 表示获取当前进程加载的捆绑软件列表 | +| uid | number | 表示进程uid | + +## AbilityMissionInfo说明 + +| 名称 | 读写属性 | 类型 | 描述 | +| ------------- | -------- | ----------- | --------------------------- | +| missionId | 只读 | number | 表示任务id | +| bottomAbility | 只读 | ElementName | 同一任务中的最底部的ability | +| topAbility | 只读 | ElementName | 同一任务中的最顶部的ability | +| windowMode | 只读 | number | 任务栈中对应的能力描述信息 | + +## ElementName说明 + +| 名称 | 类型 | 说明 | +| ----------- | ------ | --------------------------- | +| deviceId | string | 表示Ability的设备ID（可选） | +| bundleName | string | 表示包名 | +| abilityName | string | 表示Ability的名称 | +| uri | string | 表示Ability的URI（可选） | +| shortName | string | 表示Ability的简称（可选） | + -- Gitee