public class

CancelSchedulesAction

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

Class Overview

Action to cancel automation schedules.

Accepted situations: SITUATION_MANUAL_INVOCATION, SITUATION_WEB_VIEW_INVOCATION, SITUATION_AUTOMATION, and SITUATION_PUSH_RECEIVED.

Accepted argument value - Either ALL or a map with:

  • GROUPS: List of schedule groups or a single group. Optional.
  • IDS: List of schedule IDs or a single schedule Id. Optional.

Result value: null.

Default Registration Names: DEFAULT_REGISTRY_NAME, DEFAULT_REGISTRY_SHORT_NAME

Default Registration Predicate: none

Summary

Constants
String ALL Used as the action's value to cancel all schedules.
String DEFAULT_REGISTRY_NAME Default registry name
String DEFAULT_REGISTRY_SHORT_NAME Default registry short name
String GROUPS Used as the key in the action's value map to specify schedule groups to cancel.
String IDS Used as the key in the action's value map to specify schedule IDs to cancel.
[Expand]
Inherited Constants
From class com.urbanairship.actions.Action
Public Constructors
CancelSchedulesAction()
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 ALL

Used as the action's value to cancel all schedules.

Constant Value: "all"

public static final String DEFAULT_REGISTRY_NAME

Default registry name

Constant Value: "cancel_scheduled_actions"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^csa"

public static final String GROUPS

Used as the key in the action's value map to specify schedule groups to cancel.

Constant Value: "groups"

public static final String IDS

Used as the key in the action's value map to specify schedule IDs to cancel.

Constant Value: "ids"

Public Constructors

public CancelSchedulesAction ()

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.