@ohos.application.appManager (appManager)

appManager模块提供App管理的能力，包括查询当前是否处于稳定性测试场景、查询是否为ram受限设备、获取应用程序的内存大小、获取有关运行进程的信息等。

说明：

本模块首批接口从API version 8 开始支持，从API version 9废弃，替换模块为@ohos.app.ability.appManager。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import appManager from '@ohos.application.appManager';

appManager.isRunningInStabilityTest

isRunningInStabilityTest(callback: AsyncCallback<boolean>): void

查询当前是否处于稳定性测试场景。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<boolean> 是 回调函数。返回true表示当前处于稳定性测试场景；返回false表示当前不处于稳定性测试场景。

示例：

import appManager from '@ohos.application.appManager';

appManager.isRunningInStabilityTest((error, flag) => {
  if (error && error.code !== 0) {
      console.error(`isRunningInStabilityTest fail, error: ${JSON.stringify(error)}`);
  } else {
      console.log(`isRunningInStabilityTest success, the result is: ${JSON.stringify(flag)}`);
  }
});

appManager.isRunningInStabilityTest

isRunningInStabilityTest(): Promise<boolean>

查询当前是否处于稳定性测试场景。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型 说明
Promise<boolean> Promise对象。返回true表示当前处于稳定性测试场景；返回false表示当前不处于稳定性测试场景。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

appManager.isRunningInStabilityTest().then((flag) => {
    console.log(`The result of isRunningInStabilityTest is: ${JSON.stringify(flag)}`);
}).catch((error: BusinessError) => {
    console.error(`error: ${JSON.stringify(error)}`);
});

appManager.isRamConstrainedDevice

isRamConstrainedDevice(): Promise<boolean>

查询是否为ram受限设备。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型 说明
Promise<boolean> Promise对象。返回true表示是ram受限设备；返回false表示不是ram受限设备。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

appManager.isRamConstrainedDevice().then((data) => {
    console.log(`The result of isRamConstrainedDevice is: ${JSON.stringify(data)}`);
}).catch((error: BusinessError) => {
    console.error(`error: ${JSON.stringify(error)}`);
});

appManager.isRamConstrainedDevice

isRamConstrainedDevice(callback: AsyncCallback<boolean>): void

查询是否为ram受限设备。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<boolean> 是 回调函数。返回true表示当前是ram受限设备；返回false表示当前不是ram受限设备。

示例：

import appManager from '@ohos.application.appManager';

appManager.isRamConstrainedDevice((error, data) => {
    if (error && error.code !== 0) {
        console.error(`isRamConstrainedDevice fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`The result of isRamConstrainedDevice is: ${JSON.stringify(data)}`);
    }
});

appManager.getAppMemorySize

getAppMemorySize(): Promise<number>

获取应用程序的内存大小。使用Promise异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型 说明
Promise<number> Promise对象，返回应用程序内存大小, 单位为M。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

appManager.getAppMemorySize().then((data) => {
    console.log(`The size of app memory is: ${JSON.stringify(data)}`);
}).catch((error: BusinessError) => {
    console.error(`error: ${JSON.stringify(error)}`);
});

appManager.getAppMemorySize

getAppMemorySize(callback: AsyncCallback<number>): void

获取应用程序的内存大小。使用callback异步回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<number> 是 回调函数，返回应用程序内存大小, 单位为M。

示例：

import appManager from '@ohos.application.appManager';

appManager.getAppMemorySize((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getAppMemorySize fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`The size of app memory is: ${JSON.stringify(data)}`);
    }
});

appManager.getProcessRunningInfos(deprecated)

getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>

获取有关运行进程的信息。使用Promise异步回调。

从 API Version 9 开始废弃，建议使用appManager.getRunningProcessInformation替代。

需要权限：ohos.permission.GET_RUNNING_INFO

系统能力：SystemCapability.Ability.AbilityRuntime.Core

返回值：

类型 说明
Promise<Array<ProcessRunningInfo>> Promise对象，返回有关运行进程的信息。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

appManager.getProcessRunningInfos().then((data) => {
    console.log(`The process running infos is: ${JSON.stringify(data)}`);
}).catch((error: BusinessError) => {
    console.error(`error: ${JSON.stringify(error)}`);
});

appManager.getProcessRunningInfos(deprecated)

getProcessRunningInfos(callback: AsyncCallback<Array<ProcessRunningInfo>>): void

获取有关运行进程的信息。使用callback异步回调。

从 API Version 9 开始废弃，建议使用appManager.getRunningProcessInformation替代。

需要权限：ohos.permission.GET_RUNNING_INFO

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名 类型 必填 说明
callback AsyncCallback<Array<ProcessRunningInfo>> 是 回调函数，返回有关运行进程的信息。

示例：

import appManager from '@ohos.application.appManager';

appManager.getProcessRunningInfos((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getProcessRunningInfos fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getProcessRunningInfos success, data: ${JSON.stringify(data)}`);
    }
});

