public final class

ResolutionInfo

extends Object
implements JsonSerializable
java.lang.Object
   ↳ com.urbanairship.iam.ResolutionInfo

Class Overview

Info used to generate an event when a message is finished.

Summary

Nested Classes
@interface ResolutionInfo.Type  
Constants
String BUTTON_INFO_KEY Button info key.
String RESOLUTION_BUTTON_CLICK Button click resolution.
String RESOLUTION_MESSAGE_CLICK Message click resolution
String RESOLUTION_TIMED_OUT Timed out resolution.
String RESOLUTION_USER_DISMISSED User dismissed resolution.
String TYPE_KEY Type key.
Public Methods
static ResolutionInfo buttonPressed(ButtonInfo buttonInfo)
Factory method to create a resolution info for a button press.
static ResolutionInfo buttonPressed(String buttonId, String buttonDescription, boolean cancel)
Factory method to create a resolution info for a button press.
static ResolutionInfo dismissed()
Factory method to create a resolution info for when the user dismissed the in-app message.
boolean equals(Object o)
static ResolutionInfo fromJson(JsonValue value)
Parses an ResolutionInfo from a JsonValue.
ButtonInfo getButtonInfo()
The button info.
String getType()
The resolution type.
int hashCode()
static ResolutionInfo messageClicked()
Factory method to create a resolution info for when a clickable in-app message was clicked.
static ResolutionInfo timedOut()
Factory method to create a resolution info for when the in-app message times out and auto dismisses.
JsonValue toJsonValue()
Returns the objects represented as a JsonValue.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.urbanairship.json.JsonSerializable

Constants

public static final String BUTTON_INFO_KEY

Button info key.

Constant Value: "button_info"

public static final String RESOLUTION_BUTTON_CLICK

Button click resolution.

Constant Value: "button_click"

public static final String RESOLUTION_MESSAGE_CLICK

Message click resolution

Constant Value: "message_click"

public static final String RESOLUTION_TIMED_OUT

Timed out resolution.

Constant Value: "timed_out"

public static final String RESOLUTION_USER_DISMISSED

User dismissed resolution.

Constant Value: "user_dismissed"

public static final String TYPE_KEY

Type key.

Constant Value: "type"

Public Methods

public static ResolutionInfo buttonPressed (ButtonInfo buttonInfo)

Factory method to create a resolution info for a button press.

Parameters
buttonInfo The button info.
Returns
  • The resolution info.

public static ResolutionInfo buttonPressed (String buttonId, String buttonDescription, boolean cancel)

Factory method to create a resolution info for a button press.

Parameters
buttonId The button id.
buttonDescription The button description.
cancel If the button should cancel or not.
Returns
  • The resolution info.

public static ResolutionInfo dismissed ()

Factory method to create a resolution info for when the user dismissed the in-app message.

Returns
  • The resolution info.

public boolean equals (Object o)

public static ResolutionInfo fromJson (JsonValue value)

Parses an ResolutionInfo from a JsonValue.

Parameters
value The json value.
Returns
  • The parsed resolution info.
Throws
JsonException If the resolution info was unable to be parsed.

public ButtonInfo getButtonInfo ()

The button info. Only available if the type is RESOLUTION_BUTTON_CLICK.

Returns
  • The button info.

public String getType ()

The resolution type.

Returns
  • The resolution type.

public int hashCode ()

public static ResolutionInfo messageClicked ()

Factory method to create a resolution info for when a clickable in-app message was clicked.

Returns
  • The resolution info.

public static ResolutionInfo timedOut ()

Factory method to create a resolution info for when the in-app message times out and auto dismisses.

Returns
  • The resolution info.

public JsonValue toJsonValue ()

Returns the objects represented as a JsonValue.

Returns
  • The object as a JsonValue.