Interface DefaultPushNotificationMessage.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DefaultPushNotificationMessage.Builder,
,DefaultPushNotificationMessage> SdkBuilder<DefaultPushNotificationMessage.Builder,
,DefaultPushNotificationMessage> SdkPojo
- Enclosing class:
DefaultPushNotificationMessage
-
Method Summary
Modifier and TypeMethodDescriptionThe default action to occur if a recipient taps the push notification.The default action to occur if a recipient taps the push notification.The default body of the notification message.The JSON data payload to use for the default push notification, if the notification is a silent push notification.silentPush
(Boolean silentPush) Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.substitutions
(Map<String, ? extends Collection<String>> substitutions) The default message variables to use in the notification message.The default title to display above the notification message on a recipient's device.The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
action
The default action to occur if a recipient taps the push notification. 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.
- Parameters:
action
- The default action to occur if a recipient taps the push notification. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
action
The default action to occur if a recipient taps the push notification. 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.
- Parameters:
action
- The default action to occur if a recipient taps the push notification. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
body
The default body of the notification message.
- Parameters:
body
- The default body of the notification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
data
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
- Parameters:
data
- The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
silentPush
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
- Parameters:
silentPush
- Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.- 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) The default message variables to use in the notification message. You can override the default variables with individual address variables.
- Parameters:
substitutions
- The default message variables to use in the notification message. You can override the default variables with individual address variables.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
title
The default title to display above the notification message on a recipient's device.
- Parameters:
title
- The default title to display above the notification message on a recipient's device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
url
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
- Parameters:
url
- The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-