@ohos.application.appManager (appManager)

The appManager module implements application management. You can use the APIs of this module to query whether the application is undergoing a stability test, whether the application is running on a RAM constrained device, the memory size of the application, and information about the running process.

NOTE

The APIs of this module are supported since API version 7 and deprecated since API version 9. You are advised to use @ohos.app.ability.appManager instead. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

appManager.isRunningInStabilityTest⁸⁺

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

Checks whether this application is undergoing a stability test. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

import app from '@ohos.application.appManager';
app.isRunningInStabilityTest((err, flag) => {
    console.log('startAbility result:' + JSON.stringify(err));
});

appManager.isRunningInStabilityTest⁸⁺

static isRunningInStabilityTest(): Promise<boolean>

Checks whether this application is undergoing a stability test. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Example

import app from '@ohos.application.appManager';
app.isRunningInStabilityTest().then((flag) => {
    console.log('success:' + JSON.stringify(flag));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

appManager.isRamConstrainedDevice

isRamConstrainedDevice(): Promise<boolean>;

Checks whether this application is running on a RAM constrained device. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Example

app.isRamConstrainedDevice().then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

appManager.isRamConstrainedDevice

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

Checks whether this application is running on a RAM constrained device. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

app.isRamConstrainedDevice((err, data) => {
    console.log('startAbility result failed:' + JSON.stringify(err));
    console.log('startAbility result success:' + JSON.stringify(data));
});

appManager.getAppMemorySize

getAppMemorySize(): Promise<number>;

Obtains the memory size of this application. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Example

app.getAppMemorySize().then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

appManager.getAppMemorySize

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

Obtains the memory size of this application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

app.getAppMemorySize((err, data) => {
    console.log('startAbility result failed :' + JSON.stringify(err));
    console.log('startAbility result success:' + JSON.stringify(data));
});

appManager.getProcessRunningInfos^(deprecated)

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

Obtains information about the running processes. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use appManager.getRunningProcessInformation⁹⁺ instead.

Required permissions: ohos.permission.GET_RUNNING_INFO

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Example

app.getProcessRunningInfos().then((data) => {
    console.log('success:' + JSON.stringify(data));
}).catch((error) => {
    console.log('failed:' + JSON.stringify(error));
});

appManager.getProcessRunningInfos^(deprecated)

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

Obtains information about the running processes. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use appManager.getRunningProcessInformation⁹⁺ instead.

Required permissions: ohos.permission.GET_RUNNING_INFO

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Example

app.getProcessRunningInfos((err, data) => {
    console.log('startAbility result failed :' + JSON.stringify(err));
    console.log('startAbility result success:' + JSON.stringify(data));
});

appManager.registerApplicationStateObserver⁸⁺

registerApplicationStateObserver(observer: ApplicationStateObserver): number;

Registers an observer to listen for the state changes of all applications.

Required permissions: ohos.permission.RUNNING_STATE_OBSERVER

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

let 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 = app.registerApplicationStateObserver(applicationStateObserver);
console.log('-------- observerCode: ---------', observerCode);

appManager.unregisterApplicationStateObserver⁸⁺

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

Deregisters the application state observer. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.RUNNING_STATE_OBSERVER

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

let observerId = 100;

function unregisterApplicationStateObserverCallback(err) {
  if (err) {
      console.log('------------ unregisterApplicationStateObserverCallback ------------', err);
  }
}
app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);

appManager.unregisterApplicationStateObserver⁸⁺

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

Deregisters the application state observer. This API uses a promise to return the result.

Required permissions: ohos.permission.RUNNING_STATE_OBSERVER

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

let observerId = 100;

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

appManager.getForegroundApplications⁸⁺

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

Obtains information about the applications that are running in the foreground. This API uses an asynchronous callback to return the result. The application information is defined by AppStateData.

Required permissions: ohos.permission.GET_RUNNING_INFO

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

function getForegroundApplicationsCallback(err, data) {
  if (err) {
      console.log('--------- getForegroundApplicationsCallback fail ---------', err);
  } else {
      console.log('--------- getForegroundApplicationsCallback success ---------', data)
  }
}
app.getForegroundApplications(getForegroundApplicationsCallback);

appManager.getForegroundApplications⁸⁺

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

Obtains information about the applications that are running in the foreground. This API uses a promise to return the result. The application information is defined by AppStateData.

Required permissions: ohos.permission.GET_RUNNING_INFO

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Return value

Example

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

appManager.killProcessWithAccount⁸⁺

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

Kills a process by bundle name and account ID. This API uses a promise to return the result.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

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

appManager.killProcessWithAccount⁸⁺

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

Kills a process by bundle name and account ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Required permissions: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS and ohos.permission.CLEAN_BACKGROUND_PROCESSES

Parameters

Example

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

appManager.killProcessesByBundleName⁸⁺

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

Kills a process by bundle name. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CLEAN_BACKGROUND_PROCESSES

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

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

appManager.killProcessesByBundleName⁸⁺

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

Kills a process by bundle name. This API uses a promise to return the result.

Required permissions: ohos.permission.CLEAN_BACKGROUND_PROCESSES

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

let bundleName = 'bundleName';
app.killProcessesByBundleName(bundleName)
  .then((data) => {
      console.log('------------ killProcessesByBundleName success ------------', data);
  })
  .catch((err) => {
      console.log('------------ killProcessesByBundleName fail ------------', err);
  });

appManager.clearUpApplicationData⁸⁺

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

Clears application data by bundle name. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.CLEAN_APPLICATION_DATA

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

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

appManager.clearUpApplicationData⁸⁺

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

Clears application data by bundle name. This API uses a promise to return the result.

Required permissions: ohos.permission.CLEAN_APPLICATION_DATA

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

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