public class

AddTagsAction

extends Action
java.lang.Object
   ↳ com.urbanairship.actions.Action
     ↳ com.urbanairship.actions.tags.AddTagsAction

Class Overview

An action that adds tags.

Accepted situations: all

Accepted argument value types: A string for a single tag, a Collection of Strings for multiple tags, or a JSON payload for tag groups. An example JSON payload:

 {
   "channel": {
     "channel_tag_group": ["channel_tag_1", "channel_tag_2"],
     "other_channel_tag_group": ["other_channel_tag_1"]
   },
   "named_user": {
     "named_user_tag_group": ["named_user_tag_1", "named_user_tag_2"],
     "other_named_user_tag_group": ["other_named_user_tag_1"]
   },
   "device": ["tag 1", "tag 2"]
 }
 

Result value: null

Default Registration Names: ^+t, add_tags_action

Default Registration Predicate: Rejects SITUATION_PUSH_RECEIVED

Summary

Nested Classes
class AddTagsAction.AddTagsPredicate Default AddTagsAction 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
AddTagsAction()
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.
Protected Methods
AirshipChannel getChannel()
Gets the channel.
[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: "add_tags_action"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^+t"

Public Constructors

public AddTagsAction ()

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.

Protected Methods

protected AirshipChannel getChannel ()

Gets the channel.

Returns
  • A channel instance