Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Model

Implementation of IModel.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

metaModelVersion

metaModelVersion: Version

mxVersionForModel

mxVersionForModel: Version

workingCopy

workingCopy: IWorkingCopy

Accessors

id

  • get (): string

root

  • Returns the structural unit of type "Projects$Project" which is the project's root, cast to the appropriate type.

    Returns IProject

Methods

addModuleUnitInterfaces

  • addModuleUnitInterfaces(structuresJson: string | IAbstractUnitJson[]): void

allBuildingBlocks

  • allBuildingBlocks(): IBuildingBlock[]

allCodeActions

  • allCodeActions(): ICodeAction[]

allConstants

  • allConstants(): IConstant[]

allConsumedAppServices

  • allConsumedAppServices(): IConsumedAppService[]

allConsumedODataServices

  • allConsumedODataServices(): IConsumedODataService[]

allDataSets

  • allDataSets(): IDataSet[]

allDocumentTemplates

  • allDocumentTemplates(): IDocumentTemplate[]

allDocuments

  • allDocuments(): IDocument[]

allDomainModels

  • allDomainModels(): IDomainModel[]

allEnumerations

  • allEnumerations(): IEnumeration[]

allExportMappings

  • allExportMappings(): IExportMapping[]

allFolderBases

  • allFolderBases(): IFolderBase[]

allFolders

  • allFolders(): IFolder[]

allFormBases

  • allFormBases(): IFormBase[]

allImageCollections

  • allImageCollections(): IImageCollection[]

allImportMappings

  • allImportMappings(): IImportMapping[]

allImportedWebServices

  • allImportedWebServices(): IImportedWebService[]

allJavaActions

  • allJavaActions(): IJavaAction[]

allJavaScriptActions

  • allJavaScriptActions(): IJavaScriptAction[]

allJsonStructures

  • allJsonStructures(): IJsonStructure[]

allLayouts

  • allLayouts(): ILayout[]

allMappingDocuments

  • allMappingDocuments(): IMappingDocument[]

allMenuDocuments

  • allMenuDocuments(): IMenuDocument[]

allMessageDefinitionCollections

  • allMessageDefinitionCollections(): IMessageDefinitionCollection[]

allMicroflowBases

  • allMicroflowBases(): IMicroflowBase[]

allMicroflows

  • allMicroflows(): IMicroflow[]

allModuleDocuments

  • allModuleDocuments(): IModuleDocument[]

allModuleSecurities

  • allModuleSecurities(): IModuleSecurity[]

allModules

  • allModules(): IModule[]

allMxSchemas

  • allMxSchemas(): IMxSchema[]

allNanoflows

  • allNanoflows(): INanoflow[]

allNativeLayouts

  • allNativeLayouts(): INativeLayout[]

allNativePages

  • allNativePages(): INativePage[]

allNavigationDocuments

  • allNavigationDocuments(): INavigationDocument[]

allPageTemplates

  • allPageTemplates(): IPageTemplate[]

allPages

  • allPages(): IPage[]

allProjectConversions

  • allProjectConversions(): IProjectConversion[]

allProjectDocuments

  • allProjectDocuments(): IProjectDocument[]

allProjectSecurities

  • allProjectSecurities(): IProjectSecurity[]

allProjectSettings

  • allProjectSettings(): IProjectSettings[]

allProjects

  • allProjects(): IProject[]

allPublishedAppServices

  • allPublishedAppServices(): IPublishedAppService[]

allPublishedODataServices

  • allPublishedODataServices(): IPublishedODataService[]

allPublishedRestServices

  • allPublishedRestServices(): IPublishedRestService[]

allPublishedServiceBases

  • allPublishedServiceBases(): IPublishedServiceBase[]

allPublishedWebServices

  • allPublishedWebServices(): IPublishedWebService[]

allRegularExpressions

  • allRegularExpressions(): IRegularExpression[]

allRemoteEntitySourceDocuments

  • allRemoteEntitySourceDocuments(): IRemoteEntitySourceDocument[]

allRules

  • allRules(): IRule[]

allScheduledEvents

  • allScheduledEvents(): IScheduledEvent[]

allServerSideMicroflows

  • allServerSideMicroflows(): IServerSideMicroflow[]

allSnippets

  • allSnippets(): ISnippet[]

