amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexV2Models.Types.ImageResponseCard

Description

 
Synopsis

Documentation

data ImageResponseCard Source #

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.

See: newImageResponseCard smart constructor.

Constructors

ImageResponseCard' 

Fields

  • buttons :: Maybe [Button]

    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.

  • imageUrl :: Maybe Text

    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.

  • subtitle :: Maybe Text

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

  • title :: Text

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

Instances

Instances details
FromJSON ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

ToJSON ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

Generic ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

Associated Types

type Rep ImageResponseCard :: Type -> Type #

Read ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

Show ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

NFData ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

Methods

rnf :: ImageResponseCard -> () #

Eq ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

Hashable ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

type Rep ImageResponseCard Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.ImageResponseCard

type Rep ImageResponseCard = D1 ('MetaData "ImageResponseCard" "Amazonka.LexV2Models.Types.ImageResponseCard" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ImageResponseCard'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "buttons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Button])) :*: S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "subtitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newImageResponseCard Source #

Create a value of ImageResponseCard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:buttons:ImageResponseCard', imageResponseCard_buttons - 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.

$sel:imageUrl:ImageResponseCard', imageResponseCard_imageUrl - 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.

$sel:subtitle:ImageResponseCard', imageResponseCard_subtitle - The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

$sel:title:ImageResponseCard', imageResponseCard_title - The title to display on the response card. The format of the title is determined by the platform displaying the response card.

imageResponseCard_buttons :: Lens' ImageResponseCard (Maybe [Button]) Source #

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.

imageResponseCard_imageUrl :: Lens' ImageResponseCard (Maybe Text) Source #

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.

imageResponseCard_subtitle :: Lens' ImageResponseCard (Maybe Text) Source #

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

imageResponseCard_title :: Lens' ImageResponseCard Text Source #

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