org.researchstack.skin

Class PermissionRequestManager

java.lang.Object

org.researchstack.skin.PermissionRequestManager

public abstract class PermissionRequestManager
extends java.lang.Object

This class is responsible for checking permissions during runtime. It is flexible enough to handle system and custom permissions (like gainging auth for a 3rd party service).

Any PermissionRequest should be added to the PermissionRequestManager during Application.onCreate()

The PermissionRequest objects are then presented in PermissionStepLayout for denile / approval

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermissionRequestManager.PermissionRequest Class represents a permission that the user needs to grant

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERMISSION_REQUEST_CODE Request code for handling a system permission on 6.0+

Constructor Summary

Constructors

Constructor and Description
PermissionRequestManager()

Method Summary

Modifier and Type	Method and Description
void	addPermission(PermissionRequestManager.PermissionRequest permissionRequest) Adds a PermissionRequest to the internal storage map.
void	addPermissions(java.util.Collection<PermissionRequestManager.PermissionRequest> permissionRequests) Bulk add of PermissionRequests
void	addPermissions(PermissionRequestManager.PermissionRequest... permissionRequests) Bulk add of PermissionRequests
static PermissionRequestManager	getInstance() Returns a singleton static instance of the this class
java.util.List<PermissionRequestManager.PermissionRequest>	getPermissionRequests() Returns a list of permission requests
abstract boolean	hasPermission(android.content.Context context, java.lang.String permissionId) Method is used to check if a permission has been granted for a specific permission.
static void	init(PermissionRequestManager manager) Initializes the UiManager singleton.
boolean	isNonSystemPermission(java.lang.String permissionId) Checks if the permission exists in the internal map and returns true if the permission is not handled by the system.
abstract boolean	onNonSystemPermissionResult(android.app.Activity activity, int requestCode, int resultCode, android.content.Intent data) This method is called for handling the result of a non-system permission.
abstract void	onRequestNonSystemPermission(android.app.Activity activity, java.lang.String id) This method is called when a non-system permission needs to go through a grant flow.
void	setPermissionRequests(java.util.List<PermissionRequestManager.PermissionRequest> permissionRequests) Clears the internal map where PermissionRequests are stored and adds the requests that are passed in

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_REQUEST_CODE

public static final int PERMISSION_REQUEST_CODE

Request code for handling a system permission on 6.0+

See Also:

Constant Field Values

Constructor Detail

PermissionRequestManager

public PermissionRequestManager()

Method Detail

init

public static void init(PermissionRequestManager manager)

Initializes the UiManager singleton. It is best to call this method inside your Application.onCreate() method.

Parameters:

manager - an implementation of ResourcePathManager

getInstance

public static PermissionRequestManager getInstance()

Returns a singleton static instance of the this class

Returns:

A singleton static instance of the this class

getPermissionRequests

public java.util.List<PermissionRequestManager.PermissionRequest> getPermissionRequests()

Returns a list of permission requests

Returns:

list of permission requests

setPermissionRequests

public void setPermissionRequests(java.util.List<PermissionRequestManager.PermissionRequest> permissionRequests)

Clears the internal map where PermissionRequests are stored and adds the requests that are passed in

Parameters:

permissionRequests - list of permission requests

addPermissions

public void addPermissions(java.util.Collection<PermissionRequestManager.PermissionRequest> permissionRequests)

Bulk add of PermissionRequests

Parameters:

permissionRequests - collection of PermissionRequests

addPermissions

public void addPermissions(PermissionRequestManager.PermissionRequest... permissionRequests)

Bulk add of PermissionRequests

Parameters:

permissionRequests - array of PermissionRequests

addPermission

public void addPermission(PermissionRequestManager.PermissionRequest permissionRequest)

Adds a PermissionRequest to the internal storage map. The id of the PermissionRequest is used as the key and PermissionRequest object is the value

Parameters:

permissionRequest - the permission you seek to be granted

isNonSystemPermission

public boolean isNonSystemPermission(java.lang.String permissionId)

Checks if the permission exists in the internal map and returns true if the permission is not handled by the system. This property is during the creation of a PermissionRequest object

Parameters:

permissionId - the ID of the PermissionRequest

Returns:

true if the permission is a non-system permission. This means that its a permission that is not handled by the system grant flow.

hasPermission

public abstract boolean hasPermission(android.content.Context context,
                                      java.lang.String permissionId)

Method is used to check if a permission has been granted for a specific permission. This method needs to be able to handle both system and non-system permissions. This can be done by using ContextCompat.checkSelfPermission(android.content.Context, java.lang.String) for system permissions.

Parameters:

context - android context

permissionId - the ID of the PermissionRequest

Returns:

true if the permission is granted

onRequestNonSystemPermission

public abstract void onRequestNonSystemPermission(android.app.Activity activity,
                                                  java.lang.String id)

This method is called when a non-system permission needs to go through a grant flow. You should be starting an activity using the Activity param passed through and start it via Activity.startActivityForResult(Intent, int)

Parameters:

activity - the calling activity for when you request a non-system permission

id - the id of the permission

onNonSystemPermissionResult

public abstract boolean onNonSystemPermissionResult(android.app.Activity activity,
                                                    int requestCode,
                                                    int resultCode,
                                                    android.content.Intent data)

This method is called for handling the result of a non-system permission.

Parameters:

activity - the receiving activity of the permission result

requestCode - the request code from Activity.onActivityResult(int, int, Intent)

resultCode - the result code from Activity.onActivityResult(int, int, Intent)

data - the intent from Activity.onActivityResult(int, int, Intent)

Returns:

true if the result was from a permission permission flow was handled