pub.devrel.easypermissions

Class AppSettingsDialog.Builder

java.lang.Object

pub.devrel.easypermissions.AppSettingsDialog.Builder

Enclosing class:

AppSettingsDialog

public static class AppSettingsDialog.Builder
extends Object

Builder for an AppSettingsDialog.

Constructor Summary

Constructors

Constructor and Description
Builder(android.app.Activity activity) Create a new Builder for an AppSettingsDialog.
Builder(androidx.fragment.app.Fragment fragment) Create a new Builder for an AppSettingsDialog.

Method Summary

Modifier and Type	Method and Description
AppSettingsDialog	build() Build the AppSettingsDialog from the specified options.
AppSettingsDialog.Builder	setNegativeButton(int textId) Set the negative button text, default is R.string.cancel.
AppSettingsDialog.Builder	setNegativeButton(String text) Set the negative button text, default is R.string.cancel.
AppSettingsDialog.Builder	setOpenInNewTask(boolean openInNewTask) Set whether the settings screen should be opened in a separate task.
AppSettingsDialog.Builder	setPositiveButton(int textId) Set the positive button text, default is R.string.ok.
AppSettingsDialog.Builder	setPositiveButton(String text) Set the positive button text, default is R.string.ok.
AppSettingsDialog.Builder	setRationale(int rationale) Set the rationale dialog.
AppSettingsDialog.Builder	setRationale(String rationale) Set the rationale dialog.
AppSettingsDialog.Builder	setRequestCode(int requestCode) Set the request code use when launching the Settings screen for result, can be retrieved in the calling Activity's Activity.onActivityResult(int, int, Intent) method.
AppSettingsDialog.Builder	setThemeResId(int themeResId) Set the dialog theme.
AppSettingsDialog.Builder	setTitle(int title) Set the title dialog.
AppSettingsDialog.Builder	setTitle(String title) Set the title dialog.

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)

Create a new Builder for an AppSettingsDialog.

Parameters:

activity - the Activity in which to display the dialog.

Builder

public Builder(@NonNull
               androidx.fragment.app.Fragment fragment)

Create a new Builder for an AppSettingsDialog.

Parameters:

fragment - the Fragment in which to display the dialog.

Method Detail

setThemeResId

@NonNull
public AppSettingsDialog.Builder setThemeResId(@StyleRes
                                                        int themeResId)

Set the dialog theme.

setTitle

@NonNull
public AppSettingsDialog.Builder setTitle(@Nullable
                                                   String title)

Set the title dialog. Default is "Permissions Required".

setTitle

@NonNull
public AppSettingsDialog.Builder setTitle(@StringRes
                                                   int title)

Set the title dialog. Default is "Permissions Required".

setRationale

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

Set the rationale dialog. Default is "This app may not work correctly without the requested permissions. Open the app settings screen to modify app permissions."

setRationale

@NonNull
public AppSettingsDialog.Builder setRationale(@StringRes
                                                       int rationale)

Set the rationale dialog. Default is "This app may not work correctly without the requested permissions. Open the app settings screen to modify app permissions."

setPositiveButton

@NonNull
public AppSettingsDialog.Builder setPositiveButton(@Nullable
                                                            String text)

Set the positive button text, default is R.string.ok.

setPositiveButton

@NonNull
public AppSettingsDialog.Builder setPositiveButton(@StringRes
                                                            int textId)

Set the positive button text, default is R.string.ok.

setNegativeButton

@NonNull
public AppSettingsDialog.Builder setNegativeButton(@Nullable
                                                            String text)

Set the negative button text, default is R.string.cancel.

To know if a user cancelled the request, check if your permissions were given with EasyPermissions.hasPermissions(Context, String...) in Activity.onActivityResult(int, int, Intent). If you still don't have the right permissions, then the request was cancelled.

setNegativeButton

@NonNull
public AppSettingsDialog.Builder setNegativeButton(@StringRes
                                                            int textId)

Set the negative button text, default is R.string.cancel.

setRequestCode

@NonNull
public AppSettingsDialog.Builder setRequestCode(int requestCode)

Set the request code use when launching the Settings screen for result, can be retrieved in the calling Activity's Activity.onActivityResult(int, int, Intent) method. Default is AppSettingsDialog.DEFAULT_SETTINGS_REQ_CODE.

setOpenInNewTask

@NonNull
public AppSettingsDialog.Builder setOpenInNewTask(boolean openInNewTask)

Set whether the settings screen should be opened in a separate task. This is achieved by setting android.content.Intent#FLAG_ACTIVITY_NEW_TASK#FLAG_ACTIVITY_NEW_TASK on the Intent used to open the settings screen.

build

@NonNull
public AppSettingsDialog build()

Build the AppSettingsDialog from the specified options. Generally followed by a call to AppSettingsDialog.show().