Class: Aws::LexRuntimeV2::Types::ImageResponseCard

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb

Overview

Note:

When making an API call, you may pass ImageResponseCard data as a hash:

{
  title: "AttachmentTitle", # required
  subtitle: "AttachmentTitle",
  image_url: "AttachmentUrl",
  buttons: [
    {
      text: "ButtonText", # required
      value: "ButtonValue", # required
    },
  ],
}

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 Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#buttons ⇒ Array<Types::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.

Returns:



780
781
782
783
784
785
786
787
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 780

class ImageResponseCard < Struct.new(
  :title,
  :subtitle,
  :image_url,
  :buttons)
  SENSITIVE = []
  include Aws::Structure
end

#image_url ⇒ String

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.

Returns:

  • (String) 


780
781
782
783
784
785
786
787
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 780

class ImageResponseCard < Struct.new(
  :title,
  :subtitle,
  :image_url,
  :buttons)
  SENSITIVE = []
  include Aws::Structure
end

#subtitle ⇒ String

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

Returns:

  • (String) 


780
781
782
783
784
785
786
787
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 780

class ImageResponseCard < Struct.new(
  :title,
  :subtitle,
  :image_url,
  :buttons)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

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

Returns:

  • (String) 


780
781
782
783
784
785
786
787
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 780

class ImageResponseCard < Struct.new(
  :title,
  :subtitle,
  :image_url,
  :buttons)
  SENSITIVE = []
  include Aws::Structure
end