software.amazon.awscdk.services.pinpoint

Class CfnCampaign.MessageProperty.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnCampaign.MessageProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCampaign.MessageProperty>

Enclosing interface:

CfnCampaign.MessageProperty

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

A builder for CfnCampaign.MessageProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCampaign.MessageProperty.Builder	action(String action) Sets the value of CfnCampaign.MessageProperty.getAction()
CfnCampaign.MessageProperty.Builder	body(String body) Sets the value of CfnCampaign.MessageProperty.getBody()
CfnCampaign.MessageProperty	build() Builds the configured instance.
CfnCampaign.MessageProperty.Builder	imageIconUrl(String imageIconUrl) Sets the value of CfnCampaign.MessageProperty.getImageIconUrl()
CfnCampaign.MessageProperty.Builder	imageSmallIconUrl(String imageSmallIconUrl) Sets the value of CfnCampaign.MessageProperty.getImageSmallIconUrl()
CfnCampaign.MessageProperty.Builder	imageUrl(String imageUrl) Sets the value of CfnCampaign.MessageProperty.getImageUrl()
CfnCampaign.MessageProperty.Builder	jsonBody(String jsonBody) Sets the value of CfnCampaign.MessageProperty.getJsonBody()
CfnCampaign.MessageProperty.Builder	mediaUrl(String mediaUrl) Sets the value of CfnCampaign.MessageProperty.getMediaUrl()
CfnCampaign.MessageProperty.Builder	rawContent(String rawContent) Sets the value of CfnCampaign.MessageProperty.getRawContent()
CfnCampaign.MessageProperty.Builder	silentPush(Boolean silentPush) Sets the value of CfnCampaign.MessageProperty.getSilentPush()
CfnCampaign.MessageProperty.Builder	silentPush(IResolvable silentPush) Sets the value of CfnCampaign.MessageProperty.getSilentPush()
CfnCampaign.MessageProperty.Builder	timeToLive(Number timeToLive) Sets the value of CfnCampaign.MessageProperty.getTimeToLive()
CfnCampaign.MessageProperty.Builder	title(String title) Sets the value of CfnCampaign.MessageProperty.getTitle()
CfnCampaign.MessageProperty.Builder	url(String url) Sets the value of CfnCampaign.MessageProperty.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 CfnCampaign.MessageProperty.Builder action(String action)

Sets the value of CfnCampaign.MessageProperty.getAction()

Parameters:

action - The 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 iOS and Android.
• 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 CfnCampaign.MessageProperty.Builder body(String body)

Sets the value of CfnCampaign.MessageProperty.getBody()

Parameters:

body - The body of the notification message. The maximum number of characters is 200.

Returns:

this

imageIconUrl

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder imageIconUrl(String imageIconUrl)

Sets the value of CfnCampaign.MessageProperty.getImageIconUrl()

Parameters:

imageIconUrl - The URL of the image to display as the push notification icon, such as the icon for the app.

Returns:

this

imageSmallIconUrl

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder imageSmallIconUrl(String imageSmallIconUrl)

Sets the value of CfnCampaign.MessageProperty.getImageSmallIconUrl()

Parameters:

imageSmallIconUrl - The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.

Returns:

this

imageUrl

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder imageUrl(String imageUrl)

Sets the value of CfnCampaign.MessageProperty.getImageUrl()

Parameters:

imageUrl - The URL of an image to display in the push notification.

Returns:

this

jsonBody

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder jsonBody(String jsonBody)

Sets the value of CfnCampaign.MessageProperty.getJsonBody()

Parameters:

jsonBody - The JSON payload to use for a silent push notification.

Returns:

this

mediaUrl

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder mediaUrl(String mediaUrl)

Sets the value of CfnCampaign.MessageProperty.getMediaUrl()

Parameters:

mediaUrl - The URL of the image or video to display in the push notification.

Returns:

this

rawContent

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder rawContent(String rawContent)

Sets the value of CfnCampaign.MessageProperty.getRawContent()

Parameters:

rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

Returns:

this

silentPush

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder silentPush(Boolean silentPush)

Sets the value of CfnCampaign.MessageProperty.getSilentPush()

Parameters:

silentPush - Specifies whether the 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, displaying messages in an in-app message center, or supporting phone home functionality.

Returns:

this

silentPush

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder silentPush(IResolvable silentPush)

Sets the value of CfnCampaign.MessageProperty.getSilentPush()

Parameters:

silentPush - Specifies whether the 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, displaying messages in an in-app message center, or supporting phone home functionality.

Returns:

this

timeToLive

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder timeToLive(Number timeToLive)

Sets the value of CfnCampaign.MessageProperty.getTimeToLive()

Parameters:

timeToLive - The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push notification service. If this value is 0 , the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Returns:

this

title

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder title(String title)

Sets the value of CfnCampaign.MessageProperty.getTitle()

Parameters:

title - The title to display above the notification message on a recipient's device.

Returns:

this

url

@Stability(value=Stable)
public CfnCampaign.MessageProperty.Builder url(String url)

Sets the value of CfnCampaign.MessageProperty.getUrl()

Parameters:

url - The 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:

this

build

@Stability(value=Stable)
public CfnCampaign.MessageProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCampaign.MessageProperty>

Returns:

a new instance of CfnCampaign.MessageProperty

Throws:

NullPointerException - if any required attribute was not provided