Class: AWSCDK::Pinpoint::CfnCampaign::DefaultButtonConfigurationProperty

Inherits:

Jsii::Struct

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

Defined in:

pinpoint/cfn_campaign.rb

Overview

Specifies the default behavior for a button that appears in an in-app message.

You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.

See Also:

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

Instance Attribute Summary

• #background_color ⇒ String^? readonly

  The background color of a button, expressed as a hex color code (such as #000000 for black).

• #border_radius ⇒ Numeric^? readonly

  The border radius of a button.

• #button_action ⇒ String^? readonly

  The action that occurs when a recipient chooses a button in an in-app message.

• #link ⇒ String^? readonly

  The destination (such as a URL) for a button.

• #text ⇒ String^? readonly

  The text that appears on a button in an in-app message.

• #text_color ⇒ String^? readonly

  The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(background_color: nil, border_radius: nil, button_action: nil, link: nil, text: nil, text_color: nil) ⇒ DefaultButtonConfigurationProperty constructor

  A new instance of DefaultButtonConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(background_color: nil, border_radius: nil, button_action: nil, link: nil, text: nil, text_color: nil) ⇒ DefaultButtonConfigurationProperty

Returns a new instance of DefaultButtonConfigurationProperty.

Parameters:

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

  The background color of a button, expressed as a hex color code (such as #000000 for black).

• border_radius (Numeric, nil) (defaults to: nil) —

  The border radius of a button.

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

  The action that occurs when a recipient chooses a button in an in-app message.

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

  The destination (such as a URL) for a button.

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

  The text that appears on a button in an in-app message.

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

  The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

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

def initialize(background_color: nil, border_radius: nil, button_action: nil, link: nil, text: nil, text_color: nil)
  @background_color = background_color
  Jsii::Type.check_type(@background_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backgroundColor") unless @background_color.nil?
  @border_radius = border_radius
  Jsii::Type.check_type(@border_radius, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "borderRadius") unless @border_radius.nil?
  @button_action = button_action
  Jsii::Type.check_type(@button_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "buttonAction") unless @button_action.nil?
  @link = link
  Jsii::Type.check_type(@link, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "link") unless @link.nil?
  @text = text
  Jsii::Type.check_type(@text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "text") unless @text.nil?
  @text_color = text_color
  Jsii::Type.check_type(@text_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "textColor") unless @text_color.nil?
end

Instance Attribute Details

#background_color ⇒ String^? (readonly)

The background color of a button, expressed as a hex color code (such as #000000 for black).

Returns:

• (String, nil)

See Also:

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

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

def background_color
  @background_color
end

#border_radius ⇒ Numeric^? (readonly)

The border radius of a button.

Returns:

• (Numeric, nil)

See Also:

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

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

def border_radius
  @border_radius
end

#button_action ⇒ String^? (readonly)

The action that occurs when a recipient chooses a button in an in-app message.

You can specify one of the following:

• LINK – A link to a web destination.
• DEEP_LINK – A link to a specific page in an application.
• CLOSE – Dismisses the message.

Returns:

• (String, nil)

See Also:

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

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

def button_action
  @button_action
end

#link ⇒ String^? (readonly)

The destination (such as a URL) for a button.

Returns:

• (String, nil)

See Also:

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

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

def link
  @link
end

#text ⇒ String^? (readonly)

The text that appears on a button in an in-app message.

Returns:

• (String, nil)

See Also:

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

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

def text
  @text
end

#text_color ⇒ String^? (readonly)

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

Returns:

• (String, nil)

See Also:

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

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

def text_color
  @text_color
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :background_color => "backgroundColor",
    :border_radius => "borderRadius",
    :button_action => "buttonAction",
    :link => "link",
    :text => "text",
    :text_color => "textColor",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "backgroundColor" => @background_color,
    "borderRadius" => @border_radius,
    "buttonAction" => @button_action,
    "link" => @link,
    "text" => @text,
    "textColor" => @text_color,
  })
  result.compact
end