Package software.amazon.awscdk.services.lex

Interface CfnBot.ImageResponseCardProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.ImageResponseCardProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.ImageResponseCardProperty
extends software.amazon.jsii.JsiiSerializable

A card that is shown to the user by a messaging platform.

You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

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.lex.*;
 ImageResponseCardProperty imageResponseCardProperty = ImageResponseCardProperty.builder()
         .title("title")
         // the properties below are optional
         .buttons(List.of(ButtonProperty.builder()
                 .text("text")
                 .value("value")
                 .build()))
         .imageUrl("imageUrl")
         .subtitle("subtitle")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.ImageResponseCardProperty.Builder	builder()
default Object	getButtons()	A list of buttons that should be displayed on the response card.
default String	getImageUrl()	The URL of an image to display on the response card.
default String	getSubtitle()	The subtitle to display on the response card.
String	getTitle()	The title to display on the response card.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTitle

@Stability(Stable)
@NotNull
String getTitle()

The title to display on the response card.

The format of the title is determined by the platform displaying the response card.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-title

getButtons

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

A list of buttons that should be displayed on the response card.

The arrangement of the buttons is determined by the platform that displays the button.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-buttons

getImageUrl

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

The URL of an image to display on the response card.

The image URL must be publicly available so that the platform displaying the response card has access to the image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-imageurl

getSubtitle

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

The subtitle to display on the response card.

The format of the subtitle is determined by the platform displaying the response card.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-subtitle

builder

@Stability(Stable)
static CfnBot.ImageResponseCardProperty.Builder builder()

Returns:

a CfnBot.ImageResponseCardProperty.Builder of CfnBot.ImageResponseCardProperty