java.lang.Object | ||
↳ | com.urbanairship.actions.Action | |
↳ | com.urbanairship.actions.LandingPageAction |
Action for launching a Landing Page.
The landing page will not be launched in Situation.PUSH_RECEIVED, instead it will be cached if the action is triggered with a payload that sets "cache_on_receive" to true. Accepted situations: Situation.PUSH_OPENED, Situation.PUSH_RECEIVED, Situation.WEB_VIEW_INVOCATION, Situation.MANUAL_INVOCATION, and Situation.FOREGROUND_NOTIFICATION_ACTION_BUTTON. Accepted argument value types: URL defined as either a String or a Map containing the key "url" that defines the URL. The map argument value can also define a "cache_on_receive" flag to enable or disable caching when a PUSH_RECEIVED. Caching is disabled by default.Note: URLs in the format of "u:<content-id>" will be treated as a short url and
used to construct a separate url using the content id.
Result value: null
Default Registration Names: ^p, landing_page_action
Default Registration Predicate: Rejects Situation.PUSH_RECEIVED if the application
has not been opened in the last week.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | CACHE_ON_RECEIVE_KEY | The payload key for indicating if the landing page should be cached when triggered in Situation.PUSH_RECEIVED | |||||||||
String | DEFAULT_REGISTRY_NAME | Default registry name | |||||||||
String | DEFAULT_REGISTRY_SHORT_NAME | Default registry short name | |||||||||
String | SHOW_LANDING_PAGE_INTENT_ACTION | Intent action for showing a URL in a UAWebView
|
|||||||||
String | URL_KEY | The content's url payload key |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
LandingPageAction() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean |
acceptsArguments(ActionArguments arguments)
Checks if the argument's value can be parsed to a URI and if the situation is not
Situation.PUSH_RECEIVED.
| ||||||||||
ActionResult |
perform(ActionArguments arguments)
Performs the action.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Uri |
parseUri(ActionArguments arguments)
Parses the ActionArguments for a landing page URI.
| ||||||||||
boolean |
shouldCacheOnReceive(ActionArguments arguments)
Checks if the landing page arguments define whether the landing page
should cache on receive.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
The payload key for indicating if the landing page should be cached when triggered in Situation.PUSH_RECEIVED
Default registry name
Default registry short name
Intent action for showing a URL in a UAWebView
Checks if the argument's value can be parsed to a URI and if the situation is not Situation.PUSH_RECEIVED.
arguments | The action arguments. |
---|
true
if the action can perform with the arguments,
otherwise false
.
Performs the action.
arguments | The action arguments. |
---|
Parses the ActionArguments for a landing page URI.
arguments | The action arguments. |
---|
Checks if the landing page arguments define whether the landing page should cache on receive.
arguments | The action arguments. |
---|
true
if the argument's value contains a payload
with CACHE_ON_RECEIVE_KEY set to true, otherwise false
.