ProcessInformation

The ProcessInformation module defines the running information of a 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

import { appManager } from '@kit.AbilityKit';

Properties

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Type	Read-Only	Optional	Description
pid	number	No	No	Process ID. Atomic service API: This API can be used in atomic services since API version 11.
uid	number	No	No	User ID. Atomic service API: This API can be used in atomic services since API version 11.
processName	string	No	No	Process name. Atomic service API: This API can be used in atomic services since API version 11.
bundleNames	Array<string>	No	No	Names of all running bundles in the process. Atomic service API: This API can be used in atomic services since API version 11.
state¹⁰⁺	appManager.ProcessState	No	No	Running status of the process. Atomic service API: This API can be used in atomic services since API version 11.
bundleType¹²⁺	bundleManager.BundleType	No	No	Type of the bundle running in the process. Atomic service API: This API can be used in atomic services since API version 12.
appCloneIndex¹²⁺	number	No	Yes	Index of an application clone. Atomic service API: This API can be used in atomic services since API version 12.

How to Use

The process information is obtained by calling getRunningProcessInformation of the appManager module.

Example

import { appManager } from '@kit.AbilityKit';

appManager.getRunningProcessInformation((error, data) => {
  if (error) {
    console.error(`getRunningProcessInformation fail, error: ${JSON.stringify(error)}`);
  } else {
    console.log(`getRunningProcessInformation success, data: ${JSON.stringify(data)}`);
  }
});