public class

FetchDeviceInfoAction

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

Class Overview

Action to fetch a map of device properties.

Accepted situations: all.

Accepted argument value - none.

Result value: JsonMap containing the device's channel ID, named user ID, push opt-in status, location enabled status, and tags. An example response as JSON: { "channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5", "push_opt_in": true, "location_enabled": true, "named_user": "cool_user", "tags": ["tag1", "tag2, "tag3"] }

Default Registration Names: DEFAULT_REGISTRY_NAME, DEFAULT_REGISTRY_SHORT_NAME

Default Registration Predicate: only accepts SITUATION_WEB_VIEW_INVOCATION and SITUATION_MANUAL_INVOCATION

Summary

Nested Classes
class FetchDeviceInfoAction.FetchDeviceInfoPredicate Default FetchDeviceInfoAction predicate. 
Constants
String CHANNEL_ID_KEY Channel ID response key.
String DEFAULT_REGISTRY_NAME Default registry name
String DEFAULT_REGISTRY_SHORT_NAME Default registry short name
String LOCATION_ENABLED_KEY Location enabled response key.
String NAMED_USER_ID_KEY Named user response key.
String PUSH_OPT_IN_KEY Push opt-in response key.
String TAGS_KEY Tags response key.
[Expand]
Inherited Constants
From class com.urbanairship.actions.Action
Public Constructors
FetchDeviceInfoAction()
Public Methods
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 CHANNEL_ID_KEY

Channel ID response key.

Constant Value: "channel_id"

public static final String DEFAULT_REGISTRY_NAME

Default registry name

Constant Value: "fetch_device_info"

public static final String DEFAULT_REGISTRY_SHORT_NAME

Default registry short name

Constant Value: "^fdi"

public static final String LOCATION_ENABLED_KEY

Location enabled response key.

Constant Value: "location_enabled"

public static final String NAMED_USER_ID_KEY

Named user response key.

Constant Value: "named_user"

public static final String PUSH_OPT_IN_KEY

Push opt-in response key.

Constant Value: "push_opt_in"

public static final String TAGS_KEY

Tags response key.

Constant Value: "tags"

Public Constructors

public FetchDeviceInfoAction ()

Public Methods

public ActionResult perform (ActionArguments arguments)

Performs the action.

Parameters
arguments The action arguments.
Returns
  • The result of the action.