com.urbanairship.api.push.model.notification.web

Class WebDevicePayload.Builder

java.lang.Object

com.urbanairship.api.push.model.notification.web.WebDevicePayload.Builder

Enclosing class:

WebDevicePayload

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

WebDevicePayload Builder.

Method Summary

Modifier and Type	Method and Description
WebDevicePayload.Builder	addAllButtons(java.lang.Iterable<? extends Button> buttons) Add iterable of Button objects.
WebDevicePayload.Builder	addAllExtraEntries(java.util.Map<java.lang.String,java.lang.String> entries) Add a Map of key-value pairs.
WebDevicePayload.Builder	addButton(Button button) Add a Button.
WebDevicePayload.Builder	addExtraEntry(java.lang.String key, java.lang.String value) Add an extra key-value pair.
WebDevicePayload	build() Build the WebDevicePayload object.
WebDevicePayload.Builder	setActions(Actions actions) Set the Actions.
WebDevicePayload.Builder	setAlert(java.lang.String alert) Set the alert string.
WebDevicePayload.Builder	setExpiry(PushExpiry expiry) Set the PushExpiry Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now.
WebDevicePayload.Builder	setRequireInteraction(boolean value) Set the Require Interaction flag.
WebDevicePayload.Builder	setTemplate(WebTemplate webTemplate) Set a template with web-specific message.
WebDevicePayload.Builder	setTitle(java.lang.String title) Set the title string.
WebDevicePayload.Builder	setWebIcon(WebIcon webIcon) Set the webIcon payload.
WebDevicePayload.Builder	setWebImage(WebImage webImage) Set the WebImage object.

Methods inherited from class java.lang.Object

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

Method Detail

setAlert

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

Set the alert string.

Parameters:

alert - String

Returns:

WebDevicePayload Builder

setTitle

public WebDevicePayload.Builder setTitle(java.lang.String title)

Set the title string.

Parameters:

title - String

Returns:

WebDevicePayload Builder

addExtraEntry

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

Add an extra key-value pair.

Parameters:

key - String

value - String

Returns:

WebDevicePayload Builder

addAllExtraEntries

public WebDevicePayload.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:

WebDevicePayload Builder

setWebIcon

public WebDevicePayload.Builder setWebIcon(WebIcon webIcon)

Set the webIcon payload.

Parameters:

webIcon - a WebIcon

Returns:

WebDevicePayload Builder

setRequireInteraction

public WebDevicePayload.Builder setRequireInteraction(boolean value)

Set the Require Interaction flag.

Parameters:

value - Boolean

Returns:

Builder

setActions

public WebDevicePayload.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:

Builder

setWebImage

public WebDevicePayload.Builder setWebImage(WebImage webImage)

Set the WebImage object. A object that describes an image to be used with the web alert.

Parameters:

webImage - WebImage

Returns:

Builder

setExpiry

public WebDevicePayload.Builder setExpiry(PushExpiry expiry)

Set the PushExpiry Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now.

Parameters:

expiry - PushExpiry

Returns:

Builder

addButton

public WebDevicePayload.Builder addButton(Button button)

Add a Button. Contains one or two buttons that perform actions for the web notification. If you do not specify actions for a button, the button closes the notification without performing an action.

Parameters:

button - Button

Returns:

Builder

addAllButtons

public WebDevicePayload.Builder addAllButtons(java.lang.Iterable<? extends Button> buttons)

Add iterable of Button objects. Contains one or two buttons that perform actions for the web notification. If you do not specify actions for a button, the button closes the notification without performing an action.

Parameters:

buttons - Buttons

Returns:

Builder

setTemplate

public WebDevicePayload.Builder setTemplate(WebTemplate webTemplate)

Set a template with web-specific message.

Parameters:

webTemplate - WebTemplate

Returns:

Builder

build

public WebDevicePayload build()

Build the WebDevicePayload object.

Returns:

WebDevicePayload