Capacitor plugin to access battery optimization settings on Android.
npm install @capawesome-team/capacitor-android-battery-optimization
npx cap sync
This API requires the following permissions be added to your AndroidManifest.xml
before the application
tag if you want to request direct exemption from Power Management features:
<uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" />
No configuration required for this plugin.
A working example can be found here: robingenz/capacitor-plugin-demo
Android |
---|
import { Capacitor } from '@capacitor/core';
import { BatteryOptimization } from '@capawesome-team/capacitor-android-battery-optimization';
const isBatteryOptimizationEnabled = async () => {
if (Capacitor.getPlatform() !== 'android') {
return false;
}
const { enabled } = await BatteryOptimization.isBatteryOptimizationEnabled();
return enabled;
};
const openBatteryOptimizationSettings = async () => {
if (Capacitor.getPlatform() !== 'android') {
return;
}
await BatteryOptimization.openBatteryOptimizationSettings();
};
const requestIgnoreBatteryOptimization = async () => {
if (Capacitor.getPlatform() !== 'android') {
return;
}
await BatteryOptimization.requestIgnoreBatteryOptimization();
};
isBatteryOptimizationEnabled()
openBatteryOptimizationSettings()
requestIgnoreBatteryOptimization()
- Interfaces
isBatteryOptimizationEnabled() => Promise<IsBatteryOptimizationEnabledResult>
Returns whether or not battery optimization is enabled.
Only available on Android.
Returns: Promise<IsBatteryOptimizationEnabledResult>
Since: 0.0.1
openBatteryOptimizationSettings() => Promise<void>
Opens the battery optimization settings page.
Only available on Android.
Since: 0.0.1
requestIgnoreBatteryOptimization() => Promise<void>
Requests the battery optimization ignore permission.
This method needs the REQUEST_IGNORE_BATTERY_OPTIMIZATIONS
manifest permission.
Use this method only if your app meets an acceptable use case (see Google Play Policy).
Only available on Android.
Since: 0.0.1
Prop | Type | Description | Since |
---|---|---|---|
enabled |
boolean |
Whether or not battery optimization is enabled. | 0.0.1 |
See CHANGELOG.md.
See LICENSE.