Card

Card

Represents a card.

Constructor

new Card(title)

Description:
  • Constructs a Card object with the specified title.
Source:
Parameters:
Name Type Description
title string The title of the card (required).

Extends

Methods

addAction(action) → {Card}

Description:
  • Adds an action to the card.
Source:
Parameters:
Name Type Description
action Action The action to add.
Returns:
This Card instance.
Type
Card

deserializeNestedProperties()

Description:
  • Deserialize nested object properties into corresponding class instances
Source:
Overrides:

getActions() → {Array.<Action>}

Description:
  • Gets the actions of the card.
Source:
Returns:
The actions of the card.
Type
Array.<Action>

getChannelExtensionProperty(channelType, propertyName) → {any}

Description:
  • Get the value of a channel extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
Returns:
The property value
Type
any

getChannelExtensions() → {ChannelExtensions}

Description:
  • Gets the channel extensions
Source:
Overrides:
Returns:
The channel extensions
Type
ChannelExtensions

getDescription() → {string}

Description:
  • Gets the description of the card.
Source:
Returns:
The description of the card.
Type
string

getId() → {string}

Description:
  • Gets the ID of the card.
Source:
Returns:
The ID of the card.
Type
string

getImageUrl() → {string}

Description:
  • Gets the image URL of the card.
Source:
Returns:
The image URL of the card.
Type
string

getTitle() → {string}

Description:
  • Gets the title of the card.
Source:
Returns:
The title of the card.
Type
string

getUrl() → {string}

Description:
  • Gets the URL of the card.
Source:
Returns:
The URL of the card.
Type
string

getVoice() → {Voice}

Description:
  • Gets the voice settings of the card.
Source:
Returns:
the voice settings of the card.
Type
Voice

setChannelExtensionProperty(channelType, propertyName, propertyValue)

Description:
  • Sets a channel-specific extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
propertyValue any The value of the property.
Returns:
The current instance of this class.

setDescription(description) → {Card}

Description:
  • Sets the description of the card.
Source:
Parameters:
Name Type Description
description string The description of the card.
Returns:
This Card instance.
Type
Card

setId(id) → {Card}

Description:
  • Sets the ID of the card.
Source:
Parameters:
Name Type Description
id string The ID of the card.
Returns:
This Card instance.
Type
Card

setImageUrl(imageUrl) → {Card}

Description:
  • Sets the image URL of the card.
Source:
Parameters:
Name Type Description
imageUrl string The image URL of the card.
Returns:
This Card instance.
Type
Card

setTitle(title) → {Card}

Description:
  • Sets the title of the card.
Source:
Parameters:
Name Type Description
title string The title of the card.
Returns:
This Card instance.
Type
Card

setUrl(url) → {Card}

Description:
  • Sets the URL of the card.
Source:
Parameters:
Name Type Description
url string The URL of the card.
Returns:
This Card instance.
Type
Card

setVoice(voice) → {Card}

Description:
  • Sets the voice settings of the card.
Source:
Parameters:
Name Type Description
voice Voice the voice settings of the card.
Returns:
This Card instance.
Type
Card