Added in API level 1

PowerManager

class PowerManager
kotlin.Any
   ↳ android.os.PowerManager

This class lets you query and request control of aspects of the device's power state.

Summary

Nested classes
abstract

Listener passed to android.

A wake lock is a mechanism to indicate that your application needs to have the device stay on.
abstract

A listener interface to get notified when the wakelock is enabled/disabled.
Constants
static Int

Wake lock flag: Turn the screen on when the wake lock is acquired.
static String

Intent that is broadcast when the state of isDeviceIdleMode() changes.
static String

Intent that is broadcast when the state of isDeviceLightIdleMode() changes.
static String

Intent that is broadcast when Low Power Standby is enabled or disabled.
static String

Intent that is broadcast when Low Power Standby policy is changed.
static String

Intent that is broadcast when the state of isPowerSaveMode() changes.
static String

Signals that wake-on-lan/wake-on-wlan is allowed in Low Power Standby.
static Int

Wake lock level: Ensures that the screen and keyboard backlight are on at full brightness.
static Int

All location providers should be disabled when battery saver is on and the device is non-interactive.
static Int

In this mode, all the location providers will be kept available, but location fixes should only be provided to foreground apps.
static Int

In this mode, the GPS based location provider should be disabled when battery saver is on and the device is non-interactive.
static Int

Either the location providers shouldn't be affected by battery saver, or battery saver is off.
static Int

In this mode, location will not be turned off, but LocationManager will throttle all requests to providers when the device is non-interactive.
static Int

Exempts apps with ongoing calls.
static Int

Exempts apps on the temporary powersave allowlist.
static Int

Exempts active Voice Interaction Sessions in Low Power Standby.
static Int

Wake lock flag: When this wake lock is released, poke the user activity timer so the screen stays on for a little longer.
static Int

Wake lock level: Ensures that the CPU is running; the screen and keyboard backlight will be allowed to go off.
static Int

Wake lock level: Turns the screen off when the proximity sensor activates.
static Int

Flag for android.
static Int

Wake lock level: Ensures that the screen is on at full brightness; the keyboard backlight will be allowed to go off.
static Int

Wake lock level: Ensures that the screen is on (but may be dimmed); the keyboard backlight will be allowed to go off.
static Int

Thermal status code: Platform has done everything to reduce power.
static Int

Thermal status code: Key components in platform are shutting down due to thermal condition.
static Int

Thermal status code: Light throttling where UX is not impacted.
static Int

Thermal status code: Moderate throttling where UX is not largely impacted.
static Int

Thermal status code: Not under throttling.
static Int

Thermal status code: Severe throttling where UX is largely impacted.
static Int

Thermal status code: Need shutdown immediately.
Public methods
Unit

This function adds a listener for thermal status change, listen call back will be enqueued tasks on the main thread
Unit

This function adds a listener for thermal status change.
Duration?

Returns the current battery life remaining estimate.
Int

This function returns the current thermal status of the device.
Int

Returns how location features should behave when battery saver is on.
Float
getThermalHeadroom(forecastSeconds: Int)

Provides an estimate of how much thermal headroom the device currently has before hitting severe throttling.
MutableMap<Int!, Float!>

Gets the thermal headroom thresholds for all available thermal throttling status above THERMAL_STATUS_NONE.
Boolean

Returns true if Low Power Standby is disabled (so Low Power Standby does not restrict apps), or apps may be automatically exempt from Low Power Standby restrictions for the given reason.
Boolean

Returns true if Low Power Standby is disabled (so Low Power Standby does not restrict apps), or apps are allowed to use a given feature during Low Power Standby.
Boolean

Returns whether the current battery life remaining estimate is personalized based on device usage history or not.
Boolean

Returns true if the device is currently in idle mode.
Boolean

Returns true if the device is currently in light idle mode.
Boolean

Returns true if the calling package is exempt from Low Power Standby restrictions or Low Power Standby is disabled (so Low Power Standby does not restrict apps), false otherwise.
Boolean

