java.lang.Object | |
↳ | com.urbanairship.push.iam.InAppMessage |
In-app message model object.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | InAppMessage.Builder | InAppMessage Builder. | |||||||||
@interface | InAppMessage.Position |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | POSITION_BOTTOM | Display the message on bottom of the screen. | |||||||||
int | POSITION_TOP | Display the message on top of the screen. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
public static final Creator<InAppMessage> | CREATOR | InAppMessage parcel creator. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | describeContents() | ||||||||||
boolean | equals(Object o) | ||||||||||
String |
getAlert()
Returns the message's alert.
| ||||||||||
Map<String, ActionValue> |
getButtonActionValues(String buttonId)
Returns the specified button's action name to action value map.
| ||||||||||
String |
getButtonGroupId()
Returns the button group ID.
| ||||||||||
Map<String, ActionValue> |
getClickActionValues()
Returns the on click action name to action value map.
| ||||||||||
Long |
getDuration()
Returns the duration in milliseconds for how long the message should be shown.
| ||||||||||
long |
getExpiry()
Returns the expiration time in milliseconds since Jan.
| ||||||||||
JsonMap |
getExtras()
Returns extras map.
| ||||||||||
String |
getId()
Returns the message's ID
| ||||||||||
int |
getPosition()
Returns the position of the in-app message.
| ||||||||||
Integer |
getPrimaryColor()
Returns the message's primary color.
| ||||||||||
Integer |
getSecondaryColor()
Returns the message's secondary color.
| ||||||||||
int | hashCode() | ||||||||||
boolean |
isExpired()
Tests if the message is expired or not.
| ||||||||||
static InAppMessage |
parseJson(String json)
Creates an in-app message from a JSON payload.
| ||||||||||
JsonValue |
toJsonValue()
Returns the objects represented as a JsonValue.
| ||||||||||
void | writeToParcel(Parcel dest, int flags) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Display the message on bottom of the screen.
Display the message on top of the screen.
Returns the specified button's action name to action value map.
Returns the button group ID. The button group can be fetched from getNotificationActionGroup(String)
Returns the on click action name to action value map.
Returns the duration in milliseconds for how long the message should be shown.
Returns the expiration time in milliseconds since Jan. 1, 1970, midnight GMT.
Returns the position of the in-app message. Either POSITION_BOTTOM
or POSITION_TOP
.
Returns the message's primary color.
Returns the message's secondary color.
Tests if the message is expired or not.
true
if the message is expired, otherwise false
.
Creates an in-app message from a JSON payload.
json | The json payload. |
---|
JsonException | If the JSON payload is unable to parsed. |
---|
Returns the objects represented as a JsonValue.