@ohos.application.appManager (appManager)


@ohos.application.appManager (appManager)

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

说明:

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

导入模块

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

appManager.isRunningInStabilityTest8+

static isRunningInStabilityTest(callback: AsyncCallback<boolean>): void

查询当前是否处于稳定性测试场景。

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<boolean> 返回当前是否处于稳定性测试场景。

示例:

appManager.isRunningInStabilityTest((err, flag) => {
  console.log('error:' + JSON.stringfy(err));
  console.log('The result of isRunningInStabilityTest is:' + JSON.stringify(flag));
})  
1
2
3
4

appManager.isRunningInStabilityTest8+

static isRunningInStabilityTest(): Promise<boolean>

查询当前是否处于稳定性测试场景。

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

返回值:

类型 说明
Promise<boolean> 返回当前是否处于稳定性测试场景。

示例:

appManager.isRunningInStabilityTest().then((flag) => {
    console.log('The result of isRunningInStabilityTest is:' + JSON.stringify(flag));
}).catch((error) => {
    console.log('error:' + JSON.stringify(error));
});
1
2
3
4
5

appManager.isRamConstrainedDevice

isRamConstrainedDevice(): Promise<boolean>;

查询是否为ram受限设备。

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

返回值:

类型 说明
Promise<boolean> 是否为ram受限设备。

示例:

appManager.isRamConstrainedDevice().then((data) => {
    console.log('The result of isRamConstrainedDevice is:' + JSON.stringify(data));
}).catch((error) => {
    console.log('error:' + JSON.stringify(error));
});
1
2
3
4
5

appManager.isRamConstrainedDevice

isRamConstrainedDevice(callback: AsyncCallback<boolean>): void;

查询是否为ram受限设备。

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<boolean> 返回当前是否是ram受限设备。

示例:

appManager.isRamConstrainedDevice((err, data) => {
    console.log('error:' + JSON.stringify(err));
    console.log('The result of isRamConstrainedDevice is:' + JSON.stringify(data));
})
1
2
3
4

appManager.getAppMemorySize

getAppMemorySize(): Promise<number>;

获取应用程序的内存大小。

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

返回值:

类型 说明
Promise<number> 应用程序内存大小。

示例:

appManager.getAppMemorySize().then((data) => {
    console.log('The size of app memory is:' + JSON.stringify(data));
}).catch((error) => {
    console.log('error:' + JSON.stringify(error));
});
1
2
3
4
5

appManager.getAppMemorySize

getAppMemorySize(callback: AsyncCallback<number>): void;

获取应用程序的内存大小。

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<number> 应用程序内存大小。

示例:

appManager.getAppMemorySize((err, data) => {
    console.log('error:' + JSON.stringify(err));
    console.log('The size of app memory is:' + JSON.stringify(data));
})
1
2
3
4

appManager.getProcessRunningInfos(deprecated)

getProcessRunningInfos(): Promise<Array<ProcessRunningInfo>>;

获取有关运行进程的信息。

从 API Version 9 开始废弃,建议使用appManager.getProcessRunningInformation9+替代。

需要权限:ohos.permission.GET_RUNNING_INFO

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

返回值:

类型 说明
Promise<Array<ProcessRunningInfo>> 获取有关运行进程的信息。

示例:

appManager.getProcessRunningInfos().then((data) => {
    console.log('The process running infos is:' + JSON.stringify(data));
}).catch((error) => {
    console.log('error:' + JSON.stringify(error));
});
1
2
3
4
5

appManager.getProcessRunningInfos(deprecated)

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

获取有关运行进程的信息。

从 API Version 9 开始废弃,建议使用appManager.getProcessRunningInformation9+替代。

需要权限:ohos.permission.GET_RUNNING_INFO

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<ProcessRunningInfo>> 获取有关运行进程的信息。

示例:

appManager.getProcessRunningInfos((err, data) => {
    console.log('error:' + JSON.stringify(err));
    console.log('The process running infos is:' + JSON.stringify(data));
})
1
2
3
4

appManager.getProcessRunningInformation9+

getProcessRunningInformation(): Promise<Array<ProcessRunningInformation>>;

获取有关运行进程的信息。

需要权限:ohos.permission.GET_RUNNING_INFO

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

返回值:

类型 说明
Promise<Array<ProcessRunningInformation>> 获取有关运行进程的信息。

