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

    Type Alias HeadlessAppExtensionApis

    type HeadlessAppExtensionApis = {
        files: IAppFilesApi;
        model: {
            authentications: ModelAccessWithComponent<
                IAuthenticationApi,
                Authentication.Authentication,
            >;
            buildingBlocks: ModelAccessWithComponent<IBuildingBlockApi, BuildingBlock>;
            businessEventServices: ModelAccessWithComponent<
                IBusinessEventServiceApi,
                BusinessEventService,
            >;
            connectors: ModelAccessWithComponent<IConnectorApi, Connector>;
            connectorTypes: ModelAccessWithComponent<IConnectorTypeApi, ConnectorType>;
            constants: ModelAccessWithComponent<IConstantApi, Constant>;
            consumedODataServices: ModelAccessWithComponent<
                IConsumedODataServiceApi,
                ConsumedODataService,
            >;
            consumedRestServices: ModelAccessWithComponent<
                IConsumedRestServiceApi,
                ConsumedRestService,
            >;
            customBlobDocuments: ICustomBlobDocumentApi;
            customIconCollections: ModelAccessWithComponent<
                ICustomIconCollectionApi,
                CustomIconCollection,
            >;
            databaseConnections: ModelAccessWithComponent<
                IDatabaseConnectionApi,
                DatabaseConnection,
            >;
            dataSets: ModelAccessWithComponent<IDataSetApi, DataSet>;
            dataTransformers: ModelAccessWithComponent<
                IDataTransformerApi,
                DataTransformer,
            >;
            documentTemplates: ModelAccessWithComponent<
                IDocumentTemplateApi,
                DocumentTemplate,
            >;
            domainModels: ModelAccessWithComponent<IDomainModelApi, DomainModel>;
            entityChangeDataCaptureServices: ModelAccessWithComponent<
                IEntityChangeDataCaptureServiceApi,
                EntityChangeDataCaptureService,
            >;
            enumerations: ModelAccessWithComponent<IEnumerationApi, Enumeration>;
            excelDataImporterTemplates: ModelAccessWithComponent<
                IExcelDataImporterTemplateApi,
                ExcelDataImporter.Template,
            >;
            exportMappings: ModelAccessWithComponent<
                IExportMappingModelApi,
                ExportMapping,
            >;
            imageCollections: ModelAccessWithComponent<
                IImageCollectionApi,
                ImageCollection,
            >;
            importedWebServices: ModelAccessWithComponent<
                IImportedWebServiceApi,
                ImportedWebService,
            >;
            importMappings: ModelAccessWithComponent<
                IImportMappingModelApi,
                ImportMapping,
            >;
            javaActions: ModelAccessWithComponent<IJavaActionApi, JavaAction>;
            javaScriptActions: ModelAccessWithComponent<
                IJavaScriptActionApi,
                JavaScriptAction,
            >;
            jsonStructures: ModelAccessWithComponent<
                IJsonStructureModelApi,
                JsonStructure,
            >;
            layouts: ModelAccessWithComponent<ILayoutApi, Layout>;
            menuDocuments: ModelAccessWithComponent<IMenuDocumentApi, MenuDocument>;
            messageDefinitions: ModelAccessWithComponent<
                IMessageDefinitionModelApi,
                MessageDefinitionCollection,
            >;
            messageDefinitions2: ModelAccessWithComponent<
                IMessageDefinition2Api,
                MessageDefinition2,
            >;
            microflows: ModelAccessWithComponent<IMicroflowModelApi, Microflow>;
            mlMappingDocuments: ModelAccessWithComponent<
                IMLMappingDocumentApi,
                MLMappingDocument,
            >;
            modules: IModuleApi;
            moduleSecurity: ModelAccessWithComponent<
                IModuleSecurityApi,
                ModuleSecurity,
            >;
            moduleSettings: ModelAccessWithComponent<
                IModuleSettingsApi,
                ModuleSettings,
            >;
            nanoflows: ModelAccessWithComponent<INanoflowApi, Nanoflow>;
            pages: ModelAccessWithComponent<IPageApi, Page>;
            pageTemplates: ModelAccessWithComponent<IPageTemplateApi, PageTemplate>;
            projects: IProjectApi;
            publishedODataServices2: ModelAccessWithComponent<
                IPublishedODataService2Api,
                PublishedODataService2,
            >;
            publishedRestServices: ModelAccessWithComponent<
                IPublishedRestServiceApi,
                PublishedRestService,
            >;
            publishedWebServices: ModelAccessWithComponent<
                IPublishedWebServiceApi,
                PublishedWebService,
            >;
            queues: ModelAccessWithComponent<IQueueApi, Queue>;
            regularExpressions: ModelAccessWithComponent<
                IRegularExpressionApi,
                RegularExpression,
            >;
            rules: ModelAccessWithComponent<IRuleApi, Rule>;
            scheduledEvents: ModelAccessWithComponent<
                IScheduledEventApi,
                ScheduledEvent,
            >;
            snippets: ModelAccessWithComponent<ISnippetApi, Snippet>;
            viewEntitySourceDocuments: ModelAccessWithComponent<
                IViewEntitySourceDocumentApi,
                ViewEntitySourceDocument,
            >;
            workflows: ModelAccessWithComponent<IWorkflowApi, Workflow>;
            xmlSchemas: ModelAccessWithComponent<IXmlSchemaModelApi, XmlSchema>;
        };
    }
    Index

    Properties

    Properties

    API for working with files in the app directory

    model: {
        authentications: ModelAccessWithComponent<
            IAuthenticationApi,
            Authentication.Authentication,
        >;
        buildingBlocks: ModelAccessWithComponent<IBuildingBlockApi, BuildingBlock>;
        businessEventServices: ModelAccessWithComponent<
            IBusinessEventServiceApi,
            BusinessEventService,
        >;
        connectors: ModelAccessWithComponent<IConnectorApi, Connector>;
        connectorTypes: ModelAccessWithComponent<IConnectorTypeApi, ConnectorType>;
        constants: ModelAccessWithComponent<IConstantApi, Constant>;
        consumedODataServices: ModelAccessWithComponent<
            IConsumedODataServiceApi,
            ConsumedODataService,
        >;
        consumedRestServices: ModelAccessWithComponent<
            IConsumedRestServiceApi,
            ConsumedRestService,
        >;
        customBlobDocuments: ICustomBlobDocumentApi;
        customIconCollections: ModelAccessWithComponent<
            ICustomIconCollectionApi,
            CustomIconCollection,
        >;
        databaseConnections: ModelAccessWithComponent<
            IDatabaseConnectionApi,
            DatabaseConnection,
        >;
        dataSets: ModelAccessWithComponent<IDataSetApi, DataSet>;
        dataTransformers: ModelAccessWithComponent<
            IDataTransformerApi,
            DataTransformer,
        >;
        documentTemplates: ModelAccessWithComponent<
            IDocumentTemplateApi,
            DocumentTemplate,
        >;
        domainModels: ModelAccessWithComponent<IDomainModelApi, DomainModel>;
        entityChangeDataCaptureServices: ModelAccessWithComponent<
            IEntityChangeDataCaptureServiceApi,
            EntityChangeDataCaptureService,
        >;
        enumerations: ModelAccessWithComponent<IEnumerationApi, Enumeration>;
        excelDataImporterTemplates: ModelAccessWithComponent<
            IExcelDataImporterTemplateApi,
            ExcelDataImporter.Template,
        >;
        exportMappings: ModelAccessWithComponent<
            IExportMappingModelApi,
            ExportMapping,
        >;
        imageCollections: ModelAccessWithComponent<
            IImageCollectionApi,
            ImageCollection,
        >;
        importedWebServices: ModelAccessWithComponent<
            IImportedWebServiceApi,
            ImportedWebService,
        >;
        importMappings: ModelAccessWithComponent<
            IImportMappingModelApi,
            ImportMapping,
        >;
        javaActions: ModelAccessWithComponent<IJavaActionApi, JavaAction>;
        javaScriptActions: ModelAccessWithComponent<
            IJavaScriptActionApi,
            JavaScriptAction,
        >;
        jsonStructures: ModelAccessWithComponent<
            IJsonStructureModelApi,
            JsonStructure,
        >;
        layouts: ModelAccessWithComponent<ILayoutApi, Layout>;
        menuDocuments: ModelAccessWithComponent<IMenuDocumentApi, MenuDocument>;
        messageDefinitions: ModelAccessWithComponent<
            IMessageDefinitionModelApi,
            MessageDefinitionCollection,
        >;
        messageDefinitions2: ModelAccessWithComponent<
            IMessageDefinition2Api,
            MessageDefinition2,
        >;
        microflows: ModelAccessWithComponent<IMicroflowModelApi, Microflow>;
        mlMappingDocuments: ModelAccessWithComponent<
            IMLMappingDocumentApi,
            MLMappingDocument,
        >;
        modules: IModuleApi;
        moduleSecurity: ModelAccessWithComponent<
            IModuleSecurityApi,
            ModuleSecurity,
        >;
        moduleSettings: ModelAccessWithComponent<
            IModuleSettingsApi,
            ModuleSettings,
        >;
        nanoflows: ModelAccessWithComponent<INanoflowApi, Nanoflow>;
        pages: ModelAccessWithComponent<IPageApi, Page>;
        pageTemplates: ModelAccessWithComponent<IPageTemplateApi, PageTemplate>;
        projects: IProjectApi;
        publishedODataServices2: ModelAccessWithComponent<
            IPublishedODataService2Api,
            PublishedODataService2,
        >;
        publishedRestServices: ModelAccessWithComponent<
            IPublishedRestServiceApi,
            PublishedRestService,
        >;
        publishedWebServices: ModelAccessWithComponent<
            IPublishedWebServiceApi,
            PublishedWebService,
        >;
        queues: ModelAccessWithComponent<IQueueApi, Queue>;
        regularExpressions: ModelAccessWithComponent<
            IRegularExpressionApi,
            RegularExpression,
        >;
        rules: ModelAccessWithComponent<IRuleApi, Rule>;
        scheduledEvents: ModelAccessWithComponent<
            IScheduledEventApi,
            ScheduledEvent,
        >;
        snippets: ModelAccessWithComponent<ISnippetApi, Snippet>;
        viewEntitySourceDocuments: ModelAccessWithComponent<
            IViewEntitySourceDocumentApi,
            ViewEntitySourceDocument,
        >;
        workflows: ModelAccessWithComponent<IWorkflowApi, Workflow>;
        xmlSchemas: ModelAccessWithComponent<IXmlSchemaModelApi, XmlSchema>;
    }

    APIs for working with the app model

    Type declaration