PermissionsDispatcher

Additional

Language
Java
Version
2.4.0 (May 1, 2017)
Created
Aug 15, 2015
Updated
Jul 21, 2017
Owner
Shintaro Katafuchi (hotchemi)
Contributors
egor-n
Sosuke Masui (esmasui)
Shintaro Katafuchi (hotchemi)
punchdrunker
WonderCsabo
Michael Basil (intrications)
Takao Chiba (chibatching)
Henry Addo (eyedol)
Marcel Schnelle (aurae)
Yoshinori Isogai (shiraji)
Louis CAD (LouisCAD)
Jumpei Matsuda (jmatsu)
sibelius
snkashis
marciogranzotto
Aleksey Bogomolov (horse315)
patricemueller
eliseo-juan
18
Activity
Badge
Generate
Download
Source code
APK file

Announcement

PermissionsDispatcher

PermissionsDispatcher provides a simple annotation-based API to handle runtime permissions in Android Marshmallow.

This library lifts the burden that comes with writing a bunch of check statements whether a permission has been granted or not from you, in order to keep your code clean and safe.

Usage

If you're using Kotlin consider .kt file generation to make code much more concise!

Here's a minimum example, in which we register a MainActivity which requires Manifest.permission.CAMERA.

0. Prepare AndroidManifest

Add the following line to AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />

1. Attach annotations

PermissionsDispatcher introduces only a few annotations, keeping its general API concise:

NOTE: Annotated methods must not be private.

Annotation Required Description
@RuntimePermissions Register an Activity or Fragment(we support both) to handle permissions
@NeedsPermission Annotate a method which performs the action that requires one or more permissions
@OnShowRationale Annotate a method which explains why the permission/s is/are needed. It passes in a PermissionRequest object which can be used to continue or abort the current permission request upon user input
@OnPermissionDenied Annotate a method which is invoked if the user doesn't grant the permissions
@OnNeverAskAgain Annotate a method which is invoked if the user chose to have the device "never ask again" about a permission
@RuntimePermissions
public class MainActivity extends AppCompatActivity {

    @NeedsPermission(Manifest.permission.CAMERA)
    void showCamera() {
        getSupportFragmentManager().beginTransaction()
                .replace(R.id.sample_content_fragment, CameraPreviewFragment.newInstance())
                .addToBackStack("camera")
                .commitAllowingStateLoss();
    }

    @OnShowRationale(Manifest.permission.CAMERA)
    void showRationaleForCamera(final PermissionRequest request) {
        new AlertDialog.Builder(this)
            .setMessage(R.string.permission_camera_rationale)
            .setPositiveButton(R.string.button_allow, (dialog, button) -> request.proceed())
            .setNegativeButton(R.string.button_deny, (dialog, button) -> request.cancel())
            .show();
    }

    @OnPermissionDenied(Manifest.permission.CAMERA)
    void showDeniedForCamera() {
        Toast.makeText(this, R.string.permission_camera_denied, Toast.LENGTH_SHORT).show();
    }

    @OnNeverAskAgain(Manifest.permission.CAMERA)
    void showNeverAskForCamera() {
        Toast.makeText(this, R.string.permission_camera_neverask, Toast.LENGTH_SHORT).show();
    }
}

2. Delegate to generated class

Upon compilation, PermissionsDispatcher generates a class for MainActivityPermissionsDispatcher([Activity Name] + PermissionsDispatcher), which you can use to safely access these permission-protected methods.

The only step you have to do is delegating the work to this helper class:

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    findViewById(R.id.button_camera).setOnClickListener(v -> {
      // NOTE: delegate the permission handling to generated method
      MainActivityPermissionsDispatcher.showCameraWithCheck(this);
    });
}

@Override
public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
    super.onRequestPermissionsResult(requestCode, permissions, grantResults);
    // NOTE: delegate the permission handling to generated method
    MainActivityPermissionsDispatcher.onRequestPermissionsResult(this, requestCode, grantResults);
}

Check out the sample for more details.

Getting Special Permissions

maxSdkVersion

Misc

Xiaomi

Since Xiaomi manipulates something around runtime permission mechanism Google's recommended way doesn't work well. But don't worry, PermissionsDispatcher supports it! Check related PR for more detail.

IntelliJ plugin

You can use IntelliJ plugin developed by @shiraji.

For AndroidAnnotations users

If you use AndroidAnnotations, you need to add AndroidAnnotationsPermissionsDispatcherPlugin to your dependencies so PermissionsDispatcher's looks for AA's subclasses (your project won't compile otherwise). Moreover, you should not delegate to PermissionsDispatcher's generated classes, because AA will do that for you, just call your methods directly. See the AndroidAnnotationsPermissionsDispatcherPlugin readme for details.

Knows issues

See doc.

Users

Thankfully we've got hundreds of users around the world!

Download

To add it to your project, include the following in your app module build.gradle file:

${latest.version} is

dependencies {
  compile("com.github.hotchemi:permissionsdispatcher:${latest.version}") {
      // if you don't use android.app.Fragment you can exclude support for them
      exclude module: "support-v13"
  }
  annotationProcessor "com.github.hotchemi:permissionsdispatcher-processor:${latest.version}"
}

Snapshots of the development version are available in JFrog's snapshots repository. Add the repo below to download SNAPSHOT releases.

repositories {
  jcenter()
  maven { url 'http://oss.jfrog.org/artifactory/oss-snapshot-local/' }
}

If you're in trouble and use Jitpack check this doc.

Licence

Copyright 2016 Shintaro Katafuchi, Marcel Schnelle, Yoshinori Isogai

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.