CardMessage

CardMessage

Represents a card message.

Constructor

new CardMessage(cards) → {CardMessage}

Description:
  • Creates a new card message.
Source:
Parameters:
Name Type Description
cards Array.<Card> The cards of the message.
Returns:
A new instance of the CardMessage.
Type
CardMessage

Extends

Methods

addAction(action) → {this}

Description:
  • Add an action to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
action Action The action to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addCard(card) → {CardMessage}

Description:
  • Adds a card to the card message.
Source:
Parameters:
Name Type Description
card Card The card to add.
Returns:
This card message instance.
Type
CardMessage

addGlobalAction(action) → {this}

Description:
  • Add a global action to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
action Action The global action to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addKeyword(keyword) → {this}

Description:
  • Add a keyword to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
keyword Keyword The keyword to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addProperty(name, value) → {this}

Description:
  • Add a property to the message.
Source:
Overrides:
Parameters:
Name Type Description
name string The name of the property.
value any The value of the property.
Returns:
The current instance of the NonRawMessage class.
Type
this

deserializeNestedProperties()

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

getActions() → {Array.<Action>}

Description:
  • Get the actions associated with the non-raw message.
Source:
Overrides:
Returns:
The array of actions.
Type
Array.<Action>

getCards() → {Array.<Card>}

Description:
  • Gets the list of cards in the card message.
Source:
Returns:
The list of cards in the card message.
Type
Array.<Card>

getFooterForm() → {ReadOnlyForm}

Description:
  • Get the footer form associated with the non-raw message.
Source:
Overrides:
Returns:
The form
Type
ReadOnlyForm

getFooterText() → {string}

Description:
  • Get the footer text of the non-raw message.
Source:
Overrides:
Returns:
The footer text.
Type
string

getGlobalActions() → {Array.<Action>}

Description:
  • Get the global actions associated with the non-raw message.
Source:
Overrides:
Returns:
The array of global actions.
Type
Array.<Action>

getHeaderText() → {string}

Description:
  • Get the header text of the non-raw message.
Source:
Overrides:
Returns:
The header text.
Type
string

getKeywords() → {Array.<Keyword>}

Description:
  • Get the keywords associated with the non-raw message.
Source:
Overrides:
Returns:
The array of keywords.
Type
Array.<Keyword>

getLayout() → {CardLayout}

Description:
  • Gets the layout of the card message.
Source:
Returns:
The layout of the card message.
Type
CardLayout

getProperties() → {Map.<string, any>}

Description:
  • Gets the properties of the message.
Source:
Overrides:
Returns:
The properties of the message.
Type
Map.<string, any>

getPropertyValue(propertyName) → {any}

Description:
  • Gets the value of a property.
Source:
Overrides:
Parameters:
Name Type Description
propertyName string The name of the property.
Returns:
The property value.
Type
any

getVoice() → {Voice}

Description:
  • Get the voice associated with the non-raw message.
Source:
Overrides:
Returns:
The voice settings.
Type
Voice

setActions(actions) → {this}

Description:
  • Set the actions for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
actions Array.<Action> The array of actions to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setCards(cards) → {CardMessage}

Description:
  • Sets the cards of the card message.
Source:
Parameters:
Name Type Description
cards Array.<Card> The cards of the card message.
Returns:
This card message instance.
Type
CardMessage

setFooterForm(footerForm) → {this}

Description:
  • Set the footer form for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
footerForm ReadOnlyForm The form to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setFooterText(footerText) → {this}

Description:
  • Set the footer text for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
footerText string The footer text to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setGlobalActions(globalActions) → {this}

Description:
  • Set the global actions for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
globalActions Array.<Action> The array of global actions to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setHeaderText(headerText) → {this}

Description:
  • Set the header text for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
headerText string The header text to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setKeywords(keywords) → {this}

Description:
  • Set the keywords for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
keywords Array.<Keyword> The array of keywords to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setLayout(layout) → {CardMessage}

Description:
  • Sets the layout of the card message.
Source:
Parameters:
Name Type Description
layout CardLayout The layout of the card message.
Returns:
This card message instance.
Type
CardMessage

setProperties(properties) → {this}

Description:
  • Sets the properties of the message.
Source:
Overrides:
Parameters:
Name Type Description
properties Map.<string, any> The properties to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setVoice(voice) → {this}

Description:
  • Set the voice settings for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
voice Voice The voice settings to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

toJson() → {object}

Description:
  • Convert the message to JSON object
Source:
Overrides:
Returns:
The message in JSON format
Type
object