software.amazon.awssdk.services.pinpoint.model

Class DefaultPushNotificationMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.DefaultPushNotificationMessage

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

@Generated(value="software.amazon.awssdk:codegen")
public class DefaultPushNotificationMessage
extends Object
implements StructuredPojo, ToCopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

Default Push Notification Message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultPushNotificationMessage.Builder

Method Summary

Modifier and Type	Method and Description
Action	action() The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
String	actionAsString() The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
String	body() The message body of the notification, the email body or the text message.
static DefaultPushNotificationMessage.Builder	builder()
Map<String,String>	data() The data payload used for a silent push.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends DefaultPushNotificationMessage.Builder>	serializableBuilderClass()
Boolean	silentPush() Indicates if the message should display on the users device.
Map<String,List<String>>	substitutions() Default message substitutions.
String	title() The message title that displays above the message on the user's device.
DefaultPushNotificationMessage.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	url() The URL to open in the user's mobile browser.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

action

public Action action()

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

See Also:

Action

actionAsString

public String actionAsString()

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

See Also:

Action

body

public String body()

The message body of the notification, the email body or the text message.

Returns:

The message body of the notification, the email body or the text message.

data

public Map<String,String> data()

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

silentPush

public Boolean silentPush()

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

Returns:

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

substitutions

public Map<String,List<String>> substitutions()

Default message substitutions. Can be overridden by individual address substitutions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Default message substitutions. Can be overridden by individual address substitutions.

title

public String title()

The message title that displays above the message on the user's device.

Returns:

The message title that displays above the message on the user's device.

url

public String url()

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Returns:

The URL to open in the user's mobile browser. Used if the value for Action is URL.

toBuilder

public DefaultPushNotificationMessage.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

Returns:

a builder for type T

builder

public static DefaultPushNotificationMessage.Builder builder()

serializableBuilderClass

public static Class<? extends DefaultPushNotificationMessage.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.