Edit

Share via

IMediaCard interface

Package:
botbuilder

Interface definition of a generic MediaCard, which in its concrete form can be an Audio, Animation or Video card

Properties

aspect

Hint of the aspect ratio of the video or animation. Allowed values are "16:9" and "4:3".
autoloop

Should the media source reproduction run in a loop
autostart

Should the media start automatically
buttons

Set of actions applicable to the current card
duration

Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.
image

Messaging supports all media formats: audio, video, images and thumbnails as well to optimize content download.
media

Media source for video, audio or animations
shareable

Should media be shareable
subtitle

Subtitle appears just below Title field, differs from Title in font styling only
text

Text field appears just below subtitle, differs from Subtitle in font styling only
title

Title of the Card
value

Supplementary parameter for this card.

Property Details

aspect

Hint of the aspect ratio of the video or animation. Allowed values are "16:9" and "4:3".

aspect: string

Property Value

string

autoloop

Should the media source reproduction run in a loop

autoloop: boolean

Property Value

boolean

autostart

Should the media start automatically

autostart: boolean

Property Value

boolean

buttons

Set of actions applicable to the current card

buttons?: ICardAction[]

Property Value

ICardAction[]

duration

Describes the length of the media content without requiring a receiver to open the content. Formatted as an ISO 8601 Duration field.

duration: string

Property Value

string

image

Messaging supports all media formats: audio, video, images and thumbnails as well to optimize content download.

image: ICardImage

Property Value

ICardImage

media

Media source for video, audio or animations

media: ICardMediaUrl[]

Property Value

ICardMediaUrl[]

shareable

Should media be shareable

shareable: boolean

Property Value

boolean

subtitle

Subtitle appears just below Title field, differs from Title in font styling only

subtitle: string

Property Value

string

text

Text field appears just below subtitle, differs from Subtitle in font styling only

text: string

Property Value

string

title

Title of the Card

title: string

Property Value

string

value

Supplementary parameter for this card.

value: any

Property Value

any