https://github.com/sagar-viradiya/eazypermissions
Android library to handle runtime permission through Kotlin coroutines and Livedata.
https://github.com/sagar-viradiya/eazypermissions
android android-library coroutines hacktoberfest kotlin kotlin-dsl livedata runtime-permissions
Last synced: 2 months ago
JSON representation
Android library to handle runtime permission through Kotlin coroutines and Livedata.
- Host: GitHub
- URL: https://github.com/sagar-viradiya/eazypermissions
- Owner: sagar-viradiya
- License: apache-2.0
- Created: 2019-04-19T09:55:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-06T08:13:23.000Z (over 4 years ago)
- Last Synced: 2024-05-02T00:54:09.681Z (about 1 year ago)
- Topics: android, android-library, coroutines, hacktoberfest, kotlin, kotlin-dsl, livedata, runtime-permissions
- Language: Kotlin
- Homepage:
- Size: 931 KB
- Stars: 252
- Watchers: 7
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Eazy Runtime Permission
[](https://github.com/sagar-viradiya/eazypermissions/blob/master/LICENSE)  [](https://android-arsenal.com/api?level=20) [](https://ktlint.github.io/) []( https://android-arsenal.com/details/1/7799 )
A lightweight Android library which wraps boilerplate code of runtime permission and allows you to request permissions
1. from coroutines. (No callbacks yay :tada:)
2. request and observe permissions through LiveData.
3. through clean and concise Kotlin DSL.
> From release `2.0.0` onwards library is migrated to AndroidX. If you are still using support library and haven't migrated to AndroidX then check out non-androidX version of the [library](https://github.com/sagar-viradiya/eazypermissions/tree/master-nonandroidx).
## Including in your project
Eazy permissions is available in the Jcenter and divided into three modules so that based on your need you can include either coroutines or livedata or Kotlin DSL support in your project
```groovy
//For coroutines
implementation 'com.sagar:coroutinespermission:[latest_version]'
//For LiveData
implementation 'com.sagar:livedatapermission:[latest_version]'
//For Kotlin DSL
implementation 'com.sagar:dslpermission:[latest_version]'
```
- `latest_version` for coroutines - [  ](https://bintray.com/sagar-viradiya/eazypermissions/coroutinespermission/_latestVersion)
- `latest_version` for livedata - [  ](https://bintray.com/sagar-viradiya/eazypermissions/livedatapermission/_latestVersion)
- `latest_version` for Kotlin DSL - [  ](https://bintray.com/sagar-viradiya/eazypermissions/dslpermission/_latestVersion)
## Coroutines support
This is how you would request permission within coroutines.
```kotlin
.
.
.
launch {
//CoroutineScope
val permissionResult = PermissionManager.requestPermissions( //Suspends the coroutine
this@Fragment,
REQUEST_ID,
Manifest.permission.ACCESS_FINE_LOCATION,
Manifest.permission.READ_CONTACTS,
Manifest.permission.CAMERA
)
//Resume coroutine once result is ready
when(permissionResult) {
is PermissionResult.PermissionGranted -> {
//Add your logic here after user grants permission(s)
}
is PermissionResult.PermissionDenied -> {
//Add your logic to handle permission denial
}
is PermissionResult.PermissionDeniedPermanently -> {
//Add your logic here if user denied permission(s) permanently.
//Ideally you should ask user to manually go to settings and enable permission(s)
}
is PermissionResult.ShowRational -> {
//If user denied permission frequently then she/he is not clear about why you are asking this permission.
//This is your chance to explain them why you need permission.
}
}
}
```
Read more about coroutines support [*here*](coroutinespermission)
## Kotlin DSL support
This is how you would request permission through clean and concise Kotlin DSL.
```kotlin
requestPermissions(
Manifest.permission.ACCESS_FINE_LOCATION,
Manifest.permission.READ_CONTACTS,
Manifest.permission.CAMERA
) {
requestCode = 4
resultCallback = {
when(this) {
is PermissionResult.PermissionGranted -> {
//Add your logic here after user grants permission(s)
}
is PermissionResult.PermissionDenied -> {
//Add your logic to handle permission denial
}
is PermissionResult.PermissionDeniedPermanently -> {
//Add your logic here if user denied permission(s) permanently.
//Ideally you should ask user to manually go to settings and enable permission(s)
}
is PermissionResult.ShowRational -> {
//If user denied permission frequently then she/he is not clear about why you are asking this permission.
//This is your chance to explain them why you need permission.
}
}
}
}
```
Read more about Kotlin DSL support [*here*](dslpermission)
## LiveData support
This is how you would request permission within Acivity/Fragment.
```kotlin
PermissionManager.requestPermissions(
this,
REQUEST_ID,
Manifest.permission.ACCESS_FINE_LOCATION,
Manifest.permission.READ_CONTACTS
)
```
Observing permission result requires your Actvity/Fragment to implement [`PermissionObserver`](https://github.com/sagar-viradiya/eazypermissions/blob/e1a36d5fb3ad487ac22da9b18e9b4c848cfcb74c/livedatapermission/src/main/java/com/eazypermissions/livedatapermission/PermissionManager.kt#L115)
```kotlin
/**
* Interface definition for a callback to get [LiveData] of [PermissionResult]
*
* Implement this interface to get [LiveData] for observing permission request result.
*/
interface PermissionObserver {
fun setupObserver(permissionResultLiveData: LiveData)
}
```
Just as you would observe other LiveData you can observe LiveData<[`PermissionResult`](common/src/main/java/com/eazypermissions/common/model/PermissionResult.kt)> as follow.
```kotlin
override fun setupObserver(permissionResultLiveData: LiveData) {
permissionResultLiveData.observe(this, Observer {
when (it) {
is PermissionResult.PermissionGranted -> {
if (it.requestId == REQUEST_ID) {
//Add your logic here after user grants permission(s)
}
}
is PermissionResult.PermissionDenied -> {
if (it.requestId == REQUEST_ID) {
//Add your logic to handle permission denial
}
}
is PermissionResult.PermissionDeniedPermanently -> {
if (it.requestId == REQUEST_ID) {
//Add your logic here if user denied permission(s) permanently.
//Ideally you should ask user to manually go to settings and enable permission(s)
}
}
is PermissionResult.ShowRational -> {
if (it.requestId == REQUEST_ID) {
//If user denied permission frequently then she/he is not clear about why you are asking this permission.
//This is your chance to explain them why you need permission.
}
}
}
})
}
```
Read more about LiveData support [*here*](livedatapermission)
## Contributing
Have suggestions for improvements and want to contribute? or Found any issues?
Head over to [Contribution guidelines](CONTRIBUTING.md) to know more about contributing to this library.
## Screenshots of sample
 
 
# License
```
Copyright 2019 Sagar Viradiya
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```