Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.CampaignInAppMessageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.CampaignInAppMessageProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.CampaignInAppMessageProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.

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.*;
 Object customConfig;
 CampaignInAppMessageProperty campaignInAppMessageProperty = CampaignInAppMessageProperty.builder()
         .content(List.of(InAppMessageContentProperty.builder()
                 .backgroundColor("backgroundColor")
                 .bodyConfig(InAppMessageBodyConfigProperty.builder()
                         .alignment("alignment")
                         .body("body")
                         .textColor("textColor")
                         .build())
                 .headerConfig(InAppMessageHeaderConfigProperty.builder()
                         .alignment("alignment")
                         .header("header")
                         .textColor("textColor")
                         .build())
                 .imageUrl("imageUrl")
                 .primaryBtn(InAppMessageButtonProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .secondaryBtn(InAppMessageButtonProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .build()))
         .customConfig(customConfig)
         .layout("layout")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.CampaignInAppMessageProperty.Builder	builder()
default Object	getContent()	An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.
default Object	getCustomConfig()	Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
default String	getLayout()	A string that describes how the in-app message will appear.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContent

@Stability(Stable)
@Nullable
default Object getContent()

An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.

getCustomConfig

@Stability(Stable)
@Nullable
default Object getCustomConfig()

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

getLayout

@Stability(Stable)
@Nullable
default String getLayout()

A string that describes how the in-app message will appear. You can specify one of the following:.

• BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
• TOP_BANNER – a message that appears as a banner at the top of the page.
• OVERLAYS – a message that covers entire screen.
• MOBILE_FEED – a message that appears in a window in front of the page.
• MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
• CAROUSEL – a scrollable layout of up to five unique messages.

builder

@Stability(Stable)
static CfnCampaign.CampaignInAppMessageProperty.Builder builder()

Returns:

a CfnCampaign.CampaignInAppMessageProperty.Builder of CfnCampaign.CampaignInAppMessageProperty