software.amazon.awssdk.services.pinpoint.model

Interface ADMMessage.Builder

All Superinterfaces:

CopyableBuilder<ADMMessage.Builder,ADMMessage>, SdkBuilder<ADMMessage.Builder,ADMMessage>

Enclosing class:

ADMMessage

public static interface ADMMessage.Builder
extends CopyableBuilder<ADMMessage.Builder,ADMMessage>

Method Summary

Modifier and Type	Method and Description
ADMMessage.Builder	action(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.
ADMMessage.Builder	action(String 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.
ADMMessage.Builder	body(String body) The message body of the notification, the email body or the text message.
ADMMessage.Builder	consolidationKey(String consolidationKey) Optional.
ADMMessage.Builder	data(Map<String,String> data) The data payload used for a silent push.
ADMMessage.Builder	expiresAfter(String expiresAfter) Optional.
ADMMessage.Builder	iconReference(String iconReference) The icon image name of the asset saved in your application.
ADMMessage.Builder	imageIconUrl(String imageIconUrl) The URL that points to an image used as the large icon to the notification content view.
ADMMessage.Builder	imageUrl(String imageUrl) The URL that points to an image used in the push notification.
ADMMessage.Builder	md5(String md5) Optional.
ADMMessage.Builder	rawContent(String rawContent) The Raw JSON formatted string to be used as the payload.
ADMMessage.Builder	silentPush(Boolean silentPush) Indicates if the message should display on the users device.
ADMMessage.Builder	smallImageIconUrl(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
ADMMessage.Builder	sound(String sound) Indicates a sound to play when the device receives the notification.
ADMMessage.Builder	substitutions(Map<String,? extends Collection<String>> substitutions) Default message substitutions.
ADMMessage.Builder	title(String title) The message title that displays above the message on the user's device.
ADMMessage.Builder	url(String url) The URL to open in the user's mobile browser.

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

copy

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

applyMutation, build

Method Detail

action

ADMMessage.Builder action(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Action, Action

action

ADMMessage.Builder action(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Action, Action

body

ADMMessage.Builder body(String body)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

consolidationKey

ADMMessage.Builder consolidationKey(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

data

ADMMessage.Builder data(Map<String,String> data)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

expiresAfter

ADMMessage.Builder expiresAfter(String expiresAfter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

iconReference

ADMMessage.Builder iconReference(String iconReference)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

imageIconUrl

ADMMessage.Builder imageIconUrl(String imageIconUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

imageUrl

ADMMessage.Builder imageUrl(String imageUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

md5

ADMMessage.Builder md5(String md5)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

rawContent

ADMMessage.Builder rawContent(String rawContent)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

silentPush

ADMMessage.Builder silentPush(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

smallImageIconUrl

ADMMessage.Builder smallImageIconUrl(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sound

ADMMessage.Builder sound(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/

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

substitutions

ADMMessage.Builder substitutions(Map<String,? extends Collection<String>> substitutions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

title

ADMMessage.Builder title(String title)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

url

ADMMessage.Builder url(String url)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.