Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RuntimeSettings

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___afterStartupMicroflow

___afterStartupMicroflow: any

Private ___allowUserMultipleSessions

___allowUserMultipleSessions: any

Private ___beforeShutdownMicroflow

___beforeShutdownMicroflow: any

Private ___defaultTimeZoneCode

___defaultTimeZoneCode: any

Private ___firstDayOfWeek

___firstDayOfWeek: any

Private ___hashAlgorithm

___hashAlgorithm: any

Private ___healthCheckMicroflow

___healthCheckMicroflow: any

Private ___roundingMode

___roundingMode: any

Private ___scheduledEventTimeZoneCode

___scheduledEventTimeZoneCode: any

afterStartupMicroflow

afterStartupMicroflow: IMicroflow

afterStartupMicroflowQualifiedName

afterStartupMicroflowQualifiedName: string

allowUserMultipleSessions

allowUserMultipleSessions: boolean

beforeShutdownMicroflow

beforeShutdownMicroflow: IMicroflow

beforeShutdownMicroflowQualifiedName

beforeShutdownMicroflowQualifiedName: string

container

container: AbstractElement

containerAsProjectSettings

containerAsProjectSettings: ProjectSettings

defaultTimeZoneCode

defaultTimeZoneCode: string

firstDayOfWeek

firstDayOfWeek: FirstDayOfWeekEnum

hashAlgorithm

hashAlgorithm: HashAlgorithmType

healthCheckMicroflow

healthCheckMicroflow: IMicroflow

healthCheckMicroflowQualifiedName

healthCheckMicroflowQualifiedName: string

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

qualifiedName

qualifiedName: string

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

roundingMode

roundingMode: RoundingMode

scheduledEventTimeZoneCode

scheduledEventTimeZoneCode: string

typeName

typeName: string

unit

unit: ModelUnit

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 RuntimeSettings 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 RuntimeSettings

Static createIn

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

    Parameters

    Returns RuntimeSettings

Generated using TypeDoc