HeroCard Class

Package:
com.microsoft.bot.schema
Maven Artifact:
com.microsoft.bot:bot-schema:4.14.3
  • java.lang.Object
    • com.microsoft.bot.schema.HeroCard

public class HeroCard

A Hero card (card with a single, large image).

Field Summary

Modifier and Type Field and Description
static final java.lang.String CONTENTTYPE

Constructor Summary

Constructor Description
HeroCard()

Method Summary

Modifier and Type Method and Description
java.util.List<CardAction> getButtons()

Get the buttons value.
java.util.List<CardImage> getImages()

Get the images value.
java.lang.String getSubtitle()

Get the subtitle value.
CardAction getTap()

Get the tap value.
java.lang.String getText()

Get the text value.
java.lang.String getTitle()

Get the title value.
void setButtons(CardAction[] withButtons)

Set the buttons value.
void setButtons(List<CardAction> withButtons)

Set the buttons value.
void setImages(CardImage[] withImages)

Set the images value.
void setImages(List<CardImage> withImages)

Set the images value.
void setSubtitle(String withSubtitle)

Set the subtitle value.
void setTap(CardAction withTap)

Set the tap value.
void setText(String withText)

Set the text value.
void setTitle(String withTitle)

Set the title value.
Attachment toAttachment()

Creates an @{link Attachment} for this card.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Field Details

CONTENTTYPE

public static final String CONTENTTYPE

Constructor Details

HeroCard

public HeroCard()

Method Details

getButtons

public List getButtons()

Get the buttons value.

Returns:

the buttons value

getImages

public List getImages()

Get the images value.

Returns:

the images value

getSubtitle

public String getSubtitle()

Get the subtitle value.

Returns:

the subtitle value

getTap

public CardAction getTap()

Get the tap value.

Returns:

the tap value

getText

public String getText()

Get the text value.

Returns:

the text value

getTitle

public String getTitle()

Get the title value.

Returns:

the title value

setButtons

public void setButtons(CardAction[] withButtons)

Set the buttons value.

Parameters:

withButtons - the buttons value to set

setButtons

public void setButtons(List withButtons)

Set the buttons value.

Parameters:

withButtons - the buttons value to set

setImages

public void setImages(CardImage[] withImages)

Set the images value.

Parameters:

withImages - the images value to set

setImages

public void setImages(List withImages)

Set the images value.

Parameters:

withImages - the images value to set

setSubtitle

public void setSubtitle(String withSubtitle)

Set the subtitle value.

Parameters:

withSubtitle - the subtitle value to set

setTap

public void setTap(CardAction withTap)

Set the tap value.

Parameters:

withTap - the tap value to set

setText

public void setText(String withText)

Set the text value.

Parameters:

withText - the text value to set

setTitle

public void setTitle(String withTitle)

Set the title value.

Parameters:

withTitle - the title value to set

toAttachment

public Attachment toAttachment()

Creates an @{link Attachment} for this card.

Returns:

An Attachment object containing the card.

Applies to