BatteryReport BatteryReport BatteryReport BatteryReport Class

Definition

Provides properties that indicate the charge, capacity, and status of the battery. For more info, see Get battery information.

public : sealed class BatteryReport : IBatteryReportpublic sealed class BatteryReport : IBatteryReportPublic NotInheritable Class BatteryReport Implements IBatteryReport// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

All properties in BatteryReport will return null when the battery is not present or the value is not reported by the battery controller.

Properties

ChargeRateInMilliwatts ChargeRateInMilliwatts ChargeRateInMilliwatts ChargeRateInMilliwatts

Gets the rate that the battery is charging.

public : IReference<int> ChargeRateInMilliwatts { get; }public Nullable<int> ChargeRateInMilliwatts { get; }Public ReadOnly Property ChargeRateInMilliwatts As Nullable<int>// You can use this property in JavaScript.
Value
IReference<int> Nullable<int> Nullable<int> Nullable<int>

The rate that the battery is charging in milliwatts (mW). This value is negative when the battery is discharging.

See Also

DesignCapacityInMilliwattHours DesignCapacityInMilliwattHours DesignCapacityInMilliwattHours DesignCapacityInMilliwattHours

Gets the estimated energy capacity of a new battery of this type.

public : IReference<int> DesignCapacityInMilliwattHours { get; }public Nullable<int> DesignCapacityInMilliwattHours { get; }Public ReadOnly Property DesignCapacityInMilliwattHours As Nullable<int>// You can use this property in JavaScript.
Value
IReference<int> Nullable<int> Nullable<int> Nullable<int>

The estimated energy capacity of a new battery of this type, in milliwatt-hours (mWh).

Remarks

This property is not supported by all battery controllers. Some battery controllers might return the same value as FullChargeCapacityInMilliwattHours or return no value at all.

When this property is supported, the capacity ratio is the ratio of FullChargeCapacityInMilliwattHours to DesignCapacityInMilliwattHours. FullChargeCapacityInMilliwattHours is used in this way because the full charge capacity typically changes with battery wear.

See Also

FullChargeCapacityInMilliwattHours FullChargeCapacityInMilliwattHours FullChargeCapacityInMilliwattHours FullChargeCapacityInMilliwattHours

Gets the fully-charged energy capacity of the battery.

public : IReference<int> FullChargeCapacityInMilliwattHours { get; }public Nullable<int> FullChargeCapacityInMilliwattHours { get; }Public ReadOnly Property FullChargeCapacityInMilliwattHours As Nullable<int>// You can use this property in JavaScript.
Value
IReference<int> Nullable<int> Nullable<int> Nullable<int>

The fully-charged energy capacity of the battery, in milliwatt-hours (mWh).

Note: Some devices report their battery capacity in milliamp-hours (mAh) instead of mWh. As a rough heuristic, if the value reported is lower than 4400 it is likely represented in mAh, otherwise it is in mWh.

Remarks

FullChargeCapacityInMilliwattHours is used by the capacity ratio to estimate battery health.

See Also

RemainingCapacityInMilliwattHours RemainingCapacityInMilliwattHours RemainingCapacityInMilliwattHours RemainingCapacityInMilliwattHours

Gets the remaining power capacity of the battery.

public : IReference<int> RemainingCapacityInMilliwattHours { get; }public Nullable<int> RemainingCapacityInMilliwattHours { get; }Public ReadOnly Property RemainingCapacityInMilliwattHours As Nullable<int>// You can use this property in JavaScript.
Value
IReference<int> Nullable<int> Nullable<int> Nullable<int>

The remaining power capacity of the battery, in milliwatt-hours.

Remarks

To calculate the battery level, divide RemainingCapacityInMilliwattHours by FullChargeCapacityInMilliwattHours.

See Also

Status Status Status Status

Gets a BatteryStatus enumeration that indicates the status of the battery.

public : BatteryStatus Status { get; }public BatteryStatus Status { get; }Public ReadOnly Property Status As BatteryStatus// You can use this property in JavaScript.
Value
BatteryStatus BatteryStatus BatteryStatus BatteryStatus

A BatteryStatus enumeration that indicates the status of the battery.

See Also

See Also