public static interface DefaultPushNotificationMessage.Builder extends CopyableBuilder<DefaultPushNotificationMessage.Builder,DefaultPushNotificationMessage>
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.
|
copy
apply, build
DefaultPushNotificationMessage.Builder action(String 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 |
URLAction
,
Action
DefaultPushNotificationMessage.Builder action(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 |
URLAction
,
Action
DefaultPushNotificationMessage.Builder body(String body)
body
- The message body of the notification, the email body or the text message.DefaultPushNotificationMessage.Builder data(Map<String,String> data)
data
- The data payload used for a silent push. This payload is added to the notifications'
data.pinpoint.jsonBody' objectDefaultPushNotificationMessage.Builder silentPush(Boolean silentPush)
silentPush
- Indicates if the message should display on the users device. Silent pushes can be used for Remote
Configuration and Phone Home use cases.DefaultPushNotificationMessage.Builder substitutions(Map<String,? extends Collection<String>> substitutions)
substitutions
- Default message substitutions. Can be overridden by individual address substitutions.DefaultPushNotificationMessage.Builder title(String title)
title
- The message title that displays above the message on the user's device.DefaultPushNotificationMessage.Builder url(String url)
url
- The URL to open in the user's mobile browser. Used if the value for Action is URL.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.