@jigrawesome-team/jigra-android-battery-optimization

Jigra plugin to access battery optimization settings on Android.

Installation

$3

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:

``xml

`

⚠️ Attention: Google Play policies prohibit apps from requesting direct exemption from Power Management features in Android 6.0+ (Doze and App Standby) unless the core function of the app is adversely affected. Source

Configuration

No configuration required for this plugin.

Usage

`typescript
import { Jigra } from '@jigra/core';
import { BatteryOptimization } from '@jigrawesome-team/jigra-android-battery-optimization';

const isBatteryOptimizationEnabled = async () => {
if (Jigra.getPlatform() !== 'android') {
return false;
}
const { enabled } = await BatteryOptimization.isBatteryOptimizationEnabled();
return enabled;
};

const openBatteryOptimizationSettings = async () => {
if (Jigra.getPlatform() !== 'android') {
return;
}
await BatteryOptimization.openBatteryOptimizationSettings();
};

const requestIgnoreBatteryOptimization = async () => {
if (Jigra.getPlatform() !== 'android') {
return;
}
await BatteryOptimization.requestIgnoreBatteryOptimization();
};
`

API

* isBatteryOptimizationEnabled()
* openBatteryOptimizationSettings()
* requestIgnoreBatteryOptimization()
* Interfaces

$3

`typescript
isBatteryOptimizationEnabled() => Promise
`

Returns whether or not battery optimization is enabled.

Only available on Android.

Returns: Promise<IsBatteryOptimizationEnabledResult>

Since: 0.0.1

--------------------

$3

`typescript
openBatteryOptimizationSettings() => Promise
`

Opens the battery optimization settings page.

Only available on Android.

Since: 0.0.1

--------------------

$3

`typescript
requestIgnoreBatteryOptimization() => Promise
`

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

--------------------

$3


#### IsBatteryOptimizationEnabledResult

| Prop | Type | Description | Since |
| ------------- | -------------------- | ----------------------------------------------- | ----- |
| enabled` | boolean | Whether or not battery optimization is enabled. | 0.0.1 |

Changelog

See CHANGELOG.md.

License

See LICENSE.