@mendix/extensions-api - v0.2.4
    Preparing search index...

    Interface Entity

    See: relevant section in reference guide

    interface Entity {
        $CreationOptions?: EntityCreationOptions;
        $ID: string;
        $Type: "DomainModels$Entity";
        accessRules: AccessRule[];
        attributes: Attribute[];
        dataStorageGuid: string;
        documentation: string;
        eventHandlers: EventHandler[];
        generalization: GeneralizationBase;
        image: null | string;
        imageData: any;
        indexes: Index[];
        location: Location;
        name: string;
        source: null | EntitySource;
        validationRules: ValidationRule[];
        addAccessRule(): Promise<AccessRule>;
        addAttribute(options: AttributeCreationOptions): Promise<Attribute>;
        addEventHandler(): Promise<EventHandler>;
        addIndex(): Promise<Index>;
        addValidationRule(): Promise<ValidationRule>;
        delete(): void;
        getAttribute(name: string): undefined | Attribute;
        getContainer(): DomainModel;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type accessRules attributes dataStorageGuid documentation eventHandlers generalization image imageData indexes location name source validationRules

    Methods

    addAccessRule addAttribute addEventHandler addIndex addValidationRule delete getAttribute getContainer

    Properties

    $CreationOptions?: EntityCreationOptions

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "DomainModels$Entity"

    The type of the element.

    accessRules: AccessRule[]
    attributes: Attribute[]
    dataStorageGuid: string
    documentation: string
    eventHandlers: EventHandler[]
    generalization: GeneralizationBase
    image: null | string
    imageData: any
    indexes: Index[]
    location: Location
    name: string
    source: null | EntitySource
    validationRules: ValidationRule[]

    Methods

    • Returns void

    • Parameters

      • name: string

      Returns undefined | Attribute

    Settings

    On This Page

    Properties
    Methods