AppStateData (System API)

The AppStateData module defines the application state data, which can be obtained through getForegroundApplications.

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs provided by this module are system APIs.

Modules to Import

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

Attributes

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This module is marked as @systemapi and not visible to third-party applications.

Name	Type	Mandatory	Description
bundleName⁸⁺	string	No	Bundle name.
uid⁸⁺	number	No	UID of the application.
state⁸⁺	number	No	Application state. 0: The application is being initialized. 1: The application has been initialized and is ready. 2: The application is running in the foreground. 3: The application is having the focus. (This state is reserved.) 4: The application is running in the background. 5: The application has exited.
isSplitScreenMode¹¹⁺	boolean	No	Whether the application is in split-screen mode. true: The application is in split-screen mode. false: The application is not in split-screen mode.
isFloatingWindowMode¹¹⁺	boolean	No	Whether the application is in floating window mode. true: The application is in floating window mode. false: The application is not in floating window mode.

Example

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

function getForegroundAppInfos() {
    appManager.getForegroundApplications((error, data) => {
        if (error) {
            console.log(`getForegroundApplications failed, error.code: ${JSON.stringify(error.code)}, error.message: ${JSON.stringify(error.message)}`);
            return;
        }
        for (let i = 0; i < data.length; i++) {
            let appStateData = data[i];
            console.log(`appStateData.bundleName: ${appStateData.bundleName}`);
            console.log(`appStateData.uid: ${appStateData.uid}`);
            console.log(`appStateData.state: ${appStateData.state}`);
            console.log(`appStateData.isSplitScreenMode: ${appStateData.isSplitScreenMode}`);
            console.log(`appStateData.isFloatingWindowMode: ${appStateData.isFloatingWindowMode}`);
        }
    });
}