Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseModel

Hierarchy

Implemented by

Index

Properties

Methods

Properties

id

id: string

Working copy id of the current opened model (read only)

metaModelVersion

metaModelVersion: Version

The Mendix meta model version related to the project.

mxVersionForModel

mxVersionForModel: Version

The Mendix product version the model was created with/in. Note: this does not have to equal the meta model version.

workingCopy

workingCopy: IWorkingCopy

The meta data of the model.

Methods

addModuleUnitInterfaces

  • addModuleUnitInterfaces(moduleJson: string | IAbstractUnitJson[]): void
  • Adds the given module json to the project, which will make the module and its units read-only and unloadable.

    Gives error if

    • The JSON isn't an array
    • The module package is not compatible with the same metamodel version as the project

    Parameters

    • moduleJson: string | IAbstractUnitJson[]

    Returns void

allBuildingBlocks

  • allBuildingBlocks(): IBuildingBlock[]
  • Returns IBuildingBlock[]

allCodeActions

  • allCodeActions(): ICodeAction[]
  • Returns ICodeAction[]

allConstants

  • allConstants(): IConstant[]
  • Returns IConstant[]

allConsumedAppServices

  • allConsumedAppServices(): IConsumedAppService[]
  • Returns IConsumedAppService[]

allConsumedKafkaServices

  • allConsumedKafkaServices(): IConsumedKafkaService[]
  • Returns IConsumedKafkaService[]

allConsumedODataServices

  • allConsumedODataServices(): IConsumedODataService[]
  • Returns IConsumedODataService[]

allDataSets

  • allDataSets(): IDataSet[]
  • Returns IDataSet[]

allDocumentTemplates

  • allDocumentTemplates(): IDocumentTemplate[]
  • Returns IDocumentTemplate[]

allDocuments

  • allDocuments(): IDocument[]
  • Returns IDocument[]

allDomainModels

  • allDomainModels(): IDomainModel[]
  • Returns IDomainModel[]

allEnumerations

  • allEnumerations(): IEnumeration[]
  • Returns IEnumeration[]

allExportMappings

  • allExportMappings(): IExportMapping[]
  • Returns IExportMapping[]

allFolderBases

  • allFolderBases(): IFolderBase[]
  • Returns IFolderBase[]

allFolders

  • allFolders(): IFolder[]
  • Returns IFolder[]

allFormBases

  • allFormBases(): IFormBase[]
  • Returns IFormBase[]

allImageCollections

  • allImageCollections(): IImageCollection[]
  • Returns IImageCollection[]

allImportMappings

  • allImportMappings(): IImportMapping[]
  • Returns IImportMapping[]

allImportedWebServices

  • allImportedWebServices(): IImportedWebService[]
  • Returns IImportedWebService[]

allJavaActions

  • allJavaActions(): IJavaAction[]
  • Returns IJavaAction[]

allJavaScriptActions

  • allJavaScriptActions(): IJavaScriptAction[]
  • Returns IJavaScriptAction[]

allJsonStructures

  • allJsonStructures(): IJsonStructure[]
  • Returns IJsonStructure[]

allLayouts

  • allLayouts(): ILayout[]
  • Returns ILayout[]

allMappingDocuments

  • allMappingDocuments(): IMappingDocument[]
  • Returns IMappingDocument[]

allMenuDocuments

  • allMenuDocuments(): IMenuDocument[]
  • Returns IMenuDocument[]

allMessageDefinitionCollections

  • allMessageDefinitionCollections(): IMessageDefinitionCollection[]
  • Returns IMessageDefinitionCollection[]

allMicroflowBases

  • allMicroflowBases(): IMicroflowBase[]
  • Returns IMicroflowBase[]

allMicroflows

  • allMicroflows(): IMicroflow[]
  • Returns IMicroflow[]

allModuleDocuments

  • allModuleDocuments(): IModuleDocument[]
  • Returns IModuleDocument[]

allModuleSecurities

  • allModuleSecurities(): IModuleSecurity[]
  • Returns IModuleSecurity[]

allModules

  • allModules(): IModule[]
  • Returns IModule[]

allMxSchemas

  • allMxSchemas(): IMxSchema[]
  • Returns IMxSchema[]

allNanoflows

  • allNanoflows(): INanoflow[]
  • Returns INanoflow[]

allNativeLayouts

  • allNativeLayouts(): INativeLayout[]
  • Returns INativeLayout[]

