Package-level declarations

Types

Link copied to clipboard
abstract class Action

The base action class that describes an operation to perform.

Link copied to clipboard
class ActionArguments @JvmOverloads constructor(val situation: Action.Situation, val value: ActionValue = ActionValue(), val metadata: Bundle = Bundle())

Container for the argument data passed to an com.urbanairship.actions.Action.

Link copied to clipboard

An interface for callbacks signaling the completion of an com.urbanairship.actions.Action.

Link copied to clipboard
fun interface ActionPredicate
Link copied to clipboard

Class responsible for runtime-persisting actions and associating them with names and predicates.

Link copied to clipboard
sealed class ActionResult(val value: ActionValue = ActionValue(), val status: ActionResult.Status)

Stores the results of running an com.urbanairship.actions.Action.

Link copied to clipboard
interface ActionRunner

Runs actions.

Link copied to clipboard
open class ActionRunRequest

ActionRunRequests provides a fluent API for running Actions.

Link copied to clipboard

Extends an action run request.

Link copied to clipboard

An ActionValue is a representation of any value that can be described using JSON. It can contain one of the following: a JsonMap, a JsonList, a Number, a Boolean, String, or it can contain null.

Link copied to clipboard
class ActionValueException(message: String?, exception: Exception?) : Exception

Exceptions thrown when creating ActionValues from objects.

Link copied to clipboard
class AddCustomEventAction(eventRecord: (CustomEvent) -> Unit = { Airship.analytics.recordCustomEvent(it) }) : Action

An action that adds a custom event.

Link copied to clipboard
class ClipboardAction(contextProvider: () -> Context = { Airship.application }) : Action

An action that adds text to the clipboard.

Link copied to clipboard
class DeepLinkAction(onDeepLink: (String) -> Boolean = { Airship.deepLink(deepLink = it) }, contextProvider: () -> Context = { Airship.application }) : Action

Action for opening a deep link.

Link copied to clipboard
fun interface DeepLinkListener

Listener interface used to notify app when deep link is received.

Link copied to clipboard

Default action runner.

Link copied to clipboard
class EnableFeatureAction @JvmOverloads constructor(permissionsManagerProvider: () -> PermissionsManager = { Airship.permissionsManager }) : 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.

Link copied to clipboard
class FetchDeviceInfoAction(channelProvider: () -> AirshipChannel = { Airship.channel }, pushManagerProvider: () -> PushManager = { Airship.push }, contactProvider: () -> Contact = { Airship.contact }) : Action

Action to fetch a map of device properties.

Link copied to clipboard

Action for opening a URL for viewing.

Link copied to clipboard

Result receiver to receive permission results from the PromptPermissionAction.

Link copied to clipboard
open class PromptPermissionAction(permissionsManagerProvider: () -> PermissionsManager) : Action

An action that prompts for permission.

Link copied to clipboard
class RateAppAction(appStoreIntentProvider: () -> Intent, contextProvider: () -> Context) : Action

Action to link users to the rating section of their respective app store directly or through a prompt.

Link copied to clipboard

An activity that displays a Rate App prompt that links to an app store.

Link copied to clipboard
class SetAttributesAction(channelProvider: () -> AirshipChannel = { Airship.channel }, contactProvider: () -> Contact = { Airship.contact }) : Action

An action that sets attributes.

Link copied to clipboard
class ShareAction(contextProvider: () -> Context = { Airship.application }) : Action

Shows a chooser activity to share text.

Link copied to clipboard

Action for subscribing/unsubscribing to lists.

Link copied to clipboard
class ToastAction(contextProvider: () -> Context = { Airship.application }) : Action

An action that displays text in a toast.

Link copied to clipboard

Action for opening Android Pay deep links.

Link copied to clipboard

Inherited functions

Link copied to clipboard
fun ActionRunner.run(actions: Map<String, JsonSerializable>, situation: Action.Situation? = null, extender: ActionRunRequestExtender? = null)