public class

SetAttributesAction

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

Class Overview

An action that sets attributes.

Accepted situations: all

Accepted argument value types: A JSON payload for setting or removing attributes. An example JSON payload:

 {
   "channel": {
     set: {"key_1": value_1, "key_2": value_2},
     remove: ["attribute_1", "attribute_2", "attribute_3"]
   },
   "named_user": {
     set: {"key_4": value_4, "key_5": value_5},
     remove: ["attribute_4", "attribute_5", "attribute_6"]
   }
 

Summary

Nested Classes
class SetAttributesAction.SetAttributesPredicate Default SetAttributesAction.SetAttributesPredicate predicate. 
Constants
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
SetAttributesAction()
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 DEFAULT_REGISTRY_NAME

Default registry name

Constant Value: "set_attributes_action"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^a"

Public Constructors

public SetAttributesAction ()

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.