Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 10.4.0: introduced

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "ODataPublish$PublishedId"
versionInfo: StructureVersionInfo = ...

Accessors

  • get container(): TContainer
  • Returns TContainer

  • get description(): string
  • set description(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get exposedName(): string
  • set exposedName(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get isPartOfKey(): boolean
  • set isPartOfKey(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • Returns TModel

  • get summary(): string
  • set summary(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

Methods

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns PublishedId

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: PublishedId) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<PublishedId>
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<PublishedId>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new PublishedId instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    • model: IModel

    Returns PublishedId

  • Creates and returns a new PublishedId instance in the SDK and on the server. The new PublishedId will be automatically stored in the 'childMembers' property of the parent EntityType element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 10.4.0 and higher

    Parameters

    Returns PublishedId

Generated using TypeDoc