Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Settings$RuntimeSettings"
versionInfo: StructureVersionInfo = ...

Accessors

  • get afterStartupMicroflow(): null | IMicroflow
  • set afterStartupMicroflow(newValue: null | IMicroflow): void
  • get afterStartupMicroflowQualifiedName(): null | string
  • Returns null | string

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

  • Parameters

    • newValue: boolean

    Returns void

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

    Returns number

  • In version 9.11.0: introduced

    Parameters

    • newValue: number

    Returns void

  • get beforeShutdownMicroflow(): null | IMicroflow
  • set beforeShutdownMicroflow(newValue: null | IMicroflow): void
  • get beforeShutdownMicroflowQualifiedName(): null | string
  • Returns null | string

  • get container(): TContainer
  • Returns TContainer

  • Returns ProjectSettings

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

  • Parameters

    • newValue: string

    Returns void

  • get enableDataStorageNewQueryHandling(): boolean
  • set enableDataStorageNewQueryHandling(newValue: boolean): void
  • 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 void

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

    Returns boolean

  • In version 7.5.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get enforceDataStorageUniqueness(): boolean
  • set enforceDataStorageUniqueness(newValue: boolean): void
  • 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 void

  • get healthCheckMicroflow(): null | IMicroflow
  • set healthCheckMicroflow(newValue: null | IMicroflow): void
  • get healthCheckMicroflowQualifiedName(): null | string
  • Returns null | string

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

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

    Returns boolean

  • In version 10.8.0: introduced

    Returns JavaVersion

  • In version 10.8.0: introduced

    Parameters

    Returns void

  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • get useDatabaseForeignKeyConstraints(): boolean
  • set useDatabaseForeignKeyConstraints(newValue: boolean): void
  • In version 10.6.0: introduced

    Returns boolean

  • In version 10.6.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get useDeprecatedClientForWebServiceCalls(): boolean
  • set useDeprecatedClientForWebServiceCalls(newValue: boolean): void
  • 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 void

  • get useOQLVersion2(): boolean
  • set useOQLVersion2(newValue: boolean): void
  • In version 10.11.0: introduced

    Returns boolean

  • In version 10.11.0: introduced

    Parameters

    • newValue: boolean

    Returns void

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

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

    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 RuntimeSettings

  • delete(): void
  • getContainerAs<T>(containerType: any): 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.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<RuntimeSettings>

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

    • model: IModel

    Returns RuntimeSettings

  • 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