未验证 提交 8614f8b3 编写于 作者: O openharmony_ci 提交者: Gitee

!14123 更新元能力AbilityManager和AppManager相关接口资料

Merge pull request !14123 from dy/UpdateAPI9
......@@ -103,7 +103,7 @@
- [MissionSnapshot](js-apis-inner-application-missionSnapshot.md)
- [ProcessData](js-apis-inner-application-processData.md)
- [ProcessRunningInfo](js-apis-inner-application-processRunningInfo.md)
- [ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)
- [ProcessInformation](js-apis-inner-application-processInformation.md)
- [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md)
- [UIAbilityContext](js-apis-inner-application-uiAbilityContext.md)
- [shellCmdResult](js-apis-inner-application-shellCmdResult.md)
......
......@@ -110,6 +110,8 @@ class MyAbility extends UIAbility {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 说明 |
| --- | --- | --- |
| WINDOW_MODE_UNDEFINED | 0 | 未定义窗口模式。 |
......
......@@ -24,7 +24,7 @@ Ability的状态,该类型为枚举,可配合[AbilityRunningInfo](js-apis-in
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为初始化状态。|
| ACTIVE | 2 | 表示ability为获焦状态。 |
| FOCUS | 2 | 表示ability为获焦状态。 |
| FOREGROUND | 9 | 表示ability为前台状态。 |
| BACKGROUND | 10 | 表示ability为后台状态。 |
| FOREGROUNDING | 11 | 表示ability为前台调度中状态。 |
......@@ -143,7 +143,7 @@ try {
getAbilityRunningInfos(callback: AsyncCallback\<Array\<AbilityRunningInfo>>): void
获取Ability运行相关信息(callback形式)。
获取UIAbility运行相关信息(callback形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
......@@ -186,7 +186,7 @@ try {
getAbilityRunningInfos(): Promise\<Array\<AbilityRunningInfo>>
获取Ability运行相关信息(Promise形式)。
获取UIAbility运行相关信息(Promise形式)。
**需要权限**: ohos.permission.GET_RUNNING_INFO
......
......@@ -224,9 +224,9 @@ appManager.getAppMemorySize((err, data) => {
})
```
## appManager.getProcessRunningInformation
## appManager.getRunningProcessInformation
getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
getRunningProcessInformation(): Promise\<Array\<ProcessInformation>>;
获取有关运行进程的信息。
......@@ -234,13 +234,11 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 以Promise方式返回接口运行结果及有关运行进程的信息,可进行错误处理或其他自定义处理。 |
| Promise\<Array\<[ProcessInformation](js-apis-inner-application-processInformation.md)>> | 以Promise方式返回接口运行结果及有关运行进程的信息,可进行错误处理或其他自定义处理。 |
**错误码**
......@@ -255,16 +253,16 @@ getProcessRunningInformation(): Promise\<Array\<ProcessRunningInformation>>;
```ts
import appManager from '@ohos.app.ability.appManager';
appManager.getProcessRunningInformation().then((data) => {
console.log("The process running information is:" + JSON.stringify(data));
appManager.getRunningProcessInformation().then((data) => {
console.log("The running process information is:" + JSON.stringify(data));
}).catch((error) => {
console.log("error:" + JSON.stringify(error));
});
```
## appManager.getProcessRunningInformation<sup>9+</sup>
## appManager.getRunningProcessInformation<sup>9+</sup>
getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInformation>>): void;
getRunningProcessInformation(callback: AsyncCallback\<Array\<ProcessInformation>>): void;
获取有关运行进程的信息。
......@@ -272,13 +270,11 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|AsyncCallback\<Array\<[ProcessRunningInformation](js-apis-inner-application-processRunningInformation.md)>> | 以回调方式返回接口运行结果及有关运行进程的信息,可进行错误处理或其他自定义处理。 |
|AsyncCallback\<Array\<[ProcessInformation](js-apis-inner-application-processInformation.md)>> | 以回调方式返回接口运行结果及有关运行进程的信息,可进行错误处理或其他自定义处理。 |
**错误码**
......@@ -293,9 +289,9 @@ getProcessRunningInformation(callback: AsyncCallback\<Array\<ProcessRunningInfor
```ts
import appManager from '@ohos.app.ability.appManager';
appManager.getProcessRunningInformation((err, data) => {
appManager.getRunningProcessInformation((err, data) => {
if (err && err.code !== 0) {
console.log("getProcessRunningInformation fail, err: " + JSON.stringify(err));
console.log("getRunningProcessInformation fail, err: " + JSON.stringify(err));
} else {
console.log("The process running information is:" + JSON.stringify(data));
}
......
......@@ -18,6 +18,8 @@ import StartOptions from '@ohos.app.ability.StartOptions';
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**: 此接口为系统接口,三方应用不支持调用。
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| [windowMode](js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode) | number | 否 | 窗口模式。 |
......
......@@ -160,7 +160,7 @@ getProcessRunningInfos(): Promise\<Array\<ProcessRunningInfo>>;
获取有关运行进程的信息。
> 从 API Version 9 开始废弃,建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9)替代。
> 从 API Version 9 开始废弃,建议使用[appManager.getRunningProcessInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetrunningprocessinformation)替代。
**需要权限**:ohos.permission.GET_RUNNING_INFO
......@@ -188,7 +188,7 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
获取有关运行进程的信息。
> 从 API Version 9 开始废弃,建议使用[appManager.getProcessRunningInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetprocessrunninginformation9-1)替代。
> 从 API Version 9 开始废弃,建议使用[appManager.getRunningProcessInformation<sup>9+</sup>](js-apis-app-ability-appManager.md#appmanagergetrunningprocessinformation9)替代。
**需要权限**:ohos.permission.GET_RUNNING_INFO
......@@ -209,6 +209,91 @@ getProcessRunningInfos(callback: AsyncCallback\<Array\<ProcessRunningInfo>>): vo
})
```
## appManager.registerApplicationStateObserver<sup>8+</sup>
registerApplicationStateObserver(observer: ApplicationStateObserver): number;
注册全部应用程序状态观测器。
**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**:该接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
**示例:**
```ts
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
const observerCode = appManager.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);
```
## appManager.registerApplicationStateObserver<sup>9+</sup>
registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\<string>): number;
注册指定应用程序状态观测器。
**需要权限**:ohos.permission.RUNNING_STATE_OBSERVER
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**系统API**:该接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| observer | [ApplicationStateObserver](js-apis-inner-application-applicationStateObserver.md) | 是 | 返回观察者的数字代码。 |
| bundleNameList | Array<string> | 是 | 表示需要注册监听的bundleName数组。最大值128。 |
**示例:**
```ts
var applicationStateObserver = {
onForegroundApplicationChanged(appStateData) {
console.log('------------ onForegroundApplicationChanged -----------', appStateData);
},
onAbilityStateChanged(abilityStateData) {
console.log('------------ onAbilityStateChanged -----------', abilityStateData);
},
onProcessCreated(processData) {
console.log('------------ onProcessCreated -----------', processData);
},
onProcessDied(processData) {
console.log('------------ onProcessDied -----------', processData);
},
onProcessStateChanged(processData) {
console.log('------------ onProcessStateChanged -----------', processData);
}
}
var bundleNameList = ['bundleName1', 'bundleName2'];
const observerCode = appManager.registerApplicationStateObserver(applicationStateObserver, bundleNameList);
console.log('-------- observerCode: ---------', observerCode);
```
## appManager.unregisterApplicationStateObserver<sup>8+</sup>
unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback\<void>): void;
......
# ProcessRunningInformation
# ProcessInformation
ProcessRunningInformation模块提供对进程运行信息进行查询的能力。
ProcessInformation模块提供对进程运行信息进行查询的能力。
> **说明:**
>
......@@ -8,12 +8,12 @@ ProcessRunningInformation模块提供对进程运行信息进行查询的能力
## 使用说明
通过appManager的[getProcessRunningInformation](js-apis-application-appManager.md#appmanagergetprocessrunninginformation9)来获取。
通过appManager的[getRunningProcessInformation](js-apis-app-ability-appManager.md#appmanagergetrunningprocessinformation9)来获取。
```ts
import appManager from '@ohos.application.appManager';
import appManager from '@ohos.app.ability.appManager';
appManager.getProcessRunningInformation((error, data) => {
appManager.getRunningProcessInformation((error, data) => {
console.log("error: " + error.code + " data: " + JSON.stringify(data));
});
```
......
......@@ -3,7 +3,7 @@
本模块提供对进程运行信息进行查询的能力。
> **说明:**
> - 本模块接口从API version 9 开始废弃,建议使用[ProcessRunningInformation<sup>9+</sup>](js-apis-inner-application-processRunningInformation.md)替代。
> - 本模块接口从API version 9 开始废弃,建议使用[ProcessInformation<sup>9+</sup>](js-apis-inner-application-processInformation.md)替代。
> - 本模块首批接口从API version 8 开始支持。
## 属性
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册