@mendix/extensions-api - v0.9.0
    Preparing search index...

    Interface Flow

    An element is part of a Mendix model and all elements together form the logic of the model. Elements may contain other elements. An element always has a container element, which is its parent. The root of an element tree is always a unit.

    interface Flow {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "Workflows$Flow";
        $UnitID?: string;
        activities: WorkflowActivity[];
        addAIAgentTaskActivity(): Promise<AIAgentTaskActivity>;
        addCallMicroflowActivity(): Promise<CallMicroflowActivity>;
        addCallWorkflowActivity(): Promise<CallWorkflowActivity>;
        addEndOfBoundaryEventPathActivity(): Promise<
            EndOfBoundaryEventPathActivity,
        >;
        addEndOfParallelSplitPathActivity(): Promise<
            EndOfParallelSplitPathActivity,
        >;
        addEndWorkflowActivity(): Promise<EndWorkflowActivity>;
        addExclusiveSplitActivity(): Promise<ExclusiveSplitActivity>;
        addInterruptingNotificationEventSubProcessStartActivity(): Promise<
            InterruptingNotificationEventSubProcessStartActivity,
        >;
        addJumpToActivity(): Promise<JumpToActivity>;
        addMergeActivity(): Promise<MergeActivity>;
        addMultiUserTaskActivity(
            options: MultiUserTaskActivityCreationOptions,
        ): Promise<MultiUserTaskActivity>;
        addNonInterruptingNotificationEventSubProcessStartActivity(): Promise<
            NonInterruptingNotificationEventSubProcessStartActivity,
        >;
        addParallelSplitActivity(): Promise<ParallelSplitActivity>;
        addSingleUserTaskActivity(): Promise<SingleUserTaskActivity>;
        addStartWorkflowActivity(): Promise<StartWorkflowActivity>;
        addWaitForNotificationActivity(): Promise<WaitForNotificationActivity>;
        addWaitForTimerActivity(): Promise<WaitForTimerActivity>;
        getAIAgentTaskActivity(name: string): undefined | AIAgentTaskActivity;
        getCallMicroflowActivity(name: string): undefined | CallMicroflowActivity;
        getCallWorkflowActivity(name: string): undefined | CallWorkflowActivity;
        getEndOfBoundaryEventPathActivity(
            name: string,
        ): undefined | EndOfBoundaryEventPathActivity;
        getEndOfParallelSplitPathActivity(
            name: string,
        ): undefined | EndOfParallelSplitPathActivity;
        getEndWorkflowActivity(name: string): undefined | EndWorkflowActivity;
        getExclusiveSplitActivity(name: string): undefined | ExclusiveSplitActivity;
        getInterruptingNotificationEventSubProcessStartActivity(
            name: string,
        ): undefined | InterruptingNotificationEventSubProcessStartActivity;
        getJumpToActivity(name: string): undefined | JumpToActivity;
        getMergeActivity(name: string): undefined | MergeActivity;
        getMultiUserTaskActivity(name: string): undefined | MultiUserTaskActivity;
        getNonInterruptingNotificationEventSubProcessStartActivity(
            name: string,
        ): undefined | NonInterruptingNotificationEventSubProcessStartActivity;
        getParallelSplitActivity(name: string): undefined | ParallelSplitActivity;
        getSingleUserTaskActivity(name: string): undefined | SingleUserTaskActivity;
        getStartWorkflowActivity(name: string): undefined | StartWorkflowActivity;
        getWaitForNotificationActivity(
            name: string,
        ): undefined | WaitForNotificationActivity;
        getWaitForTimerActivity(name: string): undefined | WaitForTimerActivity;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type $UnitID? activities

    Methods

    addAIAgentTaskActivity addCallMicroflowActivity addCallWorkflowActivity addEndOfBoundaryEventPathActivity addEndOfParallelSplitPathActivity addEndWorkflowActivity addExclusiveSplitActivity addInterruptingNotificationEventSubProcessStartActivity addJumpToActivity addMergeActivity addMultiUserTaskActivity addNonInterruptingNotificationEventSubProcessStartActivity addParallelSplitActivity addSingleUserTaskActivity addStartWorkflowActivity addWaitForNotificationActivity addWaitForTimerActivity getAIAgentTaskActivity getCallMicroflowActivity getCallWorkflowActivity getEndOfBoundaryEventPathActivity getEndOfParallelSplitPathActivity getEndWorkflowActivity getExclusiveSplitActivity getInterruptingNotificationEventSubProcessStartActivity getJumpToActivity getMergeActivity getMultiUserTaskActivity getNonInterruptingNotificationEventSubProcessStartActivity getParallelSplitActivity getSingleUserTaskActivity getStartWorkflowActivity getWaitForNotificationActivity getWaitForTimerActivity

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Workflows$Flow"

    The type of the element.

    $UnitID?: string
    activities: WorkflowActivity[]

    Methods

    Settings

    On This Page

    Properties
    Methods
    addAIAgentTaskActivityaddCallMicroflowActivityaddCallWorkflowActivityaddEndOfBoundaryEventPathActivityaddEndOfParallelSplitPathActivityaddEndWorkflowActivityaddExclusiveSplitActivityaddInterruptingNotificationEventSubProcessStartActivityaddJumpToActivityaddMergeActivityaddMultiUserTaskActivityaddNonInterruptingNotificationEventSubProcessStartActivityaddParallelSplitActivityaddSingleUserTaskActivityaddStartWorkflowActivityaddWaitForNotificationActivityaddWaitForTimerActivitygetAIAgentTaskActivitygetCallMicroflowActivitygetCallWorkflowActivitygetEndOfBoundaryEventPathActivitygetEndOfParallelSplitPathActivitygetEndWorkflowActivitygetExclusiveSplitActivitygetInterruptingNotificationEventSubProcessStartActivitygetJumpToActivitygetMergeActivitygetMultiUserTaskActivitygetNonInterruptingNotificationEventSubProcessStartActivitygetParallelSplitActivitygetSingleUserTaskActivitygetStartWorkflowActivitygetWaitForNotificationActivitygetWaitForTimerActivity