Return whether the given application package name is on the device's power allowlist.
Boolean

Returns true if the device is in an interactive state.
Boolean

Returns true if Low Power Standby is enabled.
Boolean

Returns true if the device is currently in power save mode.
Boolean

Returns true if this device supports rebooting userspace.
Boolean

Returns true if the device is in an interactive state.
Boolean

This function checks if the device has implemented Sustained Performance Mode.
Boolean

Returns true if the specified wake lock level is supported.
PowerManager.WakeLock!
newWakeLock(levelAndFlags: Int, tag: String!)

Creates a new wake lock with the specified level and flags.
Unit
reboot(reason: String?)

Reboot the device.
Unit

This function removes a listener for thermal status change

Constants

ACQUIRE_CAUSES_WAKEUP

Added in API level 1
Deprecated in API level 33
static val ACQUIRE_CAUSES_WAKEUP: Int

Deprecated: Most applications should use android.R.attr#turnScreenOn or android.app.Activity#setTurnScreenOn(boolean) instead, as this prevents the previous foreground app from being resumed first when the screen turns on.

Wake lock flag: Turn the screen on when the wake lock is acquired.

This flag will require android.Manifest.permission#TURN_SCREEN_ON in future releases.

Normally wake locks don't actually wake the device, they just cause the screen to remain on once it's already on. This flag will cause the device to wake up when the wake lock is acquired.

Android TV playback devices attempt to turn on the HDMI-connected TV via HDMI-CEC on any wake-up, including wake-ups triggered by wake locks.

Cannot be used with PARTIAL_WAKE_LOCK. 

Value: 268435456

ACTION_DEVICE_IDLE_MODE_CHANGED

Added in API level 23
static val ACTION_DEVICE_IDLE_MODE_CHANGED: String

Intent that is broadcast when the state of isDeviceIdleMode() changes. This broadcast is only sent to registered receivers.

Value: "android.os.action.DEVICE_IDLE_MODE_CHANGED"

ACTION_DEVICE_LIGHT_IDLE_MODE_CHANGED

Added in API level 33
static val ACTION_DEVICE_LIGHT_IDLE_MODE_CHANGED: String

Intent that is broadcast when the state of isDeviceLightIdleMode() changes. This broadcast is only sent to registered receivers.

Value: "android.os.action.LIGHT_DEVICE_IDLE_MODE_CHANGED"

ACTION_LOW_POWER_STANDBY_ENABLED_CHANGED

Added in API level 33
static val ACTION_LOW_POWER_STANDBY_ENABLED_CHANGED: String

Intent that is broadcast when Low Power Standby is enabled or disabled. This broadcast is only sent to registered receivers and receivers holding android.permission.MANAGE_LOW_POWER_STANDBY.

Value: "android.os.action.LOW_POWER_STANDBY_ENABLED_CHANGED"

ACTION_LOW_POWER_STANDBY_POLICY_CHANGED

Added in API level 34
static val ACTION_LOW_POWER_STANDBY_POLICY_CHANGED: String

Intent that is broadcast when Low Power Standby policy is changed. This broadcast is only sent to registered receivers and receivers holding android.permission.MANAGE_LOW_POWER_STANDBY.

Value: "android.os.action.LOW_POWER_STANDBY_POLICY_CHANGED"

ACTION_POWER_SAVE_MODE_CHANGED

Added in API level 21
static val ACTION_POWER_SAVE_MODE_CHANGED: String

Intent that is broadcast when the state of isPowerSaveMode() changes. This broadcast is only sent to registered receivers.

Value: "android.os.action.POWER_SAVE_MODE_CHANGED"

FEATURE_WAKE_ON_LAN_IN_LOW_POWER_STANDBY

Added in API level 34
static val FEATURE_WAKE_ON_LAN_IN_LOW_POWER_STANDBY: String

Signals that wake-on-lan/wake-on-wlan is allowed in Low Power Standby.

