Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MsdMetadata

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___caption

___caption: any

Private ___description

___description: any

Private ___documentation

___documentation: any

Private ___headerAuthentication

___headerAuthentication: any

Private ___image

___image: any

Private ___instanceGuid

___instanceGuid: any

Private ___microflows

___microflows: any

Private ___name

___name: any

Private ___publishDateTime

___publishDateTime: any

Private ___serviceGuid

___serviceGuid: any

Private ___supportedProtocols

___supportedProtocols: any

Private ___version

___version: any

Private ___versionGuid

___versionGuid: any

caption

caption: string

container

container: AbstractElement

containerAsMsd

containerAsMsd: Msd

description

description: string

documentation

documentation: string

headerAuthentication

headerAuthentication: string

id

id: string

image

image: string

instanceGuid

instanceGuid: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

microflows

microflows: IList<MsdMicroflow>

model

model: IModel

name

name: string

publishDateTime

publishDateTime: string

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

serviceGuid

serviceGuid: string

supportedProtocols

supportedProtocols: IList<string>

typeName

typeName: string

unit

unit: ModelUnit

version

version: number

versionGuid

versionGuid: string

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

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

Static createIn

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

    Parameters

    • container: Msd

    Returns MsdMetadata

Generated using TypeDoc