Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetadataReference

In version 8.6.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

container

containerAsConsumedKafkaService

  • get (): ConsumedKafkaService
  • Returns ConsumedKafkaService

containerAsConsumedODataService

  • get (): ConsumedODataService
  • Returns ConsumedODataService

containerAsMetadataReference

isLoaded

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

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

    Returns boolean

metadata

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

metadataReferences

model

unit

uri

  • get (): string
  • set (newValue: string): any
  • Returns string

  • Parameters

    • newValue: string

    Returns any

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this
  • 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 this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this
  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>
  • 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

    • callback: function
        • (elem: this): void
        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new MetadataReference 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

    Returns MetadataReference

Static createIn

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.6.0 to 8.7.0

    Parameters

    • container: ConsumedODataService

    Returns MetadataReference

Static createInConsumedKafkaServiceUnderMetadataReferences

  • createInConsumedKafkaServiceUnderMetadataReferences(container: ConsumedKafkaService): MetadataReference
  • Creates and returns a new MetadataReference instance in the SDK and on the server. The new MetadataReference will be automatically stored in the 'metadataReferences' property of the parent kafka.ConsumedKafkaService element passed as argument.

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

    Parameters

    • container: ConsumedKafkaService

    Returns MetadataReference

Static createInConsumedODataServiceUnderMetadataReferences

  • createInConsumedODataServiceUnderMetadataReferences(container: ConsumedODataService): MetadataReference
  • Creates and returns a new MetadataReference instance in the SDK and on the server. The new MetadataReference will be automatically stored in the 'metadataReferences' property of the parent ConsumedODataService element passed as argument.

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

    Parameters

    • container: ConsumedODataService

    Returns MetadataReference

Static createInMetadataReferenceUnderMetadataReferences

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

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

    Parameters

    Returns MetadataReference

Generated using TypeDoc