Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScheduledEvent

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___enabled

___enabled: any

Private ___interval

___interval: any

Private ___intervalType

___intervalType: any

Private ___microflow

___microflow: any

Private ___startDateTime

___startDateTime: any

Private ___timeZone

___timeZone: any

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

enabled

enabled: boolean

excluded

excluded: boolean

id

id: string

interval

interval: number

intervalType

intervalType: IntervalType

isLoaded

isLoaded: boolean

microflow

microflow: IMicroflow

microflowQualifiedName

microflowQualifiedName: string

model

model: IModel

moduleName

moduleName: string

Returns the module name of the model unit, which is the first section of the qualified name.

name

name: string

qualifiedName

qualifiedName: string

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

startDateTime

startDateTime: string

timeZone

timeZone: TimeZoneEnum

typeName

typeName: string

unit

unit:

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

findElementById

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 createIn

  • Creates a new ScheduledEvent unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns ScheduledEvent

Generated using TypeDoc