If Low Power Standby is enabled (isLowPowerStandbyEnabled()), wake-on-lan/wake-on-wlan may not be available while in standby. Use isAllowedInLowPowerStandby(java.lang.String) to determine whether the device allows this feature to be used during Low Power Standby with the currently active Low Power Standby policy.

Value: "com.android.lowpowerstandby.WAKE_ON_LAN"

FULL_WAKE_LOCK

Added in API level 1
Deprecated in API level 17
static val FULL_WAKE_LOCK: Int

Deprecated: Most applications should use android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON instead of this type of wake lock, as it will be correctly managed by the platform as the user moves between applications and doesn't require a special permission.

Wake lock level: Ensures that the screen and keyboard backlight are on at full brightness.

If the user presses the power button, then the FULL_WAKE_LOCK will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with PARTIAL_WAKE_LOCK. 

Value: 26

LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF

Added in API level 28
static val LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF: Int

All location providers should be disabled when battery saver is on and the device is non-interactive.

Value: 2

LOCATION_MODE_FOREGROUND_ONLY

Added in API level 28
static val LOCATION_MODE_FOREGROUND_ONLY: Int

In this mode, all the location providers will be kept available, but location fixes should only be provided to foreground apps.

Value: 3

LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF

Added in API level 28
static val LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF: Int

In this mode, the GPS based location provider should be disabled when battery saver is on and the device is non-interactive.

Value: 1

LOCATION_MODE_NO_CHANGE

Added in API level 28
static val LOCATION_MODE_NO_CHANGE: Int

Either the location providers shouldn't be affected by battery saver, or battery saver is off.

Value: 0

LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF

Added in API level 29
static val LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF: Int

In this mode, location will not be turned off, but LocationManager will throttle all requests to providers when the device is non-interactive.

Value: 4

LOW_POWER_STANDBY_ALLOWED_REASON_ONGOING_CALL

Added in API level 34
static val LOW_POWER_STANDBY_ALLOWED_REASON_ONGOING_CALL: Int

Exempts apps with ongoing calls.

This includes apps with foreground services of type "phoneCall".

Value: 4

LOW_POWER_STANDBY_ALLOWED_REASON_TEMP_POWER_SAVE_ALLOWLIST

Added in API level 34
static val LOW_POWER_STANDBY_ALLOWED_REASON_TEMP_POWER_SAVE_ALLOWLIST: Int

Exempts apps on the temporary powersave allowlist.

Value: 2

LOW_POWER_STANDBY_ALLOWED_REASON_VOICE_INTERACTION

Added in API level 34
static val LOW_POWER_STANDBY_ALLOWED_REASON_VOICE_INTERACTION: Int

Exempts active Voice Interaction Sessions in Low Power Standby.

Value: 1

ON_AFTER_RELEASE

Added in API level 1
static val ON_AFTER_RELEASE: Int

Wake lock flag: When this wake lock is released, poke the user activity timer so the screen stays on for a little longer.

This will not turn the screen on if it is not already on.

Cannot be used with PARTIAL_WAKE_LOCK. 

Value: 536870912

PARTIAL_WAKE_LOCK

Added in API level 1
static val PARTIAL_WAKE_LOCK: Int

Wake lock level: Ensures that the CPU is running; the screen and keyboard backlight will be allowed to go off.

If the user presses the power button, then the screen will be turned off but the CPU will be kept on until all partial wake locks have been released. 

Value: 1

PROXIMITY_SCREEN_OFF_WAKE_LOCK

Added in API level 21
static val PROXIMITY_SCREEN_OFF_WAKE_LOCK: Int

Wake lock level: Turns the screen off when the proximity sensor activates.

If the proximity sensor detects that an object is nearby, the screen turns off immediately. Shortly after the object moves away, the screen turns on again.

A proximity wake lock does not prevent the device from falling asleep unlike FULL_WAKE_LOCK, SCREEN_BRIGHT_WAKE_LOCK and SCREEN_DIM_WAKE_LOCK. If there is no user activity and no other wake locks are held, then the device will fall asleep (and lock) as usual. However, the device will not fall asleep while the screen has been turned off by the proximity sensor because it effectively counts as ongoing user activity.

