当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
1.4K Star 7.4K Fork 8.2K

OpenHarmony/docs
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
js-apis-appmanager.md 17.22 KB
一键复制 编辑 原始数据 按行查看 历史

appManager

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

说明:

本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

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

appManager.isRunningInStabilityTest8+

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

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

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

参数:

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

示例:

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

appManager.isRunningInStabilityTest8+

static isRunningInStabilityTest(): Promise<boolean>

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

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

返回值:

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

示例:

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>;

查询是否为ram受限设备。

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

返回值:

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

示例:

      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;

查询是否为ram受限设备。

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

参数:

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

示例:

      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>;

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

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

返回值:

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

示例:

      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;

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

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

参数:

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

示例:

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

appManager.getProcessRunningInfos8+

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

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

需要权限:ohos.permission.GET_RUNNING_INFO

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

返回值:

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

示例:

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

appManager.getProcessRunningInfos8+

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

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

需要权限:ohos.permission.GET_RUNNING_INFO

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

参数:

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

示例:

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

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

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);
    }
  }
  app.unregisterApplicationStateObserver(observerId, unregisterApplicationStateObserverCallback);

appManager.unregisterApplicationStateObserver8+

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

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

需要权限:ohos.permission.RUNNING_STATE_OBSERVER

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

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

参数:

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

返回值:

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

示例:

  var observerId = 100;

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

appManager.getForegroundApplications8+

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

获取前台进程的应用程序。

需要权限:ohos.permission.GET_RUNNING_INFO

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

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

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<AppStateData>> 表示应用的状态数据。

示例:

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

appManager.getForegroundApplications8+

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

获取前台进程的应用程序。

需要权限:ohos.permission.GET_RUNNING_INFO

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

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

返回值:

类型 说明
Promise<Array<ProcessRunningInfo>> 返回进程运行信息的数组。

示例:

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

appManager.killProcessWithAccount8+

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

切断account进程(Promise形式)。

需要权限:ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

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

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

参数:

参数名 类型 必填 说明
bundleName string 应用包名。
accountId number account的Id。

示例:

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.killProcessWithAccount8+

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

切断account进程(callback形式)。

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

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

需要权限:ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS, ohos.permission.CLEAN_BACKGROUND_PROCESSES

参数:

参数名 类型 必填 说明
bundleName string 应用包名。
accountId number account的Id。
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);
   }
}
app.killProcessWithAccount(bundleName, accountId, killProcessWithAccountCallback);

appManager.killProcessesByBundleName8+

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

通过包名终止进程。

需要权限:ohos.permission.CLEAN_BACKGROUND_PROCESSES

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

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

参数:

参数名 类型 必填 说明
bundleName string 表示包名。
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);
    }
  }
  app.killProcessesByBundleName(bundleName, killProcessesByBundleNameCallback);

appManager.killProcessesByBundleName8+

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

通过包名终止进程。

需要权限:ohos.permission.CLEAN_BACKGROUND_PROCESSES

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

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

参数:

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

返回值:

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

示例:

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

appManager.clearUpApplicationData8+

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

通过包名清除应用数据。

需要权限:ohos.permission.CLEAN_APPLICATION_DATA

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

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

参数:

参数名 类型 必填 说明
bundleName string 表示包名。
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);
    }
  }
  app.clearUpApplicationData(bundleName, clearUpApplicationDataCallback);

appManager.clearUpApplicationData8+

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

通过包名清除应用数据。

需要权限:ohos.permission.CLEAN_APPLICATION_DATA

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

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

参数:

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

返回值:

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

示例:

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

ProcessRunningInfo

系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

名称 读写属性 类型 必填 描述
pid9+ 只读 number 进程ID。
uid9+ 只读 number 用户ID。
processName9+ 只读 string 进程的名称。
bundleNames9+ 只读 Array<string> 进程中运行的bundleName数组。
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
OpenHarmony-3.2-Beta1

搜索帮助