pub.devrel.easypermissions

Class PermissionRequest.Builder

java.lang.Object

pub.devrel.easypermissions.PermissionRequest.Builder

Enclosing class:

PermissionRequest

public static final class PermissionRequest.Builder
extends Object

Builder to build a permission request with variable options.

See Also:

PermissionRequest

Constructor Summary

Constructors

Constructor and Description
Builder(android.app.Activity activity, int requestCode, String... perms) Construct a new permission request builder with a host, request code, and the requested permissions.
Builder(androidx.fragment.app.Fragment fragment, int requestCode, String... perms)

Method Summary

Modifier and Type	Method and Description
PermissionRequest	build() Build the permission request.
PermissionRequest.Builder	setNegativeButtonText(int resId)
PermissionRequest.Builder	setNegativeButtonText(String negativeButtonText) Set the negative button text for the rationale dialog should it be shown.
PermissionRequest.Builder	setPositiveButtonText(int resId)
PermissionRequest.Builder	setPositiveButtonText(String positiveButtonText) Set the positive button text for the rationale dialog should it be shown.
PermissionRequest.Builder	setRationale(int resId)
PermissionRequest.Builder	setRationale(String rationale) Set the rationale to display to the user if they don't allow your permissions on the first try.
PermissionRequest.Builder	setTheme(int theme) Set the theme to be used for the rationale dialog should it be shown.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               android.app.Activity activity,
               int requestCode,
               @NonNull
               String... perms)

Construct a new permission request builder with a host, request code, and the requested permissions.

Parameters:

activity - the permission request host

requestCode - request code to track this request; must be < 256

perms - the set of permissions to be requested

Builder

public Builder(@NonNull
               androidx.fragment.app.Fragment fragment,
               int requestCode,
               @NonNull
               String... perms)

See Also:

#Builder(Activity, int, String...)

Method Detail

setRationale

@NonNull
public PermissionRequest.Builder setRationale(@Nullable
                                                       String rationale)

Set the rationale to display to the user if they don't allow your permissions on the first try. This rationale will be shown as long as the user has denied your permissions at least once, but has not yet permanently denied your permissions. Should the user permanently deny your permissions, use the AppSettingsDialog instead.

The default rationale text is R.string.rationale_ask.

Parameters:

rationale - the rationale to be displayed to the user should they deny your permission at least once

setRationale

@NonNull
public PermissionRequest.Builder setRationale(@StringRes
                                                       int resId)

Parameters:

resId - the string resource to be used as a rationale

See Also:

setRationale(String)

setPositiveButtonText

@NonNull
public PermissionRequest.Builder setPositiveButtonText(@Nullable
                                                                String positiveButtonText)

Set the positive button text for the rationale dialog should it be shown.

The default is R.string.ok

setPositiveButtonText

@NonNull
public PermissionRequest.Builder setPositiveButtonText(@StringRes
                                                                int resId)

See Also:

setPositiveButtonText(String)

setNegativeButtonText

@NonNull
public PermissionRequest.Builder setNegativeButtonText(@Nullable
                                                                String negativeButtonText)

Set the negative button text for the rationale dialog should it be shown.

The default is R.string.cancel

setNegativeButtonText

@NonNull
public PermissionRequest.Builder setNegativeButtonText(@StringRes
                                                                int resId)

See Also:

setNegativeButtonText(String)

setTheme

@NonNull
public PermissionRequest.Builder setTheme(@StyleRes
                                                   int theme)

Set the theme to be used for the rationale dialog should it be shown.

Parameters:

theme - a style resource

build

@NonNull
public PermissionRequest build()

Build the permission request.

Returns:

the permission request

See Also:

EasyPermissions.requestPermissions(PermissionRequest), PermissionRequest