urbanairship-core/com.urbanairship.actions/SetAttributesAction

SetAttributesAction

open class SetAttributesAction : Action

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"]
  }
Content copied to clipboard

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_NAME: String = "set_attributes_action"
Default registry name
Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_SHORT_NAME: String = "^a"
Default registry short name

Inherited properties

Link copied to clipboard
val SITUATION_AUTOMATION: Int = 6
Situation where an action is triggered from Action Automation.
val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5
Situation where an action is triggered from a background notification action button.
val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4
Situation where an action is triggered from a foreground notification action button.
Link copied to clipboard
val SITUATION_MANUAL_INVOCATION: Int = 0
Situation where an action is manually invoked.
Link copied to clipboard
val SITUATION_PUSH_OPENED: Int = 2
Situation where an action is triggered when a push is opened.
Link copied to clipboard
val SITUATION_PUSH_RECEIVED: Int = 1
Situation where an action is triggered when a push is received.
Link copied to clipboard
val SITUATION_WEB_VIEW_INVOCATION: Int = 3
Situation where an action is triggered from a web view.

Functions

Link copied to clipboard
open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean
Called before an action is performed to determine if the the action can accept the arguments.
Link copied to clipboard
@NonNull
open fun perform(@NonNull arguments: ActionArguments): ActionResult
Performs the action.

Inherited functions

Link copied to clipboard
open fun onFinish(@NonNull arguments: ActionArguments, @NonNull result: ActionResult)
Called after the action performs.
Link copied to clipboard
open fun onStart(@NonNull arguments: ActionArguments)
Called before an action is performed.
Link copied to clipboard
open fun shouldRunOnMainThread(): Boolean
Determines which thread runs the action.