Airship Android SDK

urbanairship-core/com.urbanairship.actions/EnableFeatureAction

EnableFeatureAction

open class EnableFeatureAction : PromptPermissionAction

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: SITUATION_PUSH_OPENED, SITUATION_WEB_VIEW_INVOCATION, SITUATION_MANUAL_INVOCATION, SITUATION_AUTOMATION, and 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_REGISTRY_NAME, DEFAULT_REGISTRY_SHORT_NAME

Constructors

EnableFeatureAction

constructor(@NonNull permissionsManagerSupplier: Supplier<PermissionsManager>, @NonNull locationClientSupplier: Supplier<AirshipLocationClient>)

constructor()

Properties

DEFAULT_REGISTRY_NAME

val DEFAULT_REGISTRY_NAME: String = "enable_feature"

Default registry name

DEFAULT_REGISTRY_SHORT_NAME

val DEFAULT_REGISTRY_SHORT_NAME: String = "^ef"

Default registry short name

FEATURE_BACKGROUND_LOCATION

val FEATURE_BACKGROUND_LOCATION: String = "background_location"

Action value to enable location with background updates.

FEATURE_LOCATION

val FEATURE_LOCATION: String = "location"

Action value to enable location.

FEATURE_USER_NOTIFICATIONS

val FEATURE_USER_NOTIFICATIONS: String = "user_notifications"

Action value to enable user notifications.

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

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

open fun onStart(@NonNull arguments: ActionArguments)

Called before an action is performed.

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

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

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

Called after the action performs.

fun perform(@NonNull arguments: ActionArguments): ActionResult

Performs the action.

protected open fun prompt(@NonNull args: PromptPermissionAction.Args, @Nullable resultReceiver: ResultReceiver)

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.