Since not all devices have proximity sensors, use isWakeLockLevelSupported to determine whether this wake lock level is supported.

Cannot be used with ACQUIRE_CAUSES_WAKEUP. 

Value: 32

RELEASE_FLAG_WAIT_FOR_NO_PROXIMITY

Added in API level 21
static val RELEASE_FLAG_WAIT_FOR_NO_PROXIMITY: Int

Flag for android.os.PowerManager.WakeLock#release: Defer releasing a PROXIMITY_SCREEN_OFF_WAKE_LOCK wake lock until the proximity sensor indicates that an object is not in close proximity.

Value: 1

SCREEN_BRIGHT_WAKE_LOCK

Added in API level 1
Deprecated in API level 15
static val SCREEN_BRIGHT_WAKE_LOCK: Int

Deprecated: Most applications should use android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON instead of this type of wake lock, as it will be correctly managed by the platform as the user moves between applications and doesn't require a special permission.

Wake lock level: Ensures that the screen is on at full brightness; the keyboard backlight will be allowed to go off.

If the user presses the power button, then the SCREEN_BRIGHT_WAKE_LOCK will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with PARTIAL_WAKE_LOCK. 

Value: 10

SCREEN_DIM_WAKE_LOCK

Added in API level 1
Deprecated in API level 17
static val SCREEN_DIM_WAKE_LOCK: Int

Deprecated: Most applications should use android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON instead of this type of wake lock, as it will be correctly managed by the platform as the user moves between applications and doesn't require a special permission.

Wake lock level: Ensures that the screen is on (but may be dimmed); the keyboard backlight will be allowed to go off.

If the user presses the power button, then the SCREEN_DIM_WAKE_LOCK will be implicitly released by the system, causing both the screen and the CPU to be turned off. Contrast with PARTIAL_WAKE_LOCK. 

Value: 6

THERMAL_STATUS_CRITICAL

Added in API level 29
static val THERMAL_STATUS_CRITICAL: Int

Thermal status code: Platform has done everything to reduce power.

Value: 4

THERMAL_STATUS_EMERGENCY

Added in API level 29
static val THERMAL_STATUS_EMERGENCY: Int

Thermal status code: Key components in platform are shutting down due to thermal condition. Device functionalities will be limited.

Value: 5

THERMAL_STATUS_LIGHT

Added in API level 29
static val THERMAL_STATUS_LIGHT: Int

Thermal status code: Light throttling where UX is not impacted.

Value: 1

THERMAL_STATUS_MODERATE

Added in API level 29
static val THERMAL_STATUS_MODERATE: Int

Thermal status code: Moderate throttling where UX is not largely impacted.

Value: 2

THERMAL_STATUS_NONE

Added in API level 29
static val THERMAL_STATUS_NONE: Int

Thermal status code: Not under throttling.

Value: 0

THERMAL_STATUS_SEVERE

Added in API level 29
static val THERMAL_STATUS_SEVERE: Int

Thermal status code: Severe throttling where UX is largely impacted.

Value: 3

THERMAL_STATUS_SHUTDOWN

Added in API level 29
static val THERMAL_STATUS_SHUTDOWN: Int

Thermal status code: Need shutdown immediately.

Value: 6

Public methods

addThermalStatusListener

Added in API level 29
fun addThermalStatusListener(listener: PowerManager.OnThermalStatusChangedListener): Unit

This function adds a listener for thermal status change, listen call back will be enqueued tasks on the main thread

Parameters
listener PowerManager.OnThermalStatusChangedListener: listener to be added, This value cannot be null.

addThermalStatusListener

Added in API level 29
fun addThermalStatusListener(
    executor: Executor, 
    listener: PowerManager.OnThermalStatusChangedListener
): Unit

This function adds a listener for thermal status change.

Parameters
executor Executor: Executor to handle listener callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
listener PowerManager.OnThermalStatusChangedListener: listener to be added. This value cannot be null.

getBatteryDischargePrediction

Added in API level 31
fun getBatteryDischargePrediction(): Duration?

