software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.MessageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.MessageProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(value=Stable)
public static interface CfnCampaign.MessageProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 MessageProperty messageProperty = MessageProperty.builder()
         .action("action")
         .body("body")
         .imageIconUrl("imageIconUrl")
         .imageSmallIconUrl("imageSmallIconUrl")
         .imageUrl("imageUrl")
         .jsonBody("jsonBody")
         .mediaUrl("mediaUrl")
         .rawContent("rawContent")
         .silentPush(false)
         .timeToLive(123)
         .title("title")
         .url("url")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCampaign.MessageProperty.Builder A builder for CfnCampaign.MessageProperty
static class	CfnCampaign.MessageProperty.Jsii$Proxy An implementation for CfnCampaign.MessageProperty

Method Summary

Modifier and Type	Method and Description
static CfnCampaign.MessageProperty.Builder	builder()
default String	getAction() The action to occur if a recipient taps the push notification.
default String	getBody() The body of the notification message.
default String	getImageIconUrl() The URL of the image to display as the push notification icon, such as the icon for the app.
default String	getImageSmallIconUrl() The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
default String	getImageUrl() The URL of an image to display in the push notification.
default String	getJsonBody() The JSON payload to use for a silent push notification.
default String	getMediaUrl() The URL of the image or video to display in the push notification.
default String	getRawContent() The raw, JSON-formatted string to use as the payload for the notification message.
default Object	getSilentPush() Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
default Number	getTimeToLive() 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.
default String	getTitle() The title to display above the notification message on a recipient's device.
default String	getUrl() 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` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAction

@Stability(value=Stable)
 @Nullable
default String getAction()

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.

getBody

@Stability(value=Stable)
 @Nullable
default String getBody()

The body of the notification message.

The maximum number of characters is 200.

getImageIconUrl

@Stability(value=Stable)
 @Nullable
default String getImageIconUrl()

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

getImageSmallIconUrl

@Stability(value=Stable)
 @Nullable
default String getImageSmallIconUrl()

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

getImageUrl

@Stability(value=Stable)
 @Nullable
default String getImageUrl()

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

getJsonBody

@Stability(value=Stable)
 @Nullable
default String getJsonBody()

The JSON payload to use for a silent push notification.

getMediaUrl

@Stability(value=Stable)
 @Nullable
default String getMediaUrl()

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

getRawContent

@Stability(value=Stable)
 @Nullable
default String getRawContent()

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.

getSilentPush

@Stability(value=Stable)
 @Nullable
default Object getSilentPush()

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.

getTimeToLive

@Stability(value=Stable)
 @Nullable
default Number getTimeToLive()

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.

getTitle

@Stability(value=Stable)
 @Nullable
default String getTitle()

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

getUrl

@Stability(value=Stable)
 @Nullable
default String getUrl()

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` .

builder

@Stability(value=Stable)
static CfnCampaign.MessageProperty.Builder builder()

Returns:

a CfnCampaign.MessageProperty.Builder of CfnCampaign.MessageProperty