ru.noties.requirements

Class PermissionCase<T>

java.lang.Object

ru.noties.requirements.RequirementCase<T>

ru.noties.requirements.PermissionCase<T>

public abstract class PermissionCase<T>
extends RequirementCase<T>

A helper case to ease the pressure working with Android permissions. PermissionCase(String) takes single permission (which is good in terms of UX instead of String[] like Activity.requestPermissions suggests). The only method that must be overriden is `showPermissionRationale`. This class contains few helper methods:

• requestPermission()
• RequirementCase.requestPermission(String, int)
• RequirementCase.checkSelfPermission(String)
• navigateToSettingsScreen()

Constructor Summary

Constructors

Constructor and Description
PermissionCase(java.lang.String permission)
PermissionCase(java.lang.String permission, int requestCode)

Method Summary

Modifier and Type	Method and Description
boolean	meetsRequirement() Synchronous method to check if requirement is satisfied
protected void	navigateToSettingsScreen() Opens settings screen of the application.
boolean	onActivityResult(int requestCode, int resultCode, android.content.Intent data) Please override this method if your RequirementCase need to receive `onActivityResult` event
boolean	onRequestPermissionsResult(int requestCode, java.lang.String[] permissions, int[] grantResults) Please override this method if your RequirementCase need to receive `onRequestPermissionsResult` event
java.lang.String	permission()
int	requestCode()
protected void	requestPermission() This method must be called after rationale was shown (showPermissionRationale()) and user gave his/her agreement
protected void	showExplanationOnNever() Override this method if you would like to display a confirmation to a user when he/she checks `never` checkbox on the system permission request dialog.
protected abstract void	showPermissionRationale() Should display rationale.
void	startResolution() Starts requirement resolution process.
java.lang.String	toString()

Methods inherited from class ru.noties.requirements.RequirementCase

activity, appContext, attach, checkSelfPermission, deliverResult, deliverResult, detach, requestPermission, shouldShowRequestPermissionRationale, startActivityForResult, target

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionCase

public PermissionCase(java.lang.String permission)

PermissionCase

public PermissionCase(java.lang.String permission,
                      int requestCode)

Method Detail

meetsRequirement

public boolean meetsRequirement()

Synchronous method to check if requirement is satisfied

Specified by:

meetsRequirement in class RequirementCase<T>

Returns:

a boolean indicating if this requirement is satisfied

startResolution

public void startResolution()

Starts requirement resolution process. This method will be called only if RequirementCase.meetsRequirement() returns false

Specified by:

startResolution in class RequirementCase<T>

showPermissionRationale

protected abstract void showPermissionRationale()

Should display rationale. Further actions must be taken in this method: either RequirementCase.deliverResult(boolean) with cancellation event or requestPermission()

showExplanationOnNever

protected void showExplanationOnNever()

Override this method if you would like to display a confirmation to a user when he/she checks `never` checkbox on the system permission request dialog. Please note that default implementation exits immediately with cancellation event

requestPermission

protected void requestPermission()

This method must be called after rationale was shown (showPermissionRationale()) and user gave his/her agreement

navigateToSettingsScreen

protected void navigateToSettingsScreen()

Opens settings screen of the application. This method must be used only if you show some confirmation in showExplanationOnNever(), which should indicate further user actions

onActivityResult

public boolean onActivityResult(int requestCode,
                                int resultCode,
                                android.content.Intent data)

Please override this method if your RequirementCase need to receive `onActivityResult` event

Overrides:

onActivityResult in class RequirementCase<T>

Returns:

boolean indicating if this event was consumed

onRequestPermissionsResult

public boolean onRequestPermissionsResult(int requestCode,
                                          java.lang.String[] permissions,
                                          int[] grantResults)

Please override this method if your RequirementCase need to receive `onRequestPermissionsResult` event

Overrides:

onRequestPermissionsResult in class RequirementCase<T>

Returns:

boolean indicating if this event was consumed

permission

public java.lang.String permission()

requestCode

public int requestCode()

Returns:

automatically generated requestCode

See Also:

RequestCode.createRequestCode(String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object