Returns the current battery life remaining estimate.

Return
Duration? The estimated battery life remaining as a Duration. Will be null if the device is powered, charging, or an error was encountered.

getCurrentThermalStatus

Added in API level 29
fun getCurrentThermalStatus(): Int

This function returns the current thermal status of the device.

Return
Int thermal status as int, THERMAL_STATUS_NONE if device in not under thermal throttling. Value is android.os.PowerManager#THERMAL_STATUS_NONE, android.os.PowerManager#THERMAL_STATUS_LIGHT, android.os.PowerManager#THERMAL_STATUS_MODERATE, android.os.PowerManager#THERMAL_STATUS_SEVERE, android.os.PowerManager#THERMAL_STATUS_CRITICAL, android.os.PowerManager#THERMAL_STATUS_EMERGENCY, or android.os.PowerManager#THERMAL_STATUS_SHUTDOWN

getLocationPowerSaveMode

Added in API level 28
fun getLocationPowerSaveMode(): Int

Returns how location features should behave when battery saver is on. When battery saver is off, this will always return LOCATION_MODE_NO_CHANGE.

This API is normally only useful for components that provide location features.

Return
Int Value is android.os.PowerManager#LOCATION_MODE_NO_CHANGE, android.os.PowerManager#LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF, android.os.PowerManager#LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF, android.os.PowerManager#LOCATION_MODE_FOREGROUND_ONLY, or android.os.PowerManager#LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF

getThermalHeadroom

Added in API level 30
fun getThermalHeadroom(forecastSeconds: Int): Float

Provides an estimate of how much thermal headroom the device currently has before hitting severe throttling. Note that this only attempts to track the headroom of slow-moving sensors, such as the skin temperature sensor. This means that there is no benefit to calling this function more frequently than about once per second, and attempts to call significantly more frequently may result in the function returning NaN.

In addition, in order to be able to provide an accurate forecast, the system does not attempt to forecast until it has multiple temperature samples from which to extrapolate. This should only take a few seconds from the time of the first call, but during this time, no forecasting will occur, and the current headroom will be returned regardless of the value of forecastSeconds.

The value returned is a non-negative float that represents how much of the thermal envelope is in use (or is forecasted to be in use). A value of 1.0 indicates that the device is (or will be) throttled at THERMAL_STATUS_SEVERE. Such throttling can affect the CPU, GPU, and other subsystems. Values may exceed 1.0, but there is no implied mapping to specific thermal status levels beyond that point. This means that values greater than 1.0 may correspond to THERMAL_STATUS_SEVERE, but may also represent heavier throttling.

A value of 0.0 corresponds to a fixed distance from 1.0, but does not correspond to any particular thermal status or temperature. Values on (0.0, 1.0] may be expected to scale linearly with temperature, though temperature changes over time are typically not linear. Negative values will be clamped to 0.0 before returning.

Parameters
forecastSeconds Int: how many seconds in the future to forecast. Given that device conditions may change at any time, forecasts from further in the future will likely be less accurate than forecasts in the near future. Value is between 0 and 60 inclusive
Return
Float a value greater than or equal to 0.0 where 1.0 indicates the SEVERE throttling threshold, as described above. Returns NaN if the device does not support this functionality or if this function is called significantly faster than once per second.

getThermalHeadroomThresholds

Added in API level 35
fun getThermalHeadroomThresholds(): MutableMap<Int!, Float!>

Gets the thermal headroom thresholds for all available thermal throttling status above THERMAL_STATUS_NONE.

A thermal status key in the returned map is only set if the device manufacturer has the corresponding threshold defined for at least one of its sensors. If it's set, one should expect to see that from getCurrentThermalStatus() or OnThermalStatusChangedListener#onThermalStatusChanged(int).

The headroom threshold is used to interpret the possible thermal throttling status based on the headroom prediction. For example, if the headroom threshold for THERMAL_STATUS_LIGHT is 0.7, and a headroom prediction in 10s returns 0.75 (or getThermalHeadroom(10)=0.75), one can expect that in 10 seconds the system could be in lightly throttled state if the workload remains the same. The app can consider taking actions according to the nearest throttling status the difference between the headroom and the threshold.