allNativePages

  • allNativePages(): INativePage[]
  • Returns INativePage[]

allNavigationDocuments

  • allNavigationDocuments(): INavigationDocument[]
  • Returns INavigationDocument[]

allPageTemplates

  • allPageTemplates(): IPageTemplate[]
  • Returns IPageTemplate[]

allPages

  • allPages(): IPage[]
  • Returns IPage[]

allProjectConversions

  • allProjectConversions(): IProjectConversion[]
  • Returns IProjectConversion[]

allProjectDocuments

  • allProjectDocuments(): IProjectDocument[]
  • Returns IProjectDocument[]

allProjectSecurities

  • allProjectSecurities(): IProjectSecurity[]
  • Returns IProjectSecurity[]

allProjectSettings

  • allProjectSettings(): IProjectSettings[]
  • Returns IProjectSettings[]

allProjects

  • allProjects(): IProject[]
  • Returns IProject[]

allPublishedAppServices

  • allPublishedAppServices(): IPublishedAppService[]
  • Returns IPublishedAppService[]

allPublishedKafkaServices

  • allPublishedKafkaServices(): IPublishedKafkaService[]
  • Returns IPublishedKafkaService[]

allPublishedODataServices

  • allPublishedODataServices(): IPublishedODataService[]
  • Returns IPublishedODataService[]

allPublishedRestServices

  • allPublishedRestServices(): IPublishedRestService[]
  • Returns IPublishedRestService[]

allPublishedServiceBases

  • allPublishedServiceBases(): IPublishedServiceBase[]
  • Returns IPublishedServiceBase[]

allPublishedWebServices

  • allPublishedWebServices(): IPublishedWebService[]
  • Returns IPublishedWebService[]

allRegularExpressions

  • allRegularExpressions(): IRegularExpression[]
  • Returns IRegularExpression[]

allRemoteEntitySourceDocuments

  • allRemoteEntitySourceDocuments(): IRemoteEntitySourceDocument[]
  • Returns IRemoteEntitySourceDocument[]

allRules

  • allRules(): IRule[]
  • Returns IRule[]

allScheduledEvents

  • allScheduledEvents(): IScheduledEvent[]
  • Returns IScheduledEvent[]

allServerSideMicroflows

  • allServerSideMicroflows(): IServerSideMicroflow[]
  • Returns IServerSideMicroflow[]

allSnippets

  • allSnippets(): ISnippet[]
  • Returns ISnippet[]

allSystemTextCollections

  • allSystemTextCollections(): ISystemTextCollection[]
  • Returns ISystemTextCollection[]

allTemplateFormBases

  • allTemplateFormBases(): ITemplateFormBase[]
  • Returns ITemplateFormBase[]

allUnits

  • allUnits(): IAbstractUnit[]
  • Returns all units in the project, including modules, folders etc. To retrieve all "real" documents (pages, microflows etc.), use allDocuments().

    Returns IAbstractUnit[]

allWorkflows

  • allWorkflows(): IWorkflow[]
  • Returns IWorkflow[]

allXmlSchemas

  • allXmlSchemas(): IXmlSchema[]
  • Returns IXmlSchema[]

closeConnection

  • Ends the connection with the Model API client. Flushes any pending deltas and invokes the callback once complete. If a callback is provided but no error callback is provided, errors will be handled through the default modelstore error handler.

    Parameters

    Returns void

  • Returns Promise<void>

createElement

  • createElement<T>(typeName: T): ConcreteModelElements[T]
  • Creates and returns a new element in the SDK and on the server. After creation, assign or add this instance to a property that accepts this kind of elements.

    Type parameters

    • T: keyof ConcreteModelElements

    Parameters

    • typeName: T

      structureTypeName of the element type you want to create

    Returns ConcreteModelElements[T]