appManager.registerApplicationStateObserver

registerApplicationStateObserver(observer: ApplicationStateObserver): number

注册全部应用程序状态观测器。

需要权限：ohos.permission.RUNNING_STATE_OBSERVER

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
observer ApplicationStateObserver 是 表示程序状态观测器，用于观测应用的生命周期变化。

返回值：

类型 说明
number 已注册观测器的数字代码。

示例：

import appManager from '@ohos.application.appManager';

const observerCode = appManager.registerApplicationStateObserver({
  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);
  }
});
console.log('-------- observerCode: ---------', observerCode);

appManager.unregisterApplicationStateObserver

unregisterApplicationStateObserver(observerId: number, callback: AsyncCallback<void>): void

取消注册应用程序状态观测器。使用callback异步回调。

需要权限：ohos.permission.RUNNING_STATE_OBSERVER

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
observerId number 是 表示观察者的编号代码。
callback AsyncCallback<void> 是 表示指定的callback回调方法。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let observerId = 100;

function unregisterApplicationStateObserverCallback(err: BusinessError) {
  if (err) {
      console.error('------------ unregisterApplicationStateObserverCallback ------------', err);
  }
}
appManager.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);

appManager.unregisterApplicationStateObserver

unregisterApplicationStateObserver(observerId: number): Promise<void>

取消注册应用程序状态观测器。使用Promise异步回调。

需要权限：ohos.permission.RUNNING_STATE_OBSERVER

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
observerId number 是 表示观察者的编号代码。

返回值：

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let observerId = 100;

appManager.unregisterApplicationStateObserver(observerId)
.then((data) => {
    console.log('----------- unregisterApplicationStateObserver success ----------', data);
})
.catch((err: BusinessError) => {
    console.error('----------- unregisterApplicationStateObserver fail ----------', err);
});

appManager.getForegroundApplications

getForegroundApplications(callback: AsyncCallback<Array<AppStateData>>): void

获取所有当前处于前台的应用信息。该应用信息由AppStateData定义。使用callback异步回调。

需要权限：ohos.permission.GET_RUNNING_INFO

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
callback AsyncCallback<Array<AppStateData>> 是 回调函数，返回所有当前处于前台的应用信息。

示例：

import appManager from '@ohos.application.appManager';

appManager.getForegroundApplications((err, data) => {
  if (err) {
      console.error('--------- getForegroundApplicationsCallback fail ---------', err);
  } else {
      console.log('--------- getForegroundApplicationsCallback success ---------', data);
  }
});

appManager.getForegroundApplications

getForegroundApplications(): Promise<Array<AppStateData>>

获取所有当前处于前台的应用信息。该应用信息由AppStateData定义。使用Promise异步回调。

需要权限：ohos.permission.GET_RUNNING_INFO

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

返回值：

类型 说明
Promise<Array<AppStateData>> Promise对象，返回所有当前处于前台的应用信息。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

appManager.getForegroundApplications()
.then((data) => {
    console.log('--------- getForegroundApplications success -------', data);
})
.catch((err: BusinessError) => {
    console.error('--------- getForegroundApplications fail -------', err);
});

appManager.killProcessWithAccount

