public class

OverlayRichPushMessageAction

extends Action
java.lang.Object
   ↳ com.urbanairship.actions.Action
     ↳ com.urbanairship.actions.OverlayRichPushMessageAction

Class Overview

Displays an inbox message in a landing page.

To view messages, the intent will use the action com.urbanairship.SHOW_LANDING_PAGE_INTENT_ACTION with the message ID supplied as the data in the form of message:<MESSAGE_ID>.

Accepted situations: SITUATION_PUSH_OPENED, SITUATION_WEB_VIEW_INVOCATION, SITUATION_MANUAL_INVOCATION, SITUATION_AUTOMATION, and SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON.

Accepted argument values: The specified message ID, or "auto" to look for the message ID in the getMetadata().

Result value: null

Default Registration Names: ^mco, open_mc_overlay_action

Summary

Constants
String DEFAULT_REGISTRY_NAME Default registry name
String DEFAULT_REGISTRY_SHORT_NAME Default registry short name
String MESSAGE_ID_PLACEHOLDER
[Expand]
Inherited Constants
From class com.urbanairship.actions.Action
Public Constructors
OverlayRichPushMessageAction()
Public Methods
boolean acceptsArguments(ActionArguments arguments)
Called before an action is performed to determine if the the action can accept the arguments.
ActionResult perform(ActionArguments arguments)
Performs the action.
boolean shouldRunOnMainThread()
Determines which thread runs the action.
[Expand]
Inherited Methods
From class com.urbanairship.actions.Action
From class java.lang.Object

Constants

public static final String DEFAULT_REGISTRY_NAME

Default registry name

Constant Value: "open_mc_overlay_action"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^mco"

public static final String MESSAGE_ID_PLACEHOLDER

Constant Value: "auto"

Public Constructors

public OverlayRichPushMessageAction ()

Public Methods

public boolean acceptsArguments (ActionArguments arguments)

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

Parameters
arguments The action arguments.
Returns
  • true if the action can perform with the arguments, otherwise false.

public ActionResult perform (ActionArguments arguments)

Performs the action.

Parameters
arguments The action arguments.
Returns
  • The result of the action.

public boolean shouldRunOnMainThread ()

Determines which thread runs the action.

Returns
  • true if the action should be run on the main thread, or false if the action should run on a background thread.