java.lang.Object | ||
↳ | com.urbanairship.actions.Action | |
↳ | com.urbanairship.actions.RateAppAction |
Action to link users to the rating section of their respective app store directly or through a prompt.
Accepted situations: SITUATION_MANUAL_INVOCATION, SITUATION_WEB_VIEW_INVOCATION, SITUATION_PUSH_OPENED, SITUATION_AUTOMATION, and SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON.
Expected argument values:
``show_link_prompt``: Optional Boolean. If NO action will link directly to the Amazon or Play store
review page, if YES action will display a rating prompt. Defaults to NO if null.
``title``: Optional String. String to override the link prompt's title. Header defaults to "Enjoying
Result value:
Default Registration Names: ^ra, rate_app_action
null
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | BODY_KEY | Key to define the app review link prompt's body when providing the action's value as a map. | |||||||||
String | DEFAULT_REGISTRY_NAME | Default registry name | |||||||||
String | DEFAULT_REGISTRY_SHORT_NAME | Default registry short name | |||||||||
String | SHOW_LINK_PROMPT_KEY | Key for the showing link prompt option. | |||||||||
String | SHOW_RATE_APP_INTENT_ACTION | Intent action for linking directly to store review page or displaying a rating link prompt with the option of opening the review page link. | |||||||||
String | TITLE_KEY | Key to define the app review link prompt's title when providing the action's value as a map. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.urbanairship.actions.Action
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
RateAppAction() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean |
acceptsArguments(ActionArguments arguments)
Checks if the argument's value can be parsed and ensures the situation is neither
Action.SITUATION_PUSH_RECEIVED nor Action.SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON.
| ||||||||||
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
|
Key to define the app review link prompt's body when providing the action's value as a map.
Default registry name
Default registry short name
Key for the showing link prompt option.
Intent action for linking directly to store review page or displaying a rating link prompt with the option of opening the review page link.
Key to define the app review link prompt's title when providing the action's value as a map.
Checks if the argument's value can be parsed and ensures the situation is neither Action.SITUATION_PUSH_RECEIVED nor Action.SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON.
arguments | The action arguments. |
---|
true
if the action can perform with the arguments,
otherwise false
.
Performs the action.
arguments | The action arguments. |
---|
Determines which thread runs the action.
true
if the action should be run on the main thread, or false
if the
action should run on a background thread.