https://github.com/merail/request-permissions-tool
Utility classes for handling permissions in an Android application.
https://github.com/merail/request-permissions-tool
android kotlin runtime-permissions special-permission
Last synced: 4 months ago
JSON representation
Utility classes for handling permissions in an Android application.
- Host: GitHub
- URL: https://github.com/merail/request-permissions-tool
- Owner: merail
- Created: 2022-02-13T21:29:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T19:43:14.000Z (about 2 years ago)
- Last Synced: 2024-04-14T06:10:55.765Z (about 2 years ago)
- Topics: android, kotlin, runtime-permissions, special-permission
- Language: Kotlin
- Homepage:
- Size: 435 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://jitpack.io/#merail/request-permissions-tool)
# Request Permissions Tool
Make work with Android permissions simpler. The library provides:
- information about permissions using ```PermissionsInformer```, such as its [type](https://developer.android.com/guide/topics/permissions/overview#types), required min SDK, etc.
- ```RuntimePermissionRequester``` for handling requests with single or multiple runtime permissions and responses for them
- ```SpecialPermissionRequester``` to manage some special permissions
.
- ```RoleRequester``` for requesting [roles](https://source.android.com/docs/core/permissions/android-roles)
## Add the library to a project
### Groovy
```
dependencies {
// other dependencies
implementation 'com.github.merail:request-permissions-tool:1.2.0'
}
```
### Kotlin
```
dependencies {
// other dependencies
implementation("com.github.merail:request-permissions-tool:1.2.0")
}
```
## Usage
### PermissionsInformer
```
val permissionsInformer = PermissionsInformer(
activity = this,
)
if (permissionsInformer.isInstallTime(Manifest.permission.INTERNET)) {
// do something
} else {
// do something
}
```
> [!NOTE]
> If you just need fast simple permission's type check, you can go to [permissions-lists](https://github.com/merail/permissions-lists) repository.
### RuntimePermissionRequester
```
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
...
val runtimePermissionRequester = RuntimePermissionRequester(
activity = this,
requestedPermissions = arrayOf(
Manifest.permission.ACCESS_COARSE_LOCATION,
Manifest.permission.READ_CONTACTS,
)
)
runtimePermissionRequester.requestPermissions { permissionsMap ->
permissionsMap.entries.forEach { entry ->
when (entry.value) {
RuntimePermissionState.GRANTED -> // do something
RuntimePermissionState.DENIED -> // do something
RuntimePermissionState.IGNORED -> // do something
RuntimePermissionState.PERMANENTLY_DENIED -> // do something
}
}
}
}
```
> [!NOTE]
> Since Android 11 you can't manually deny permission forever using checkbox
>
> 
>
> A second denial will block permission permanently. For first fast decision you can use ```SettingsSnackbar``` to handle this usecase
>
> 
### SpecialPermissionRequester
```
val specialPermissionRequester = SpecialPermissionRequester(
activity = this,
requestedPermission = Manifest.permission.MANAGE_EXTERNAL_STORAGE,
)
specialPermissionRequester.requestPermission { (permission, state) ->
if (state == SpecialPermissionState.GRANTED) {
// do something
} else {
// do something
}
}
```
## License
Copyright 2022-2025 Rail' Meshcherov
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.