software.amazon.awssdk.services.pinpoint.model

Class DefaultPushNotificationMessage

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

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

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

See Also:

Serialized Form

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 default action to occur if a recipient taps the push notification.
String	actionAsString() The default action to occur if a recipient taps the push notification.
String	body() The default body of the notification message.
static DefaultPushNotificationMessage.Builder	builder()
Map<String,String>	data() The JSON data payload to use for the default push notification, if the notification is a silent push notification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasData() For responses, this returns true if the service returned a value for the Data property.
int	hashCode()
boolean	hasSubstitutions() For responses, this returns true if the service returned a value for the Substitutions property.
List<SdkField<?>>	sdkFields()
static Class<? extends DefaultPushNotificationMessage.Builder>	serializableBuilderClass()
Boolean	silentPush() Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
Map<String,List<String>>	substitutions() The default message variables to use in the notification message.
String	title() The default title to display above the notification message on a recipient's device.
DefaultPushNotificationMessage.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

action

public final Action action()

The default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

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 default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

See Also:

Action

actionAsString

public final String actionAsString()

The default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

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 default action to occur if a recipient taps the push notification. Valid values are:

• OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

• DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

• URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

See Also:

Action

body

public final String body()

The default body of the notification message.

Returns:

The default body of the notification message.

hasData

public final boolean hasData()

For responses, this returns true if the service returned a value for the Data property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

data

public final Map<String,String> data()

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasData() method.

Returns:

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

silentPush

public final Boolean silentPush()

Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

Returns:

Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

hasSubstitutions

public final boolean hasSubstitutions()

For responses, this returns true if the service returned a value for the Substitutions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

substitutions

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

The default message variables to use in the notification message. You can override the default variables with individual address variables.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubstitutions() method.

Returns:

The default message variables to use in the notification message. You can override the default variables with individual address variables.

title

public final String title()

The default title to display above the notification message on a recipient's device.

Returns:

The default title to display above the notification message on a recipient's device.

url

public final String url()

The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Returns:

The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

toBuilder

public DefaultPushNotificationMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

builder

public static DefaultPushNotificationMessage.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo