Class CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder
java.lang.Object
software.amazon.awscdk.services.pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPushTemplate.DefaultPushNotificationTemplateProperty>
- Enclosing interface:
CfnPushTemplate.DefaultPushNotificationTemplateProperty
@Stability(Stable)
public static final class CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPushTemplate.DefaultPushNotificationTemplateProperty>
A builder for
CfnPushTemplate.DefaultPushNotificationTemplateProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getAction()
Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getBody()
build()
Builds the configured instance.Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getSound()
Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getTitle()
Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getUrl()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
action
@Stability(Stable) public CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder action(String action) Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getAction()
- Parameters:
action
- The action to occur if a recipient taps a push notification that's based on the message template. 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:
this
-
body
@Stability(Stable) public CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder body(String body) Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getBody()
- Parameters:
body
- The message body to use in push notifications that are based on the message template.- Returns:
this
-
sound
@Stability(Stable) public CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder sound(String sound) Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getSound()
- Parameters:
sound
- The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in/res/raw/
.For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the
Library/Sounds
folder in your app's data container. If the sound file can't be found or you specifydefault
for the value, the system plays the default alert sound.- Returns:
this
-
title
@Stability(Stable) public CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder title(String title) Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getTitle()
- Parameters:
title
- The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.- Returns:
this
-
url
@Stability(Stable) public CfnPushTemplate.DefaultPushNotificationTemplateProperty.Builder url(String url) Sets the value ofCfnPushTemplate.DefaultPushNotificationTemplateProperty.getUrl()
- Parameters:
url
- The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of theAction
property isURL
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnPushTemplate.DefaultPushNotificationTemplateProperty>
- Returns:
- a new instance of
CfnPushTemplate.DefaultPushNotificationTemplateProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-