urbanairship-core/com.urbanairship.actions/FetchDeviceInfoAction

FetchDeviceInfoAction

open class FetchDeviceInfoAction : Action

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

Default Registration Names: DEFAULT_REGISTRY_NAME, DEFAULT_REGISTRY_SHORT_NAME

Default Registration Predicate: only accepts SITUATION_WEB_VIEW_INVOCATION and SITUATION_MANUAL_INVOCATION

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard

Properties

Link copied to clipboard
@NonNull
val CHANNEL_ID_KEY: String = "channel_id"
Channel ID response key.
Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_NAME: String = "fetch_device_info"
Default registry name
Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_SHORT_NAME: String = "^fdi"
Default registry short name
Link copied to clipboard
@NonNull
val LOCATION_ENABLED_KEY: String = "location_enabled"
Location enabled response key.
Link copied to clipboard
@NonNull
val NAMED_USER_ID_KEY: String = "named_user"
Named user response key.
Link copied to clipboard
@NonNull
val PUSH_OPT_IN_KEY: String = "push_opt_in"
Push opt-in response key.
Link copied to clipboard
@NonNull
val TAGS_KEY: String = "tags"
Tags response key.

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
@NonNull
open fun perform(@NonNull arguments: ActionArguments): ActionResult
Performs the action.

Inherited 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
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.