public final class

ActionArguments

extends Object
java.lang.Object
   ↳ com.urbanairship.actions.ActionArguments

Class Overview

Container for the argument data passed to an Action.

Summary

Constants
String ACTION_SCHEDULE_METADATA Metadata attached to action arguments when running scheduled actions from Automation.
String PUSH_MESSAGE_METADATA Metadata attached to action arguments when running actions from a push message.
String REGISTRY_ACTION_NAME_METADATA Metadata attached to action arguments when triggering an action from by name.
String REMOTE_INPUT_METADATA Metadata attached to action argument when running actions from a NotificationActionButton with LocalizableRemoteInput.
String RICH_PUSH_ID_METADATA Metadata when running an action from the JavaScript interface with an associated RichPushMessage.
Public Constructors
ActionArguments(int situation, ActionValue value, Bundle metadata)
Constructs ActionArguments.
Public Methods
Bundle getMetadata()
Gets the metadata for the action arguments.
int getSituation()
Retrieves the situation.
ActionValue getValue()
Retrieves the argument value.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ACTION_SCHEDULE_METADATA

Metadata attached to action arguments when running scheduled actions from Automation. The value is stored as a ActionSchedule.

Constant Value: "com.urbanairship.ACTION_SCHEDULE"

public static final String PUSH_MESSAGE_METADATA

Metadata attached to action arguments when running actions from a push message. The value is stored as a PushMessage.

Constant Value: "com.urbanairship.PUSH_MESSAGE"

public static final String REGISTRY_ACTION_NAME_METADATA

Metadata attached to action arguments when triggering an action from by name. The value is stored as a String.

Constant Value: "com.urbanairship.REGISTRY_ACTION_NAME"

public static final String REMOTE_INPUT_METADATA

Metadata attached to action argument when running actions from a NotificationActionButton with LocalizableRemoteInput.

Constant Value: "com.urbanairship.REMOTE_INPUT"

public static final String RICH_PUSH_ID_METADATA

Metadata when running an action from the JavaScript interface with an associated RichPushMessage. The value is stored as a String.

Constant Value: "com.urbanairship.RICH_PUSH_ID_METADATA"

Public Constructors

public ActionArguments (int situation, ActionValue value, Bundle metadata)

Constructs ActionArguments.

Parameters
situation The situation.
value The argument's value.
metadata The argument's metadata.

Public Methods

public Bundle getMetadata ()

Gets the metadata for the action arguments. Metadata provides additional information about the calling environment.

Returns
  • The arguments metadata.

public int getSituation ()

Retrieves the situation.

Returns
  • The situation.

public ActionValue getValue ()

Retrieves the argument value.

Returns
  • The value as an Object.

public String toString ()