Class ImageResponseCard
- java.lang.Object
-
- software.amazon.awssdk.services.lexruntimev2.model.ImageResponseCard
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ImageResponseCard.Builder,ImageResponseCard>
@Generated("software.amazon.awssdk:codegen") public final class ImageResponseCard extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImageResponseCard.Builder,ImageResponseCard>
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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceImageResponseCard.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImageResponseCard.Builderbuilder()List<Button>buttons()A list of buttons that should be displayed on the response card.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasButtons()For responses, this returns true if the service returned a value for the Buttons property.inthashCode()StringimageUrl()The URL of an image to display on the response card.List<SdkField<?>>sdkFields()static Class<? extends ImageResponseCard.Builder>serializableBuilderClass()Stringsubtitle()The subtitle to display on the response card.Stringtitle()The title to display on the response card.ImageResponseCard.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
title
public final String title()
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
- Returns:
- The title to display on the response card. The format of the title is determined by the platform displaying the response card.
-
subtitle
public final String subtitle()
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
- Returns:
- The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
-
imageUrl
public final String 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.
- Returns:
- 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.
-
hasButtons
public final boolean hasButtons()
For responses, this returns true if the service returned a value for the Buttons property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
buttons
public final List<Button> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasButtons()method.- Returns:
- 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.
-
toBuilder
public ImageResponseCard.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ImageResponseCard.Builder,ImageResponseCard>
-
builder
public static ImageResponseCard.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImageResponseCard.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-