Edit

Share via

CardAction interface

Package:
botframework-schema

A clickable action

Properties

channelData

Channel-specific data associated with this action
displayText

(Optional) text to display in the chat feed if the button is clicked
image

Image URL which will appear on the button, next to text label
imageAltText

Alternate image text to be used in place of the image field
text

Text for this action
title

Text description which appears on the button
type

The type of action implemented by this button. Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp'
value

Supplementary parameter for action. Content of this property depends on the ActionType

Property Details

channelData

Channel-specific data associated with this action

channelData?: any

Property Value

any

displayText

(Optional) text to display in the chat feed if the button is clicked

displayText?: string

Property Value

string

image

Image URL which will appear on the button, next to text label

image?: string

Property Value

string

imageAltText

Alternate image text to be used in place of the image field

imageAltText?: string

Property Value

string

text

Text for this action

text?: string

Property Value

string

title

Text description which appears on the button

title: string

Property Value

string

type

The type of action implemented by this button. Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp'

type: ActionTypes | string

Property Value

ActionTypes | string

value

Supplementary parameter for action. Content of this property depends on the ActionType

value: any

Property Value

any