BatteryState

Kotlin |Java

abstract class BatteryState

kotlin.Any
↳	android.hardware.BatteryState

The BatteryState class is a representation of a single battery on a device.

Summary

Constants
static Int	`STATUS_CHARGING` Battery is charging.
static Int	`STATUS_DISCHARGING` Battery is discharging.
static Int	`STATUS_FULL` Battery is full.
static Int	`STATUS_NOT_CHARGING` Battery is connected to power but not charging.
static Int	`STATUS_UNKNOWN` Battery status is unknown.

Public constructors
`BatteryState()`

Public methods
abstract Float	`getCapacity()` Get remaining battery capacity as float percentage [0.
abstract Int	`getStatus()` Get the battery status.
abstract Boolean	`isPresent()` Check whether the hardware has a battery.

static val STATUS_CHARGING: Int

Battery is charging.

Value: 2

static val STATUS_DISCHARGING: Int

Battery is discharging.

Value: 3

static val STATUS_FULL: Int

Battery is full.

Value: 5

static val STATUS_NOT_CHARGING: Int

Battery is connected to power but not charging.

Value: 4

static val STATUS_UNKNOWN: Int

Battery status is unknown.

Value: 1

BatteryState()

abstract fun getCapacity(): Float

Get remaining battery capacity as float percentage [0.0f, 1.0f] of total capacity Returns NaN when battery capacity can't be read.

Return
`Float`	the battery capacity. Value is between -1.0f and 1.0f inclusive

abstract fun getStatus(): Int

Get the battery status.

Return
`Int`	the battery status. Value is `android.hardware.BatteryState#STATUS_UNKNOWN`, `android.hardware.BatteryState#STATUS_CHARGING`, `android.hardware.BatteryState#STATUS_DISCHARGING`, `android.hardware.BatteryState#STATUS_NOT_CHARGING`, or `android.hardware.BatteryState#STATUS_FULL`

abstract fun isPresent(): Boolean

Check whether the hardware has a battery.

Return
`Boolean`	True if the hardware has a battery, else false.