# @ohos.app.ability.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 initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import ```ts import appManager from '@ohos.app.ability.appManager'; ``` ## appManager.isRunningInStabilityTest9+ 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | Yes| Callback used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| **Example** ```ts import app from '@ohos.application.appManager'; app.isRunningInStabilityTest((err, flag) => { console.log('startAbility result:' + JSON.stringify(err)); }) ``` ## appManager.isRunningInStabilityTest9+ 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** | Type| Description| | -------- | -------- | | Promise<boolean> | Promise used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| **Example** ```ts 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\; 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** | Type| Description| | -------- | -------- | | Promise<boolean> | Promise used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| **Example** ```ts app.isRamConstrainedDevice().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); ``` ## appManager.isRamConstrainedDevice isRamConstrainedDevice(callback: AsyncCallback\): 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<boolean> | Yes| Callback used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| **Example** ```ts app.isRamConstrainedDevice((err, data) => { console.log('startAbility result failed:' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) ``` ## appManager.getAppMemorySize getAppMemorySize(): Promise\; Obtains the memory size of this application. This API uses a promise to return the result. **System capability**: SystemCapability.Ability.AbilityRuntime.Core **Return value** | Type| Description| | -------- | -------- | | Promise<number> | Size of the application memory.| **Example** ```ts app.getAppMemorySize().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); ``` ## appManager.getAppMemorySize getAppMemorySize(callback: AsyncCallback\): 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<number> | Yes| Size of the application memory.| **Example** ```ts app.getAppMemorySize((err, data) => { console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) ``` ## appManager.getProcessRunningInformation9+ getProcessRunningInformation(): Promise\>; Obtains information about the running processes. This API uses a promise to return the result. **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** | Type| Description| | -------- | -------- | | Promise\> | Promise used to return the process information.| **Example** ```ts app.getProcessRunningInformation().then((data) => { console.log('success:' + JSON.stringify(data)); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); ``` ## appManager.getProcessRunningInformation9+ getProcessRunningInformation(callback: AsyncCallback\>): void; Obtains information about the running processes. This API uses an asynchronous callback to return the result. **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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback\> | Yes| Callback used to return the process information.| **Example** ```ts app.getProcessRunningInformation((err, data) => { console.log('startAbility result failed :' + JSON.stringify(err)); console.log('startAbility result success:' + JSON.stringify(data)); }) ``` ## appManager.on on(type: "applicationState", 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Type of the API to call.| | observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | Yes| Numeric code of the observer.| **Example** ```js 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); } } try { const observerCode = app.on(applicationStateObserver); console.log('-------- observerCode: ---------', observerCode); } catch (paramError) { console.log('error: ' + paramError.code + ', ' + paramError.message); } ``` ## appManager.on on(type: "applicationState", observer: ApplicationStateObserver, bundleNameList: Array\): number; Registers an observer to listen for the state changes of a specified application. **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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Type of the API to call.| | observer | [ApplicationStateObserver](./js-apis-inner-application-applicationStateObserver.md) | Yes| Numeric code of the observer.| | bundleNameList | Array | Yes| **bundleName** array of the application. A maximum of 128 bundle names can be passed.| **Example** ```js 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']; try { const observerCode = app.on("applicationState", applicationStateObserver, bundleNameList); console.log('-------- observerCode: ---------', observerCode); } catch (paramError) { console.log('error: ' + paramError.code + ', ' + paramError.message); } ``` ## appManager.off off(type: "applicationState", observerId: number, callback: AsyncCallback\): 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Type of the API to call.| | observerId | number | Yes| Numeric code of the observer.| | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** ```js var observerId = 100; function unregisterApplicationStateObserverCallback(err) { if (err) { console.log('------------ unregisterApplicationStateObserverCallback ------------', err); } } try { app.off(observerId, unregisterApplicationStateObserverCallback); } catch (paramError) { console.log('error: ' + paramError.code + ', ' + paramError.message); } ``` ## appManager.off off(type: "applicationState", observerId: number): Promise\; 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Type of the API to call.| | observerId | number | Yes| Numeric code of the observer.| **Return value** | Type| Description| | -------- | -------- | | Promise\ | Promise used to return the result.| **Example** ```js var observerId = 100; try { app.off(observerId) .then((data) => { console.log('----------- unregisterApplicationStateObserver success ----------', data); }) .catch((err) => { console.log('----------- unregisterApplicationStateObserver fail ----------', err); }) } catch (paramError) { console.log('error: ' + paramError.code + ', ' + paramError.message); } ``` ## appManager.getForegroundApplications getForegroundApplications(callback: AsyncCallback\>): void; Obtains applications that are running in the foreground. This API uses an asynchronous callback to return the result. **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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback\> | Yes| Callback used to return the application state data.| **Example** ```js function getForegroundApplicationsCallback(err, data) { if (err) { console.log('--------- getForegroundApplicationsCallback fail ---------', err.code + ': ' + err.message); } else { console.log('--------- getForegroundApplicationsCallback success ---------', data) } } app.getForegroundApplications(getForegroundApplicationsCallback); ``` unregisterApplicationStateObserver(observerId: number): Promise\; 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | observerId | number | Yes| Numeric code of the observer.| **Return value** | Type| Description| | -------- | -------- | | Promise\ | Promise used to return the result.| **Example** ```ts var observerId = 100; app.unregisterApplicationStateObserver(observerId) .then((data) => { console.log('----------- unregisterApplicationStateObserver success ----------', data); }) .catch((err) => { console.log('----------- unregisterApplicationStateObserver fail ----------', err); }) ``` ## appManager.getForegroundApplications9+ getForegroundApplications(callback: AsyncCallback\>): void; Obtains applications that are running in the foreground. This API uses an asynchronous callback to return the result. **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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback\> | Yes| Callback used to return the application state data.| **Example** ```ts function getForegroundApplicationsCallback(err, data) { if (err) { console.log('--------- getForegroundApplicationsCallback fail ---------', err); } else { console.log('--------- getForegroundApplicationsCallback success ---------', data) } } app.getForegroundApplications(getForegroundApplicationsCallback); ``` ## appManager.getForegroundApplications9+ getForegroundApplications(): Promise\>; Obtains applications that are running in the foreground. This API uses a promise to return the result. **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** | Type| Description| | -------- | -------- | | Promise\> | Promise used to return the application state data.| **Example** ```ts app.getForegroundApplications() .then((data) => { console.log('--------- getForegroundApplications success -------', data); }) .catch((err) => { console.log('--------- getForegroundApplications fail -------', err); }) ``` ## appManager.killProcessWithAccount9+ killProcessWithAccount(bundleName: string, accountId: number): Promise\ 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| | accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| **Example** ```ts var bundleName = 'bundleName'; var accountId = 0; app.killProcessWithAccount(bundleName, accountId) .then((data) => { console.log('------------ killProcessWithAccount success ------------', data); }) .catch((err) => { console.log('------------ killProcessWithAccount fail ------------', err); }) ``` ## appManager.killProcessWithAccount9+ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback\): 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| | accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** ```ts 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); } } app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback); ``` ## appManager.killProcessesByBundleName9+ killProcessesByBundleName(bundleName: string, callback: AsyncCallback\); 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** ```ts var 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.killProcessesByBundleName9+ killProcessesByBundleName(bundleName: string): Promise\; 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| **Return value** | Type| Description| | -------- | -------- | | Promise\ | Promise used to return the result.| **Example** ```ts var bundleName = 'bundleName'; app.killProcessesByBundleName(bundleName) .then((data) => { console.log('------------ killProcessesByBundleName success ------------', data); }) .catch((err) => { console.log('------------ killProcessesByBundleName fail ------------', err); }) ``` ## appManager.clearUpApplicationData9+ clearUpApplicationData(bundleName: string, callback: AsyncCallback\); 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** ```ts var 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.clearUpApplicationData9+ clearUpApplicationData(bundleName: string): Promise\; 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** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | bundleName | string | Yes| Bundle name of an application.| **Return value** | Type| Description| | -------- | -------- | | Promise\ | Promise used to return the result.| **Example** ```ts var bundleName = 'bundleName'; app.clearUpApplicationData(bundleName) .then((data) => { console.log('------------ clearUpApplicationData success ------------', data); }) .catch((err) => { console.log('------------ clearUpApplicationData fail ------------', err); }) ``` ## ApplicationState9+ **System capability**: SystemCapability.Ability.AbilityRuntime.Core **System API**: This is a system API and cannot be called by third-party applications. | Name | Value | Description | | -------------------- | --- | --------------------------------- | | STATE_CREATE | 1 | State indicating that the application is being created. | | STATE_FOREGROUND | 2 | State indicating that the application is running in the foreground. | | STATE_ACTIVE | 3 | State indicating that the application is active. | | STATE_BACKGROUND | 4 | State indicating that the application is running in the background. | | STATE_DESTROY | 5 | State indicating that the application is destroyed. | ## ProcessState9+ **System capability**: SystemCapability.Ability.AbilityRuntime.Core **System API**: This is a system API and cannot be called by third-party applications. | Name | Value | Description | | -------------------- | --- | --------------------------------- | | STATE_CREATE | 1 | State indicating that the process is being created. | | STATE_FOREGROUND | 2 | State indicating that the process is running in the foreground. | | STATE_ACTIVE | 3 | State indicating that the process is active. | | STATE_BACKGROUND | 4 | State indicating that the process is running in the background. | | STATE_DESTROY | 5 | State indicating that the process is destroyed. |