BackgroundEnergyManager BackgroundEnergyManager BackgroundEnergyManager BackgroundEnergyManager BackgroundEnergyManager Class

Definition

Provides information about your app's background energy usage.

public : static class BackgroundEnergyManager
static struct winrt::Windows::System::Power::BackgroundEnergyManager
public static class BackgroundEnergyManager
Public Shared Class BackgroundEnergyManager
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The energy usage of a background task is classified into one of these predefined levels, from lowest to highest energy consumption: LowUsageLevel, NearMaxAcceptableUsageLevel, MaxAcceptableUsageLevel, ExcessiveUsageLevel, NearTerminationUsageLevel, or TerminationUsageLevel.

Properties

ExcessiveUsageLevel ExcessiveUsageLevel ExcessiveUsageLevel ExcessiveUsageLevel ExcessiveUsageLevel

Gets the excessive usage level, expressed as a percentage of normal energy usage.

LowUsageLevel LowUsageLevel LowUsageLevel LowUsageLevel LowUsageLevel

Gets the low usage level, expressed as a percentage of normal energy consumption.

MaxAcceptableUsageLevel MaxAcceptableUsageLevel MaxAcceptableUsageLevel MaxAcceptableUsageLevel MaxAcceptableUsageLevel

Gets the maximum acceptable usage level, expressed as a percentage of normal energy consumption.

NearMaxAcceptableUsageLevel NearMaxAcceptableUsageLevel NearMaxAcceptableUsageLevel NearMaxAcceptableUsageLevel NearMaxAcceptableUsageLevel

Gets the near-maximum acceptable usage level, expressed as a percentage of normal energy usage.

NearTerminationUsageLevel NearTerminationUsageLevel NearTerminationUsageLevel NearTerminationUsageLevel NearTerminationUsageLevel

Gets the near-termination usage level, expressed as a percentage of normal energy usage.

RecentEnergyUsage RecentEnergyUsage RecentEnergyUsage RecentEnergyUsage RecentEnergyUsage

Gets the energy usage of the app's background task for the current 30 minute period, expressed as a percentage of normal.

RecentEnergyUsageLevel RecentEnergyUsageLevel RecentEnergyUsageLevel RecentEnergyUsageLevel RecentEnergyUsageLevel

Gets the nearest predefined energy level of the app's background task for the current 30 minute period, equal to LowUsageLevel, NearMaxAcceptableUsageLevel, MaxAcceptableUsageLevel, ExcessiveUsageLevel, NearTerminationUsageLevel, or TerminationUsageLevel.

TerminationUsageLevel TerminationUsageLevel TerminationUsageLevel TerminationUsageLevel TerminationUsageLevel

Gets the termination usage level, expressed as a percentage of normal energy usage.

Events

RecentEnergyUsageIncreased RecentEnergyUsageIncreased RecentEnergyUsageIncreased RecentEnergyUsageIncreased RecentEnergyUsageIncreased

Occurs when the background task's energy usage has increased significantly.

RecentEnergyUsageReturnedToLow RecentEnergyUsageReturnedToLow RecentEnergyUsageReturnedToLow RecentEnergyUsageReturnedToLow RecentEnergyUsageReturnedToLow

Occurs when the background task's energy usage has decreased to a low usage level.