urbanairship-core/com.urbanairship.actions/SubscriptionListAction

SubscriptionListAction

open class SubscriptionListAction : Action

Action for subscribing/unsubscribing to lists.

Accepted situations: all

Accepted argument value types: A JSON Payload containing a type, a list, an action and a scope. An example JSON Payload : [ { "type": "contact", "action": "subscribe", "list": "mylist", "scope": "app" }, { "type": "channel", "action": "unsubscribe", "list": "thelist" } ]

Result value: The payload used.

Default Registration Names: ^sla, ^sl, subscription_list_action, edit_subscription_list_action

Default Registration Predicate: none

Constructors

Link copied to clipboard
constructor()
Default constructor.

Properties

Link copied to clipboard
@NonNull
val ALT_DEFAULT_REGISTRY_NAME: String = "edit_subscription_list_action"
Default registry short name
Link copied to clipboard
@NonNull
val ALT_DEFAULT_REGISTRY_SHORT_NAME: String = "^sl"
Default registry short name
Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_NAME: String = "subscription_list_action"
Default registry name
Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_SHORT_NAME: String = "^sla"
Default registry short name

Inherited properties

Link copied to clipboard
val SITUATION_AUTOMATION: Int = 6
Situation where an action is triggered from Action Automation.
val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5
Situation where an action is triggered from a background notification action button.
val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4
Situation where an action is triggered from a foreground notification action button.
Link copied to clipboard
val SITUATION_MANUAL_INVOCATION: Int = 0
Situation where an action is manually invoked.
Link copied to clipboard
val SITUATION_PUSH_OPENED: Int = 2
Situation where an action is triggered when a push is opened.
Link copied to clipboard
val SITUATION_PUSH_RECEIVED: Int = 1
Situation where an action is triggered when a push is received.
Link copied to clipboard
val SITUATION_WEB_VIEW_INVOCATION: Int = 3
Situation where an action is triggered from a web view.

Functions

Link copied to clipboard
open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean
Called before an action is performed to determine if the the action can accept the arguments.
Link copied to clipboard
@NonNull
open fun perform(@NonNull arguments: ActionArguments): ActionResult
Performs the action.

Inherited functions

Link copied to clipboard
open fun onFinish(@NonNull arguments: ActionArguments, @NonNull result: ActionResult)
Called after the action performs.
Link copied to clipboard
open fun onStart(@NonNull arguments: ActionArguments)
Called before an action is performed.
Link copied to clipboard
open fun shouldRunOnMainThread(): Boolean
Determines which thread runs the action.