Class CallWorkflowActivity

In version 9.0.5: removed experimental In version 9.0.2: introduced

Hierarchy

WorkflowActivity

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CallWorkflowActivity(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): CallWorkflowActivity

Overwrites WorkflowActivity.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns CallWorkflowActivity

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

caption

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

Inherited from WorkflowActivity.caption

Returns string
Inherited from WorkflowActivity.caption

Parameters
- newValue: string
Returns any

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

containerAsFlow

get (): Flow

Overwrites WorkflowActivity.containerAsFlow

Returns Flow

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

name

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

Inherited from WorkflowActivity.name

In version 9.0.5: introduced

Returns string
Inherited from WorkflowActivity.name

In version 9.0.5: introduced

Parameters
- newValue: string
Returns any

parameterExpression

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

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

In version 9.6.0: introduced

Returns string
The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

In version 9.6.0: introduced

Parameters
- newValue: string
Returns any

qualifiedName

get (): string | null

Inherited from WorkflowActivity.qualifiedName

Returns string | null

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

workflow

get (): IWorkflow | null
set (newValue: IWorkflow | null): any

Returns IWorkflow | null
Parameters
- newValue: IWorkflow | null
Returns any

workflowQualifiedName

get (): string | null

Returns string | null

Methods

allProperties

allProperties(): AbstractProperty<any, any>[]

Implementation of ICallWorkflowActivity.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of ICallWorkflowActivity.asLoaded

Inherited from ModelUnit.asLoaded
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

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of ICallWorkflowActivity.findElementById

Inherited from AbstractElement.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: function, forceRefresh?: undefined | false | true): void
load(forceRefresh?: undefined | false | true): Promise<this>

Inherited from ModelUnit.load
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
Implementation of ICallWorkflowActivity.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

loadedProperties(): AbstractProperty<any, any>[]

Implementation of ICallWorkflowActivity.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

publicProperties(): AbstractProperty<any, any>[]

Implementation of ICallWorkflowActivity.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of ICallWorkflowActivity.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: function): T | null

Inherited from AbstractUnit.traverseFind

Type parameters
- T
Parameters
- visit: function
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns T | null

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): CallWorkflowActivity

Creates and returns a new CallWorkflowActivity 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 CallWorkflowActivity

Static createIn

createIn(container: Flow): CallWorkflowActivity

Creates and returns a new CallWorkflowActivity instance in the SDK and on the server. The new CallWorkflowActivity will be automatically stored in the 'activities' property of the parent Flow element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 9.0.2 and higher

Parameters
- container: Flow
Returns CallWorkflowActivity

Generated using TypeDoc