com.tumblr.permissme

Class PermissMe.Builder

java.lang.Object

com.tumblr.permissme.PermissMe.Builder

Enclosing class:

PermissMe

public static class PermissMe.Builder
extends Object

The Builder to make a permissions request. A request can be executed with: 1) launchActivityWithPermissions(Class, Bundle, Bundle). The Bundle is for the activity that will be launched once the required permissions are granted by the user 2) verifyPermissions(). It will not do anything special; just queries for the permissions specified; set a listener to receive callbacks on user's interactions.

Constructor Summary

Constructors

Constructor and Description
PermissMe.Builder(AppCompatActivity callerActivity) Constructor
PermissMe.Builder(Fragment callerFragment) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
PermissMe.Builder	customAutoFailureMessage(String failureMsg) Sets a custom message that will be shown upon auto-denied permission Snackbar.
PermissMe.Builder	destinationActivityAnim(int enterAnim, int exitAnim) Animation for the activity that will be started; not required
PermissMe.Builder	finishActivityUponResult() Finishes the caller activity upon the result of the permissions request
void	launchActivityWithPermissions(Class destinationActivity, Bundle destinationBundle, Bundle optionsBundle) Launches the destination activity.The required/optional permissions queried are specified using setRequiredPermissions(String...) and setOptionalPermissions(String...) If the package already has the permissions granted, this will launch the destination activity class, and set the bundle as the bundle of the destinationAcitivity.
void	launchActivityWithPermissions(Intent activityIntent, Bundle optionsBundle) Launches the destination activity intent.The required/optional permissions queried are specified using setRequiredPermissions(String...) and setOptionalPermissions(String...) If the package already has the permissions granted, this will launch the destination intent using
PermissMe.Builder	listener(PermissMe.PermissionListener listener) The PermissMe.PermissionListener that will provide callbacks when permissions are granted/denied.
PermissMe.Builder	requestCode(int requestCode) A request code if the destination activity specified in launchActivityWithPermissions(Class, Bundle, Bundle) needs to be launched to listen for result
PermissMe.Builder	setOptionalPermissions(String... optionalPermissions) Set the optional permissions to query; PermissMe.PermissionListener.onSuccess() will called even if optional permissions are NOT granted.
PermissMe.Builder	setRequiredPermissions(String... requiredPermissions) Set the required permissions to query; PermissMe.PermissionListener.onSuccess() will be called iff the required permissions are granted.
PermissMe.Builder	showNoUIOnFailure() Indicates that we don't want to see the permission-denied UI when we get a auto-denied permissions.
PermissMe.Builder	targetFragment(Fragment targetFragment) A target fragment that can be specified if requestCode(int) is specified to Fragment.startActivityForResult(Intent, int).
void	verifyPermissions() This method will start the permission check flow and query for the permissions set through setRequiredPermissions(String...) and setOptionalPermissions(String...)

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissMe.Builder

public PermissMe.Builder(@NonNull
                 AppCompatActivity callerActivity)

Constructor

Parameters:

callerActivity - caller activity

PermissMe.Builder

public PermissMe.Builder(@NonNull
                 Fragment callerFragment)

Constructor

Parameters:

callerFragment - caller fragment

Method Detail

listener

public PermissMe.Builder listener(PermissMe.PermissionListener listener)

The PermissMe.PermissionListener that will provide callbacks when permissions are granted/denied.

Parameters:

listener - the listener

Returns:

this, for chaining

showNoUIOnFailure

public PermissMe.Builder showNoUIOnFailure()

Indicates that we don't want to see the permission-denied UI when we get a auto-denied permissions. Auto-denied happens when the user has tapped "Do not ask again" for permission request previously or currently.

Returns:

this, for chaining

customAutoFailureMessage

public PermissMe.Builder customAutoFailureMessage(String failureMsg)

Sets a custom message that will be shown upon auto-denied permission Snackbar. If no custom message was set, the default message will be used. To not show a Snackbar at all, use showNoUIOnFailure()

Parameters:

failureMsg - The custom message that should show up for the auto-denied permission snackbar

Returns:

