com.urbanairship.api.push.model.notification.android

Class AndroidDevicePayload.Builder

java.lang.Object

com.urbanairship.api.push.model.notification.android.AndroidDevicePayload.Builder

Enclosing class:

AndroidDevicePayload

public static class AndroidDevicePayload.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
AndroidDevicePayload.Builder	addAllExtraEntries(java.util.Map<java.lang.String,java.lang.String> entries) Add a Map of key-value pairs.
AndroidDevicePayload.Builder	addExtraEntry(java.lang.String key, java.lang.String value) Add an extra key-value pair.
AndroidDevicePayload	build() Build the AndroidDevicePayload object.
AndroidDevicePayload.Builder	setActions(Actions actions) Describes Actions to be performed by the SDK when a user interacts with the notification.
AndroidDevicePayload.Builder	setAlert(java.lang.String alert) Set the alert string.
AndroidDevicePayload.Builder	setAndroidLiveUpdate(AndroidLiveUpdate androidLiveUpdate) Set an Android live update for the message.
AndroidDevicePayload.Builder	setCategory(Category value) Set the category specifier.
AndroidDevicePayload.Builder	setCollapseKey(java.lang.String collapseKey) Set the collapse key string.
AndroidDevicePayload.Builder	setDelayWhileIdle(boolean value) Set the delay while idle flag.
AndroidDevicePayload.Builder	setDeliveryPriority(java.lang.String deliveryPriority) Set the delivery priority.
AndroidDevicePayload.Builder	setIcon(java.lang.String icon) Set the icon string.
AndroidDevicePayload.Builder	setIconColor(java.lang.String iconColor) Set the icon color string.
AndroidDevicePayload.Builder	setInteractive(Interactive value) Set the interactive payload.
AndroidDevicePayload.Builder	setLocalOnly(java.lang.Boolean value) Set the local only flag.
AndroidDevicePayload.Builder	setNotificationChannel(java.lang.String notificationChannel) Set the notification channel string.
AndroidDevicePayload.Builder	setNotificationTag(java.lang.String notificationTag) Set the notification tag string.
AndroidDevicePayload.Builder	setPriority(java.lang.Integer value) Set the priority specifier.
AndroidDevicePayload.Builder	setPublicNotification(PublicNotification publicNotification) Set the public notification payload.
AndroidDevicePayload.Builder	setSound(java.lang.String sound) Set the sound string.
AndroidDevicePayload.Builder	setStyle(Style value) Set the style payload.
AndroidDevicePayload.Builder	setSummary(java.lang.String value) Set the summary string.
AndroidDevicePayload.Builder	setTemplate(AndroidTemplate template) Set a template with android-specific message.
AndroidDevicePayload.Builder	setTimeToLive(PushExpiry value) Set the push expiry.
AndroidDevicePayload.Builder	setTitle(java.lang.String value) Set the title string.
AndroidDevicePayload.Builder	setVisibility(java.lang.Integer value) Set the visibility specifier.
AndroidDevicePayload.Builder	setWearable(Wearable value) Set the wearable payload.

Methods inherited from class java.lang.Object

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

Method Detail

setAlert

public AndroidDevicePayload.Builder setAlert(java.lang.String alert)

Set the alert string.

Parameters:

alert - String

Returns:

Builder

setCollapseKey

public AndroidDevicePayload.Builder setCollapseKey(java.lang.String collapseKey)

Set the collapse key string.

Parameters:

collapseKey - String

Returns:

Builder

setNotificationChannel

public AndroidDevicePayload.Builder setNotificationChannel(java.lang.String notificationChannel)

Set the notification channel string.

Parameters:

notificationChannel - String

Returns:

Builder

setNotificationTag

public AndroidDevicePayload.Builder setNotificationTag(java.lang.String notificationTag)

Set the notification tag string.

Parameters:

notificationTag - String

Returns:

Builder

setTimeToLive

