Interface MessageDefinitionCollection

See: relevant section in reference guide

interface MessageDefinitionCollection {
    $CreationOptions?: MessageDefinitionCollectionCreationOptions;
    $ID: string;
    $Type: "MessageDefinitions$MessageDefinitionCollection";
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    messageDefinitions: EntityMessageDefinition[];
    name: string;
    addEntityMessageDefinition(
        options: EntityMessageDefinitionCreationOptions,
    ): Promise<EntityMessageDefinition>;
    getEntityMessageDefinition(
        name: string,
    ): undefined | EntityMessageDefinition;
}

Hierarchy (View Summary)

Document
- MessageDefinitionCollection

Index

Properties

$CreationOptions? $ID $Type documentation excluded exportLevel messageDefinitions name

Methods

addEntityMessageDefinition getEntityMessageDefinition

Properties

`Optional`$CreationOptions

$CreationOptions?: MessageDefinitionCollectionCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "MessageDefinitions$MessageDefinitionCollection"

The type of the element.

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

messageDefinitions

messageDefinitions: EntityMessageDefinition[]

name

name: string

Methods

addEntityMessageDefinition

addEntityMessageDefinition(
options: EntityMessageDefinitionCreationOptions,
): Promise<EntityMessageDefinition>
Parameters
- options: EntityMessageDefinitionCreationOptions
Returns Promise<EntityMessageDefinition>

getEntityMessageDefinition

getEntityMessageDefinition(name: string): undefined | EntityMessageDefinition
Parameters
- name: string
Returns undefined | EntityMessageDefinition