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

Class ADMDevicePayload.Builder

java.lang.Object

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

Enclosing class:

ADMDevicePayload

public static class ADMDevicePayload.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
ADMDevicePayload.Builder	addAllExtraEntries(Map<String,String> entries)
ADMDevicePayload.Builder	addExtraEntry(String key, String value)
ADMDevicePayload	build()
ADMDevicePayload.Builder	setActions(Actions actions) Set the Actions.
ADMDevicePayload.Builder	setAlert(String alert)
ADMDevicePayload.Builder	setConsolidationKey(String consolidationKey)
ADMDevicePayload.Builder	setExpiresAfter(PushExpiry value)
ADMDevicePayload.Builder	setIcon(String icon) Set the string representing an image file included in the application’s resources.
ADMDevicePayload.Builder	setIconColor(String iconColor) Set the string representing the icon color in API Color Format.
ADMDevicePayload.Builder	setInteractive(Interactive value)
ADMDevicePayload.Builder	setNotificationChannel(String notificationChannel) Set the string representing a notification channel.
ADMDevicePayload.Builder	setNotificationTag(String notificationTag) Set the string representing a notification tag.
ADMDevicePayload.Builder	setSound(String sound) Set the string representing a sound file name included in the application’s resources.
ADMDevicePayload.Builder	setStyle(Style style) Set the style.
ADMDevicePayload.Builder	setSummary(String summary) Set the string representing a summary/subtitle of the notification.
ADMDevicePayload.Builder	setTemplate(ADMTemplate template) Set a template with amazon-specific message.
ADMDevicePayload.Builder	setTitle(String title) Set the string representing the title of the notification.

Methods inherited from class java.lang.Object

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

Method Detail

setAlert

public ADMDevicePayload.Builder setAlert(String alert)

setConsolidationKey

public ADMDevicePayload.Builder setConsolidationKey(String consolidationKey)

setExpiresAfter

public ADMDevicePayload.Builder setExpiresAfter(PushExpiry value)

addExtraEntry

public ADMDevicePayload.Builder addExtraEntry(String key,
                                              String value)

addAllExtraEntries

public ADMDevicePayload.Builder addAllExtraEntries(Map<String,String> entries)

setInteractive

public ADMDevicePayload.Builder setInteractive(Interactive value)

setActions

public ADMDevicePayload.Builder setActions(Actions actions)

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

Parameters:

actions - Actions

Returns:

Optional Actions

setIcon

public ADMDevicePayload.Builder setIcon(String icon)

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

Parameters:

icon - String

Returns:

Optional String

setIconColor

public ADMDevicePayload.Builder setIconColor(String iconColor)

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

Parameters:

iconColor - String

Returns:

Optional String

setNotificationChannel

public ADMDevicePayload.Builder setNotificationChannel(String notificationChannel)

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

Parameters:

notificationChannel - String

Returns:

Optional String

setNotificationTag

public ADMDevicePayload.Builder setNotificationTag(String notificationTag)

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

Parameters:

notificationTag - String

Returns:

Optional String

setSound

public ADMDevicePayload.Builder setSound(String sound)

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

Parameters:

sound - String

Returns:

Optional String

setSummary

public ADMDevicePayload.Builder setSummary(String summary)

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

Parameters:

summary - String

Returns:

Optional String

setTitle

public ADMDevicePayload.Builder setTitle(String title)

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

Parameters:

title - String

Returns:

Optional String

setStyle

public ADMDevicePayload.Builder setStyle(Style style)

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

Parameters:

style - Style

Returns:

Optional String

setTemplate

public ADMDevicePayload.Builder setTemplate(ADMTemplate template)

Set a template with amazon-specific message.

Parameters:

template - ADMTemplate

Returns:

Builder

build

public ADMDevicePayload build()