For new devices it's guaranteed to have a single sensor, but for older devices with multiple sensors reporting different threshold values, the minimum threshold is taken to be conservative on predictions. Thus, when reading real-time headroom, it's not guaranteed that a real-time value of 0.75 (or getThermalHeadroom(0)=0.75) exceeding the threshold of 0.7 above will always come with lightly throttled state (or getCurrentThermalStatus()=THERMAL_STATUS_LIGHT) but it can be lower (or getCurrentThermalStatus()=THERMAL_STATUS_NONE). While it's always guaranteed that the device won't be throttled heavier than the unmet threshold's state, so a real-time headroom of 0.75 will never come with THERMAL_STATUS_MODERATE but lower, and 0.65 will never come with THERMAL_STATUS_LIGHT but THERMAL_STATUS_NONE.

The returned map of thresholds will not change between calls to this function, so it's best to call this once on initialization. Modifying the result will not change the thresholds cached by the system, and a new call to the API will get a new copy.

Return
MutableMap<Int!, Float!> map from each thermal status to its thermal headroom This value cannot be null.
Exceptions
java.lang.IllegalStateException if the thermal service is not ready
java.lang.UnsupportedOperationException if the feature is not enabled

isAllowedInLowPowerStandby

Added in API level 34
fun isAllowedInLowPowerStandby(reason: Int): Boolean

Returns true if Low Power Standby is disabled (so Low Power Standby does not restrict apps), or apps may be automatically exempt from Low Power Standby restrictions for the given reason. The system may exempt apps from Low Power Standby restrictions when using allowed features. For example, if LOW_POWER_STANDBY_ALLOWED_REASON_VOICE_INTERACTION is allowed, then apps with active voice interaction sessions are exempt from restrictions.

Parameters
reason Int: Value is either 0 or a combination of android.os.PowerManager#LOW_POWER_STANDBY_ALLOWED_REASON_VOICE_INTERACTION, android.os.PowerManager#LOW_POWER_STANDBY_ALLOWED_REASON_TEMP_POWER_SAVE_ALLOWLIST, and android.os.PowerManager#LOW_POWER_STANDBY_ALLOWED_REASON_ONGOING_CALL

isAllowedInLowPowerStandby

Added in API level 34
fun isAllowedInLowPowerStandby(feature: String): Boolean

Returns true if Low Power Standby is disabled (so Low Power Standby does not restrict apps), or apps are allowed to use a given feature during Low Power Standby.

Parameters
feature String: This value cannot be null.

isBatteryDischargePredictionPersonalized

Added in API level 31
fun isBatteryDischargePredictionPersonalized(): Boolean

Returns whether the current battery life remaining estimate is personalized based on device usage history or not. This value does not take a device's powered or charging state into account.

Return
Boolean A boolean indicating if the current discharge estimate is personalized based on historical device usage or not.

isDeviceIdleMode

Added in API level 23
fun isDeviceIdleMode(): Boolean

Returns true if the device is currently in idle mode. This happens when a device has been sitting unused and unmoving for a sufficiently long period of time, so that it decides to go into a lower power-use state. This may involve things like turning off network access to apps. You can monitor for changes to this state with ACTION_DEVICE_IDLE_MODE_CHANGED.

Return
Boolean Returns true if currently in active device idle mode, else false. This is when idle mode restrictions are being actively applied; it will return false if the device is in a long-term idle mode but currently running a maintenance window where restrictions have been lifted.

isDeviceLightIdleMode

Added in API level 33
fun isDeviceLightIdleMode(): Boolean

Returns true if the device is currently in light idle mode. This happens when a device has had its screen off for a short time, switching it into a batching mode where we execute jobs, syncs, networking on a batching schedule. You can monitor for changes to this state with ACTION_DEVICE_LIGHT_IDLE_MODE_CHANGED.

