com.anthonycr.grant

Class PermissionsResultAction

java.lang.Object

com.anthonycr.grant.PermissionsResultAction

public abstract class PermissionsResultAction
extends java.lang.Object

This abstract class should be used to create an if/else action that the PermissionsManager can execute when the permissions you request are granted or denied. Simple use involves creating an anonymous instance of it and passing that instance to the requestPermissionsIfNecessaryForResult method. The result will be sent back to you as either onGranted (all permissions have been granted), or onDenied (a required permission has been denied). Ideally you put your functionality in the onGranted method and notify the user what won't work in the onDenied method.

Constructor Summary

Constructors

Constructor and Description
PermissionsResultAction() Default Constructor
PermissionsResultAction(android.os.Looper looper) Alternate Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onDenied(java.lang.String permission) This method is called when a permission has been denied by the user.
abstract void	onGranted() This method is called when ALL permissions that have been requested have been granted by the user.
protected boolean	onResult(java.lang.String permission, int result)
protected boolean	onResult(java.lang.String permission, com.anthonycr.grant.Permissions result) This method is called when a particular permission has changed.
protected void	registerPermissions(java.lang.String[] perms) This method registers the PermissionsResultAction object for the specified permissions so that it will know which permissions to look for changes to.
boolean	shouldIgnorePermissionNotFound(java.lang.String permission) This method is used to determine if a permission not being present on the current Android platform should affect whether the PermissionsResultAction should continue listening for events.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsResultAction

public PermissionsResultAction()

Default Constructor

PermissionsResultAction

public PermissionsResultAction(android.os.Looper looper)

Alternate Constructor. Pass the looper you wish the PermissionsResultAction callbacks to be executed on if it is not the current Looper. For instance, if you are making a permissions request from a background thread but wish the callback to be on the UI thread, use this constructor to specify the UI Looper.

Parameters:

looper - the looper that the callbacks will be called using.

Method Detail

onGranted

public abstract void onGranted()

This method is called when ALL permissions that have been requested have been granted by the user. In this method you should put all your permissions sensitive code that can only be executed with the required permissions.

onDenied

public abstract void onDenied(java.lang.String permission)

This method is called when a permission has been denied by the user. It provides you with the permission that was denied and will be executed on the Looper you pass to the constructor of this class, or the Looper that this object was created on.

Parameters:

permission - the permission that was denied.

shouldIgnorePermissionNotFound

public boolean shouldIgnorePermissionNotFound(java.lang.String permission)

This method is used to determine if a permission not being present on the current Android platform should affect whether the PermissionsResultAction should continue listening for events. By default, it returns true and will simply ignore the permission that did not exist. Usually this will work fine since most new permissions are introduced to restrict what was previously allowed without permission. If that is not the case for your particular permission you request, override this method and return false to result in the Action being denied.

Parameters:

permission - the permission that doesn't exist on this Android version

Returns:

return true if the PermissionsResultAction should ignore the lack of the permission and proceed with exection or false if the PermissionsResultAction should treat the absence of the permission on the API level as a denial.

onResult

protected final boolean onResult(java.lang.String permission,
               int result)

onResult

protected final boolean onResult(java.lang.String permission,
               com.anthonycr.grant.Permissions result)

This method is called when a particular permission has changed. This method will be called for all permissions, so this method determines if the permission affects the state or not and whether it can proceed with calling onGranted or if onDenied should be called.

Parameters:

permission - the permission that changed.

result - the result for that permission.

Returns:

this method returns true if its primary action has been completed and it should be removed from the data structure holding a reference to it.

registerPermissions

protected final void registerPermissions(java.lang.String[] perms)

This method registers the PermissionsResultAction object for the specified permissions so that it will know which permissions to look for changes to. The PermissionsResultAction will then know to look out for changes to these permissions.

Parameters:

perms - the permissions to listen for