urbanairship-core/com.urbanairship.actions/RateAppAction

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 ?" if null. ``body``: Optional String. String to override the link prompt's body. Body defaults to "Tap Rate to rate it in the app store." if null.

Result value: null

Default Registration Names: ^ra, rate_app_action

Constructors

RateAppAction

constructor()

Properties

BODY_KEY

@NonNull

val BODY_KEY: String = "body"

Key to define the app review link prompt's body when providing the action's value as a map.

DEFAULT_REGISTRY_NAME

@NonNull

val DEFAULT_REGISTRY_NAME: String = "rate_app_action"

Default registry name

DEFAULT_REGISTRY_SHORT_NAME

@NonNull

val DEFAULT_REGISTRY_SHORT_NAME: String = "^ra"

Default registry short name

SHOW_LINK_PROMPT_KEY

@NonNull

val SHOW_LINK_PROMPT_KEY: String = "show_link_prompt"

Key for the showing link prompt option.

SHOW_RATE_APP_INTENT_ACTION

@NonNull

val SHOW_RATE_APP_INTENT_ACTION: String = "com.urbanairship.actions.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.

TITLE_KEY

@NonNull

val TITLE_KEY: String = "title"

Key to define the app review link prompt's title when providing the action's value as a map.

Inherited properties

SITUATION_AUTOMATION

val SITUATION_AUTOMATION: Int = 6

Situation where an action is triggered from Action Automation.

SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5

Situation where an action is triggered from a background notification action button.

SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4

Situation where an action is triggered from a foreground notification action button.

SITUATION_MANUAL_INVOCATION

val SITUATION_MANUAL_INVOCATION: Int = 0

Situation where an action is manually invoked.

SITUATION_PUSH_OPENED

val SITUATION_PUSH_OPENED: Int = 2

Situation where an action is triggered when a push is opened.

SITUATION_PUSH_RECEIVED

val SITUATION_PUSH_RECEIVED: Int = 1

Situation where an action is triggered when a push is received.

SITUATION_WEB_VIEW_INVOCATION

val SITUATION_WEB_VIEW_INVOCATION: Int = 3

Situation where an action is triggered from a web view.

Functions

acceptsArguments

open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean

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.

perform

@NonNull

open fun perform(@NonNull arguments: ActionArguments): ActionResult

Performs the action.

shouldRunOnMainThread

open fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.

Inherited functions

onFinish

open fun onFinish(@NonNull arguments: ActionArguments, @NonNull result: ActionResult)

Called after the action performs.

onStart

open fun onStart(@NonNull arguments: ActionArguments)

Called before an action is performed.