PermissionsDispatcher vs AndroidX ActivityResult API for handling permissions

PermissionsDispatcher uses annotations to generate compile-time code for a declarative approach, reducing boilerplate, while AndroidX ActivityResult API is a modern, callback-based solution integrated into the framework. Choose PermissionsDispatcher for type-safe, reflection-free handling, but AndroidX API might be better for teams preferring official Google support and minimal dependencies.

How to handle multiple permissions with PermissionsDispatcher

Annotate a method with @NeedsPermission and list multiple permissions, e.g., @NeedsPermission(Manifest.permission.CAMERA, Manifest.permission.RECORD_AUDIO). The generated function manages all permissions, and you can use @OnShowRationale, @OnPermissionDenied, and @OnNeverAskAgain annotations for each permission or collectively to customize the flow.

Does PermissionsDispatcher work with Jetpack Compose?

No, PermissionsDispatcher is designed for Activities and Fragments, not directly for Jetpack Compose. For Compose apps, you'd need to use it within an Activity or Fragment context, or consider alternatives like Accompanist Permissions library which is built for Compose.

How to test permission flows in apps using PermissionsDispatcher

Testing involves mocking the generated methods and permission states using unit tests for annotation logic and integration tests with Android frameworks. The library doesn't provide built-in testing tools, so you'll rely on standard Android testing libraries like Espresso or Mockito to simulate grants and denials.

PermissionsDispatcher special permissions example for system overlay

For special permissions like SYSTEM_ALERT_WINDOW, refer to the special permissions documentation which provides examples using @NeedsPermission with specific flags and handling the intent-based requests required, such as overriding onActivityResult for unique permission flows.

Migrating from jCenter to MavenCentral for PermissionsDispatcher

PermissionsDispatcher has moved to MavenCentral; follow the migration guide in the README to update your build.gradle dependencies. Replace jCenter repositories with MavenCentral and ensure you're using the latest version from the new artifact source to avoid build errors.

Permission Dispatcher — Android Runtime Permissions Library

What is Permission Dispatcher?

PermissionsDispatcher is an open-source Android library that provides a declarative, annotation-based API for handling runtime permissions. It solves the problem of verbose and error-prone permission-checking code by generating the necessary logic at compile time, allowing developers to focus on app functionality instead of permission boilerplate.

Target Audience

Android developers building apps that require runtime permissions, particularly those using Kotlin or Java who want a type-safe, maintainable solution.

Value Proposition

Developers choose PermissionsDispatcher because it offers a clean, reflection-free approach that reduces boilerplate, integrates seamlessly with Android lifecycle, and supports both Kotlin and Java with special permission handling.

A declarative API to handle Android runtime permissions.

Use Cases

Best For

Simplifying runtime permission requests in Android apps
Reducing boilerplate code for permission checks
Handling special permissions like system overlay or write settings
Integrating permission logic with Android Activities and Fragments
Building maintainable permission flows in Kotlin or Java
Ensuring type-safe permission handling without runtime reflection

Not Ideal For

Projects using AndroidX ActivityResult API or other modern permission helpers that prefer callback-based approaches
Apps with minimal permission needs where a few lines of native code suffice, avoiding extra dependencies
Teams that avoid annotation processors due to increased build times or toolchain complexity
Cross-platform frameworks like Flutter or React Native where permission handling is managed through platform channels

Pros & Cons

Pros

Annotation-Based Simplicity

Uses concise annotations like @RuntimePermissions and @NeedsPermission to declare permission requirements, drastically reducing boilerplate code as shown in the Kotlin example with generated methods like showCameraWithPermissionCheck.

Reflection-Free Performance

Generates all permission-handling code at compile time, avoiding runtime reflection for better performance and safety, which is emphasized as a core feature in the README.

Special Permissions Support

Handles tricky permissions like system overlay or write settings with specific annotations and documentation, making it easier to manage beyond standard runtime permissions.

Kotlin and Java Compatibility

Works seamlessly with both Kotlin (via kapt or ktx) and Java (via apt), offering flexibility for diverse codebases without sacrificing functionality.

Cons

Annotation Processor Overhead

Requires setting up kapt for Kotlin or apt for Java, which can slow down build times and add configuration complexity, especially in large projects.

Limited Component Scope

Only supports Activities and Fragments, not other Android components like Services or ViewModels, forcing workarounds for broader use cases.

Version Fragmentation

Has separate versions for Jetpack and appcompat (4.x vs 3.x), requiring careful migration and potentially causing compatibility issues, as noted in the installation section.

Frequently Asked Questions

What is Permission Dispatcher?

Target Audience

Android developers building apps that require runtime permissions, particularly those using Kotlin or Java who want a type-safe, maintainable solution.

Value Proposition

Use Cases

Best For

Simplifying runtime permission requests in Android apps
Reducing boilerplate code for permission checks
Handling special permissions like system overlay or write settings
Integrating permission logic with Android Activities and Fragments
Building maintainable permission flows in Kotlin or Java
Ensuring type-safe permission handling without runtime reflection

Not Ideal For

Projects using AndroidX ActivityResult API or other modern permission helpers that prefer callback-based approaches
Apps with minimal permission needs where a few lines of native code suffice, avoiding extra dependencies
Teams that avoid annotation processors due to increased build times or toolchain complexity
Cross-platform frameworks like Flutter or React Native where permission handling is managed through platform channels

Pros & Cons

Pros

Annotation-Based Simplicity

Reflection-Free Performance

Generates all permission-handling code at compile time, avoiding runtime reflection for better performance and safety, which is emphasized as a core feature in the README.

Special Permissions Support

Handles tricky permissions like system overlay or write settings with specific annotations and documentation, making it easier to manage beyond standard runtime permissions.

Kotlin and Java Compatibility

Works seamlessly with both Kotlin (via kapt or ktx) and Java (via apt), offering flexibility for diverse codebases without sacrificing functionality.

Cons

Annotation Processor Overhead

Requires setting up kapt for Kotlin or apt for Java, which can slow down build times and add configuration complexity, especially in large projects.

Limited Component Scope

Only supports Activities and Fragments, not other Android components like Services or ViewModels, forcing workarounds for broader use cases.

Version Fragmentation

Has separate versions for Jetpack and appcompat (4.x vs 3.x), requiring careful migration and potentially causing compatibility issues, as noted in the installation section.

Frequently Asked Questions

Permission Dispatcher

What is Permission Dispatcher?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Permission Dispatcher

What is Permission Dispatcher?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?