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

Class WebDevicePayload

java.lang.Object

com.urbanairship.api.common.model.APIModelObject

com.urbanairship.api.push.model.PushModelObject

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

All Implemented Interfaces:

DevicePayloadOverride

public final class WebDevicePayload
extends PushModelObject
implements DevicePayloadOverride

Represents the payload to be used for sending to web devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebDevicePayload.Builder WebDevicePayload Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<Actions>	getActions() Get the Actions.
java.util.Optional<java.lang.String>	getAlert() Get the alert.
java.util.Optional<<any>>	getButtons() Get the List of buttons.
DeviceType	getDeviceType() Get the device type.
java.util.Optional<PushExpiry>	getExpiry() Get the PushExpiry Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now.
java.util.Optional<<any>>	getExtra() Get an extra mapping of key-value pairs.
java.util.Optional<java.lang.Boolean>	getRequireInteraction() Get the Require Interaction flag.
java.util.Optional<WebTemplate>	getTemplate() Get the template with web-specific message.
java.util.Optional<java.lang.String>	getTitle() Get the title.
java.util.Optional<WebIcon>	getWebIcon() Get the web icon that describes an icon to be used with the web alert.
java.util.Optional<WebImage>	getWebImage() Get the WebImage object.
int	hashCode()
static WebDevicePayload.Builder	newBuilder() New WebDevicePayload Builder.
java.lang.String	toString()

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, wait, wait, wait

Method Detail

newBuilder

public static WebDevicePayload.Builder newBuilder()

New WebDevicePayload Builder.

Returns:

Builder

getDeviceType

public DeviceType getDeviceType()

Get the device type.

Specified by:

getDeviceType in interface DevicePayloadOverride

Returns:

DeviceType.WEB

getAlert

public java.util.Optional<java.lang.String> getAlert()

Get the alert.

Specified by:

getAlert in interface DevicePayloadOverride

Returns:

Optional String alert

getTitle

public java.util.Optional<java.lang.String> getTitle()

Get the title.

Returns:

Optional String title

getExtra

public java.util.Optional<<any>> getExtra()

Get an extra mapping of key-value pairs.

Returns:

Optional ImmutableMap of Strings

getWebIcon

public java.util.Optional<WebIcon> getWebIcon()

Get the web icon that describes an icon to be used with the web alert.

Returns:

Optional WebIcon object

getRequireInteraction

public java.util.Optional<java.lang.Boolean> getRequireInteraction()

Get the Require Interaction flag.

Returns:

Optional Boolean require interaction flag.

getActions

public java.util.Optional<Actions> getActions()

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

Returns:

Optional Actions

getWebImage

public java.util.Optional<WebImage> getWebImage()

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

Returns:

Optional WebImage

getExpiry

public java.util.Optional<PushExpiry> getExpiry()

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

Returns:

Optional PushExpiry

getButtons

public java.util.Optional<<any>> getButtons()

Get the List of buttons. 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.

Returns:

Optional ImmutableList of Button objects.

getTemplate

public java.util.Optional<WebTemplate> getTemplate()

Get the template with web-specific message.

Returns:

Optional WebTemplate

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object