public final class

ResolutionInfo

extends Object
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 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.
Public Methods
static ResolutionInfo buttonPressed(ButtonInfo buttonInfo, long displayMilliseconds)
Factory method to create a resolution info for a button press.
static ResolutionInfo dismissed(long displayMilliseconds)
Factory method to create a resolution info for when the user dismissed the in-app message.
ButtonInfo getButtonInfo()
The button info.
long getDisplayMilliseconds()
The elapsed time the message was displayed in milliseconds.
String getType()
The resolution type.
static ResolutionInfo messageClicked(long displayMilliseconds)
Factory method to create a resolution info for when a clickable in-app message was clicked.
static ResolutionInfo timedOut(long displayMilliseconds)
Factory method to create a resolution info for when the in-app message times out and auto dismisses.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

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 Methods

public static ResolutionInfo buttonPressed (ButtonInfo buttonInfo, long displayMilliseconds)

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

Parameters
buttonInfo The button info.
displayMilliseconds How long in milliseconds the in-app message was displayed.
Returns
  • The resolution info.

public static ResolutionInfo dismissed (long displayMilliseconds)

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

Parameters
displayMilliseconds How long in milliseconds the in-app message was displayed.
Returns
  • The resolution info.

public ButtonInfo getButtonInfo ()

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

Returns
  • The button info.

public long getDisplayMilliseconds ()

The elapsed time the message was displayed in milliseconds.

Returns
  • The display time in milliseconds.

public String getType ()

The resolution type.

Returns
  • The resolution type.

public static ResolutionInfo messageClicked (long displayMilliseconds)

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

Parameters
displayMilliseconds How long in milliseconds the in-app message was displayed.
Returns
  • The resolution info.

public static ResolutionInfo timedOut (long displayMilliseconds)

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

Parameters
displayMilliseconds How long in milliseconds the in-app message was displayed.
Returns
  • The resolution info.