Options
All
  • Public
  • Public/Protected
  • All
Menu

Mendix Model SDK - v4.64.0

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Delta: ICreateElementTreeDelta | IDeleteElementDelta | IAttachElementDelta | IDetachElementDelta | ICreateUnitTreeDelta | IDeleteUnitDelta | IUpdatePropertyValueDelta
IMergeState: ILockData
IModel: base.IModel
IModelEvent: IFileEvent | IDeltaEvent
LockType: "bidi" | "conversion" | "edit" | "commit" | "update" | "switch" | "commit-wc"
ModelSdkClient: ModelSdkClientImpl<IModel, Model>

Variables

MAX_METAMODEL_VERSION: string = "9.15.0"

Highest supported Metamodel version: 9.15.0

SDK_VERSION: string = "4.64.0"

Current SDK version: 4.64.0

Functions

  • Begin an explicit transaction for the given model.

    Rolling back the following actions are not possible:

    • Changes made to a structural unit.
    • Deleting a non-loaded unit.

    When rolling back a deleted element/unit, a new element/unit instance will be created with the same id. Be sure not to use the old - deleted - instance.

    Parameters

    Returns Transaction

  • Creates a new model unit from JSON and attaches it to the provided container unit. All element IDs are replaced by new ones.

    Parameters

    Returns ModelUnit

  • Run the specified action inside a transaction for the given model. The transaction will be committed when the action is finished. In case of an error the transaction will be rolled back.

    Rolling back the following actions are not possible:

    • Changes made to a structural unit.
    • Deleting a non-loaded unit.

    When rolling back a deleted element/unit, a new element/unit instance will be created with the same id. Be sure not to use the old - deleted - instance.

    Type parameters

    • T

    Parameters

    Returns T

  • Type parameters

    • T

    Parameters

    • model: IAbstractModel
    • action: () => Promise<T>
        • (): Promise<T>
        • Returns Promise<T>

    Returns Promise<T>

  • Type parameters

    • T

    Parameters

    Returns T

  • Type parameters

    • T

    Parameters

    Returns Promise<T>

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

    • T

    • P

    Parameters

    • property: AbstractProperty<T[], IList<P>> & { toRawChangeValue: any }
    • change: IArrayWillSplice<P> | IArrayWillChange<P>

    Returns void

Generated using TypeDoc