Options
All
  • Public
  • Public/Protected
  • All
Menu

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

IEnvironmentStatus

IEnvironmentStatus: object | object

IMergeState

IMergeState: ILockData

IUpdateAppJobStatus

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

InstanceConstructor

LockType

LockType: "bidi" | "conversion" | "edit"

ModelSdkClient

ModelSdkClient: ModelSdkClientImpl<IModel, Model>

Mutator

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.20.0

SDK_VERSION

SDK_VERSION: string

Current SDK version: 4.16.0

testDataPathPrefix

testDataPathPrefix: "./data/"

Functions

asModelUnit

checkInsertionIndex

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

checkMutator

checkUpdateOrRemovalIndex

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

contains

createElementFromJSON

  • 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

    Returns Element

createInVersionCheck

findElement

getAuthInfo

getContainmentInfo

getElement

getElementNotFoundError

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

    Returns Error

getProperty

getUnit

isAtLeast

  • Parameters

    Returns boolean

isListProperty

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

rawList

rawValue

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

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