xappmedia.sdk.permissions.ui

Class RequestPermissionsSoftAskActivity

java.lang.Object

AppCompatActivity

xappmedia.sdk.permissions.ui.RequestPermissionsBaseActivity

xappmedia.sdk.permissions.ui.RequestPermissionsSoftAskActivity

All Implemented Interfaces:

RequestDialogListener

public class RequestPermissionsSoftAskActivity
extends RequestPermissionsBaseActivity
implements RequestDialogListener

An Activity that can be used to ask the user for provided permissions. On result, the granted permissions will be provided in the Intent Bundle under RequestPermissionsBaseActivity.RESULT_PERMISSION_GRANTED_LIST as an ArrayList. The denied permissions will be provided with RequestPermissionsBaseActivity.RESULT_PERMISSION_DENIED_LIST as an ArrayList.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestPermissionsSoftAskActivity.IntentBuilder Builder that can be used to generate an Intent which will start this Activity.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_API_KEY_STRING Registered Xapp API key.
static java.lang.String	PARAM_APP_KEY_STRING Registered Xapp APP key registered to the app.
static java.lang.String	PARAM_CREATIVE_ONLY_BOOL Boolean indicating if only the cached strategy should be used.
static java.lang.String	PARAM_TYPE_INT Type of dialog that should be used.
static int	TYPE_IMAGE Type of dialog to display should be the paging image dialog.
static int	TYPE_TEXT Type of dialog to display should be a text dialog.

Fields inherited from class xappmedia.sdk.permissions.ui.RequestPermissionsBaseActivity

PARAM_PERMISSION_ARR_LIST, RESULT_PERMISSION_DENIED_LIST, RESULT_PERMISSION_GRANTED_LIST

Constructor Summary

Constructors

Constructor and Description
RequestPermissionsSoftAskActivity()

Method Summary

Modifier and Type	Method and Description
void	closing(RequestPermissionsCreativeFragment fragment, boolean showingFragment)
static RequestPermissionsSoftAskActivity.IntentBuilder	newIntent(java.util.Collection<Permission> permissions)
boolean	onAccept() The user has accepted the requested permissions.
void	onCancel() Notification that the dialog has been canceled.
void	onCreate(android.os.Bundle savedInstanceState)
boolean	onDecline() The user has declined to give the permissions.
void	onDismiss() Notification that the dialog has been dismissed.
void	onResume()
protected void	onShowRationale(java.util.Collection<Permission> permissions) Inheriting activities can call this to show their rationale for the given permissions.
static void	requestPermission(android.app.Activity activity, java.util.Collection<Permission> permissions, int requestCode) Deprecated.
void	showingStrategy(java.lang.String from, Strategy strategy, Creative creative)

Methods inherited from class xappmedia.sdk.permissions.ui.RequestPermissionsBaseActivity

declineRequestPermissions, getDeniedPermissions, onRequestPermissionsResult, onSaveInstanceState, requestPermissions

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TEXT

public static int TYPE_TEXT

Type of dialog to display should be a text dialog. This is modeled after a standard Android AlertDialog.

TYPE_IMAGE

public static int TYPE_IMAGE

Type of dialog to display should be the paging image dialog.

PARAM_API_KEY_STRING

public static final java.lang.String PARAM_API_KEY_STRING

Registered Xapp API key. Type: String

See Also:

Constant Field Values

PARAM_APP_KEY_STRING

public static final java.lang.String PARAM_APP_KEY_STRING

Registered Xapp APP key registered to the app. Type: String

See Also:

Constant Field Values

PARAM_TYPE_INT

public static final java.lang.String PARAM_TYPE_INT

Type of dialog that should be used. This would either be TYPE_TEXT or TYPE_IMAGE The default is TYPE_TEXT. Type: int

See Also:

Constant Field Values

PARAM_CREATIVE_ONLY_BOOL

public static final java.lang.String PARAM_CREATIVE_ONLY_BOOL

Boolean indicating if only the cached strategy should be used. If this is set to true, this will return instantly as if the permissions have been denied. It will also download and save the creative to be used on the next call. The next time this is called, the cached version will be used to ask the user. The default is `false`. Type: boolean

See Also:

Constant Field Values

Constructor Detail

RequestPermissionsSoftAskActivity

public RequestPermissionsSoftAskActivity()

Method Detail

newIntent

public static RequestPermissionsSoftAskActivity.IntentBuilder newIntent(java.util.Collection<Permission> permissions)

requestPermission

@Deprecated
public static void requestPermission(android.app.Activity activity,
                                                 java.util.Collection<Permission> permissions,
                                                 int requestCode)

Deprecated.

Convenience method to start this activity with the given permissions to request. RequestPermissionSoftAskActivity must be registered in the project's Android manifest to start.

Parameters:

activity - Calling activity.

permissions - Permissions to request.

requestCode - Request code that will be returned with Activity.onActivityResult(int, int, Intent).

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Description copied from class: RequestPermissionsBaseActivity

Overrides:

onCreate in class RequestPermissionsBaseActivity

onResume

public void onResume()

onAccept

public boolean onAccept()

Description copied from interface: RequestDialogListener

The user has accepted the requested permissions. The default action is to request all the permissions from the system. Return true to override this.

Specified by:

onAccept in interface RequestDialogListener

Returns:

True if the action has been handled or false otherwise.

onDecline

public boolean onDecline()

Description copied from interface: RequestDialogListener

The user has declined to give the permissions.

Specified by:

onDecline in interface RequestDialogListener

Returns:

True if the action has been handled or false otherwise.

onCancel

public void onCancel()

Description copied from interface: RequestDialogListener

Notification that the dialog has been canceled. This would be if DialogFragment#isCancelable() is true and the user tapped outside the dialog or Dialog.cancel() was explicitly called. Generally this can be treated as a decline, but it generally means the user did not explicitly accept or decline the requests.

Specified by:

onCancel in interface RequestDialogListener

onDismiss

public void onDismiss()

Description copied from interface: RequestDialogListener

Notification that the dialog has been dismissed. This will be called after onAccept, onDecline, or onCancel.

Specified by:

onDismiss in interface RequestDialogListener

onShowRationale

protected void onShowRationale(java.util.Collection<Permission> permissions)

Description copied from class: RequestPermissionsBaseActivity

Inheriting activities can call this to show their rationale for the given permissions.

Overrides:

onShowRationale in class RequestPermissionsBaseActivity

Parameters:

permissions - Permissions that have not been granted yet and the reason for them to exist should be explained to the user.

showingStrategy

public void showingStrategy(java.lang.String from,
                            Strategy strategy,
                            Creative creative)

closing

public void closing(RequestPermissionsCreativeFragment fragment,
                    boolean showingFragment)