killProcessWithAccount(bundleName: string, accountId: number): Promise<void>

切断account进程（Promise形式）。

说明：

当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。

需要权限：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 应用Bundle名称。
accountId number 是 系统帐号的帐号ID，详情参考getCreatedOsAccountsCount。

返回值：

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'bundleName';
let accountId = 0;
appManager.killProcessWithAccount(bundleName, accountId)
   .then((data) => {
       console.log('------------ killProcessWithAccount success ------------', data);
   })
   .catch((err: BusinessError) => {
       console.error('------------ killProcessWithAccount fail ------------', err);
   });

appManager.killProcessWithAccount

killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback<void>): void

切断account进程（callback形式）。

说明：

当accountId为当前用户时，不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

需要权限：ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

参数：

参数名 类型 必填 说明
bundleName string 是 应用Bundle名称。
accountId number 是 系统帐号的帐号ID，详情参考getCreatedOsAccountsCount。
callback AsyncCallback<void> 是 回调函数，当切断account进程成功。，err为undefined，否则为错误对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'bundleName';
let accountId = 0;
function killProcessWithAccountCallback(err: BusinessError, data: void) {
   if (err) {
       console.error('------------- killProcessWithAccountCallback fail, err: --------------', err);
   } else {
       console.log('------------- killProcessWithAccountCallback success, data: --------------', data);
   }
}
appManager.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);

appManager.killProcessesByBundleName

killProcessesByBundleName(bundleName: string, callback: AsyncCallback<void>)

通过Bundle名称终止进程。使用callback异步回调。

需要权限：ohos.permission.CLEAN_BACKGROUND_PROCESSES

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 表示Bundle名称。
callback AsyncCallback<void> 是 回调函数，当通过Bundle名称终止进程成功，err为undefined，否则为错误对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'bundleName';
function killProcessesByBundleNameCallback(err: BusinessError, data: void) {
  if (err) {
      console.error('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
  } else {
      console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
  }
}
appManager.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);

appManager.killProcessesByBundleName

killProcessesByBundleName(bundleName: string): Promise<void>

通过Bundle名称终止进程。使用Promise异步回调。

需要权限：ohos.permission.CLEAN_BACKGROUND_PROCESSES

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 表示Bundle名称。

返回值：

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'com.example.myapplication';
appManager.killProcessesByBundleName(bundleName)
  .then((data) => {
      console.log('------------ killProcessesByBundleName success ------------', data);
  })
  .catch((err: BusinessError) => {
      console.error('------------ killProcessesByBundleName fail ------------', err);
  });

appManager.clearUpApplicationData

clearUpApplicationData(bundleName: string, callback: AsyncCallback<void>)

通过Bundle名称清除应用数据。使用callback异步回调。

需要权限：ohos.permission.CLEAN_APPLICATION_DATA

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 表示Bundle名称。
callback AsyncCallback<void> 是 回调函数，当通过Bundle名称清除应用数据成功，err为undefined，否则为错误对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'bundleName';
function clearUpApplicationDataCallback(err: BusinessError, data: void) {
  if (err) {
      console.error('------------- clearUpApplicationDataCallback fail, err: --------------', err);
  } else {
      console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
  }
}
appManager.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);

appManager.clearUpApplicationData

clearUpApplicationData(bundleName: string): Promise<void>

通过Bundle名称清除应用数据。使用Promise异步回调。

需要权限：ohos.permission.CLEAN_APPLICATION_DATA

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统接口: 此接口为系统接口。

参数：

参数名 类型 必填 说明
bundleName string 是 表示Bundle名称。

返回值：

类型 说明
Promise<void> Promise对象。无返回结果的Promise对象。

示例：

import appManager from '@ohos.application.appManager';
import { BusinessError } from '@ohos.base';

let bundleName = 'bundleName';
appManager.clearUpApplicationData(bundleName)
  .then((data) => {
      console.log('------------ clearUpApplicationData success ------------', data);
  })
  .catch((err: BusinessError) => {
      console.error('------------ clearUpApplicationData fail ------------', err);
  });