software.amazon.awssdk.services.pinpoint.model

Interface DefaultPushNotificationMessage.Builder

All Superinterfaces:

CopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>, SdkBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>

Enclosing class:

DefaultPushNotificationMessage

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

Method Summary

Modifier and Type	Method and Description
DefaultPushNotificationMessage.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.
DefaultPushNotificationMessage.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.
DefaultPushNotificationMessage.Builder	body(String body) The message body of the notification, the email body or the text message.
DefaultPushNotificationMessage.Builder	data(Map<String,String> data) The data payload used for a silent push.
DefaultPushNotificationMessage.Builder	silentPush(Boolean silentPush) Indicates if the message should display on the users device.
DefaultPushNotificationMessage.Builder	substitutions(Map<String,? extends Collection<String>> substitutions) Default message substitutions.
DefaultPushNotificationMessage.Builder	title(String title) The message title that displays above the message on the user's device.
DefaultPushNotificationMessage.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

apply, build

Method Detail

action

DefaultPushNotificationMessage.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

DefaultPushNotificationMessage.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

DefaultPushNotificationMessage.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.

data

DefaultPushNotificationMessage.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.

silentPush

DefaultPushNotificationMessage.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.

substitutions

DefaultPushNotificationMessage.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

DefaultPushNotificationMessage.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

DefaultPushNotificationMessage.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.