com.robopupu.api.util

Class PermissionRequest

java.lang.Object

com.robopupu.api.util.PermissionRequest

public class PermissionRequest
extends java.lang.Object

PermissionRequest is an object that can be used for requesting a permission at run time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PermissionRequest.Callback

Constructor Summary

Constructors

Constructor and Description
PermissionRequest(android.app.Activity activity, java.lang.String permission, PermissionRequest.Callback callback) Constructs a new instance PermissionRequest for requesting the specified user permission.

Method Summary

Modifier and Type	Method and Description
void	commit() Commits this PermissionRequest.
java.lang.String	getPermission() Return the requested permission.
int	getRequestId() Return the request ID assigned for this PermissionRequest.
static boolean	isPermissionGranted(android.content.Context context, java.lang.String permission) Test if the specific user permission has been already granted.
protected void	onRequestPermissionsResult(boolean granted) Invoked by PermissionRequestManager when the permission has been granted or denied.
void	recommit() Recommit this PermissionRequest after the user has shown the rationale for granting the permission.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionRequest

public PermissionRequest(android.app.Activity activity,
                         java.lang.String permission,
                         PermissionRequest.Callback callback)

Constructs a new instance PermissionRequest for requesting the specified user permission.

Parameters:

activity - An Activity needed for ActivityCompat#requestPermissions(Activity, String[], int). May not be null.

permission - A String specifying the requested permission. May not be null.

callback - A PermissionRequest.Callback provided by the permission requester. May not be null.

Method Detail

getPermission

public java.lang.String getPermission()

Return the requested permission.

Returns:

A String specifying the permission.

getRequestId

public int getRequestId()

Return the request ID assigned for this PermissionRequest.

Returns:

The request ID as an int value.

commit

public void commit()

Commits this PermissionRequest. First it check if the requested user permission has been already granted. If not then, it is checked if the user should be presented with a rationale for granting the requested permission. If it is not necessary to show the rationale, the permission is actually requested by invoking ActivityCompat#requestPermissions(Activity, String[], int).

recommit

public void recommit()

Recommit this PermissionRequest after the user has shown the rationale for granting the permission.

onRequestPermissionsResult

protected void onRequestPermissionsResult(boolean granted)

Invoked by PermissionRequestManager when the permission has been granted or denied.

Parameters:

granted - A boolean value.

isPermissionGranted

public static boolean isPermissionGranted(android.content.Context context,
                                          java.lang.String permission)

Test if the specific user permission has been already granted.

Parameters:

context - A Context.

permission - A String specifying the requested permission. May not be null.

Returns:

A boolean value.