software.amazon.awssdk.services.pinpoint.model

Class ADMMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ADMMessage

All Implemented Interfaces:

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

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

ADM Message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ADMMessage.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.
static ADMMessage.Builder	builder()
String	consolidationKey() Optional.
Map<String,String>	data() The data payload used for a silent push.
boolean	equals(Object obj)
String	expiresAfter() Optional.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iconReference() The icon image name of the asset saved in your application.
String	imageIconUrl() The URL that points to an image used as the large icon to the notification content view.
String	imageUrl() The URL that points to an image used in the push notification.
String	md5() Optional.
String	rawContent() The Raw JSON formatted string to be used as the payload.
List<SdkField<?>>	sdkFields()
static Class<? extends ADMMessage.Builder>	serializableBuilderClass()
Boolean	silentPush() Indicates if the message should display on the users device.
String	smallImageIconUrl() The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
String	sound() Indicates a sound to play when the device receives the notification.
Map<String,List<String>>	substitutions() Default message substitutions.
String	title() The message title that displays above the message on the user's device.
ADMMessage.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.

Returns:

The message body of the notification.

consolidationKey

public String consolidationKey()

Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.

Returns:

Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.

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

expiresAfter

public String expiresAfter()

Optional. Number of seconds ADM should retain the message if the device is offline

Returns:

Optional. Number of seconds ADM should retain the message if the device is offline

iconReference

public String iconReference()

The icon image name of the asset saved in your application.

Returns:

The icon image name of the asset saved in your application.

imageIconUrl

public String imageIconUrl()

The URL that points to an image used as the large icon to the notification content view.

Returns:

The URL that points to an image used as the large icon to the notification content view.

imageUrl

public String imageUrl()

The URL that points to an image used in the push notification.

Returns:

The URL that points to an image used in the push notification.

md5

public String md5()

Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity

Returns:

Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity

rawContent

public String rawContent()

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

The Raw JSON formatted string to be used as the payload. This value overrides the message.

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.

smallImageIconUrl

public String smallImageIconUrl()

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

Returns:

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

sound

public String sound()

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

Returns:

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

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 ADMMessage.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<ADMMessage.Builder,ADMMessage>

Returns:

a builder for type T

builder

public static ADMMessage.Builder builder()

serializableBuilderClass

public static Class<? extends ADMMessage.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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.