TableFormMessage

TableFormMessage

Represents a table form message.

Constructor

new TableFormMessage(headings, rows, forms)

Description:
  • Creates an instance of TableFormMessage.
Source:
Parameters:
Name Type Description
headings Array.<TableHeading> The table headings.
rows Array.<Row> The table rows.
forms Array.<ReadOnlyForm> The read-only forms.

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

addForm(form) → {this}

Description:
  • Adds a read-only form.
Source:
Parameters:
Name Type Description
form ReadOnlyForm The form to add.
Returns:
The current instance of TableFormMessage.
Type
this

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

addHeading(heading) → {this}

Description:
  • Adds a heading to the table.
Source:
Parameters:
Name Type Description
heading TableHeading The heading to add.
Returns:
The current instance of TableFormMessage.
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

addRow(row) → {this}

Description:
  • Adds a row to the table.
Source:
Parameters:
Name Type Description
row Row The row to add.
Returns:
The current instance of TableFormMessage.
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>

getDisclosedFormIndex() → {number}

Description:
  • Gets the index of the disclosed form.
Source:
Returns:
The index of the disclosed form.
Type
number

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

getFormColumns() → {number}

Description:
  • Gets the number of form columns.
Source:
Returns:
The number of form columns.
Type
number

getForms() → {Array.<ReadOnlyForm>}

Description:
  • Gets the read-only forms.
Source:
Returns:
The read-only forms.
Type
Array.<ReadOnlyForm>

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

getHeadings() → {Array.<TableHeading>}

Description:
  • Gets the table headings.
Source:
Returns:
The table headings.
Type
Array.<TableHeading>

getKeywords() → {Array.<Keyword>}

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

getPaginationInfo() → {PaginationInfo}

Description:
  • Gets the pagination information.
Source:
Returns:
The pagination information.
Type
PaginationInfo

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

getRows() → {Array.<Row>}

Description:
  • Gets the table rows.
Source:
Returns:
The table rows.
Type
Array.<Row>

getShowFormButtonLabel() → {string}

Description:
  • Gets the label for the show form button.
Source:
Returns:
The label for the show form button.
Type
string

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

setDisclosedFormIndex(disclosedFormIndex) → {this}

Description:
  • Sets the index of the disclosed form.
Source:
Parameters:
Name Type Description
disclosedFormIndex number The index of the disclosed form.
Returns:
The current instance of TableFormMessage.
Type
this

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

setFormColumns(formColumns) → {this}

Description:
  • Sets the number of form columns.
Source:
Parameters:
Name Type Description
formColumns number The number of form columns.
Returns:
The current instance of TableFormMessage.
Type
this

setForms(forms) → {this}

Description:
  • Sets the read-only forms.
Source:
Parameters:
Name Type Description
forms Array.<ReadOnlyForm> The read-only forms.
Returns:
The current instance of TableFormMessage.
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

setHeadings(headings) → {this}

Description:
  • Sets the table headings.
Source:
Parameters:
Name Type Description
headings Array.<TableHeading> The table headings.
Returns:
The current instance of TableFormMessage.
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

setPaginationInfo(paginationInfo) → {this}

Description:
  • Sets the pagination information.
Source:
Parameters:
Name Type Description
paginationInfo PaginationInfo The pagination information.
Returns:
The current instance of TableFormMessage.
Type
this

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

setRows(rows) → {this}

Description:
  • Sets the table rows.
Source:
Parameters:
Name Type Description
rows Array.<Row> The table rows.
Returns:
The current instance of TableFormMessage.
Type
this

setShowFormButtonLabel(showFormButtonLabel) → {this}

Description:
  • Sets the label for the show form button.
Source:
Parameters:
Name Type Description
showFormButtonLabel string The label for the show form button.
Returns:
The current instance of TableFormMessage.
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