allSystemTextCollections

  • allSystemTextCollections(): ISystemTextCollection[]

allTemplateFormBases

  • allTemplateFormBases(): ITemplateFormBase[]

allUnits

  • allUnits(): IAbstractUnit[]

allWorkflows

  • allWorkflows(): IWorkflow[]

allXmlSchemas

  • allXmlSchemas(): IXmlSchema[]

closeConnection

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

findConstantByQualifiedName

  • findConstantByQualifiedName(qname: string): IConstant | null

findConsumedODataServiceByQualifiedName

findDataSetByQualifiedName

  • findDataSetByQualifiedName(qname: string): IDataSet | null

findDataSetParameterByQualifiedName

findDocumentTemplateByQualifiedName

findEntityByQualifiedName

  • findEntityByQualifiedName(qname: string): IEntity | null

findEnumerationByQualifiedName

  • findEnumerationByQualifiedName(qname: string): IEnumeration | null

findEnumerationValueByQualifiedName

findExportMappingByQualifiedName

  • findExportMappingByQualifiedName(qname: string): IExportMapping | null

findImageByQualifiedName

  • findImageByQualifiedName(qname: string): 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

findLayoutParameterByQualifiedName

findMenuDocumentByQualifiedName

  • findMenuDocumentByQualifiedName(qname: string): IMenuDocument | null

findMessageDefinitionByQualifiedName

findMicroflowByQualifiedName

  • findMicroflowByQualifiedName(qname: string): IMicroflow | null

findMicroflowParameterByQualifiedName

findModuleByQualifiedName

  • findModuleByQualifiedName(qname: string): IModule | null

findModuleRoleByQualifiedName

  • findModuleRoleByQualifiedName(qname: string): IModuleRole | null

findNanoflowByQualifiedName

  • findNanoflowByQualifiedName(qname: string): INanoflow | null

findNanoflowParameterByQualifiedName

findNativeLayoutByQualifiedName

  • findNativeLayoutByQualifiedName(qname: string): INativeLayout | null

findNativePageByQualifiedName

  • findNativePageByQualifiedName(qname: string): INativePage | null

findNavigationProfileByQualifiedName

findPageByQualifiedName

  • findPageByQualifiedName(qname: string): IPage | null

findRegularExpressionByQualifiedName

findRemoteEntitySourceDocumentByQualifiedName

findRuleByQualifiedName

  • findRuleByQualifiedName(qname: string): IRule | null

findRuleParameterByQualifiedName

  • findRuleParameterByQualifiedName(qname: string): IRuleParameter | null

findSnippetByQualifiedName

  • findSnippetByQualifiedName(qname: string): ISnippet | null

findUserRoleByQualifiedName

  • findUserRoleByQualifiedName(qname: string): IUserRole | null

findWorkflowByQualifiedName

  • findWorkflowByQualifiedName(qname: string): IWorkflow | null

findWorkflowTaskOutcomeByQualifiedName

findXmlSchemaByQualifiedName

  • findXmlSchemaByQualifiedName(qname: string): IXmlSchema | null

flushChanges

getAppEnvironmentStatus

getAppEnvironmentStatusV2

getAppUpdateStatus

getFile

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

getFilePaths

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

getFiles

getLastEventId

  • getLastEventId(callback: ICallback<number>, errorCallback?: IErrorCallback): void
  • getLastEventId(): Promise<number>

handleError

  • handleError(message: string, errorCallback: IErrorCallback | undefined): void

importModuleMpk

  • importModuleMpk(mpkPath: string | Blob, callback: IVoidCallback, errorCallback?: IErrorCallback): void
  • importModuleMpk(mpkPath: string | Blob): Promise<void>

loadUnitById

  • loadUnitById<T>(id: string, forceRefresh: boolean | undefined, callback: ICallback<T>, errorCallback?: IErrorCallback): void
  • loadUnitById<T>(id: string, forceRefresh: boolean | undefined): 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

startAppUpdate

startReceivingModelEvents

  • startReceivingModelEvents(): void

startReceivingWorkingCopyEvents

  • startReceivingWorkingCopyEvents(): void

stopReceivingModelEvents

  • stopReceivingModelEvents(): void

stopReceivingWorkingCopyEvents

  • stopReceivingWorkingCopyEvents(): void

Static createSdkClient

Generated using TypeDoc