xappmedia.sdk.permissions

Class PermissionsManager

java.lang.Object

xappmedia.sdk.permissions.PermissionsManager

public abstract class PermissionsManager
extends java.lang.Object

Utility method that can be used to handle all permissions tasks including Android M permissions.

Constructor Summary

Constructors

Constructor and Description
PermissionsManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkPermission(java.lang.String permission) Check if the current app has the permission specified.
abstract java.util.Set<java.lang.String>	getDeniedPermissions(java.util.Collection<java.lang.String> permissionsToCheck) Check all the permission in a collection and return a subset of the permissions that the user currently has not granted.
abstract java.util.Set<java.lang.String>	getDeniedPermissions(java.lang.String[] permissionsToCheck) Check all the permission in a collection and return a subset of the permissions that the user currently has not granted.
static PermissionsManager	instance(android.app.Activity act) This wraps the check permissions of any Activity so it will be compatible with old versions of Android.
abstract boolean	requestPermission(java.lang.String permission, int requestCode) Request a permission for a specific service.
abstract boolean	requestPermissions(java.util.Collection<java.lang.String> permissions, int requestCode) Request a permission for a specific service.
abstract boolean	requestPermissions(java.lang.String[] permissions, int requestCode) Request a permission for a specific service.
abstract boolean	shouldShowRequestPermissionRationale(java.lang.String permission) This will always return false if the build version is less than M.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsManager

public PermissionsManager()

Method Detail

instance

public static PermissionsManager instance(android.app.Activity act)

This wraps the check permissions of any Activity so it will be compatible with old versions of Android. Do not keep the reference of the returned object outside the scope of the Activity that created it.

getDeniedPermissions

public abstract java.util.Set<java.lang.String> getDeniedPermissions(java.util.Collection<java.lang.String> permissionsToCheck)

Check all the permission in a collection and return a subset of the permissions that the user currently has not granted.

Parameters:

permissionsToCheck - List of permissions to check if they are granted or not.

Returns:

List of permissions that are currently not granted to the application.

getDeniedPermissions

public abstract java.util.Set<java.lang.String> getDeniedPermissions(java.lang.String[] permissionsToCheck)

Check all the permission in a collection and return a subset of the permissions that the user currently has not granted.

Parameters:

permissionsToCheck - List of permissions to check if they are granted or not.

Returns:

List of permissions that are currently not granted to the application.

checkPermission

public abstract boolean checkPermission(java.lang.String permission)

Check if the current app has the permission specified. If true, then the app is free to use the resources that the permission provides. If false, then the app may have to request the permission.

Parameters:

permission - Permission to check

Returns:

True if the app has the permission (and subsequently can use the resources that permission provides).

requestPermission

public abstract boolean requestPermission(java.lang.String permission,
                                          int requestCode)

Request a permission for a specific service. If using Android M, then the callback will be Activity.onRequestPermissionsResult(int, String[], int[]) or android.support.v7.app.AppCompatActivity#onRequestPermissionsResult(int, String[], int[]). This will silently fail if pre-M device calls this with an Activity that does not support this feature.

Parameters:

permission - Permission to request.

requestCode - Request Code that will be the first parameter for `onRequestPermissionResult`

Returns:

True if the permission is being requested or false if there is an error (most likely because the calling activity does not support this).

See Also:

Activity#onRequestPermissionsResult(int, String[], int[])

requestPermissions

public abstract boolean requestPermissions(java.util.Collection<java.lang.String> permissions,
                                           int requestCode)

Request a permission for a specific service. If using Android M, then the callback will be Activity.onRequestPermissionsResult(int, String[], int[]) or android.support.v7.app.AppCompatActivity#onRequestPermissionsResult(int, String[], int[]). This will silently fail if pre-M device calls this with an Activity that does not support this feature.

Parameters:

permissions - Permissions to request.

requestCode - Request Code that will be the first parameter for `onRequestPermissionResult`

Returns:

True if the permission is being requested or false if there is an error (most likely because the calling activity does not support this.

See Also:

Activity#onRequestPermissionsResult(int, String[], int[])

requestPermissions

public abstract boolean requestPermissions(java.lang.String[] permissions,
                                           int requestCode)

Request a permission for a specific service. If using Android M, then the callback will be Activity#onRequestPermissionsResult(int, String[], int[]) or android.support.v7.app.AppCompatActivity#onRequestPermissionsResult(int, String[], int[]). This will silently fail if pre-M device calls this with an Activity that does not support this feature.

Parameters:

permissions - Permissions to request.

requestCode - Request Code that will be the first parameter for `onRequestPermissionResult`

Returns:

True if the permission is being requested or false if there is an error (most likely because the calling activity does not support this).

See Also:

Activity#onRequestPermissionsResult(int, String[], int[])

shouldShowRequestPermissionRationale

public abstract boolean shouldShowRequestPermissionRationale(java.lang.String permission)

This will always return false if the build version is less than M. Otherwise, it will return the appropriate rationale response as defined in Activity#shouldShowRequestPermissionRationale(String).

Parameters:

permission - Permission to check.

Returns:

True if the user should be notified why the specific permission should be granted or false if the user should not be notified just yet.

See Also:

Activity#shouldShowRequestPermissionRationale(String)