java.lang.Object | ||
↳ | com.urbanairship.actions.Action | |
↳ | com.urbanairship.automation.actions.CancelSchedulesAction |
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
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()
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
|
Used as the action's value to cancel all schedules.
Default registry name
Default registry short name
Used as the key in the action's value map to specify schedule groups to cancel.
Used as the key in the action's value map to specify schedule IDs to cancel.
Default constructor.
Called before an action is performed to determine if the the action can accept the arguments.
arguments | The action arguments. |
---|
true
if the action can perform with the arguments,
otherwise false
.
Performs the action.
arguments | The action arguments. |
---|