urbanairship-core/com.urbanairship.actions/PromptPermissionAction

PromptPermissionAction

open class PromptPermissionAction(permissionsManagerProvider: () -> PermissionsManager) : Action(source)

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: Action.Situation.PUSH_OPENED, Action.Situation.WEB_VIEW_INVOCATION, Action.Situation.MANUAL_INVOCATION, Action.Situation.AUTOMATION, and Action.Situation.FOREGROUND_NOTIFICATION_ACTION_BUTTON.

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

Default Registration Name: DEFAULT_NAMES

Inheritors

EnableFeatureAction

Constructors

PromptPermissionAction

constructor(permissionsManagerProvider: () -> PermissionsManager)

constructor()

Types

open class Args

object Companion

Functions

acceptsArguments

open override fun acceptsArguments(arguments: ActionArguments): Boolean

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

protected open fun parseArg(arguments: ActionArguments): PromptPermissionAction.Args

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

protected fun prompt(args: PromptPermissionAction.Args, resultReceiver: ResultReceiver?)

fun sendResult(permission: Permission, before: PermissionStatus, after: PermissionStatus, resultReceiver: ResultReceiver?)

shouldRunOnMainThread

open override fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.

Inherited functions

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

Called after the action performs.

open fun onStart(arguments: ActionArguments)

Called before an action is performed.

fun run(arguments: ActionArguments): ActionResult

Performs the action, with pre/post execution calls, if it accepts the provided arguments.