Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MicroflowSettings

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

asynchronous

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

confirmationInfo

container

containerAsAssociationWidget

containerAsAttributeWidget

containerAsMicroflowClientAction

containerAsMicroflowSource

containerAsOnClickMicroflow

containerAsReferenceSetSelector

containerAsSelectorMicroflowSource

formValidations

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

microflow

microflowQualifiedName

  • get (): string | null

  • Returns string | null

model

parameterMappings

progressBar

progressMessage

  • get (): Text | null
  • set (newValue: Text | null): any

  • Returns Text | null

  • Parameters

    • newValue: Text | null

    Returns any

unit

useAllPages

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

  • In version 7.19.0: deleted

    Returns boolean

  • In version 7.19.0: deleted

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

Static createInAssociationWidgetUnderOnChangeMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.12.0

    Parameters

    Returns MicroflowSettings

Static createInAttributeWidgetUnderOnChangeMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.12.0

    Parameters

    Returns MicroflowSettings

Static createInAttributeWidgetUnderOnEnterMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.12.0

    Parameters

    Returns MicroflowSettings

Static createInAttributeWidgetUnderOnLeaveMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.12.0

    Parameters

    Returns MicroflowSettings

Static createInMicroflowClientActionUnderMicroflowSettings

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

    Parameters

    Returns MicroflowSettings

Static createInMicroflowSourceUnderMicroflowSettings

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

    Parameters

    Returns MicroflowSettings

Static createInOnClickMicroflowUnderMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.17.0

    Parameters

    Returns MicroflowSettings

Static createInReferenceSetSelectorUnderOnChangeMicroflowSettings

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.12.0

    Parameters

    Returns MicroflowSettings

Static createInSelectorMicroflowSourceUnderDataSourceMicroflowSettings

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

    Parameters

    Returns MicroflowSettings

Generated using TypeDoc