💡Introduction

🚀 Implementation

1. Gradle setup

dependencies {    implementation"dev.shreyaspatil.permission-flow:permission-flow-android:$version"// For using in Jetpack Compose    implementation"dev.shreyaspatil.permission-flow:permission-flow-compose:$version"}

2. Observing a Permission State

2.1 Observing Permission withStateFlow

val permissionFlow=PermissionFlow.getInstance()// Observe state of single permissionsuspendfunobservePermission() {    permissionFlow.getPermissionState(Manifest.permission.READ_CONTACTS).collect { state->if (state.isGranted) {// Permission granted, access contacts.        }elseif (state.isRationaleRequired==true) {// Permission denied, but can be requested again        }else {// Permission denied, and can't be requested again        }    }}// Observe state of multiple permissionssuspendfunobserveMultiplePermissions() {    permissionFlow.getMultiplePermissionState(Manifest.permission.READ_CONTACTS,Manifest.permission.READ_SMS    ).collect { state->// All permission statesval allPermissions= state.permissions// Check whether all permissions are grantedval allGranted= state.allGranted// List of granted permissionsval grantedPermissions= state.grantedPermissions// List of denied permissionsval deniedPermissions= state.deniedPermissions// List of permissions requiring rationaleval permissionsRequiringRationale= state.permissionsRequiringRationale    }}

2.2 Observing permissions in Jetpack Compose

@ComposablefunExampleSinglePermission() {val state by rememberPermissionState(Manifest.permission.CAMERA)if (state.isGranted) {// Permission granted    }elseif (state.isRationaleRequired==true) {// Permission denied, but can be requested again    }else {// Permission denied, and can't be requested again    }}@ComposablefunExampleMultiplePermission() {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

3.1 Request permission from Activity / Fragment

classContactsActivity :AppCompatActivity() {privateval permissionLauncher= registerForPermissionFlowRequestsResult()privatefunaskContactsPermission() {        permissionLauncher.launch(Manifest.permission.READ_CONTACTS,...)    }}

3.2 Request permission in Jetpack Compose

@ComposablefunExample() {val permissionLauncher= rememberPermissionFlowRequestLauncher()Button(onClick= { permissionLauncher.launch(android.Manifest.permission.CAMERA,...) }) {Text("Request Permissions")    }}

4. Manually notifying permission state changes⚠️

classMyActivity:AppCompatActivity() {privateval permissionFlow=PermissionFlow.getInstance()privateval permissionLauncher= registerForActivityResult(RequestPermission()) { isGranted->        permissionFlow.notifyPermissionsChanged(android.Manifest.permission.READ_CONTACTS)    }}

5. Manually Start / Stop Listening⚠️

fundoSomething() {// 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?

6.1 InitializePermissionFlow as follows (For example, inApplication class)

classMyApplication:Application() {overridefunonCreate() {super.onCreate()val permissionDispatcher=Executors.newFixedThreadPool(3).asCoroutineDispatcher()PermissionFlow.init(this, permissionDispatcher)    }}

6.2 Disable PermissionFlowInitializer in AndroidManifest.xml

<providerandroid:name="androidx.startup.InitializationProvider"android:authorities="${applicationId}.androidx-startup"android:exported="false"tools:node="merge">    <meta-dataandroid:name="dev.shreyaspatil.permissionFlow.initializer.PermissionFlowInitializer"android:value="androidx.startup"tools:node="remove" /></provider>

📄 API Documentation

📊 Test coverage report

🙋‍♂️ Contribute

💬 Discuss?

📝 License

Copyright 2022 Shreyas PatilLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.