Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RuntimeSettings

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

afterStartupMicroflow

afterStartupMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

allowUserMultipleSessions

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

  • Parameters

    • newValue: boolean

    Returns any

bcryptCost

  • get (): number
  • set (newValue: number): any
  • In version 9.11.0: introduced

    Returns number

  • In version 9.11.0: introduced

    Parameters

    • newValue: number

    Returns any

beforeShutdownMicroflow

beforeShutdownMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

container

containerAsProjectSettings

defaultTimeZoneCode

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

  • Parameters

    • newValue: string

    Returns any

enableDataStorageNewQueryHandling

  • get (): boolean
  • set (newValue: boolean): any
  • In version 8.0.0: deleted In version 7.10.0: introduced

    Returns boolean

  • In version 8.0.0: deleted In version 7.10.0: introduced

    Parameters

    • newValue: boolean

    Returns any

enableDataStorageOptimisticLocking

  • get (): boolean
  • set (newValue: boolean): any
  • In version 7.5.0: introduced

    Returns boolean

  • In version 7.5.0: introduced

    Parameters

    • newValue: boolean

    Returns any

enforceDataStorageUniqueness

  • get (): boolean
  • set (newValue: boolean): any
  • In version 9.0.2: deleted In version 7.1.0: introduced

    Returns boolean

  • In version 9.0.2: deleted In version 7.1.0: introduced

    Parameters

    • newValue: boolean

    Returns any

firstDayOfWeek

hashAlgorithm

healthCheckMicroflow

healthCheckMicroflowQualifiedName

  • get (): string | null
  • Returns string | null

isLoaded

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

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

    Returns boolean

model

roundingMode

scheduledEventTimeZoneCode

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

  • Parameters

    • newValue: string

    Returns any

unit

useDeprecatedClientForWebServiceCalls

  • get (): boolean
  • set (newValue: boolean): any
  • In version 8.0.0: deleted In version 7.15.0: introduced

    Returns boolean

  • In version 8.0.0: deleted In version 7.15.0: introduced

    Parameters

    • newValue: boolean

    Returns any

useSystemContextForBackgroundTasks

  • get (): boolean
  • set (newValue: boolean): any
  • In version 9.6.0: introduced

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

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