deleteFile

  • deleteFile(filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • deleteFile(filePath: string): Promise<void>

deleteWorkingCopy

exportModuleMpk

  • exportModuleMpk(moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • exportModuleMpk(moduleId: string, outFilePath: string): Promise<void>

exportMpk

  • exportMpk(outFilePath: string, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • exportMpk(outFilePath: string): Promise<void>

filterUnitsByCustomWidgetId

  • filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string, callback: ICallback<string[]>, errorCallback?: IErrorCallback): void
  • filterUnitsByCustomWidgetId(workingCopyId: string, widgetId: string): Promise<string[]>

findAppServiceActionByQualifiedName

findAppServiceActionParameterByQualifiedName

findAssociationBaseByQualifiedName

findAttributeByQualifiedName

  • findAttributeByQualifiedName(qname: string): IAttribute | null
  • Parameters

    • qname: string

    Returns IAttribute | null

findConstantByQualifiedName

  • findConstantByQualifiedName(qname: string): IConstant | null
  • Parameters

    • qname: string

    Returns IConstant | null

findConsumedKafkaServiceByQualifiedName

findConsumedODataServiceByQualifiedName

findDataSetByQualifiedName

  • findDataSetByQualifiedName(qname: string): IDataSet | null
  • Parameters

    • qname: string

    Returns IDataSet | null

findDataSetParameterByQualifiedName

findDocumentTemplateByQualifiedName

findEntityByQualifiedName

  • findEntityByQualifiedName(qname: string): IEntity | null
  • Parameters

    • qname: string

    Returns IEntity | null

findEnumerationByQualifiedName

  • findEnumerationByQualifiedName(qname: string): IEnumeration | null

findEnumerationValueByQualifiedName

findExportMappingByQualifiedName

  • findExportMappingByQualifiedName(qname: string): IExportMapping | null

findImageByQualifiedName

  • findImageByQualifiedName(qname: string): IImage | null
  • Parameters

    • qname: string

    Returns IImage | null

findImportMappingByQualifiedName

  • findImportMappingByQualifiedName(qname: string): IImportMapping | null

findImportedWebServiceByQualifiedName

findJavaActionByQualifiedName

  • findJavaActionByQualifiedName(qname: string): IJavaAction | null

findJavaActionParameterByQualifiedName

findJavaScriptActionByQualifiedName

findJavaScriptActionParameterByQualifiedName

findJsonStructureByQualifiedName

  • findJsonStructureByQualifiedName(qname: string): IJsonStructure | null

findLayoutByQualifiedName

  • findLayoutByQualifiedName(qname: string): ILayout | null
  • Parameters

    • qname: string

    Returns ILayout | null

findLayoutParameterByQualifiedName

findMenuDocumentByQualifiedName

  • findMenuDocumentByQualifiedName(qname: string): IMenuDocument | null

findMessageDefinitionByQualifiedName

findMicroflowByQualifiedName

  • findMicroflowByQualifiedName(qname: string): IMicroflow | null
  • Parameters

    • qname: string

    Returns IMicroflow | null

findMicroflowParameterByQualifiedName

findModuleRoleByQualifiedName

  • findModuleRoleByQualifiedName(qname: string): IModuleRole | null

findNanoflowByQualifiedName

  • findNanoflowByQualifiedName(qname: string): INanoflow | null
  • Parameters

    • qname: string

    Returns INanoflow | null

findNanoflowParameterByQualifiedName

findNativeLayoutByQualifiedName

  • findNativeLayoutByQualifiedName(qname: string): INativeLayout | null

findNativePageByQualifiedName

  • findNativePageByQualifiedName(qname: string): INativePage | null

findNavigationProfileByQualifiedName

findPageByQualifiedName

  • findPageByQualifiedName(qname: string): IPage | null
  • Parameters

    • qname: string

    Returns IPage | null

findRegularExpressionByQualifiedName

findRemoteEntitySourceDocumentByQualifiedName

findRuleByQualifiedName

  • findRuleByQualifiedName(qname: string): IRule | null
  • Parameters

    • qname: string

    Returns IRule | null

findRuleParameterByQualifiedName

  • findRuleParameterByQualifiedName(qname: string): IRuleParameter | null

findSnippetByQualifiedName

  • findSnippetByQualifiedName(qname: string): ISnippet | null
  • Parameters

    • qname: string

    Returns ISnippet | null

findUserRoleByQualifiedName

  • findUserRoleByQualifiedName(qname: string): IUserRole | null
  • Parameters

    • qname: string

    Returns IUserRole | null

findWorkflowByQualifiedName

  • findWorkflowByQualifiedName(qname: string): IWorkflow | null
  • Parameters

    • qname: string

    Returns IWorkflow | null

findWorkflowTaskOutcomeByQualifiedName

findXmlSchemaByQualifiedName

  • findXmlSchemaByQualifiedName(qname: string): IXmlSchema | null
  • Parameters

    • qname: string

    Returns IXmlSchema | null

flushChanges

getAppEnvironmentStatus

getAppEnvironmentStatusV2

getAppUpdateStatus

getFile

  • getFile(filePath: string, outFilePath: string, callback: function, errorCallback: IErrorCallback): void
  • getFile(filePath: string, outFilePath: string): Promise<any>
  • Downloads the file specified by the supplied filepath. If filePath is empty, the raw response body will be provided in the callback

    Parameters

    • filePath: string
    • outFilePath: string
    • callback: function
        • (response?: any): void
        • Parameters

          • Optional response: any

          Returns void

    • errorCallback: IErrorCallback

    Returns void

  • Parameters

    • filePath: string
    • outFilePath: string

    Returns Promise<any>

getFilePaths

  • getFilePaths(callback: ICallback<string[]>, errorCallback: IErrorCallback): void
  • getFilePaths(): Promise<string[]>

getFiles

  • Returns all files or a subset of files options.filter: glob pattern to limit the set of files options.format: "json" or "zip" options.path: useful if format is "zip". If provided the zip will be stored on disk

    Parameters

    • callback: function
        • (response?: string[]): void
        • Parameters

          • Optional response: string[]

          Returns void

    • errorCallback: IErrorCallback

    Returns void

  • Returns Promise<string[]>

  • Parameters

    • options: IGetFilesOptions
    • callback: function
        • (response?: string[] | any): void
        • Parameters

          • Optional response: string[] | any

          Returns void

    • errorCallback: IErrorCallback

    Returns void

  • Parameters

    Returns Promise<string[] | any>

getLastEventId

  • getLastEventId(callback: ICallback<number>, errorCallback?: IErrorCallback): void
  • getLastEventId(): Promise<number>
  • Get the event id for the last processed batch of deltas in Model Server after flushing any pending deltas. If a callback is provided but no error callback is provided, errors will be handled through the default modelstore error handler.

    Parameters

    Returns void

  • Returns Promise<number>

importModuleMpk

  • importModuleMpk(mpkPath: string | Blob, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • importModuleMpk(mpkPath: string | Blob): Promise<void>
  • Imports the given module MPK.

    Importing a module overwrites existing files in the project.

    Gives error if

    • A module with the same name already exists
    • The module package is not using the same metamodel version as the project

    Parameters

    Returns void

  • Parameters

    • mpkPath: string | Blob

    Returns Promise<void>

loadUnitById

  • loadUnitById<T>(id: string, forceRefresh: boolean, callback: ICallback<T>, errorCallback?: IErrorCallback): void
  • loadUnitById<T>(id: string, forceRefresh: boolean): Promise<T>
  • Given an id, fetches a complete unit. The result might be returned from the cache. Use this method if you have just a unit Id, otherwise, unit.fetch() is a simpler alternative.

    Type parameters

    Parameters

    Returns void

  • Type parameters

    Parameters

    • id: string
    • forceRefresh: boolean

    Returns Promise<T>

onBuildResultEventReceived

  • onBuildResultEventReceived(callback: function): void

onFileChangesReceived

  • onFileChangesReceived(callback: function): void

onModelChange

onModelEventProcessed

onWorkingCopyDataEventReceived

  • onWorkingCopyDataEventReceived(callback: function): void

putFile

  • putFile(inFilePath: string | Blob, filePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • putFile(inFilePath: string | Blob, filePath: string): Promise<void>

setErrorHandler

  • Sets the callback that is invoked when an error occurs in an asynchronous operation for which no error callback is specified.

    Examples of such operations are making changes to the model and loading elements.

    Parameters

    Returns void

startAppUpdate

  • Start async deploy flow, creates new app job and returns it. This call immediately returns after successfully initiating the deployment job, and it's progress can be tracked using `getAppUpdateStates.

    A start update packs the mpk and sends it to the cloud environment to update the application, a new application will be provisioned if needed.

    The update job will always converge to a stable state (one of "started" | "failed" | "consistencyerrors"). Use the returned job id to poll for this.

    Parameters

    Returns void

  • Returns Promise<IDeployJobStatus>

startReceivingModelEvents

  • startReceivingModelEvents(): void

startReceivingWorkingCopyEvents

  • startReceivingWorkingCopyEvents(): void

stopReceivingModelEvents

  • stopReceivingModelEvents(): void

stopReceivingWorkingCopyEvents

  • stopReceivingWorkingCopyEvents(): void

Generated using TypeDoc