urbanairship-core/com.urbanairship.actions/SubscriptionListAction

SubscriptionListAction

class SubscriptionListAction : Action(source)

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: DEFAULT_NAMES

Default Registration Predicate: none

Constructors

SubscriptionListAction

constructor()

Default constructor.

Types

Companion

object Companion

Functions

acceptsArguments

open override fun acceptsArguments(arguments: ActionArguments): Boolean

Called before an action is performed to determine if the the action can accept the arguments.

perform

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

Inherited functions

onFinish

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

Called after the action performs.

onStart

open fun onStart(arguments: ActionArguments)

Called before an action is performed.

run

fun run(arguments: ActionArguments): ActionResult

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

shouldRunOnMainThread

open fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.