示例:

appManager.getProcessRunningInformation().then((data) => {
    console.log('The process running info is:' + JSON.stringify(data));
}).catch((error) => {
    console.log('error:' + JSON.stringify(error));
});
1
2
3
4
5

appManager.getProcessRunningInformation9+

getProcessRunningInformation(callback: AsyncCallback<Array<ProcessRunningInformation>>): void;

获取有关运行进程的信息。

需要权限:ohos.permission.GET_RUNNING_INFO

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<ProcessRunningInformation>> 获取有关运行进程的信息。

示例:

appManager.getProcessRunningInformation((err, data) => {
    console.log('error:' + JSON.stringify(err));
    console.log('The process running info is:' + JSON.stringify(data));
})
1
2
3
4

appManager.registerApplicationStateObserver8+

registerApplicationStateObserver(observer: ApplicationStateObserver): number;

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

需要权限:ohos.permission.RUNNING_STATE_OBSERVER

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

参数名 类型 必填 说明
observer ApplicationStateObserver 返回观察者的数字代码。

示例:

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);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

appManager.registerApplicationStateObserver9+

registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array<string>): number;

注册指定应用程序状态观测器。

需要权限:ohos.permission.RUNNING_STATE_OBSERVER

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

参数名 类型 必填 说明
observer ApplicationStateObserver 返回观察者的数字代码。
bundleNameList Array 表示需要注册监听的bundleName数组。最大值128。

示例:

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);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

appManager.unregisterApplicationStateObserver8+

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

取消注册应用程序状态观测器。

需要权限:ohos.permission.RUNNING_STATE_OBSERVER

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

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

示例:

var observerId = 100;

function unregisterApplicationStateObserverCallback(err) {
  if (err) {
      console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
  }
}
appManager.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);
1
2
3
4
5
6
7
8

appManager.unregisterApplicationStateObserver8+

unregisterApplicationStateObserver(observerId: number): Promise<void>;

取消注册应用程序状态观测器。

需要权限:ohos.permission.RUNNING_STATE_OBSERVER

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

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

返回值:

类型 说明
Promise<void> 返回执行结果。

示例:

var observerId = 100;

appManager.unregisterApplicationStateObserver(observerId)
.then((data) => {
    console.log('----------- unregisterApplicationStateObserver success ----------', data);
})
.catch((err) => {
    console.log('----------- unregisterApplicationStateObserver fail ----------', err);
})
1
2
3
4
5
6
7
8
9

appManager.getForegroundApplications8+

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

获取所有当前处于前台的应用信息。该应用信息由AppStateData定义。

需要权限:ohos.permission.GET_RUNNING_INFO

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

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

示例:

function getForegroundApplicationsCallback(err, data) {
  if (err) {
      console.log('--------- getForegroundApplicationsCallback fail ---------', err);
  } else {
      console.log('--------- getForegroundApplicationsCallback success ---------', data)
  }
}
appManager.getForegroundApplications(getForegroundApplicationsCallback);
1
2
3
4
5
6
7
8

appManager.getForegroundApplications8+

getForegroundApplications(): Promise<Array<AppStateData>>;

获取所有当前处于前台的应用信息。该应用信息由AppStateData定义。

需要权限:ohos.permission.GET_RUNNING_INFO

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

系统API:该接口为系统接口,三方应用不支持调用。

返回值:

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

示例:

appManager.getForegroundApplications()
.then((data) => {
    console.log('--------- getForegroundApplications success -------', data);
})
.catch((err) => {
    console.log('--------- getForegroundApplications fail -------', err);
})
1
2
3
4
5
6
7

appManager.killProcessWithAccount8+

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

切断account进程(Promise形式)。

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

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

系统API: 此接口为系统接口,三方应用不支持调用。

参数:

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

示例:

var bundleName = 'bundleName';
var accountId = 0;
appManager.killProcessWithAccount(bundleName, accountId)
   .then((data) => {
       console.log('------------ killProcessWithAccount success ------------', data);
   })
   .catch((err) => {
       console.log('------------ killProcessWithAccount fail ------------', err);
   })
1
2
3
4
5
6
7
8
9

appManager.killProcessWithAccount8+

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

切断account进程(callback形式)。

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

系统API: 此接口为系统接口,三方应用不支持调用。

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

