urbanairship-core/com.urbanairship.actions/PromptPermissionAction

PromptPermissionAction

open class PromptPermissionAction : Action

An action that prompts for permission.

Expected value: - permission: post_notifications, contacts, bluetooth, location, media, mic, or camera - fallback_system_settings: true to navigate to app settings if the permission is silently denied. - allow_airship_usage: If the permission is granted, any Airship features that depend on the permission will be enabled as well, e.g., enable user notifications on PushManager and push feature on privacy Manager if notifications are allowed.

Accepted situations: SITUATION_PUSH_OPENED, SITUATION_WEB_VIEW_INVOCATION, SITUATION_MANUAL_INVOCATION, SITUATION_AUTOMATION, and SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON.

Default Result: empty. The actual permission result can be received using a ResultReceiver in the metadata.

Default Registration Names: DEFAULT_REGISTRY_NAME, DEFAULT_REGISTRY_SHORT_NAME

Inheritors

EnableFeatureAction

Constructors

PromptPermissionAction

constructor(@NonNull permissionsManagerSupplier: Supplier<PermissionsManager>)

constructor()

Properties

AFTER_PERMISSION_STATUS_RESULT_KEY

val AFTER_PERMISSION_STATUS_RESULT_KEY: String = "after"

Resulting permission status key when using a result receiver.

BEFORE_PERMISSION_STATUS_RESULT_KEY

val BEFORE_PERMISSION_STATUS_RESULT_KEY: String = "before"

The starting permission status key when using a result receiver.

DEFAULT_REGISTRY_NAME

val DEFAULT_REGISTRY_NAME: String = "prompt_permission_action"

Default registry name

DEFAULT_REGISTRY_SHORT_NAME

val DEFAULT_REGISTRY_SHORT_NAME: String = "^pp"

Default registry short name

ENABLE_AIRSHIP_USAGE_ARG_KEY

val ENABLE_AIRSHIP_USAGE_ARG_KEY: String = "enable_airship_usage"

Enable airship usage argument key.

FALLBACK_SYSTEM_SETTINGS_ARG_KEY

val FALLBACK_SYSTEM_SETTINGS_ARG_KEY: String = "fallback_system_settings"

Fallback system settings argument key.

PERMISSION_ARG_KEY

val PERMISSION_ARG_KEY: String = "permission"

Permission argument key.

PERMISSION_RESULT_KEY

val PERMISSION_RESULT_KEY: String = "permission"

Permissions result key when using a result receiver.

RECEIVER_METADATA

val RECEIVER_METADATA: String = "com.urbanairship.actions.PromptPermissionActionReceiver"

Metadata key for a result receiver.

Inherited properties

SITUATION_AUTOMATION

val SITUATION_AUTOMATION: Int = 6

Situation where an action is triggered from Action Automation.

SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5

Situation where an action is triggered from a background notification action button.

SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4

Situation where an action is triggered from a foreground notification action button.

SITUATION_MANUAL_INVOCATION

val SITUATION_MANUAL_INVOCATION: Int = 0

Situation where an action is manually invoked.

SITUATION_PUSH_OPENED

val SITUATION_PUSH_OPENED: Int = 2

Situation where an action is triggered when a push is opened.

SITUATION_PUSH_RECEIVED

val SITUATION_PUSH_RECEIVED: Int = 1

Situation where an action is triggered when a push is received.

SITUATION_WEB_VIEW_INVOCATION

val SITUATION_WEB_VIEW_INVOCATION: Int = 3

Situation where an action is triggered from a web view.

Functions

acceptsArguments

open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean

Called before an action is performed to determine if the the action can accept the arguments.

fun perform(@NonNull arguments: ActionArguments): ActionResult

Performs the action.

open fun sendResult(@NonNull permission: Permission, @NonNull before: PermissionStatus, @NonNull after: PermissionStatus, @Nullable resultReceiver: ResultReceiver)

shouldRunOnMainThread

open fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.

Inherited functions

open fun onFinish(@NonNull arguments: ActionArguments, @NonNull result: ActionResult)

Called after the action performs.

open fun onStart(@NonNull arguments: ActionArguments)

Called before an action is performed.