urbanairship-core/com.urbanairship.actions/EnableFeatureAction

EnableFeatureAction

class EnableFeatureAction @JvmOverloads constructor(permissionsManagerProvider: () -> PermissionsManager = { Airship.permissionsManager }) : PromptPermissionAction(source)

An action that enables features. Running the action with value FEATURE_LOCATION or FEATURE_BACKGROUND_LOCATION will prompt the user for permissions before enabling.

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.

Accepted argument value - either FEATURE_USER_NOTIFICATIONS, FEATURE_BACKGROUND_LOCATION, or FEATURE_LOCATION.

Result value: true if the feature was enabled, otherwise false.

Default Registration Names: DEFAULT_NAMES

Constructors

EnableFeatureAction

constructor(permissionsManagerProvider: () -> PermissionsManager = { Airship.permissionsManager })

Types

object Companion

Functions

open override fun onStart(arguments: ActionArguments)

Called before an action is performed.

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

Inherited 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.

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

Called after the action performs.

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

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

fun run(arguments: ActionArguments): ActionResult

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

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

shouldRunOnMainThread

open override fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.