public class

SubscriptionListAction

extends Action
java.lang.Object
   ↳ com.urbanairship.actions.Action
     ↳ com.urbanairship.actions.SubscriptionListAction

Class Overview

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

Summary

Constants
String ALT_DEFAULT_REGISTRY_NAME Default registry short name
String ALT_DEFAULT_REGISTRY_SHORT_NAME Default registry short name
String DEFAULT_REGISTRY_NAME Default registry name
String DEFAULT_REGISTRY_SHORT_NAME Default registry short name
[Expand]
Inherited Constants
From class com.urbanairship.actions.Action
Public Constructors
SubscriptionListAction()
Default constructor.
Public Methods
boolean acceptsArguments(ActionArguments arguments)
Called before an action is performed to determine if the the action can accept the arguments.
ActionResult perform(ActionArguments arguments)
Performs the action.
[Expand]
Inherited Methods
From class com.urbanairship.actions.Action
From class java.lang.Object

Constants

public static final String ALT_DEFAULT_REGISTRY_NAME

Default registry short name

Constant Value: "edit_subscription_list_action"

public static final String ALT_DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^sl"

public static final String DEFAULT_REGISTRY_NAME

Default registry name

Constant Value: "subscription_list_action"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^sla"

Public Constructors

public SubscriptionListAction ()

Default constructor.

Public Methods

public boolean acceptsArguments (ActionArguments arguments)

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

Parameters
arguments The action arguments.
Returns
  • true if the action can perform with the arguments, otherwise false.

public ActionResult perform (ActionArguments arguments)

Performs the action.

Parameters
arguments The action arguments.
Returns
  • The result of the action.