software.amazon.awssdk.services.pinpoint.model

Class DefaultPushNotificationTemplate

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.DefaultPushNotificationTemplate

All Implemented Interfaces:

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

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

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultPushNotificationTemplate.Builder

Method Summary

Modifier and Type	Method and Description
Action	action() The action to occur if a recipient taps a push notification that's based on the message template.
String	actionAsString() The action to occur if a recipient taps a push notification that's based on the message template.
String	body() The message body to use in push notifications that are based on the message template.
static DefaultPushNotificationTemplate.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DefaultPushNotificationTemplate.Builder>	serializableBuilderClass()
String	sound() The sound to play when a recipient receives a push notification that's based on the message template.
String	title() The title to use in push notifications that are based on the message template.
DefaultPushNotificationTemplate.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template 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 Action action()

The action to occur if a recipient taps a push notification that's based on the message template. 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 action to occur if a recipient taps a push notification that's based on the message template. 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 String actionAsString()

The action to occur if a recipient taps a push notification that's based on the message template. 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 action to occur if a recipient taps a push notification that's based on the message template. 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 String body()

The message body to use in push notifications that are based on the message template.

Returns:

The message body to use in push notifications that are based on the message template.

sound

public String sound()

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

Returns:

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

title

public String title()

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

Returns:

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

url

public String url()

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

Returns:

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

toBuilder

public DefaultPushNotificationTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultPushNotificationTemplate.Builder,DefaultPushNotificationTemplate>

builder

public static DefaultPushNotificationTemplate.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo