com.urbanairship.api.push.model.notification.adm

Class ADMDevicePayload

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.push.model.PushModelObject

com.urbanairship.api.push.model.notification.adm.ADMDevicePayload

All Implemented Interfaces:

DevicePayloadOverride

public final class ADMDevicePayload
extends PushModelObject
implements DevicePayloadOverride

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ADMDevicePayload.Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<Actions>	getActions() Get the Actions.
Optional<String>	getAlert()
Optional<String>	getConsolidationKey()
DeviceType	getDeviceType()
Optional<PushExpiry>	getExpiresAfter()
Optional<com.google.common.collect.ImmutableMap<String,String>>	getExtra()
Optional<String>	getIcon() Get the string representing an image file included in the application’s resources.
Optional<String>	getIconColor() Get the string representing the icon color in API Color Format.
Optional<Interactive>	getInteractive()
Optional<String>	getNotificationChannel() Get the string representing a notification channel.
Optional<String>	getNotificationTag() Get the string representing a notification tag.
Optional<String>	getSound() Get the string representing a sound file name included in the application’s resources.
Optional<Style>	getStyle() Get the style.
Optional<String>	getSummary() Get the string representing a summary/subtitle of the notification.
Optional<ADMTemplate>	getTemplate() Get the template with amazon-specific message.
Optional<String>	getTitle() Get the string representing the title of the notification.
int	hashCode()
static ADMDevicePayload.Builder	newBuilder()

Methods inherited from class com.urbanairship.api.push.model.PushModelObject

toJSON

Methods inherited from class com.urbanairship.api.common.model.APIModelObject

toJSON

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static ADMDevicePayload.Builder newBuilder()

getDeviceType

public DeviceType getDeviceType()

Specified by:

getDeviceType in interface DevicePayloadOverride

getAlert

public Optional<String> getAlert()

Specified by:

getAlert in interface DevicePayloadOverride

getConsolidationKey

public Optional<String> getConsolidationKey()

getExpiresAfter

public Optional<PushExpiry> getExpiresAfter()

getExtra

public Optional<com.google.common.collect.ImmutableMap<String,String>> getExtra()

getInteractive

public Optional<Interactive> getInteractive()

getActions

public Optional<Actions> getActions()

Get the Actions. Describes Actions to be performed by the SDK when a user interacts with the notification.

Returns:

Optional Actions

getIcon

public Optional<String> getIcon()

Get the string representing an image file included in the application’s resources.

Returns:

Optional String

getIconColor

public Optional<String> getIconColor()

Get the string representing the icon color in API Color Format. i.e. ‘#rrggbb’

Returns:

Optional String

getNotificationChannel

public Optional<String> getNotificationChannel()

Get the string representing a notification channel. Used to group notifications with similar behavior.

Returns:

Optional String

getNotificationTag

public Optional<String> getNotificationTag()

Get the string representing a notification tag. If a message is currently displaying and has a tag set, sending another message with the same tag will replace the posted notification.

Returns:

Optional String

getSound

public Optional<String> getSound()

Get the string representing a sound file name included in the application’s resources.

Returns:

Optional String

getSummary

public Optional<String> getSummary()

Get the string representing a summary/subtitle of the notification.

Returns:

Optional String

getTitle

public Optional<String> getTitle()

Get the string representing the title of the notification. The default value is the name of the app.

Returns:

Optional String

getStyle

public Optional<Style> getStyle()

Get the style. Advanced styles big text, big picture, and inbox are available on Android 4.3+ by adding the style to the platform specific notification payload on Android platforms.

Returns:

Optional String

getTemplate

public Optional<ADMTemplate> getTemplate()

Get the template with amazon-specific message.

Returns:

Optional ADMTemplate

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object