Return
Boolean Returns true if currently in active device light idle mode, else false. This is when light idle mode restrictions are being actively applied; it will return false if the device is in a long-term idle mode but currently running a maintenance window where restrictions have been lifted.

isExemptFromLowPowerStandby

Added in API level 34
fun isExemptFromLowPowerStandby(): Boolean

Returns true if the calling package is exempt from Low Power Standby restrictions or Low Power Standby is disabled (so Low Power Standby does not restrict apps), false otherwise.

isIgnoringBatteryOptimizations

Added in API level 23
fun isIgnoringBatteryOptimizations(packageName: String!): Boolean

Return whether the given application package name is on the device's power allowlist. Apps can be placed on the allowlist through the settings UI invoked by android.provider.Settings#ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS.

Being on the power allowlist means that the system will not apply most power saving features to the app. Guardrails for extreme cases may still be applied.

isInteractive

Added in API level 20
fun isInteractive(): Boolean

Returns true if the device is in an interactive state.

When this method returns true, the device is awake and ready to interact with the user (although this is not a guarantee that the user is actively interacting with the device just this moment). The main screen is usually turned on while in this state. Certain features, such as the proximity sensor, may temporarily turn off the screen while still leaving the device in an interactive state. Note in particular that the device is still considered to be interactive while dreaming (since dreams can be interactive) but not when it is dozing or asleep.

When this method returns false, the device is dozing or asleep and must be awoken before it will become ready to interact with the user again. The main screen is usually turned off while in this state. Certain features, such as "ambient mode" may cause the main screen to remain on (albeit in a low power state) to display system-provided content while the device dozes.

The system will send a screen on or screen off broadcast whenever the interactive state of the device changes. For historical reasons, the names of these broadcasts refer to the power state of the screen but they are actually sent in response to changes in the overall interactive state of the device, as described by this method.

Services may use the non-interactive state as a hint to conserve power since the user is not present.

Return
Boolean True if the device is in an interactive state.

isLowPowerStandbyEnabled

Added in API level 33
fun isLowPowerStandbyEnabled(): Boolean

Returns true if Low Power Standby is enabled.

When Low Power Standby is enabled, apps (including apps running foreground services) are subject to additional restrictions while the device is non-interactive, outside of device idle maintenance windows: Their network access is disabled, and any wakelocks they hold are ignored.

When Low Power Standby is enabled or disabled, a Intent with action ACTION_LOW_POWER_STANDBY_ENABLED_CHANGED is broadcast to registered receivers.

isPowerSaveMode

Added in API level 21
fun isPowerSaveMode(): Boolean

Returns true if the device is currently in power save mode. When in this mode, applications should reduce their functionality in order to conserve battery as much as possible. You can monitor for changes to this state with ACTION_POWER_SAVE_MODE_CHANGED.

Return
Boolean Returns true if currently in low power mode, else false.

isRebootingUserspaceSupported

Added in API level 30
Deprecated in API level 35
fun isRebootingUserspaceSupported(): Boolean

Deprecated: userspace reboot is deprecated, this method always returns false.

Returns true if this device supports rebooting userspace.

isScreenOn

Added in API level 7
Deprecated in API level 20
fun isScreenOn(): Boolean

Deprecated: Use isInteractive instead.

Returns true if the device is in an interactive state.

For historical reasons, the name of this method refers to the power state of the screen but it actually describes the overall interactive state of the device. This method has been replaced by isInteractive.

The value returned by this method only indicates whether the device is in an interactive state which may have nothing to do with the screen being on or off. To determine the actual state of the screen, use android.view.Display#getState.

Return
Boolean True if the device is in an interactive state.

isSustainedPerformanceModeSupported

Added in API level 24
fun isSustainedPerformanceModeSupported(): Boolean

This function checks if the device has implemented Sustained Performance Mode. This needs to be checked only once and is constant for a particular device/release. Sustained Performance Mode is intended to provide a consistent level of performance for prolonged amount of time. Applications should check if the device supports this mode, before using android.view.Window#setSustainedPerformanceMode.

