simple-runtime-permission

A simple Android runtime permission handler

中文文档

Joke with my poor English

This library refers from those library, give original author high respect.

The core to achieve the idea of learning and reference tbruyelle/RxPermissions

• tbruyelle/RxPermissions
• hotchemi/PermissionsDispatcher
• yanzhenjie/AndPermission

Environment

Android API_LEVEL >= 11

Reference Method

• Gradle LatestVersion is

repositories {
  maven { url 'https://jitpack.io' } // If not already there
}

dependencies {

  /*
  BaseLibrary
  */
  compile 'com.github.imfms.simple-runtime-permission:simple-runtime-permission:${latest.version}'

  /*
  Support For RxJava1
  */
  compile 'com.github.imfms.simple-runtime-permission:simple-runtime-permission-rxjava1:${latest.version}'

  /*
  Support For RxJava2
  */
  compile 'com.github.imfms.simple-runtime-permission:simple-runtime-permission-rxjava2:${latest.version}'
}

How to use

Base Library

normal callback mode

Example

// Request 'read contacts' & 'call phone' permission, When user has refused this permission(not select never tip)  tell user why need this permission
SimpleRuntimePermissionHelper.with(mActivity)
  .permission(Manifest.permission.READ_CONTACTS, Manifest.permission.CALL_PHONE)
  .showPermissionRationaleListener(new ShowRequestPermissionRationaleListener() {
      @Override
      public void onShowRequestPermissionRationale(final ShowRequestPermissionRationaleControler controler, String[] permissions) {
          new AlertDialog.Builder(mActivity)
                  .setTitle("Tips")
                  .setMessage("Please Give Me Those Permissions")
                  .setPositiveButton("Yes, I Will", new DialogInterface.OnClickListener() {
                      @Override
                      public void onClick(DialogInterface dialog, int which) {
                          controler.doContinue();
                      }
                  })
                  .setNegativeButton("Sorry, I can't", new DialogInterface.OnClickListener() {
                      @Override
                      public void onClick(DialogInterface dialog, int which) {
                          controler.doCancel();
                      }
                  })
                  .setCancelable(false)
                  .create()
                  .show();
      }

      @Override
      public void onRequestPermissionRationaleRefuse(String[] permissions) {
          Toast.makeText(mActivity, "Well, You refused.", Toast.LENGTH_SHORT).show();
      }
  })
  .execute(new PermissionListener() {
      @Override
      public void onAllPermissionGranted() {
          Toast.makeText(mActivity, requestSuccessStr, Toast.LENGTH_SHORT).show();
      }

      @Override
      public void onPermissionRefuse(PermissionRefuseResultHelper resultHelper) {
          String str = String.format("all: %s\ngranted: %s\nrefuse:%s\nnever_ask: %s",
                  resultHelper.getAllPermissions(),
                  resultHelper.getGrantPermissions(),
                  resultHelper.getRefusePermissions(),
                  resultHelper.getNeverAskAgainPermissions()
          );

          new AlertDialog.Builder(MainActivity.this)
                  .setMessage(str)
                  .show();
      }
  });

Argument Explain

// create new instance, linked mode invoke
SimpleRuntimePermissionHelper.with(mActivity)
  // Permission string array, accept mulit args, recommend use from Manifest.permission.*
  .permission(PermissionStr...)
  // [Optional] ShowRequestPermissionRationaleListener ShowRequestPermissionRationale callback listener, can refer official document Requesting Permissions at https://developer.android.com/training/permissions/requesting.html#explain
  .showPermissionRationaleListener(new ShowRequestPermissionRationaleListener() {
      @Override
      public void onShowRequestPermissionRationale(ShowRequestPermissionRationaleControler controler, String[] permissions) {
        /* 
        when need show RequestPermissionRationale tips, developer can custom show ui. need call controler's method doContinue() or doCancel when user select agree or refuse from your custom ui
        controler.doContinue(); // user agree
        controler.doCancel(); // user refuse
        */
      }

      @Override
      public void onRequestPermissionRationaleRefuse(String[] permissions) {
          /*
          When request permission rationale refuse
          when ShowRequestPermissionRationaleControler.doCancel() invoke
          */
      }
  })
  // request it
  .execute(new PermissionListener() {
      @Override
      public void onAllPermissionGranted() {
           // When all of request permissions were granted
      }

      @Override
      public void onPermissionRefuse(PermissionRefuseResultHelper resultHelper) {
          // When any permissions were refused
      }
  });

For RxJava1

1. Instance RxSimpleRuntimePermission

   RxSimpleRuntimePermission(Activity activity)
   

2. Invoke request permision method

   • compose Use RxJava operator 'compose' to compose request permission action, when get refuse result it will wrapper result to PermissionException for subscriber's onError()

       <T> RxSimpleRuntimePermissionTransform<T> compose(ShowRequestPermissionRationaleListener showRequestPermissionRationaleListener, String... permissions)
     

   • request Create observer, developer can subscribe result, when get refuse result it will wrapper result to PermissionException for subscriber's onError()

       Observable<None> request(ShowRequestPermissionRationaleListener showRequestPermissionRationaleListener, String... permissions)
     

   • Permisssion Exception

   public class PermissionException extends RuntimeException {
       public final PermissionRefuseResultHelper result;
   }

3. Sample

   Request 'read contacts' & 'call phone' permission, When user has refused this permission(not select never tip) tell user why need this permission

   RxSimpleRuntimePermission rxSimpleRuntimePermission = new RxSimpleRuntimePermission(mActivity);
   
   Observable.just(requestSuccessStr)
           .compose(rxSimpleRuntimePermission.<String>compose(
                   new ShowRequestPermissionRationaleListener() {
                       @Override
                       public void onShowRequestPermissionRationale(ShowRequestPermissionRationaleControler controler, String[] permissions) {
   
                           new AlertDialog.Builder(mActivity)
                                   .setTitle("PermissionRequestTip")
                                   .setMessage("I need those permissions, please select agree")
                                   .setPositiveButton("OK", new DialogInterface.OnClickListener() {
                                       @Override
                                       public void onClick(DialogInterface dialog, int which) {
                                           controler.doContinue();
                                       }
                                   })
                                   .setNegativeButton("Refuse", new DialogInterface.OnClickListener() {
                                       @Override
                                       public void onClick(DialogInterface dialog, int which) {
                                           controler.doCancel();
                                       }
                                   })
                                   .create()
                                   .show();
   
                       }
   
                       @Override
                       public void onRequestPermissionRationaleRefuse(String[] permissions) {
                          Toast.makeText(mActivity, "Fail, user refused request permission tip", Toast.LENGTH_SHORT).show();
                       }
                   }
                   , Manifest.permission.READ_CONTACTS, Manifest.permission.CALL_PHONE)
           )
           .subscribe(new Subscriber<String>() {
               @Override
               public void onCompleted() {
   
               }
   
               @Override
               public void onError(Throwable e) {
                   if (e instanceof cn.f_ms.runtimepermission.simple.rxjava1.PermissionException) {
                       Toast.makeText(mActivity, e.getMessage(), Toast.LENGTH_SHORT).show();
                   }
               }
   
               @Override
               public void onNext(String s) {
                   Toast.makeText(mActivity, s, Toast.LENGTH_SHORT).show();
               }
           });

For RxJava2

Same with For RxJava1

Links

• Android Runtime Permission Official Document Working with System Permissions