Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zubairehman/permissionmanager
A simple library written in Kotlin that allows you to request runtime permissions very easily.
https://github.com/zubairehman/permissionmanager
android marshmallow permissions runtime-permissions
Last synced: 2 days ago
JSON representation
A simple library written in Kotlin that allows you to request runtime permissions very easily.
- Host: GitHub
- URL: https://github.com/zubairehman/permissionmanager
- Owner: zubairehman
- License: mit
- Created: 2018-09-17T18:02:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-18T11:08:41.000Z (over 6 years ago)
- Last Synced: 2024-11-10T01:27:55.706Z (about 2 months ago)
- Topics: android, marshmallow, permissions, runtime-permissions
- Language: Kotlin
- Homepage:
- Size: 152 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PermissionManager
[](https://jitpack.io/#zubairehman/PermissionManager)
`PermissionManager` is a simple library written in kotlin that lets you request runtime permission very easily. When you install an app from Google Play on a device running Android 6.0 and up, you control which capabilities or information that app can access—known as permissions. For example, an app might want permission to see your device contacts or location. `PermissionManager` makes it easier for you to request or check for runtime permissions.
## How to use
**Step 1.** Add the `JitPack` repository to your build file. Add it in your root `build.gradle` at the end of repositories:
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
**Step 2.** Add the dependency
```
dependencies {
implementation 'com.github.zubairehman:PermissionManager:v1.0.0-alpha01'
}
```
### Request a permission
Requesting a permission is really easy, all you need to do is to pass in the permission(s) you want to request and the `PermissionManager` will do the work for you.
```kotlin
PermissionManager.Builder()
.key(REQUEST_PERMISSIONS)
.permission(PermissionEnum.READ_EXTERNAL_STORAGE, PermissionEnum.WRITE_EXTERNAL_STORAGE)
.callback(this@MainActivity)
.ask(this@MainActivity)
```
or
```kotlin
ArrayList permissionEnumArrayList = new ArrayList<>();
permissionEnumArrayList.add(PermissionEnum.ACCESS_FINE_LOCATION);
permissionEnumArrayList.add(PermissionEnum.GET_ACCOUNTS);
permissionEnumArrayList.add(PermissionEnum.READ_CONTACTS);
PermissionManager.Builder()
.key(REQUEST_PERMISSIONS)
.permission(permissionEnumArrayList)
.callback(this@MainActivity)
.ask(this@MainActivity)
```
### Permission results
You need to override `onRequestPermissionsResult()` and `result()` methods to get the permission results as shown below:
```kotlin
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array, grantResults: IntArray) {
PermissionManager.handleResult(this, requestCode, permissions, grantResults)
}
override fun result(permissionsGranted: ArrayList, permissionsDenied: ArrayList, permissionsDeniedForever: ArrayList, permissionsAsked: ArrayList) {
if (permissionsGranted.size == permissionsAsked.size) {
//Do some action
} else if (permissionsDeniedForever.size > 0) {
//If user answer "Never ask again" to a request for permission, you can redirect user to app settings, with an utils
showDialog(true)
} else {
showDialog(false)
}
}
```
### Check for permission
In-order to check for permissions, simply call the code below:
```kotlin
val permissionEnum = PermissionEnum.WRITE_EXTERNAL_STORAGE
val granted = PermissionUtils.isGranted(this@MainActivity, PermissionEnum.WRITE_EXTERNAL_STORAGE)
Toast.makeText(this@MainActivity, permissionEnum.toString() + " isGranted [" + granted + "]", Toast.LENGTH_SHORT).show()
```
### Callbacks
You can use three different callbacks depending upon your needs.
- **FullCallback:** gives you all the information on permission requested by you
- **SimpleCallback:** returns a boolean that says if all permission requests were permitted
- **SmartCallback:** returns a boolean that says if all permission requests were permitted and a boolean that says if some permissions are denied forever
### Open app settings
If user selects "Never ask again" to a request for permission, you can redirect user to app settings by calling a method provided by `PermissionUtils` class as mentioned below:
```kotlin
PermissionUtils.openApplicationSettings(this@MainActivity, R::class.java.getPackage().name)
```
## Complete Example
Here is the complete code that demonstrate the use of `PermissionManager`:
```kotlin
class MainActivity : AppCompatActivity(), FullCallback {
//static variables
private val REQUEST_PERMISSIONS = 1
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
//permission test
if (isStoragePermissionGranted()) {
} else {
requestStoragePermissions()
}
}
//Permission Methods:---------------------------------------------------------------------------
override fun onRequestPermissionsResult(requestCode: Int, permissions: Array, grantResults: IntArray) {
PermissionManager.handleResult(this, requestCode, permissions, grantResults)
}
override fun result(permissionsGranted: ArrayList, permissionsDenied: ArrayList, permissionsDeniedForever: ArrayList, permissionsAsked: ArrayList) {
if (permissionsGranted.size == permissionsAsked.size) {
//Do some action
} else if (permissionsDeniedForever.size > 0) {
//If user answer "Never ask again" to a request for permission, you can redirect user to app settings, with an utils
showDialog(true)
} else {
showDialog(false)
}
}
private fun isStoragePermissionGranted(): Boolean {
var flag = false
if (PermissionUtils.isGranted(this@MainActivity, PermissionEnum.WRITE_EXTERNAL_STORAGE) && PermissionUtils.isGranted(this@MainActivity, PermissionEnum.READ_EXTERNAL_STORAGE)) {
flag = true
}
return flag
}
private fun requestStoragePermissions() {
PermissionManager.Builder()
.key(REQUEST_PERMISSIONS)
.permission(PermissionEnum.READ_EXTERNAL_STORAGE, PermissionEnum.WRITE_EXTERNAL_STORAGE)
.callback(this@MainActivity)
.ask(this@MainActivity)
}
private fun showDialog(isNeverAskAgainChecked: Boolean) {
AlertDialog.Builder(this@MainActivity)
.setTitle("Permission needed")
.setMessage(R.string.permission_confirmation)
.setPositiveButton(android.R.string.ok) { dialogInterface, i ->
if (!isNeverAskAgainChecked) {
requestStoragePermissions()
} else {
PermissionUtils.openApplicationSettings(this@MainActivity, R::class.java.getPackage().name)
}
}
.setNegativeButton(android.R.string.cancel) { dialogInterface, i -> dialogInterface.dismiss() }
.show()
}
}
```