CardAction Class

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

public class CardAction

A clickable action.

Constructor Summary

Constructor Description
CardAction()

Default empty CardAction.
CardAction(ActionTypes withType, String withTitle)

Creation of CardAction with type and title.
CardAction(ActionTypes withType, String withTitle, String withValue)

Creation of CardAction with type and title.
CardAction(String withInput)

Creation of CardAction with string values.

Method Summary

Modifier and Type Method and Description
static CardAction clone(CardAction cardAction)

Perform a deep copy of a CardAction.
java.lang.Object getChannelData()

Gets the channelData value.
java.lang.String getDisplayText()

Get the displayText value.
java.lang.String getImage()

Get the image value.
java.lang.String getImageAltText()

Get the image alternate text value.
java.lang.String getText()

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

Get the title value.
ActionTypes getType()

Get the type value.
java.lang.Object getValue()

Get the value value.
void setChannelData(Object withChannelData)

Sets the channelData value.
void setDisplayText(String withDisplayText)

Set the displayText value.
void setImage(String withImage)

Set the image value.
void setImageAltText(String withImageAltText)

Set the image alternate text value.
void setText(String withText)

Set the text value.
void setTitle(String withTitle)

Set the title value.
void setType(ActionTypes withType)

Set the type value.
void setValue(Object withValue)

Set the value value.

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

Constructor Details

CardAction

public CardAction()

Default empty CardAction.

CardAction

public CardAction(ActionTypes withType, String withTitle)

Creation of CardAction with type and title.

Parameters:

withType - the type value to set.
withTitle - the title value to set.

CardAction

public CardAction(ActionTypes withType, String withTitle, String withValue)

Creation of CardAction with type and title.

Parameters:

withType - the type value to set.
withTitle - the title value to set.
withValue - The value for both Title and Value.

CardAction

public CardAction(String withInput)

Creation of CardAction with string values.

Parameters:

withInput - The value for both Title and Value.

Method Details

clone

public static CardAction clone(CardAction cardAction)

Perform a deep copy of a CardAction.

Parameters:

cardAction - The CardAction to clone.

Returns:

A cloned copy of the CardAction.

getChannelData

public Object getChannelData()

Gets the channelData value.

Returns:

ChannelData as a JsonNode.

getDisplayText

public String getDisplayText()

Get the displayText value.

Returns:

the displayText value

getImage

public String getImage()

Get the image value.

Returns:

the image value

getImageAltText

public String getImageAltText()

Get the image alternate text value.

Returns:

the text 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

getType

public ActionTypes getType()

Get the type value.

Returns:

the type value

getValue

public Object getValue()

Get the value value.

Returns:

the value value

setChannelData

public void setChannelData(Object withChannelData)

Sets the channelData value.

Parameters:

withChannelData - The channelData object to set.

setDisplayText

public void setDisplayText(String withDisplayText)

Set the displayText value.

Parameters:

withDisplayText - the displayText value to set

setImage

public void setImage(String withImage)

Set the image value.

Parameters:

withImage - the image value to set

setImageAltText

public void setImageAltText(String withImageAltText)

Set the image alternate text value.

Parameters:

withImageAltText - the text 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

setType

public void setType(ActionTypes withType)

Set the type value.

Parameters:

withType - the type value to set

setValue

public void setValue(Object withValue)

Set the value value.

Parameters:

withValue - the value value to set

Applies to