Interface CfnInAppTemplateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnInAppTemplateProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:20.332Z")
@Stability(Stable)
public interface CfnInAppTemplateProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnInAppTemplate
.
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; Object tags; CfnInAppTemplateProps cfnInAppTemplateProps = CfnInAppTemplateProps.builder() .templateName("templateName") // the properties below are optional .content(List.of(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())) .customConfig(customConfig) .layout("layout") .tags(tags) .templateDescription("templateDescription") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnInAppTemplateProps
static final class
An implementation forCfnInAppTemplateProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.default Object
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.default String
A string that determines the appearance of the in-app message.default Object
getTags()
An array of key-value pairs to apply to this resource.default String
An optional description of the in-app template.The name of the in-app message template.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getTemplateName
The name of the in-app message template.- See Also:
-
getContent
An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.- See Also:
-
getCustomConfig
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.- See Also:
-
getLayout
A string that determines the appearance of the in-app message. 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.
- See Also:
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
getTemplateDescription
An optional description of the in-app template.- See Also:
-
builder
- Returns:
- a
CfnInAppTemplateProps.Builder
ofCfnInAppTemplateProps
-