software.amazon.awscdk.services.pinpoint

Class CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPushTemplate.APNSPushNotificationTemplateProperty>

Enclosing interface:

CfnPushTemplate.APNSPushNotificationTemplateProperty

@Stability(value=Stable)
public static final class CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPushTemplate.APNSPushNotificationTemplateProperty>

A builder for CfnPushTemplate.APNSPushNotificationTemplateProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	action(String action) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getAction()
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	body(String body) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getBody()
CfnPushTemplate.APNSPushNotificationTemplateProperty	build() Builds the configured instance.
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	mediaUrl(String mediaUrl) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getMediaUrl()
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	sound(String sound) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getSound()
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	title(String title) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getTitle()
CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder	url(String url) Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

action

@Stability(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder action(String action)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.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 platform.
• 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(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder body(String body)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getBody()

Parameters:

body - The message body to use in push notifications that are based on the message template.

Returns:

this

mediaUrl

@Stability(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder mediaUrl(String mediaUrl)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getMediaUrl()

Parameters:

mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.

Returns:

this

sound

@Stability(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder sound(String sound)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getSound()

Parameters:

sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is 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 specify default for the value, the system plays the default alert sound.

Returns:

this

title

@Stability(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder title(String title)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.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(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder url(String url)

Sets the value of CfnPushTemplate.APNSPushNotificationTemplateProperty.getUrl()

Parameters:

url - The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `Action` property is `URL` .

Returns:

this

build

@Stability(value=Stable)
public CfnPushTemplate.APNSPushNotificationTemplateProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPushTemplate.APNSPushNotificationTemplateProperty>

Returns:

a new instance of CfnPushTemplate.APNSPushNotificationTemplateProperty

Throws:

NullPointerException - if any required attribute was not provided