urbanairship-core/com.urbanairship.actions/RateAppAction

RateAppAction

class RateAppAction(appStoreIntentProvider: () -> Intent, contextProvider: () -> Context) : Action(source)

Action to link users to the rating section of their respective app store directly or through a prompt.

Accepted situations: Action.Situation.MANUAL_INVOCATION, Action.Situation.WEB_VIEW_INVOCATION, Action.Situation.PUSH_OPENED, Action.Situation.AUTOMATION, and Action.Situation.FOREGROUND_NOTIFICATION_ACTION_BUTTON.

Expected argument values: SHOW_LINK_PROMPT_KEY: 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_KEY: Optional String. String to override the link prompt's title. Header defaults to "Enjoying ?" if null. BODY_KEY: 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: DEFAULT_NAMES

Constructors

constructor(appStoreIntentProvider: () -> Intent, contextProvider: () -> Context)

constructor()

Types

object Companion

Functions

acceptsArguments

open override fun acceptsArguments(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.

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

shouldRunOnMainThread

open override fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.

Inherited functions

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

Called after the action performs.

open fun onStart(arguments: ActionArguments)

Called before an action is performed.

performSuspending

open suspend fun performSuspending(arguments: ActionArguments): ActionResult

Performs the action, suspending until it completes.

fun run(arguments: ActionArguments): ActionResult

Performs the action, with pre/post execution calls, if it accepts the provided arguments.

suspend fun runSuspending(arguments: ActionArguments): ActionResult

Performs the action, with pre/post execution calls, if it accepts the provided arguments, suspending until the action completes.