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

    Type Alias AppExtensionApis

    type AppExtensionApis = {
        files: IAppFilesApi;
        model: {
            buildingBlocks: ModelAccessWithComponent<
                IBuildingBlockApi,
                BuildingBlock,
            >;
            customBlobDocuments: ICustomBlobDocumentApi;
            domainModels: ModelAccessWithComponent<IDomainModelApi, DomainModel>;
            enumerations: ModelAccessWithComponent<IEnumerationApi, Enumeration>;
            exportMappings: ModelAccessWithComponent<
                IExportMappingModelApi,
                ExportMappings.ExportMapping,
            >;
            importMappings: ModelAccessWithComponent<
                IImportMappingModelApi,
                ImportMappings.ImportMapping,
            >;
            jsonStructures: ModelAccessWithComponent<
                IJsonStructureModelApi,
                JsonStructures.JsonStructure,
            >;
            messageDefinitions: ModelAccessWithComponent<
                IMessageDefinitionModelApi,
                MessageDefinitions.MessageDefinitionCollection,
            >;
            microflows: ModelAccessWithComponent<IMicroflowModelApi, Microflow>;
            moduleSettings: ModelAccessWithComponent<
                IModuleSettingsApi,
                Projects.ModuleSettings,
            >;
            pages: ModelAccessWithComponent<IPageApi, Page>;
            projects: IProjectApi;
            snippets: ModelAccessWithComponent<ISnippetApi, Snippet>;
            workflows: ModelAccessWithComponent<IWorkflowApi, Workflows.Workflow>;
            xmlSchemas: ModelAccessWithComponent<
                IXmlSchemaModelApi,
                XmlSchemas.XmlSchema,
            >;
        };
    }
    Index

    Properties

    files model

    Properties

    files: IAppFilesApi

    API for working with files in the app directory

    model: {
        buildingBlocks: ModelAccessWithComponent<
            IBuildingBlockApi,
            BuildingBlock,
        >;
        customBlobDocuments: ICustomBlobDocumentApi;
        domainModels: ModelAccessWithComponent<IDomainModelApi, DomainModel>;
        enumerations: ModelAccessWithComponent<IEnumerationApi, Enumeration>;
        exportMappings: ModelAccessWithComponent<
            IExportMappingModelApi,
            ExportMappings.ExportMapping,
        >;
        importMappings: ModelAccessWithComponent<
            IImportMappingModelApi,
            ImportMappings.ImportMapping,
        >;
        jsonStructures: ModelAccessWithComponent<
            IJsonStructureModelApi,
            JsonStructures.JsonStructure,
        >;
        messageDefinitions: ModelAccessWithComponent<
            IMessageDefinitionModelApi,
            MessageDefinitions.MessageDefinitionCollection,
        >;
        microflows: ModelAccessWithComponent<IMicroflowModelApi, Microflow>;
        moduleSettings: ModelAccessWithComponent<
            IModuleSettingsApi,
            Projects.ModuleSettings,
        >;
        pages: ModelAccessWithComponent<IPageApi, Page>;
        projects: IProjectApi;
        snippets: ModelAccessWithComponent<ISnippetApi, Snippet>;
        workflows: ModelAccessWithComponent<IWorkflowApi, Workflows.Workflow>;
        xmlSchemas: ModelAccessWithComponent<
            IXmlSchemaModelApi,
            XmlSchemas.XmlSchema,
        >;
    }

    APIs for working with the app model

    Type declaration

    • buildingBlocks: ModelAccessWithComponent<IBuildingBlockApi, BuildingBlock>

      API for working with building blocks

    • customBlobDocuments: ICustomBlobDocumentApi

      API for working with user-defined document types

    • domainModels: ModelAccessWithComponent<IDomainModelApi, DomainModel>

      API for working with domain models

    • enumerations: ModelAccessWithComponent<IEnumerationApi, Enumeration>

      API for working with enumerations

    • exportMappings: ModelAccessWithComponent<IExportMappingModelApi, ExportMappings.ExportMapping>

      API for working with Export Mappings

    • importMappings: ModelAccessWithComponent<IImportMappingModelApi, ImportMappings.ImportMapping>

      API for working with Import Mappings

    • jsonStructures: ModelAccessWithComponent<IJsonStructureModelApi, JsonStructures.JsonStructure>

      API for working with Json Structures

    • messageDefinitions: ModelAccessWithComponent<
          IMessageDefinitionModelApi,
          MessageDefinitions.MessageDefinitionCollection,
      >

      API for working with Message Definitions

    • microflows: ModelAccessWithComponent<IMicroflowModelApi, Microflow>

      API for working with Microflows

    • moduleSettings: ModelAccessWithComponent<IModuleSettingsApi, Projects.ModuleSettings>

      API for working with Module Settings

    • pages: ModelAccessWithComponent<IPageApi, Page>

      API for working with pages

    • projects: IProjectApi

      API for working with project, modules, and folders

    • snippets: ModelAccessWithComponent<ISnippetApi, Snippet>

      API for working with snippets

    • workflows: ModelAccessWithComponent<IWorkflowApi, Workflows.Workflow>
    • xmlSchemas: ModelAccessWithComponent<IXmlSchemaModelApi, XmlSchemas.XmlSchema>

      API for working with Xml Schemas

    Settings

    On This Page

    Properties