BatteryPermissionHelper

KO | EN

gitlite — search

#docker #python #php #java #minecraft #golang #typescript #csharp #javascript #android #kotlin-android #bot

BatteryPermissionHelper

★ 49 Open GitHub ↗

This Library helps whitelist your Android App in Battery Settings, to prevent the app from getting killed due to Battery Optimisations.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BatteryPermissionHelper
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
[![Android Build](https://github.com/WaseemSabir/BatteryPermissionHelper/actions/workflows/build.yml/badge.svg)](https://github.com/WaseemSabir/BatteryPermissionHelper/actions/workflows/build.yml)
[![Unit Tests](https://github.com/WaseemSabir/BatteryPermissionHelper/actions/workflows/tests.yml/badge.svg)](https://github.com/WaseemSabir/BatteryPermissionHelper/actions/workflows/tests.yml)
[![API](https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=16)

An Android Library to detect battery optimizations settings and navigate the user to the relevant screens so that they can whitelist the app. This will prevent the app from getting killed in the background due to Battery Optimization Managers. The library supports multiple OEMs.

## Installation
### Gradle
Add this to your module's build.gradle file:
```gradle
dependencies {
    // ... other dependencies
    implementation 'com.waseemsabir:betterypermissionhelper:1.0.3'    
}
```

### Maven
```maven
<dependency>
    <groupId>com.waseemsabir</groupId>
    <artifactId>betterypermissionhelper</artifactId>
    <version>1.0.3</version>
</dependency>
```

Other instructions for installation can be viewed [here](https://central.sonatype.com/artifact/com.waseemsabir/betterypermissionhelper/1.0.0).

## Usage

To keep the library small and extendable, UI elements (dialog/popups) implementation is left up to the library user. The library will not show any screens.

### Kotlin

```kotlin
private val batteryPermissionHelper = BatteryPermissionHelper.getInstance()

// check whether or not Battery Permission is Available for Device
val isBatteryPermissionAvailable = batteryPermissionHelper.isBatterySaverPermissionAvailable(context = context, onlyIfSupported = true)

// Show a dialog based on availability (Implementation left to Dev) and OnClick open permission manager
buttonInDialog.setOnClickListener {
    batteryPermissionHelper.getPermission(this, open = true, newTask = true)
}
```

### Java

```java
private final BatteryPermissionHelper batteryPermissionHelper = BatteryPermissionHelper.Companion.getInstance();

// Check whether or not Battery Permission is Available for Device
boolean isBatteryPermissionAvailable = batteryPermissionHelper.isBatterySaverPermissionAvailable(context, /* onlyIfSupported */ true);

// Show a dialog based on availability (Implementation left to Dev) and OnClick open permission manager
buttonInDialog.setOnClickListener((view) -> {
    batteryPermissionHelper.getPermission(context, /* open */ true, /* newTask */ true);
});
```

## Supported Devices

Currently, the library supports following devices.

1. Xiaomi
2. Redmi
3. Poco
4. Letv [ Untested ]
5. HTC [ Untested ]
6. Huawei
7. Oppo
8. Samsung
9. ZTE [ Untested ]
10. Meizu [ Untested ]

I am open to any PR's and contributions for any devices. I'll also try to add more devices, whenever possible.

## Relevant Work

* [AutoStarter](https://github.com/judemanutd/AutoStarter)
* [dont-kill-my-app](https://github.com/urbandroid-team/dont-kill-my-app)

BatteryPermissionHelper

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README