Return
Boolean Returns True if the device supports it, false otherwise.

isWakeLockLevelSupported

Added in API level 21
fun isWakeLockLevelSupported(level: Int): Boolean

Returns true if the specified wake lock level is supported.

Parameters
level Int: The wake lock level to check.
Return
Boolean True if the specified wake lock level is supported.

newWakeLock

Added in API level 1
fun newWakeLock(
    levelAndFlags: Int, 
    tag: String!
): PowerManager.WakeLock!

Creates a new wake lock with the specified level and flags.

The levelAndFlags parameter specifies a wake lock level and optional flags combined using the logical OR operator.

The wake lock levels are: PARTIAL_WAKE_LOCK, FULL_WAKE_LOCK, SCREEN_DIM_WAKE_LOCK and SCREEN_BRIGHT_WAKE_LOCK. Exactly one wake lock level must be specified as part of the levelAndFlags parameter.

The wake lock flags are: ACQUIRE_CAUSES_WAKEUP and ON_AFTER_RELEASE. Multiple flags can be combined as part of the levelAndFlags parameters.

Call acquire() on the object to acquire the wake lock, and android.os.PowerManager.WakeLock#release when you are done.

{@samplecode * PowerManager pm = mContext.getSystemService(PowerManager.class); * PowerManager.WakeLock wl = pm.newWakeLock( * PowerManager.SCREEN_DIM_WAKE_LOCK * | PowerManager.ON_AFTER_RELEASE, * TAG); * wl.acquire(); * // ... do work... * wl.release(); * }

Although a wake lock can be created without special permissions, the android.Manifest.permission#WAKE_LOCK permission is required to actually acquire or release the wake lock that is returned.

Device battery life will be significantly affected by the use of this API. Do not acquire WakeLocks unless you really need them, use the minimum levels possible, and be sure to release them as soon as possible.

If using this to keep the screen on, you should strongly consider using android.view.WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON instead. This window flag will be correctly managed by the platform as the user moves between applications and doesn't require a special permission. Additionally using the flag will keep only the appropriate screen on in a multi-display scenario while using a wake lock will keep every screen powered on.

Recommended naming conventions for tags to make debugging easier:

  • use a unique prefix delimited by a colon for your app/library (e.g. gmail:mytag) to make it easier to understand where the wake locks comes from. This namespace will also avoid collision for tags inside your app coming from different libraries which will make debugging easier.
  • use constants (e.g. do not include timestamps in the tag) to make it easier for tools to aggregate similar wake locks. When collecting debugging data, the platform only monitors a finite number of tags, using constants will help tools to provide better debugging data.
  • avoid using Class#getName() or similar method since this class name can be transformed by java optimizer and obfuscator tools.
  • avoid wrapping the tag or a prefix to avoid collision with wake lock tags from the platform (e.g. *alarm*).
  • never include personally identifiable information for privacy reasons.

Parameters
levelAndFlags Int: Combination of wake lock level and flag values defining the requested behavior of the WakeLock.
tag String!: Your class name (or other tag) for debugging purposes.

reboot

Added in API level 8
fun reboot(reason: String?): Unit

Reboot the device. Will not return if the reboot is successful.

Requires the android.Manifest.permission#REBOOT permission.

If the reason string contains ",quiescent", then the screen stays off during reboot and is not turned on again until the user triggers the device to wake up (for example, by pressing the power key). This behavior applies to Android TV devices launched on Android 11 (API level 30) or higher.


Requires android.Manifest.permission#REBOOT
Parameters
reason String?: code to pass to the kernel (e.g., "recovery") to request special boot modes, or null.
Exceptions
java.lang.UnsupportedOperationException if userspace reboot was requested on a device that doesn't support it.

removeThermalStatusListener

Added in API level 29
fun removeThermalStatusListener(listener: PowerManager.OnThermalStatusChangedListener): Unit

This function removes a listener for thermal status change

Parameters
listener PowerManager.OnThermalStatusChangedListener: listener to be removed This value cannot be null.