Package software.amazon.awscdk.services.pinpoint

Interface CfnInAppTemplate.InAppMessageContentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInAppTemplate.InAppMessageContentProperty.Jsii$Proxy

Enclosing class:

CfnInAppTemplate

@Stability(Stable)
public static interface CfnInAppTemplate.InAppMessageContentProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.

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.*;
 InAppMessageContentProperty inAppMessageContentProperty = InAppMessageContentProperty.builder()
         .backgroundColor("backgroundColor")
         .bodyConfig(BodyConfigProperty.builder()
                 .alignment("alignment")
                 .body("body")
                 .textColor("textColor")
                 .build())
         .headerConfig(HeaderConfigProperty.builder()
                 .alignment("alignment")
                 .header("header")
                 .textColor("textColor")
                 .build())
         .imageUrl("imageUrl")
         .primaryBtn(ButtonConfigProperty.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(ButtonConfigProperty.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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInAppTemplate.InAppMessageContentProperty.Builder	builder()
default String	getBackgroundColor()	The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
default Object	getBodyConfig()	An object that contains configuration information about the header or title text of the in-app message.
default Object	getHeaderConfig()	An object that contains configuration information about the header or title text of the in-app message.
default String	getImageUrl()	The URL of the image that appears on an in-app message banner.
default Object	getPrimaryBtn()	An object that contains configuration information about the primary button in an in-app message.
default Object	getSecondaryBtn()	An object that contains configuration information about the secondary button in an in-app message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackgroundColor

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

The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-backgroundcolor

getBodyConfig

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

An object that contains configuration information about the header or title text of the in-app message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-bodyconfig

getHeaderConfig

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

An object that contains configuration information about the header or title text of the in-app message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-headerconfig

getImageUrl

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

The URL of the image that appears on an in-app message banner.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-imageurl

getPrimaryBtn

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

An object that contains configuration information about the primary button in an in-app message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-primarybtn

getSecondaryBtn

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

An object that contains configuration information about the secondary button in an in-app message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-secondarybtn

builder

@Stability(Stable)
static CfnInAppTemplate.InAppMessageContentProperty.Builder builder()

Returns:

a CfnInAppTemplate.InAppMessageContentProperty.Builder of CfnInAppTemplate.InAppMessageContentProperty