this, for chaining

finishActivityUponResult

public PermissMe.Builder finishActivityUponResult()

Finishes the caller activity upon the result of the permissions request

Returns:

this, for chaining

targetFragment

public PermissMe.Builder targetFragment(Fragment targetFragment)

A target fragment that can be specified if requestCode(int) is specified to Fragment.startActivityForResult(Intent, int). The target fragment will be the one that receives the result of the activity being started for result. Otherwise, it will send the result to the caller activity by default.

Parameters:

targetFragment - the target fragment to return the Activity.onActivityResult(int, int, Intent) call

Returns:

this, for chaining

requestCode

public PermissMe.Builder requestCode(int requestCode)

A request code if the destination activity specified in launchActivityWithPermissions(Class, Bundle, Bundle) needs to be launched to listen for result

Parameters:

requestCode - The request code to launch the destination activity with

Returns:

this for chaining

destinationActivityAnim

public PermissMe.Builder destinationActivityAnim(@AnimRes
                                        int enterAnim,
                                        @AnimRes
                                        int exitAnim)

Animation for the activity that will be started; not required

Parameters:

enterAnim - animation resource for the enter animation of the destination activity, 0 if no enter animation required

exitAnim - animation resource for the exit animation of the destination activity, 0 if no exit animation required

Returns:

this, for chaining

setRequiredPermissions

public PermissMe.Builder setRequiredPermissions(String... requiredPermissions)

Set the required permissions to query; PermissMe.PermissionListener.onSuccess() will be called iff the required permissions are granted. PermissMe.PermissionListener.onRequiredPermissionDenied(String[], boolean[]) will be called if a required permission is denied

Parameters:

requiredPermissions - the required permissions

Returns:

this, for chaining

setOptionalPermissions

public PermissMe.Builder setOptionalPermissions(String... optionalPermissions)

Set the optional permissions to query; PermissMe.PermissionListener.onSuccess() will called even if optional permissions are NOT granted. PermissMe.PermissionListener.onOptionalPermissionDenied(String[], boolean[]) will also be called if an optional permission is denied

Parameters:

optionalPermissions - the optional permissions

Returns:

this, for chaining

launchActivityWithPermissions

public void launchActivityWithPermissions(@NonNull
                                 Intent activityIntent,
                                 @Nullable
                                 Bundle optionsBundle)

Launches the destination activity intent.The required/optional permissions queried are specified using setRequiredPermissions(String...) and setOptionalPermissions(String...) If the package already has the permissions granted, this will launch the destination intent using

Activity.startActivity(Intent) method, with other parameters such as destinationActivityAnim(int, int), Fragment.setTargetFragment(Fragment, int), etc.

Parameters:

activityIntent - The activity intent to be started once permissions are checked+granted

optionsBundle - Additional options for how the activity should be started See bundle field in Activity.startActivity(Intent, Bundle) or Activity.startActivityForResult(Intent, int, Bundle)

Throws:

RuntimeException - thrown if no permissions are specified when this method is called

launchActivityWithPermissions

public void launchActivityWithPermissions(@NonNull
                                 Class destinationActivity,
                                 @Nullable
                                 Bundle destinationBundle,
                                 @Nullable
                                 Bundle optionsBundle)

Launches the destination activity.The required/optional permissions queried are specified using setRequiredPermissions(String...) and setOptionalPermissions(String...) If the package already has the permissions granted, this will launch the destination activity class, and set the bundle as the bundle of the destinationAcitivity.

Parameters:

destinationActivity - The activity to launch if the required permissions are granted by the user

destinationBundle - The bundle with extra information the destination class may need

optionsBundle - Additional options for how the activity should be started See bundle field in Activity.startActivity(Intent, Bundle) or Activity.startActivityForResult(Intent, int, Bundle)

Throws:

RuntimeException - thrown if no permissions are specified when this method is called

verifyPermissions

public void verifyPermissions()

This method will start the permission check flow and query for the permissions set through setRequiredPermissions(String...) and setOptionalPermissions(String...)

Throws:

RuntimeException - thrown if no permissions are specified when this method is called