VideoCard Class

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

public class VideoCard

Video card.

Field Summary

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

Constructor Summary

Constructor Description
VideoCard()

Method Summary

Modifier and Type Method and Description
java.lang.String getAspect()

Aspect ratio of thumbnail/media placeholder, allowed values are "16:9" and "4:3".
boolean getAutoloop()

Should the client loop playback at end of content.
boolean getAutostart()

Should the client automatically start playback of media in this card.
java.util.List<CardAction> getButtons()

Get the buttons value.
java.lang.String getDuration()

Gets the duration value.
ThumbnailUrl getImage()

Get the image value.
java.util.List<MediaUrl> getMedia()

Media URLs for this card.
boolean getShareable()

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

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

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

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

Get the value value.
void setAspect(String withAspect)

Aspect ratio of thumbnail/media placeholder, allowed values are "16:9" and "4:3".
void setAutoloop(boolean withAutoloop)

Should the client loop playback at end of content.
void setAutostart(boolean withAutostart)

Should the client automatically start playback of media in this card.
void setButtons(CardAction[] withButtons)

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

Set the buttons value.
void setDuration(String withDuration)

Sets the duration value.
void setImage(ThumbnailUrl withImage)

Set the image value.
void setMedia(MediaUrl[] withMedia)

Media URLs for this card.
void setMedia(List<MediaUrl> withMedia)

Media URLs for this card.
void setShareable(boolean withShareable)

Set the shareable value.
void setSubtitle(String withSubtitle)

Set the subtitle value.
void setText(String withText)

Set the text value.
void setTitle(String withTitle)

Set the title value.
void setValue(Object withValue)

Set the value 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

VideoCard

public VideoCard()

Method Details

getAspect

public String getAspect()

Aspect ratio of thumbnail/media placeholder, allowed values are "16:9" and "4:3".

Returns:

the aspect value

getAutoloop

public boolean getAutoloop()

Should the client loop playback at end of content.

Returns:

the autoloop value

getAutostart

public boolean getAutostart()

Should the client automatically start playback of media in this card.

Returns:

the autostart value

getButtons

public List getButtons()

Get the buttons value.

Returns:

the buttons value

getDuration

public String getDuration()

Gets the duration value.

Returns:

Duration of the video.

getImage

public ThumbnailUrl getImage()

Get the image value.

Returns:

the image value

getMedia

public List getMedia()

Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.

Returns:

the media value

getShareable

public boolean getShareable()

Get the shareable value.

Returns:

the shareable value

getSubtitle

public String getSubtitle()

Get the subtitle value.

Returns:

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

getValue

public Object getValue()

Get the value value.

Returns:

the value value

setAspect

public void setAspect(String withAspect)

Aspect ratio of thumbnail/media placeholder, allowed values are "16:9" and "4:3".

Parameters:

withAspect - the aspect value to set

setAutoloop

public void setAutoloop(boolean withAutoloop)

Should the client loop playback at end of content.

Parameters:

withAutoloop - the autoloop value to set

setAutostart

public void setAutostart(boolean withAutostart)

Should the client automatically start playback of media in this card.

Parameters:

withAutostart - the autostart value to set

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

setDuration

public void setDuration(String withDuration)

Sets the duration value.

Parameters:

withDuration - the duration value to set

setImage

public void setImage(ThumbnailUrl withImage)

Set the image value.

Parameters:

withImage - the image value to set

setMedia

public void setMedia(MediaUrl[] withMedia)

Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.

Parameters:

withMedia - the media value to set

setMedia

public void setMedia(List withMedia)

Media URLs for this card. When this field contains more than one URL, each URL is an alternative format of the same content.

Parameters:

withMedia - the media value to set

setShareable

public void setShareable(boolean withShareable)

Set the shareable value.

Parameters:

withShareable - the shareable value to set

setSubtitle

public void setSubtitle(String withSubtitle)

Set the subtitle value.

Parameters:

withSubtitle - the subtitle 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

setValue

public void setValue(Object withValue)

Set the value value.

Parameters:

withValue - the value value to set

toAttachment

public Attachment toAttachment()

Creates an @{link Attachment} for this card.

Returns:

An Attachment object containing the card.

Applies to