harmony 鸿蒙@ohos.batteryInfo (电量信息)(系统接口)

2025-06-12
浏览 (3)

@ohos.batteryInfo (电量信息)(系统接口)

该模块主要提供电池状态和充放电状态的查询接口。

说明：

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

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.batteryInfo (电量信息)。

导入模块

import {batteryInfo} from '@kit.BasicServicesKit';

batteryInfo.setBatteryConfig¹¹⁺

setBatteryConfig(sceneName: string, sceneValue: string): number

按场景名称设置电池配置。

系统接口： 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryManager.Core

参数：

参数名	类型	必填	说明
sceneName	string	是	设置场景名称；该参数必须为字符串类型。
sceneValue	string	是	设置场景的值；该参数必须为字符串类型。

返回值：

类型	说明
number	返回设置充电结果。返回0表示设置成功，返回非0表示设置失败。

错误码：

以下错误码的详细介绍请参见电量信息错误码和通用错误码。

错误码ID	错误信息
5100101	Failed to connect to the service.
401	Parameter error. Possible causes: 1.Incorrect parameter types.
202	Permission verification failed. A non-system application calls a system API.

示例：

  import {batteryInfo} from '@kit.BasicServicesKit';

  let sceneName = 'xxx';
  let sceneValue = '0';
  let result = batteryInfo.setBatteryConfig(sceneName, sceneValue);

  console.info("The result is: " + result);

batteryInfo.getBatteryConfig¹¹⁺

getBatteryConfig(sceneName: string): string

按场景名称查询电池配置。

系统接口： 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryManager.Core

参数：

参数名	类型	必填	说明
sceneName	string	是	设置场景名称；该参数必须为字符串类型。

返回值：

类型	说明
string	返回电池充电配置，否则返回”“。

错误码：

以下错误码的详细介绍请参见电量信息错误码和通用错误码。

错误码ID	错误信息
5100101	Failed to connect to the service.
401	Parameter error. Possible causes: 1.Incorrect parameter types.
202	Permission verification failed. A non-system application calls a system API.

示例：

  import {batteryInfo} from '@kit.BasicServicesKit';

  let sceneName = 'xxx';
  let result = batteryInfo.getBatteryConfig(sceneName);

  console.info("The result is: " + result);

batteryInfo.isBatteryConfigSupported¹¹⁺

isBatteryConfigSupported(sceneName: string): boolean

检查是否按场景名称启用电池配置。

系统接口： 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryManager.Core

参数：

参数名	类型	必填	说明
sceneName	string	是	设置场景名称；该参数必须为字符串类型。

返回值：

类型	说明
boolean	如果设备支持充电场景，则返回true，否则返回false。

错误码：

以下错误码的详细介绍请参见电量信息错误码和通用错误码。

错误码ID	错误信息
5100101	Failed to connect to the service.
401	Parameter error. Possible causes: 1.Incorrect parameter types.
202	Permission verification failed. A non-system application calls a system API.

示例：

  import {batteryInfo} from '@kit.BasicServicesKit';

  let sceneName = 'xxx';
  let result = batteryInfo.isBatteryConfigSupported(sceneName);

  console.info("The result is: " + result);

属性

描述电池信息。

系统能力：SystemCapability.PowerManager.BatteryManager.Core

名称	类型	只读	可选	说明
estimatedRemainingChargeTime⁹⁺	number	是	否	表示当前设备充满电的预估时间，单位毫秒。此接口为系统接口。
totalEnergy⁹⁺	number	是	否	表示当前设备电池的总容量，单位毫安时。此接口为系统接口。
remainingEnergy⁹⁺	number	是	否	表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口。

示例：

  import {batteryInfo} from '@kit.BasicServicesKit';

  let estimatedRemainingChargeTimeInfo: number = batteryInfo.estimatedRemainingChargeTime;
  console.info("The estimatedRemainingChargeTimeInfo is: " + estimatedRemainingChargeTimeInfo);

  let totalEnergyInfo: number = batteryInfo.totalEnergy;
  console.info("The totalEnergyInfo is: " + totalEnergyInfo);

  let remainingEnergyInfo: number = batteryInfo.remainingEnergy;
  console.info("The remainingEnergyInfo is: " + remainingEnergyInfo);