permission-flow-android
Permission Flow for Android
Know about real-time state of a Android app Permissions with Kotlin Flow APIs. Made with ❤️ for Android Developers.
💡Introduction
In big projects, app is generally divided in several modules and in such cases, if any individual module is just a data module (not having UI) and need to know state of a permission, it’s not that easy. This library provides a way to know state of a permission throughout the app and from any layer of the application safely.
For example, you can listen for state of contacts permission in class where you’ll instantly show list of contacts when permission is granted.
It’s a simple and easy to use library. Just Plug and Play.
🚀 Implementation
You can check /app directory which includes example application for demonstration.
1. Gradle setup
In build.gradle of app module, include this dependency
dependencies {
implementation "dev.shreyaspatil.permission-flow:permission-flow-android:$version"
// For using in Jetpack Compose
implementation "dev.shreyaspatil.permission-flow:permission-flow-compose:$version"
}
You can find latest version and changelogs in the releases.
2. Observing a Permission State
2.1 Observing Permission with StateFlow
A permission state can be subscribed by retrieving StateFlow<PermissionState> or StateFlow<MultiplePermissionState> as follows:
val permissionFlow = PermissionFlow.getInstance()
// Observe state of single permission
suspend fun observePermission() {
permissionFlow.getPermissionState(Manifest.permission.READ_CONTACTS).collect { state ->
if (state.isGranted) {
// Permission granted, access contacts.
} else if (state.isRationaleRequired == true) {
// Permission denied, but can be requested again
} else {
// Permission denied, and can't be requested again
}
}
}
// Observe state of multiple permissions
suspend fun observeMultiplePermissions() {
permissionFlow.getMultiplePermissionState(
Manifest.permission.READ_CONTACTS,
Manifest.permission.READ_SMS
).collect { state ->
// All permission states
val allPermissions = state.permissions
// Check whether all permissions are granted
val allGranted = state.allGranted
// List of granted permissions
val grantedPermissions = state.grantedPermissions
// List of denied permissions
val deniedPermissions = state.deniedPermissions
// List of permissions requiring rationale
val permissionsRequiringRationale = state.permissionsRequiringRationale
}
}
2.2 Observing permissions in Jetpack Compose
State of a permission and state of multiple permissions can also be observed in Jetpack Compose application as follows:
@Composable
fun ExampleSinglePermission() {
val state by rememberPermissionState(Manifest.permission.CAMERA)
if (state.isGranted) {
// Permission granted
} else if (state.isRationaleRequired == true) {
// Permission denied, but can be requested again
} else {
// Permission denied, and can't be requested again
}
}
@Composable
fun ExampleMultiplePermission() {
val state by rememberMultiplePermissionState(
Manifest.permission.CAMERA,
Manifest.permission.ACCESS_FINE_LOCATION,
Manifest.permission.READ_CONTACTS
)
if (state.allGranted) {
// Render something
}
val grantedPermissions = state.grantedPermissions
// Do something with `grantedPermissions`
val deniedPermissions = state.deniedPermissions
// Do something with `deniedPermissions`
val permissionsRequiringRationale = state.permissionsRequiringRationale
// Do something with `permissionsRequiringRationale`
}
3. Requesting permission with PermissionFlow
It’s necessary to use utilities provided by this library to request permissions so that whenever permission state changes, this library takes care of notifying respective flows.
3.1 Request permission from Activity / Fragment
Use registerForPermissionFlowRequestsResult() method to get ActivityResultLauncher
and use launch() method to request for permission.
class ContactsActivity : AppCompatActivity() {
private val permissionLauncher = registerForPermissionFlowRequestsResult()
private fun askContactsPermission() {
permissionLauncher.launch(Manifest.permission.READ_CONTACTS, ...)
}
}
3.2 Request permission in Jetpack Compose
Use rememberPermissionFlowRequestLauncher() method to get ManagedActivityResultLauncher
and use launch() method to request for permission.
@Composable
fun Example() {
val permissionLauncher = rememberPermissionFlowRequestLauncher()
Button(onClick = { permissionLauncher.launch(android.Manifest.permission.CAMERA, ...) }) {
Text("Request Permissions")
}
}
4. Manually notifying permission state changes ⚠️
If you’re not using ActivityResultLauncher APIs provided by this library then
you will not receive permission state change updates. But there’s a provision by which
you can help this library to know about permission state changes.
Use PermissionFlow#notifyPermissionsChanged() to notify the permission state changes
from your manual implementations.
For example:
class MyActivity: AppCompatActivity() {
private val permissionFlow = PermissionFlow.getInstance()
private val permissionLauncher = registerForActivityResult(RequestPermission()) { isGranted ->
permissionFlow.notifyPermissionsChanged(android.Manifest.permission.READ_CONTACTS)
}
}
5. Manually Start / Stop Listening ⚠️
This library starts processing things lazily whenever getPermissionState() or getMultiplePermissionState() is called
for the first time. But this can be controlled with these methods:
fun doSomething() {
// Stops listening to the state changes of permissions throughout the application.
// This means the state of permission retrieved with [getMultiplePermissionState] method will not
// be updated after stopping listening.
permissionFlow.stopListening()
// Starts listening the changes of state of permissions after stopping listening
permissionFlow.startListening()
}
6. What about Initialization?
This library automatically gets initialized with the App Startup library. If you want to provide own coroutine dispatcher
6.1 Initialize PermissionFlow as follows (For example, in Application class)
class MyApplication: Application() {
override fun onCreate() {
super.onCreate()
val permissionDispatcher = Executors.newFixedThreadPool(3).asCoroutineDispatcher()
PermissionFlow.init(this, permissionDispatcher)
}
}
6.2 Disable PermissionFlowInitializer in AndroidManifest.xml
Disable auto initialization of library with default configuration using this:
<provider
android:name="androidx.startup.InitializationProvider"
android:authorities="${applicationId}.androidx-startup"
android:exported="false"
tools:node="merge">
<meta-data
android:name="dev.shreyaspatil.permissionFlow.initializer.PermissionFlowInitializer"
android:value="androidx.startup"
tools:node="remove" />
</provider>
📄 API Documentation
Visit the API documentation of this library to get more information in detail. This documentation is generated using Dokka.
📊 Test coverage report
Check the Test Coverage Report of this library. This is generated using Kover.
🙋♂️ Contribute
Read contribution guidelines for more information regarding contribution.
💬 Discuss?
Have any questions, doubts or want to present your opinions, views? You’re always welcome. You can start discussions.
📝 License
Copyright 2022 Shreyas Patil
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.