public AndroidDevicePayload.Builder setTimeToLive(PushExpiry value)

Set the push expiry.

Parameters:

value - PushExpiry

Returns:

Builder

setDeliveryPriority

public AndroidDevicePayload.Builder setDeliveryPriority(java.lang.String deliveryPriority)

Set the delivery priority.

Parameters:

deliveryPriority - String

Returns:

Builder

setDelayWhileIdle

public AndroidDevicePayload.Builder setDelayWhileIdle(boolean value)

Set the delay while idle flag.

Parameters:

value - boolean

Returns:

Builder

addExtraEntry

public AndroidDevicePayload.Builder addExtraEntry(java.lang.String key,
                                                  java.lang.String value)

Add an extra key-value pair.

Parameters:

key - String

value - String

Returns:

Builder

addAllExtraEntries

public AndroidDevicePayload.Builder addAllExtraEntries(java.util.Map<java.lang.String,java.lang.String> entries)

Add a Map of key-value pairs.

Parameters:

entries - A Map of Strings

Returns:

Builder

setInteractive

public AndroidDevicePayload.Builder setInteractive(Interactive value)

Set the interactive payload.

Parameters:

value - Interactive

Returns:

Builder

setTitle

public AndroidDevicePayload.Builder setTitle(java.lang.String value)

Set the title string.

Parameters:

value - String

Returns:

Builder

setLocalOnly

public AndroidDevicePayload.Builder setLocalOnly(java.lang.Boolean value)

Set the local only flag.

Parameters:

value - Boolean

Returns:

Builder

setWearable

public AndroidDevicePayload.Builder setWearable(Wearable value)

Set the wearable payload.

Parameters:

value - Wearable

Returns:

Builder

setSummary

public AndroidDevicePayload.Builder setSummary(java.lang.String value)

Set the summary string.

Parameters:

value - String

Returns:

Builder

setStyle

public AndroidDevicePayload.Builder setStyle(Style value)

Set the style payload.

Parameters:

value - Style

Returns:

Builder

setSound

public AndroidDevicePayload.Builder setSound(java.lang.String sound)

Set the sound string.

Parameters:

sound - String

Returns:

Builder

setIcon

public AndroidDevicePayload.Builder setIcon(java.lang.String icon)

Set the icon string.

Parameters:

icon - String

Returns:

Builder

setIconColor

public AndroidDevicePayload.Builder setIconColor(java.lang.String iconColor)

Set the icon color string.

Parameters:

iconColor - String

Returns:

Builder

setPriority

public AndroidDevicePayload.Builder setPriority(java.lang.Integer value)

Set the priority specifier.

Parameters:

value - Integer

Returns:

Builder

setCategory

public AndroidDevicePayload.Builder setCategory(Category value)

Set the category specifier.

Parameters:

value - Category

Returns:

Builder

setVisibility

public AndroidDevicePayload.Builder setVisibility(java.lang.Integer value)

Set the visibility specifier.

Parameters:

value - Integer

Returns:

Builder

setPublicNotification

public AndroidDevicePayload.Builder setPublicNotification(PublicNotification publicNotification)

Set the public notification payload.

Parameters:

publicNotification - PublicNotification

Returns:

Builder

setActions

public AndroidDevicePayload.Builder setActions(Actions actions)

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

Parameters:

actions - Actions

Returns:

Builder

setTemplate

public AndroidDevicePayload.Builder setTemplate(AndroidTemplate template)

Set a template with android-specific message.

Parameters:

template - AndroidTemplate

Returns:

Builder

setAndroidLiveUpdate

public AndroidDevicePayload.Builder setAndroidLiveUpdate(AndroidLiveUpdate androidLiveUpdate)

Set an Android live update for the message.

Parameters:

androidLiveUpdate - AndroidTemplate

Returns:

Builder

build

public AndroidDevicePayload build()

Build the AndroidDevicePayload object.

Returns:

AndroidDevicePayload