Repository: PatilShreyas/permission-flow-android Branch: main Commit: 257d9243bd3b Files: 85 Total size: 190.6 KB Directory structure: gitextract_5sp6w6t0/ ├── .github/ │ ├── CODEOWNERS │ ├── FUNDING.yml │ ├── dependabot.yml │ └── workflows/ │ ├── build.yml │ └── release.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── app/ │ ├── .gitignore │ ├── README.md │ ├── build.gradle │ ├── proguard-rules.pro │ └── src/ │ ├── androidTest/ │ │ └── java/ │ │ └── dev/ │ │ └── shreyaspatil/ │ │ └── permissionFlow/ │ │ └── ExampleInstrumentedTest.kt │ ├── main/ │ │ ├── AndroidManifest.xml │ │ ├── java/ │ │ │ └── dev/ │ │ │ └── shreyaspatil/ │ │ │ └── permissionFlow/ │ │ │ └── example/ │ │ │ ├── data/ │ │ │ │ ├── ContactRepository.kt │ │ │ │ ├── impl/ │ │ │ │ │ └── AndroidDefaultContactRepository.kt │ │ │ │ └── model/ │ │ │ │ └── Contact.kt │ │ │ └── ui/ │ │ │ ├── MainActivity.kt │ │ │ ├── composePermission/ │ │ │ │ └── ComposePermissionActivity.kt │ │ │ ├── contacts/ │ │ │ │ ├── ContactsActivity.kt │ │ │ │ ├── ContactsUiEvents.kt │ │ │ │ └── ContactsViewModel.kt │ │ │ ├── fragment/ │ │ │ │ ├── ExampleFragment.kt │ │ │ │ └── ExampleFragmentActivity.kt │ │ │ └── multipermission/ │ │ │ └── MultiPermissionActivity.kt │ │ └── res/ │ │ ├── drawable/ │ │ │ └── ic_launcher_background.xml │ │ ├── drawable-v24/ │ │ │ └── ic_launcher_foreground.xml │ │ ├── layout/ │ │ │ ├── activity_contacts.xml │ │ │ ├── activity_fragment_example.xml │ │ │ ├── activity_main.xml │ │ │ ├── activity_multipermission.xml │ │ │ └── view_fragment_example.xml │ │ ├── mipmap-anydpi-v26/ │ │ │ ├── ic_launcher.xml │ │ │ └── ic_launcher_round.xml │ │ ├── values/ │ │ │ ├── colors.xml │ │ │ ├── strings.xml │ │ │ └── themes.xml │ │ ├── values-night/ │ │ │ └── themes.xml │ │ └── xml/ │ │ ├── backup_rules.xml │ │ └── data_extraction_rules.xml │ └── test/ │ └── java/ │ └── dev/ │ └── shreyaspatil/ │ └── permissionFlow/ │ └── ExampleUnitTest.kt ├── build.gradle ├── gradle/ │ └── wrapper/ │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradle.properties ├── gradlew ├── gradlew.bat ├── permission-flow/ │ ├── .gitignore │ ├── build.gradle │ ├── consumer-rules.pro │ ├── gradle.properties │ ├── proguard-rules.pro │ └── src/ │ ├── androidTest/ │ │ └── java/ │ │ └── dev/ │ │ └── shreyaspatil/ │ │ └── permissionFlow/ │ │ └── ExampleInstrumentedTest.kt │ ├── main/ │ │ ├── AndroidManifest.xml │ │ └── java/ │ │ └── dev/ │ │ └── shreyaspatil/ │ │ └── permissionFlow/ │ │ ├── PermissionFlow.kt │ │ ├── State.kt │ │ ├── contract/ │ │ │ └── RequestPermissionsContract.kt │ │ ├── impl/ │ │ │ └── PermissionFlowImpl.kt │ │ ├── initializer/ │ │ │ └── PermissionFlowInitializer.kt │ │ ├── internal/ │ │ │ └── ApplicationStateMonitor.kt │ │ ├── utils/ │ │ │ ├── ActivityResultLauncherExt.kt │ │ │ ├── PermissionResultLauncher.kt │ │ │ └── stateFlow/ │ │ │ └── CombinedStateFlow.kt │ │ └── watchmen/ │ │ └── PermissionWatchmen.kt │ └── test/ │ └── java/ │ └── dev/ │ └── shreyaspatil/ │ └── permissionFlow/ │ ├── MultiplePermissionStateTest.kt │ ├── PermissionFlowTest.kt │ ├── contract/ │ │ └── RequestPermissionsContractTest.kt │ ├── impl/ │ │ └── PermissionFlowImplTest.kt │ ├── initializer/ │ │ └── PermissionFlowInitializerTest.kt │ ├── internal/ │ │ └── ApplicationStateMonitorTest.kt │ ├── utils/ │ │ ├── ActivityResultLauncherExtTest.kt │ │ ├── PermissionResultLauncherTest.kt │ │ └── stateFlow/ │ │ └── CombinedStateFlowTest.kt │ └── watchmen/ │ └── PermissionWatchmenTest.kt ├── permission-flow-compose/ │ ├── .gitignore │ ├── build.gradle │ ├── consumer-rules.pro │ ├── gradle.properties │ ├── proguard-rules.pro │ └── src/ │ └── main/ │ ├── AndroidManifest.xml │ └── java/ │ └── dev/ │ └── shreyaspatil/ │ └── permissionflow/ │ └── compose/ │ └── PermissionFlow.kt ├── settings.gradle └── spotless/ └── copyright.kt ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/CODEOWNERS ================================================ * @PatilShreyas ================================================ FILE: .github/FUNDING.yml ================================================ github: # patreon: # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: PatilShreyas otechie: # Replace with a single Otechie username custom: ['https://www.paypal.me/PatilShreyas99/', 'https://github.com/sponsors/PatilShreyas/'] ================================================ FILE: .github/dependabot.yml ================================================ # To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 updates: - package-ecosystem: "gradle" directory: "/" schedule: interval: "daily" commit-message: prefix: "[Update]" ================================================ FILE: .github/workflows/build.yml ================================================ name: Build on: [push, pull_request] jobs: build: name: Build runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: Set up JDK 17 uses: actions/setup-java@v3 with: java-version: 17 distribution: temurin cache: gradle - name: Grant Permission to Execute run: chmod +x gradlew - name: Build with Gradle uses: gradle/gradle-build-action@v2 with: arguments: build koverXmlReport --stacktrace - name: Upload Coverage report to CodeCov uses: codecov/codecov-action@v2 with: token: ${{ secrets.CODECOV_TOKEN }} files: permission-flow/build/coverageReport/report.xml flags: unittests fail_ci_if_error: true verbose: true ================================================ FILE: .github/workflows/release.yml ================================================ name: Release on: workflow_dispatch: inputs: versionName: description: 'Version Name' required: true jobs: release: name: Release runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Set up JDK 17 uses: actions/setup-java@v3 with: java-version: 17 distribution: temurin cache: gradle - name: Grant Permission to Execute Gradle run: chmod +x gradlew - name: Build with Gradle uses: gradle/gradle-build-action@v2 with: arguments: build dokkaHtmlMultiModule koverHtmlReport - name: Publish Library run: | echo "Publishing library 🚀" ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache env: ORG_GRADLE_PROJECT_VERSION_NAME: ${{ github.event.inputs.versionName }} ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY }} ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_PASSWORD }} ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} - name: Create and push tag run: | git config --global user.email "shreyaspatilg@gmail.com" git config --global user.name "$GITHUB_ACTOR" git tag -a $TAG -m "Release $TAG" git push origin $TAG env: TAG: v${{ github.event.inputs.versionName }} - name: Create Release on GitHub id: create_release uses: actions/create-release@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: tag_name: v${{ github.event.inputs.versionName }} release_name: v${{ github.event.inputs.versionName }} draft: true prerelease: false - name: Gather API Documentation and Coverage Report run: | mkdir gh-pages mv README.md gh-pages/README.md mv build/docs gh-pages/docs mv permission-flow/build/coverageReport/html gh-pages/coverageReport - name: Publish Documentation and Coverage Report uses: JamesIves/github-pages-deploy-action@v4.3.3 with: branch: gh-pages folder: gh-pages ================================================ FILE: .gitignore ================================================ *.iml .gradle /local.properties /.idea/ .DS_Store /build */build/ /captures .externalNativeBuild .cxx local.properties .idea ================================================ FILE: CODE_OF_CONDUCT.md ================================================ # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at . All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. ================================================ FILE: CONTRIBUTING.md ================================================ ## Feeling Awesome! Thanks for thinking about this. You can contribute us by filing issues, bugs and PRs. You can also take a look at active issues and fix them. If you want to discuss on something then feel free to present your opinions, views or any other relevant comment on [discussions](https://github.com/PatilShreyas/permission-flow-android/discussions). ### Code contribution - Open issue regarding proposed change. - If your proposed change is approved, Fork this repo and do changes. - Open PR against latest *development* branch. Add nice description in PR. - You're done! ### Code contribution checklist - New code addition/deletion should not break existing flow of a system. - All tests should be passed. - Verify `./gradlew build` is passing before raising a PR. - Reformat code with Spotless `./gradlew spotlessApply` before raising a PR. ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. 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. ================================================ FILE: README.md ================================================ # Permission Flow for Android Know about real-time state of a Android app Permissions with Kotlin Flow APIs. _Made with ❤️ for Android Developers_. [![Build](https://github.com/PatilShreyas/permission-flow-android/actions/workflows/build.yml/badge.svg)](https://github.com/PatilShreyas/permission-flow-android/actions/workflows/build.yml) [![Release](https://github.com/PatilShreyas/permission-flow-android/actions/workflows/release.yml/badge.svg)](https://github.com/PatilShreyas/permission-flow-android/actions/workflows/release.yml) [![codecov](https://codecov.io/gh/PatilShreyas/permission-flow-android/branch/main/graph/badge.svg?token=6TOHNLQDVW)](https://codecov.io/gh/PatilShreyas/permission-flow-android) [![Maven Central](https://img.shields.io/maven-central/v/dev.shreyaspatil.permission-flow/permission-flow-android?label=Maven%20Central&logo=android&style=flat-square)](https://search.maven.org/artifact/dev.shreyaspatil.permission-flow/permission-flow-android) [![GitHub](https://img.shields.io/github/license/PatilShreyas/permission-flow-android?label=License)](LICENSE) [![dokka](https://img.shields.io/badge/Dokka-Docs-blueviolet.svg?style=flat&logo=kotlin)](https://patilshreyas.github.io/permission-flow-android/docs/) [![kover](https://img.shields.io/badge/Kover-Coverage-blueviolet.svg?style=flat&logo=kotlin)](https://patilshreyas.github.io/permission-flow-android/coverageReport/) ## 💡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](/app) directory which includes example application for demonstration. ### 1. Gradle setup In `build.gradle` of app module, include this dependency ```gradle 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](https://github.com/PatilShreyas/permission-flow-android/releases)_. ### 2. Observing a Permission State #### 2.1 Observing Permission with `StateFlow` A permission state can be subscribed by retrieving `StateFlow` or `StateFlow` as follows: ```kotlin 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: ```kotlin @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()`](https://patilshreyas.github.io/permission-flow-android/docs/permission-flow/dev.shreyaspatil.permissionFlow.utils/register-for-permission-flow-requests-result.html) method to get `ActivityResultLauncher` and use `launch()` method to request for permission. ```kotlin 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()`](https://patilshreyas.github.io/permission-flow-android/docs/permission-flow-compose/dev.shreyaspatil.permissionflow.compose/remember-permission-flow-request-launcher.html) method to get `ManagedActivityResultLauncher` and use `launch()` method to request for permission. ```kotlin @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()`](https://patilshreyas.github.io/permission-flow-android/docs/permission-flow/dev.shreyaspatil.permissionFlow/-permission-flow/notify-permissions-changed.html) to notify the permission state changes from your manual implementations. For example: ```kotlin 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: ```kotlin 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) ```kotlin 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: ```xml ``` ## 📄 API Documentation [Visit the API documentation](https://patilshreyas.github.io/permission-flow-android/docs/) of this library to get more information in detail. This documentation is generated using [Dokka](https://github.com/Kotlin/dokka). ## 📊 Test coverage report [Check the Test Coverage Report](https://patilshreyas.github.io/permission-flow-android/coverageReport/) of this library. This is generated using [Kover](https://github.com/Kotlin/kotlinx-kover). --- ## 🙋‍♂️ Contribute Read [contribution guidelines](CONTRIBUTING.md) 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](https://github.com/PatilShreyas/permission-flow-android/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. ``` ================================================ FILE: app/.gitignore ================================================ /build ================================================ FILE: app/README.md ================================================ # Example https://github.com/PatilShreyas/permission-flow-android/assets/19620536/5ea5ac2c-24a6-4d16-87f8-1b5a0b8e708e ================================================ FILE: app/build.gradle ================================================ plugins { id 'com.android.application' id 'org.jetbrains.kotlin.android' id 'org.jetbrains.kotlin.plugin.compose' } kotlin { jvmToolchain(17) } android { compileSdk 35 defaultConfig { applicationId "dev.shreyaspatil.permissionFlow.example" minSdk 21 versionCode 1 versionName "1.0" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } } buildFeatures { viewBinding true compose true } packagingOptions { resources { excludes += '/META-INF/{AL2.0,LGPL2.1}' } } namespace 'dev.shreyaspatil.permissionFlow.example' } dependencies { // Library implementation(project(":permission-flow")) implementation(project(":permission-flow-compose")) // Android implementation 'androidx.core:core-ktx:1.15.0' implementation 'androidx.fragment:fragment-ktx:1.8.6' implementation "androidx.appcompat:appcompat:$appCompatVersion" implementation 'com.google.android.material:material:1.12.0' implementation 'androidx.constraintlayout:constraintlayout:2.2.1' // Jetpack Compose implementation platform("androidx.compose:compose-bom:$composeBomVersion") implementation "androidx.activity:activity-compose:$activityVersion" implementation "androidx.compose.material:material" implementation "androidx.compose.runtime:runtime" implementation "androidx.compose.animation:animation" implementation "androidx.compose.ui:ui-tooling" // Lifecycle def lifecycleVersion = '2.8.7' implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycleVersion" implementation "androidx.lifecycle:lifecycle-runtime-ktx:$lifecycleVersion" // Coroutines implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutinesVersion") // Testing testImplementation 'junit:junit:4.13.2' androidTestImplementation 'androidx.test.ext:junit:1.1.5' androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1' } ================================================ FILE: app/proguard-rules.pro ================================================ # Add project specific ProGuard rules here. # You can control the set of applied configuration files using the # proguardFiles setting in build.gradle. # # For more details, see # http://developer.android.com/guide/developing/tools/proguard.html # If your project uses WebView with JS, uncomment the following # and specify the fully qualified class name to the JavaScript interface # class: #-keepclassmembers class fqcn.of.javascript.interface.for.webview { # public *; #} # Uncomment this to preserve the line number information for # debugging stack traces. #-keepattributes SourceFile,LineNumberTable # If you keep the line number information, uncomment this to # hide the original source file name. #-renamesourcefileattribute SourceFile ================================================ FILE: app/src/androidTest/java/dev/shreyaspatil/permissionFlow/ExampleInstrumentedTest.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow import androidx.test.ext.junit.runners.AndroidJUnit4 import androidx.test.platform.app.InstrumentationRegistry import org.junit.Assert.assertEquals import org.junit.Test import org.junit.runner.RunWith /** * Instrumented test, which will execute on an Android device. * * See [testing documentation](http://d.android.com/tools/testing). */ @RunWith(AndroidJUnit4::class) class ExampleInstrumentedTest { @Test fun useAppContext() { // Context of the app under test. val appContext = InstrumentationRegistry.getInstrumentation().targetContext assertEquals("dev.shreyaspatil.permiduct", appContext.packageName) } } ================================================ FILE: app/src/main/AndroidManifest.xml ================================================ ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/data/ContactRepository.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.data import dev.shreyaspatil.permissionFlow.example.data.model.Contact import kotlinx.coroutines.flow.Flow interface ContactRepository { val allContacts: Flow> } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/data/impl/AndroidDefaultContactRepository.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.data.impl import android.Manifest import android.content.ContentResolver import android.database.Cursor import android.provider.ContactsContract import androidx.core.database.getStringOrNull import dev.shreyaspatil.permissionFlow.PermissionFlow import dev.shreyaspatil.permissionFlow.example.data.ContactRepository import dev.shreyaspatil.permissionFlow.example.data.model.Contact import kotlinx.coroutines.CoroutineDispatcher import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.transform import kotlinx.coroutines.withContext class AndroidDefaultContactRepository( private val contentResolver: ContentResolver, private val permissionFlow: PermissionFlow = PermissionFlow.getInstance(), private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO, ) : ContactRepository { override val allContacts: Flow> = permissionFlow.getPermissionState(Manifest.permission.READ_CONTACTS).transform { state -> if (state.isGranted) { emit(getContacts()) } else { emit(emptyList()) } } private suspend fun getContacts(): List = withContext(ioDispatcher) { buildList { var cursor: Cursor? = null try { val projection = arrayOf( ContactsContract.CommonDataKinds.Phone.CONTACT_ID, ContactsContract.CommonDataKinds.Phone.NUMBER, ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME, ContactsContract.CommonDataKinds.Phone.PHOTO_URI, ) val order = "${ContactsContract.CommonDataKinds.Phone.CONTACT_ID} ASC" cursor = contentResolver.query( ContactsContract.CommonDataKinds.Phone.CONTENT_URI, projection, null, null, order, ) if (cursor != null) { while (cursor.moveToNext()) { val contactId = cursor.getStringOrNull( cursor.getColumnIndex( ContactsContract.CommonDataKinds.Phone.CONTACT_ID), ) val name = cursor.getStringOrNull( cursor.getColumnIndex( ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME), ) val number = cursor.getStringOrNull( cursor.getColumnIndex( ContactsContract.CommonDataKinds.Phone.NUMBER), ) if (contactId != null && name != null && number != null) { add(Contact(contactId, name, number)) } } } } finally { cursor?.close() } } } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/data/model/Contact.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.data.model data class Contact(val id: String, val name: String, val number: String) ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/MainActivity.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui import android.content.Intent import android.os.Bundle import androidx.activity.ComponentActivity import androidx.appcompat.app.AppCompatActivity import dev.shreyaspatil.permissionFlow.example.databinding.ActivityMainBinding import dev.shreyaspatil.permissionFlow.example.ui.composePermission.ComposePermissionActivity import dev.shreyaspatil.permissionFlow.example.ui.contacts.ContactsActivity import dev.shreyaspatil.permissionFlow.example.ui.fragment.ExampleFragmentActivity import dev.shreyaspatil.permissionFlow.example.ui.multipermission.MultiPermissionActivity class MainActivity : AppCompatActivity() { private lateinit var binding: ActivityMainBinding override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) binding = ActivityMainBinding.inflate(layoutInflater) setContentView(binding.root) with(binding) { buttonContacts.setOnClickListener { launchScreen() } buttonMultiPermission.setOnClickListener { launchScreen() } buttonComposeSample.setOnClickListener { launchScreen() } buttonFragmentSample.setOnClickListener { launchScreen() } } } private inline fun launchScreen() { startActivity(Intent(this, S::class.java)) } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/composePermission/ComposePermissionActivity.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.composePermission import android.os.Bundle import androidx.activity.ComponentActivity import androidx.activity.compose.setContent import androidx.compose.foundation.background import androidx.compose.foundation.layout.Arrangement import androidx.compose.foundation.layout.Column import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.foundation.layout.padding import androidx.compose.material.Button import androidx.compose.material.Text import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier import androidx.compose.ui.graphics.Color import androidx.compose.ui.unit.dp import dev.shreyaspatil.permissionflow.compose.rememberMultiplePermissionState import dev.shreyaspatil.permissionflow.compose.rememberPermissionFlowRequestLauncher /** * The example activity which demonstrates the usage of PermissionFlow APIs in the Jetpack Compose */ class ComposePermissionActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContent { MainScreen() } } } private val permissions = arrayOf( android.Manifest.permission.CAMERA, android.Manifest.permission.READ_EXTERNAL_STORAGE, android.Manifest.permission.READ_CALL_LOG, android.Manifest.permission.READ_CONTACTS, android.Manifest.permission.READ_PHONE_STATE, ) @Composable fun MainScreen() { val permissionLauncher = rememberPermissionFlowRequestLauncher() val state by rememberMultiplePermissionState(*permissions) // or use `rememberPermissionState()` to get the state of a single permission Column( modifier = Modifier.fillMaxSize().padding(16.dp), verticalArrangement = Arrangement.spacedBy(8.dp, Alignment.CenterVertically), horizontalAlignment = Alignment.CenterHorizontally, ) { Button(onClick = { permissionLauncher.launch(permissions) }) { Text("Request Permissions") } Column(modifier = Modifier.background(Color.Green).padding(16.dp)) { Text(text = "Granted Permissions:") Text(text = state.grantedPermissions.joinToString()) } Column(modifier = Modifier.background(Color.Red).padding(16.dp)) { Text(text = "Denied Permissions:") Text(text = state.deniedPermissions.joinToString()) } } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/contacts/ContactsActivity.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.contacts import android.Manifest import android.os.Bundle import android.widget.Toast import androidx.activity.viewModels import androidx.appcompat.app.AppCompatActivity import androidx.lifecycle.flowWithLifecycle import androidx.lifecycle.lifecycleScope import dev.shreyaspatil.permissionFlow.example.databinding.ActivityContactsBinding import dev.shreyaspatil.permissionFlow.utils.launch import dev.shreyaspatil.permissionFlow.utils.registerForPermissionFlowRequestsResult import kotlinx.coroutines.flow.launchIn import kotlinx.coroutines.flow.onEach class ContactsActivity : AppCompatActivity() { private lateinit var binding: ActivityContactsBinding private val viewModel by viewModels { ContactsViewModel.FactoryProvider(contentResolver).get() } private val permissionLauncher = registerForPermissionFlowRequestsResult() override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) binding = ActivityContactsBinding.inflate(layoutInflater) setContentView(binding.root) observeStates() } private fun render(state: ContactsUiEvents) { when (state) { ContactsUiEvents.ContactPermissionGranted -> { binding.permissionStatusText.apply { text = "Contacts Permission Granted!" setOnClickListener(null) } } ContactsUiEvents.ContactPermissionNotGranted -> { binding.permissionStatusText.apply { text = "Click here to ask for contacts permission" setOnClickListener { askContactsPermission() } } } is ContactsUiEvents.ContactsAvailable -> { binding.contactsDataText.text = state.contacts.joinToString("\n") { "${it.id}. ${it.name} (${it.number})" } } is ContactsUiEvents.Failure -> { Toast.makeText(this, state.error, Toast.LENGTH_SHORT).show() } } } private fun askContactsPermission() { permissionLauncher.launch(Manifest.permission.READ_CONTACTS) } private fun observeStates() { viewModel.state.flowWithLifecycle(lifecycle).onEach { render(it) }.launchIn(lifecycleScope) } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/contacts/ContactsUiEvents.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.contacts import dev.shreyaspatil.permissionFlow.example.data.model.Contact sealed class ContactsUiEvents { object ContactPermissionNotGranted : ContactsUiEvents() object ContactPermissionGranted : ContactsUiEvents() data class ContactsAvailable(val contacts: List) : ContactsUiEvents() data class Failure(val error: String) : ContactsUiEvents() } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/contacts/ContactsViewModel.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.contacts import android.Manifest import android.content.ContentResolver import androidx.lifecycle.ViewModel import androidx.lifecycle.ViewModelProvider import androidx.lifecycle.viewModelScope import androidx.lifecycle.viewmodel.ViewModelInitializer import dev.shreyaspatil.permissionFlow.PermissionFlow import dev.shreyaspatil.permissionFlow.example.data.ContactRepository import dev.shreyaspatil.permissionFlow.example.data.impl.AndroidDefaultContactRepository import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.Channel.Factory.BUFFERED import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.catch import kotlinx.coroutines.flow.receiveAsFlow import kotlinx.coroutines.launch class ContactsViewModel( private val repository: ContactRepository, private val permissionFlow: PermissionFlow = PermissionFlow.getInstance(), ) : ViewModel() { private val uiEvents = Channel(capacity = BUFFERED) val state: Flow = uiEvents.receiveAsFlow() init { observeContacts() observeContactsPermission() } private fun observeContacts() { viewModelScope.launch { repository.allContacts .catch { setNextState(ContactsUiEvents.Failure(it.message ?: "Error occurred")) } .collect { contacts -> setNextState(ContactsUiEvents.ContactsAvailable(contacts)) } } } private fun observeContactsPermission() { viewModelScope.launch { permissionFlow.getPermissionState(Manifest.permission.READ_CONTACTS).collect { state -> if (state.isGranted) { setNextState(ContactsUiEvents.ContactPermissionGranted) } else { setNextState(ContactsUiEvents.ContactPermissionNotGranted) } } } } private fun setNextState(nextState: ContactsUiEvents) { uiEvents.trySend(nextState) } class FactoryProvider(private val contentResolver: ContentResolver) { fun get(): ViewModelProvider.Factory { val initializer = ViewModelInitializer(ContactsViewModel::class.java) { ContactsViewModel(AndroidDefaultContactRepository(contentResolver)) } return ViewModelProvider.Factory.from(initializer) } } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/fragment/ExampleFragment.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.fragment import android.os.Bundle import android.view.LayoutInflater import android.view.View import android.view.ViewGroup import androidx.core.view.isVisible import androidx.fragment.app.Fragment import androidx.lifecycle.lifecycleScope import dev.shreyaspatil.permissionFlow.PermissionFlow import dev.shreyaspatil.permissionFlow.example.databinding.ViewFragmentExampleBinding import dev.shreyaspatil.permissionFlow.utils.registerForPermissionFlowRequestsResult import kotlinx.coroutines.launch @Suppress("ktlint:standard:property-naming") class ExampleFragment : Fragment() { private var _binding: ViewFragmentExampleBinding? = null private val binding: ViewFragmentExampleBinding get() = _binding!! private val permissions = arrayOf( android.Manifest.permission.CAMERA, android.Manifest.permission.READ_CALL_LOG, android.Manifest.permission.READ_CONTACTS, android.Manifest.permission.READ_PHONE_STATE, ) private val permissionFlow = PermissionFlow.getInstance() private val permissionLauncher = registerForPermissionFlowRequestsResult() override fun onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?, ): View { _binding = ViewFragmentExampleBinding.inflate(inflater, null, false) return binding.root } override fun onViewCreated(view: View, savedInstanceState: Bundle?) { super.onViewCreated(view, savedInstanceState) initView() observePermissions() } private fun initView() { binding.button.setOnClickListener { permissionLauncher.launch(permissions) } } private fun observePermissions() { viewLifecycleOwner.lifecycleScope.launch { permissionFlow.getMultiplePermissionState(*permissions).collect { val grantedPermissionsText = it.grantedPermissions.joinToString( separator = "\n", prefix = "Granted Permissions:\n", ) val deniedPermissionsText = it.deniedPermissions.joinToString( separator = "\n", prefix = "Denied Permissions:\n", ) binding.grantedPermissionsText.text = grantedPermissionsText binding.deniedPermissionsText.text = deniedPermissionsText binding.button.isVisible = !it.allGranted } } } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/fragment/ExampleFragmentActivity.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.fragment import android.os.Bundle import android.widget.FrameLayout import androidx.appcompat.app.AppCompatActivity import dev.shreyaspatil.permissionFlow.example.R class ExampleFragmentActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_fragment_example) findViewById(R.id.frameLayout).let { frameLayout -> supportFragmentManager .beginTransaction() .replace(frameLayout.id, ExampleFragment()) .commit() } } } ================================================ FILE: app/src/main/java/dev/shreyaspatil/permissionFlow/example/ui/multipermission/MultiPermissionActivity.kt ================================================ /** * 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. */ package dev.shreyaspatil.permissionFlow.example.ui.multipermission import android.os.Bundle import android.widget.Toast import androidx.appcompat.app.AppCompatActivity import androidx.lifecycle.flowWithLifecycle import androidx.lifecycle.lifecycleScope import dev.shreyaspatil.permissionFlow.MultiplePermissionState import dev.shreyaspatil.permissionFlow.PermissionFlow import dev.shreyaspatil.permissionFlow.example.databinding.ActivityMultipermissionBinding import dev.shreyaspatil.permissionFlow.utils.registerForPermissionFlowRequestsResult import kotlinx.coroutines.flow.launchIn import kotlinx.coroutines.flow.onEach /** * This example activity shows how to use [PermissionFlow] to request multiple permissions at once * and observe multiple permissions at once. */ class MultiPermissionActivity : AppCompatActivity() { private lateinit var binding: ActivityMultipermissionBinding private val permissionFlow = PermissionFlow.getInstance() private val permissionLauncher = registerForPermissionFlowRequestsResult() private val permissions = arrayOf( android.Manifest.permission.CAMERA, android.Manifest.permission.READ_EXTERNAL_STORAGE, android.Manifest.permission.READ_CALL_LOG, android.Manifest.permission.READ_CONTACTS, android.Manifest.permission.READ_PHONE_STATE, ) override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) binding = ActivityMultipermissionBinding.inflate(layoutInflater) setContentView(binding.root) initViews() observePermissions() } private fun initViews() { binding.buttonAskPermission.setOnClickListener { permissionLauncher.launch(permissions) } } private fun observePermissions() { permissionFlow .getMultiplePermissionState( *permissions) // or use `getPermissionState()` for observing a single permission .flowWithLifecycle(lifecycle) .onEach { onPermissionStateChange(it) } .launchIn(lifecycleScope) } private fun onPermissionStateChange(state: MultiplePermissionState) { if (state.allGranted) { Toast.makeText(this, "All permissions are granted!", Toast.LENGTH_SHORT).show() } binding.textViewGrantedPermissions.text = "Granted permissions: ${state.grantedPermissions.joinToStringByNewLine()}" binding.textViewDeniedPermissions.text = "Denied permissions: ${state.deniedPermissions.joinToStringByNewLine()}" } private fun List.joinToStringByNewLine(): String { return joinToString(prefix = "\n", postfix = "\n", separator = ",\n") } } ================================================ FILE: app/src/main/res/drawable/ic_launcher_background.xml ================================================ ================================================ FILE: app/src/main/res/drawable-v24/ic_launcher_foreground.xml ================================================ ================================================ FILE: app/src/main/res/layout/activity_contacts.xml ================================================ ================================================ FILE: app/src/main/res/layout/activity_fragment_example.xml ================================================ ================================================ FILE: app/src/main/res/layout/activity_main.xml ================================================