参数:

参数名 类型 必填 说明
bundleName string 应用Bundle名称。
accountId number 系统帐号的帐号ID,详情参考getCreatedOsAccountsCount
callback AsyncCallback<void> 切断account进程的回调函数。

示例:

var bundleName = 'bundleName';
var accountId = 0;
function killProcessWithAccountCallback(err, data) {
   if (err) {
       console.log('------------- killProcessWithAccountCallback fail, err: --------------', err);
   } else {
       console.log('------------- killProcessWithAccountCallback success, data: --------------', data);
   }
}
appManager.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);
1
2
3
4
5
6
7
8
9
10

appManager.killProcessesByBundleName8+

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

通过Bundle名称终止进程。

需要权限:ohos.permission.CLEAN_BACKGROUND_PROCESSES

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

参数名 类型 必填 说明
bundleName string 表示Bundle名称。
callback AsyncCallback<void> 表示指定的回调方法。

示例:

var bundleName = 'bundleName';
function killProcessesByBundleNameCallback(err, data) {
  if (err) {
      console.log('------------- killProcessesByBundleNameCallback fail, err: --------------', err);
  } else {
      console.log('------------- killProcessesByBundleNameCallback success, data: --------------', data);
  }
}
appManager.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);
1
2
3
4
5
6
7
8
9

appManager.killProcessesByBundleName8+

killProcessesByBundleName(bundleName: string): Promise<void>;

通过Bundle名称终止进程。

需要权限:ohos.permission.CLEAN_BACKGROUND_PROCESSES

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

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

返回值:

类型 说明
Promise<void> 返回执行结果。

示例:

var bundleName = 'com.example.myapplication';
appManager.killProcessesByBundleName(bundleName)
  .then((data) => {
      console.log('------------ killProcessesByBundleName success ------------', data);
  })
  .catch((err) => {
      console.log('------------ killProcessesByBundleName fail ------------', err);
  })
1
2
3
4
5
6
7
8

appManager.clearUpApplicationData8+

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

通过Bundle名称清除应用数据。

需要权限:ohos.permission.CLEAN_APPLICATION_DATA

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

参数名 类型 必填 说明
bundleName string 表示Bundle名称。
callback AsyncCallback<void> 表示指定的回调方法。

示例:

var bundleName = 'bundleName';
function clearUpApplicationDataCallback(err, data) {
  if (err) {
      console.log('------------- clearUpApplicationDataCallback fail, err: --------------', err);
  } else {
      console.log('------------- clearUpApplicationDataCallback success, data: --------------', data);
  }
}
appManager.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);
1
2
3
4
5
6
7
8
9

appManager.clearUpApplicationData8+

clearUpApplicationData(bundleName: string): Promise<void>;

通过Bundle名称清除应用数据。

需要权限:ohos.permission.CLEAN_APPLICATION_DATA

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

系统API:该接口为系统接口,三方应用不支持调用。

参数:

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

返回值:

类型 说明
Promise<void> 返回执行结果。

示例:

var bundleName = 'bundleName';
appManager.clearUpApplicationData(bundleName)
  .then((data) => {
      console.log('------------ clearUpApplicationData success ------------', data);
  })
  .catch((err) => {
      console.log('------------ clearUpApplicationData fail ------------', err);
  })
1
2
3
4
5
6
7
8

ApplicationState9+

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

系统API: 此接口为系统接口,三方应用不支持调用。

名称 说明
STATE_CREATE 1 当应用在创建中的时候处于的状态。
STATE_FOREGROUND 2 当应用切换到前台的时候处于的状态。
STATE_ACTIVE 3 当应用在获焦的时候处于的状态。
STATE_BACKGROUND 4 当应用处于后台不可见时处于的状态。
STATE_DESTROY 5 当应用在销毁的时候处于的状态。

ProcessState9+

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

系统API: 此接口为系统接口,三方应用不支持调用。

名称 说明
STATE_CREATE 1 当进程在创建中的时候处于的状态。
STATE_FOREGROUND 2 当进程切换到前台的时候处于的状态。
STATE_ACTIVE 3 当进程在获焦的时候处于的状态。
STATE_BACKGROUND 4 当进程处于后台不可见时处于的状态。
STATE_DESTROY 5 当进程在销毁的时候处于的状态。