Class: AWSCDK::Pinpoint::CfnCampaign::CampaignInAppMessageProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pinpoint::CfnCampaign::CampaignInAppMessageProperty

Defined in:

pinpoint/cfn_campaign.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #content ⇒ AWSCDK::IResolvable, ... readonly

  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.

• #custom_config ⇒ Object^? readonly

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

• #layout ⇒ String^? readonly

  A string that describes how the in-app message will appear.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(content: nil, custom_config: nil, layout: nil) ⇒ CampaignInAppMessageProperty constructor

  A new instance of CampaignInAppMessageProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(content: nil, custom_config: nil, layout: nil) ⇒ CampaignInAppMessageProperty

Returns a new instance of CampaignInAppMessageProperty.

Parameters:

• content (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::InAppMessageContentProperty>, nil) (defaults to: nil) —

  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.

• custom_config (Object, nil) (defaults to: nil) —

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

• layout (String, nil) (defaults to: nil) —

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

# File 'pinpoint/cfn_campaign.rb', line 993

def initialize(content: nil, custom_config: nil, layout: nil)
  @content = content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlucG9pbnQuQ2ZuQ2FtcGFpZ24uSW5BcHBNZXNzYWdlQ29udGVudFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "content") unless @content.nil?
  @custom_config = custom_config
  Jsii::Type.check_type(@custom_config, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "customConfig") unless @custom_config.nil?
  @layout = layout
  Jsii::Type.check_type(@layout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "layout") unless @layout.nil?
end

Instance Attribute Details

#content ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::InAppMessageContentProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-content

# File 'pinpoint/cfn_campaign.rb', line 1006

def content
  @content
end

#custom_config ⇒ Object^? (readonly)

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

Returns:

• (Object, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-customconfig

# File 'pinpoint/cfn_campaign.rb', line 1011

def custom_config
  @custom_config
end

#layout ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-layout

# File 'pinpoint/cfn_campaign.rb', line 1023

def layout
  @layout
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 1025

def self.jsii_properties
  {
    :content => "content",
    :custom_config => "customConfig",
    :layout => "layout",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 1033

def to_jsii
  result = {}
  result.merge!({
    "content" => @content,
    "customConfig" => @custom_config,
    "layout" => @layout,
  })
  result.compact
end