@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ImageResponseCard extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
ImageResponseCard() |
Modifier and Type | Method and Description |
---|---|
ImageResponseCard |
clone() |
boolean |
equals(Object obj) |
List<Button> |
getButtons()
A list of buttons that should be displayed on the response card.
|
String |
getImageUrl()
The URL of an image to display on the response card.
|
String |
getSubtitle()
The subtitle to display on the response card.
|
String |
getTitle()
The title to display on the response card.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setButtons(Collection<Button> buttons)
A list of buttons that should be displayed on the response card.
|
void |
setImageUrl(String imageUrl)
The URL of an image to display on the response card.
|
void |
setSubtitle(String subtitle)
The subtitle to display on the response card.
|
void |
setTitle(String title)
The title to display on the response card.
|
String |
toString()
Returns a string representation of this object.
|
ImageResponseCard |
withButtons(Button... buttons)
A list of buttons that should be displayed on the response card.
|
ImageResponseCard |
withButtons(Collection<Button> buttons)
A list of buttons that should be displayed on the response card.
|
ImageResponseCard |
withImageUrl(String imageUrl)
The URL of an image to display on the response card.
|
ImageResponseCard |
withSubtitle(String subtitle)
The subtitle to display on the response card.
|
ImageResponseCard |
withTitle(String title)
The title to display on the response card.
|
public void setTitle(String title)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
title
- The title to display on the response card. The format of the title is determined by the platform
displaying the response card.public String getTitle()
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
public ImageResponseCard withTitle(String title)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
title
- The title to display on the response card. The format of the title is determined by the platform
displaying the response card.public void setSubtitle(String subtitle)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
subtitle
- The subtitle to display on the response card. The format of the subtitle is determined by the platform
displaying the response card.public String getSubtitle()
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
public ImageResponseCard withSubtitle(String subtitle)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
subtitle
- The subtitle to display on the response card. The format of the subtitle is determined by the platform
displaying the response card.public void setImageUrl(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.
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.public 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.
public ImageResponseCard withImageUrl(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.
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.public List<Button> 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.
public void setButtons(Collection<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.
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.public ImageResponseCard withButtons(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.
NOTE: This method appends the values to the existing list (if any). Use
setButtons(java.util.Collection)
or withButtons(java.util.Collection)
if you want to override
the existing values.
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.public ImageResponseCard withButtons(Collection<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.
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.public String toString()
toString
in class Object
Object.toString()
public ImageResponseCard clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.