pub.devrel.easypermissions

Class EasyPermissions

java.lang.Object

pub.devrel.easypermissions.EasyPermissions

public class EasyPermissions
extends Object

Utility to request and check System permissions for apps targeting Android M (API >= 23).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EasyPermissions.PermissionCallbacks Callback interface to receive the results of EasyPermissions.requestPermissions() calls.
static interface	EasyPermissions.RationaleCallbacks Callback interface to receive button clicked events of the rationale dialog

Constructor Summary

Constructors

Constructor and Description
EasyPermissions()

Method Summary

Modifier and Type	Method and Description
static boolean	hasPermissions(android.content.Context context, String... perms) Check if the calling context has a set of permissions.
static void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults, Object... receivers) Handle the result of a permission request, should be called from the calling Activity's ActivityCompat.OnRequestPermissionsResultCallback#onRequestPermissionsResult(int, String[], int[]) method.
static boolean	permissionPermanentlyDenied(android.app.Activity host, String deniedPermission) Check if a permission has been permanently denied (user clicked "Never ask again").
static boolean	permissionPermanentlyDenied(androidx.fragment.app.Fragment host, String deniedPermission)
static void	requestPermissions(android.app.Activity host, String rationale, int requestCode, String... perms) Request a set of permissions, showing a rationale if the system requests it.
static void	requestPermissions(androidx.fragment.app.Fragment host, String rationale, int requestCode, String... perms) Request permissions from a Support Fragment with standard OK/Cancel buttons.
static void	requestPermissions(PermissionRequest request) Request a set of permissions.
static boolean	somePermissionDenied(android.app.Activity host, String... perms) See if some denied permission has been permanently denied.
static boolean	somePermissionDenied(androidx.fragment.app.Fragment host, String... perms)
static boolean	somePermissionPermanentlyDenied(android.app.Activity host, List<String> deniedPermissions) Check if at least one permission in the list of denied permissions has been permanently denied (user clicked "Never ask again").
static boolean	somePermissionPermanentlyDenied(androidx.fragment.app.Fragment host, List<String> deniedPermissions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EasyPermissions

public EasyPermissions()

Method Detail

hasPermissions

public static boolean hasPermissions(@NonNull
                                     android.content.Context context,
                                     @NonNull
                                     String... perms)

Check if the calling context has a set of permissions.

Parameters:

context - the calling context.

perms - one ore more permissions, such as Manifest.permission#CAMERA.

Returns:

true if all permissions are already granted, false if at least one permission is not yet granted.

See Also:

Manifest.permission

requestPermissions

public static void requestPermissions(@NonNull
                                      android.app.Activity host,
                                      @NonNull
                                      String rationale,
                                      int requestCode,
                                      @NonNull
                                      String... perms)

Request a set of permissions, showing a rationale if the system requests it.

Parameters:

host - requesting context.

rationale - a message explaining why the application needs this set of permissions; will be displayed if the user rejects the request the first time.

requestCode - request code to track this request, must be < 256.

perms - a set of permissions to be requested.

See Also:

Manifest.permission

requestPermissions

public static void requestPermissions(@NonNull
                                      androidx.fragment.app.Fragment host,
                                      @NonNull
                                      String rationale,
                                      int requestCode,
                                      @NonNull
                                      String... perms)

Request permissions from a Support Fragment with standard OK/Cancel buttons.

See Also:

requestPermissions(Activity, String, int, String...)

requestPermissions

public static void requestPermissions(PermissionRequest request)

Request a set of permissions.

Parameters:

request - the permission request

See Also:

PermissionRequest

onRequestPermissionsResult

public static void onRequestPermissionsResult(int requestCode,
                                              @NonNull
                                              String[] permissions,
                                              @NonNull
                                              int[] grantResults,
                                              @NonNull
                                              Object... receivers)

Handle the result of a permission request, should be called from the calling Activity's ActivityCompat.OnRequestPermissionsResultCallback#onRequestPermissionsResult(int, String[], int[]) method.

If any permissions were granted or denied, the object will receive the appropriate callbacks through EasyPermissions.PermissionCallbacks and methods annotated with AfterPermissionGranted will be run if appropriate.

Parameters:

requestCode - requestCode argument to permission result callback.

permissions - permissions argument to permission result callback.

grantResults - grantResults argument to permission result callback.

receivers - an array of objects that have a method annotated with AfterPermissionGranted or implement EasyPermissions.PermissionCallbacks.

somePermissionPermanentlyDenied

public static boolean somePermissionPermanentlyDenied(@NonNull
                                                      android.app.Activity host,
                                                      @NonNull
                                                      List<String> deniedPermissions)

Check if at least one permission in the list of denied permissions has been permanently denied (user clicked "Never ask again"). Note: Due to a limitation in the information provided by the Android framework permissions API, this method only works after the permission has been denied and your app has received the onPermissionsDenied callback. Otherwise the library cannot distinguish permanent denial from the "not yet denied" case.

Parameters:

host - context requesting permissions.

deniedPermissions - list of denied permissions, usually from EasyPermissions.PermissionCallbacks.onPermissionsDenied(int, List)

Returns:

true if at least one permission in the list was permanently denied.

somePermissionPermanentlyDenied

public static boolean somePermissionPermanentlyDenied(@NonNull
                                                      androidx.fragment.app.Fragment host,
                                                      @NonNull
                                                      List<String> deniedPermissions)

See Also:

somePermissionPermanentlyDenied(Activity, List)

permissionPermanentlyDenied

public static boolean permissionPermanentlyDenied(@NonNull
                                                  android.app.Activity host,
                                                  @NonNull
                                                  String deniedPermission)

Check if a permission has been permanently denied (user clicked "Never ask again").

Parameters:

host - context requesting permissions.

deniedPermission - denied permission.

Returns:

true if the permissions has been permanently denied.

permissionPermanentlyDenied

public static boolean permissionPermanentlyDenied(@NonNull
                                                  androidx.fragment.app.Fragment host,
                                                  @NonNull
                                                  String deniedPermission)

See Also:

permissionPermanentlyDenied(Activity, String)

somePermissionDenied

public static boolean somePermissionDenied(@NonNull
                                           android.app.Activity host,
                                           @NonNull
                                           String... perms)

See if some denied permission has been permanently denied.

Parameters:

host - requesting context.

perms - array of permissions.

Returns:

true if the user has previously denied any of the perms and we should show a rationale, false otherwise.

somePermissionDenied

public static boolean somePermissionDenied(@NonNull
                                           androidx.fragment.app.Fragment host,
                                           @NonNull
                                           String... perms)

See Also:

somePermissionDenied(Activity, String...)