ReadOnlyForm

ReadOnlyForm

Represents a read-only form.

Constructor

new ReadOnlyForm(fieldsopt)

Description:
  • Creates an instance of the ReadOnlyForm class.
Source:
Parameters:
Name Type Attributes Description
fields Array.<ReadOnlyField> <optional>
 The list of fields in the read-only form.

Extends

Methods

addAction(action) → {ReadOnlyForm}

Description:
  • Adds an action to the read-only form.
Source:
Parameters:
Name Type Description
action Action The action to add.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

addField(field) → {ReadOnlyForm}

Description:
  • Adds a field to the read-only form.
Source:
Parameters:
Name Type Description
field ReadOnlyField The field to add.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

addFormRow(formRow) → {ReadOnlyForm}

Description:
  • Adds a form row to the edit form message.
Source:
Parameters:
Name Type Description
formRow FormRow The form row to add.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

deserializeNestedProperties()

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

getActions() → {Array.<Action>}

Description:
  • Gets the list of actions in the read-only form.
Source:
Returns:
The list of actions in the read-only form.
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

getFields() → {Array.<ReadOnlyField>}

Description:
  • Gets the list of fields in the read-only form.
Source:
Returns:
The list of fields in the read-only form.
Type
Array.<ReadOnlyField>

getFormRows() → {Array.<FormRow>}

Description:
  • Gets the list of form rows in the edit form message.
Source:
Returns:
The list of form rows in the edit form message.
Type
Array.<FormRow>

getId() → {string}

Description:
  • Gets the ID of the read-only form.
Source:
Returns:
The ID of the read-only form.
Type
string

getSelectAction()

Description:
  • Gets the select action of the read-only form.
Source:
Returns:
The select action of the read-only form.

getTitle() → {string}

Description:
  • Gets the title of the read-only form.
Source:
Returns:
The title of the read-only form.
Type
string

getVoice() → {Voice}

Description:
  • Gets the voice settings of the read-only form.
Source:
Returns:
the voice settings of the read-only form.
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.

setFields(fields) → {ReadOnlyForm}

Description:
  • Sets the fields of the read-only form.
Source:
Parameters:
Name Type Description
fields Array.<ReadOnlyField> The fields to set.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

setFormRows(formRows) → {ReadOnlyForm}

Description:
  • Sets the form rows of the edit form message.
Source:
Parameters:
Name Type Description
formRows Array.<FormRow> The form rows to set.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

setId(id) → {ReadOnlyForm}

Description:
  • Sets the ID of the read-only form.
Source:
Parameters:
Name Type Description
id string The ID to set.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

setSelectAction(selectAction)

Description:
  • Sets the select action of the read-only form.
Source:
Parameters:
Name Type Description
selectAction The select action to set.
Returns:
The updated instance of the ReadOnlyForm.

setTitle(title) → {ReadOnlyForm}

Description:
  • Sets the title of the read-only form.
Source:
Parameters:
Name Type Description
title string The title to set.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm

setVoice(voice) → {ReadOnlyForm}

Description:
  • Sets the voice settings of the read-only form.
Source:
Parameters:
Name Type Description
voice Voice The voice to set.
Returns:
The updated instance of the ReadOnlyForm.
Type
ReadOnlyForm