Mendix Model SDK

Index

Type aliases

AbstractStructureProperty

AbstractStructureProperty: PartProperty<any> | PartListProperty<any> | StructuralChildProperty<any> | StructuralChildListProperty<any>

CannotFixAppState

CannotFixAppState: "INVALID_PROJECTID" | "UNKNOWN_DEPLOYER" | "INVALID_OPENID" | "UNKNOWN_PROJECT" | "UNKNOWN_ACCOUNT" | "BUSY_PROVISIONING" | "UNLINKED" | "NO_WEBMODELER_TARGET_SELECTED" | "UNKNOWN"

Change

Change: IDeltaChange[]

Delta

Delta: ICreateElementTreeDelta | IDeleteElementDelta | IAttachElementDelta | IDetachElementDelta | ICreateUnitTreeDelta | IDeleteUnitDelta | IUpdatePropertyValueDelta

IEnvironmentStatus

IEnvironmentStatus: object | object

IMergeState

IMergeState: ILockData

IUpdateAppJobStatus

IUpdateAppJobStatus: "updating" | "resuming" | "provisioning" | "started" | "consistencyerrors" | "failed"

InstanceConstructor

InstanceConstructor: IElementConstructor | IAbstractUnitConstructor

LockType

LockType: "bidi" | "conversion" | "edit" | "commit" | "update" | "switch"

ModelSdkClient

ModelSdkClient: ModelSdkClientImpl<IModel, Model>

Mutator

Mutator: IChangeMutator | IAddMutator | IRemoveMutator

PrimitiveValue

PrimitiveValue: boolean | number | string | IPoint | ISize | IColor

RequestMethod

RequestMethod: "get" | "put" | "post" | "delete"

StructureState

StructureState: "new" | "attached" | "detached" | "deleted"

SuccessAppState

SuccessAppState: "APP_NOT_FOUND" | "STAGING" | "UPDATING" | "STARTING" | "FAILED_STAGING" | "FAILED" | "STARTED" | "MXBUILD_STARTED" | "STOPPED"

Variables

MAX_METAMODEL_VERSION

MAX_METAMODEL_VERSION: string

Highest supported Metamodel version: 7.23.0

SDK_VERSION

SDK_VERSION: string

Current SDK version: 4.19.0

testDataPathPrefix

testDataPathPrefix: "./data/"

Functions

asModelUnit

asModelUnit(unit: IAbstractUnit): ModelUnit

Parameters
- unit: IAbstractUnit
Returns ModelUnit

checkInsertionIndex

checkInsertionIndex(index: number, property: AbstractProperty<any[], any>): void

Parameters
- index: number
- property: AbstractProperty<any[], any>
Returns void

checkMutator

checkMutator(mutator: Mutator, property: AbstractProperty<any, any>): void

Parameters
- mutator: Mutator
- property: AbstractProperty<any, any>
Returns void

checkUpdateOrRemovalIndex

checkUpdateOrRemovalIndex(index: number, property: AbstractProperty<any[], any>): void

Parameters
- index: number
- property: AbstractProperty<any[], any>
Returns void

contains

contains(range: IVersionRange, version: Version): boolean

Parameters
- range: IVersionRange
- version: Version
Returns boolean

createElementFromJSON

createElementFromJSON(model: AbstractModel, json: IAbstractElementJson): Element

Creates a new element instance from JSON. All element IDs are replaced by new ones. After creation, the element can be attached to a container.

Parameters
- model: AbstractModel
- json: IAbstractElementJson
Returns Element

createInVersionCheck

createInVersionCheck(model: IAbstractModel, structureTypeName: string, versionRange: IVersionRange): void

Parameters
- model: IAbstractModel
- structureTypeName: string
- versionRange: IVersionRange
Returns void

findElement

findElement(model: AbstractModel, unit: ModelUnit, elementId: string): AbstractElement | null

Parameters
- model: AbstractModel
- unit: ModelUnit
- elementId: string
Returns AbstractElement | null

