Interface Text

See: relevant section in reference guide

interface Text {
    $CreationOptions?: TextCreationOptions;
    $ID: string;
    $Type: "Texts$Text";
    translations: Translation[];
    addTranslation(options: TranslationCreationOptions): Promise<Translation>;
}

Hierarchy (View Summary)

ElementBase
- Text

Index

Properties

$CreationOptions? $ID $Type translations

Methods

Properties

`Optional`$CreationOptions

$CreationOptions?: TextCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Texts$Text"

The type of the element.

translations

translations: Translation[]

Methods

addTranslation

addTranslation(options: TranslationCreationOptions): Promise<Translation>
Parameters
- options: TranslationCreationOptions
Returns Promise<Translation>