getAuthInfo

getAuthInfo(config: ISdkConfig): IAuthInfo

Parameters
- config: ISdkConfig
Returns IAuthInfo

getContainmentInfo

getContainmentInfo(unit: ModelUnit, model: AbstractModel, elementId: string): IContainmentInfo

Parameters
- unit: ModelUnit
- model: AbstractModel
- elementId: string
Returns IContainmentInfo

getElement

getElement(model: AbstractModel, unit: ModelUnit, elementId: string): AbstractElement

Parameters
- model: AbstractModel
- unit: ModelUnit
- elementId: string
Returns AbstractElement

getElementNotFoundError

getElementNotFoundError(unit: ModelUnit, elementId: string): Error

Parameters
- unit: ModelUnit
- elementId: string
Returns Error

getProperty

getProperty(structure: IStructure, propertyName: string): AbstractProperty<any, any>

Parameters
- structure: IStructure
- propertyName: string
Returns AbstractProperty<any, any>

getUnit

getUnit(model: AbstractModel, unitId: string): IAbstractUnit

Parameters
- model: AbstractModel
- unitId: string
Returns IAbstractUnit

isAtLeast

isAtLeast(versionString: string, model: IAbstractModel): boolean

Parameters
- versionString: string
- model: IAbstractModel
Returns boolean

isListProperty

isListProperty(property: AbstractProperty<any, any>): boolean

Parameters
- property: AbstractProperty<any, any>
Returns boolean

isNamedElement

isNamedElement(element: IStructure): boolean

Parameters
- element: IStructure
Returns boolean

parseAsNormalizedVersion

parseAsNormalizedVersion(versionString: string): Version

Parses the given string as a sem-Version, ignoring non-numeric and "extra" data, and padding with ".0" where necessary.

Parameters
- versionString: string
Returns Version

promiseOrCallbacks

promiseOrCallbacks<T>(action: function, callback: ICallback<T> | undefined, errorCallback: IErrorCallback | undefined): Promise | void

Type parameters
- T
Parameters
- action: function
  - - (resolve: function, reject: function): void
    - Parameters
      - resolve: function
        
        (result?: T): void
        
        Parameters
        
        Optional result: T
        
        Returns void
      - reject: function
        
        (err: any): void
        
        Parameters
        
        err: any
        
        Returns void
      Returns void
- callback: ICallback<T> | undefined
- errorCallback: IErrorCallback | undefined
Returns Promise | void

rawList

rawList(property: AbstractProperty<any[], any>): any[]

Parameters
- property: AbstractProperty<any[], any>
Returns any[]

rawValue

rawValue(property: AbstractProperty<any, any>): any

Parameters
- property: AbstractProperty<any, any>
Returns any

readJson

readJson<T>(fileName: string): T

Reads the file with the given name relative to 'mendixmodelsdk', and parses and returns it as JSON.

Type parameters
- T
Parameters
- fileName: string
Returns T

removeUselessDeltas

removeUselessDeltas(deltas: Delta[]): Delta[]

Parameters
- deltas: Delta[]
Returns Delta[]

sendListChangeDeltas

sendListChangeDeltas<T, P>(property: AbstractProperty<T[], IList<P>> & { toRawChangeValue: (value: P) => any; }, change: IArrayWillSplice | IArrayWillChange): void

Type parameters
- T
- P
Parameters
- property: AbstractProperty<T[], IList<P>> & { toRawChangeValue: (value: P) => any; }
- change: IArrayWillSplice | IArrayWillChange
Returns void

updateStructure

updateStructure(structure: Structure, updateAction: function): void

Parameters
- structure: Structure
- updateAction: function
  - - (): void
    - Returns void
Returns void

writeJson

writeJson(fileName: string, json: object): void

Writes the given JSON under the given file name into the test-output directory.

Parameters
- fileName: string
- json: object
Returns void

xTimes

xTimes(n: number): string

Parameters
- n: number
Returns string

a string consisting of n times an 'x'.

Generated using TypeDoc