Assembly: OptimaJet.Workflow.FormsPlugin

Class FormsPlugin

OptimaJet.Workflow.Plugins.FormsPlugin.FormsPlugin

The plugin for managing forms in the Workflow Engine.

Namespace: OptimaJet.Workflow.Plugins.FormsPlugin

public class FormsPlugin : IWorkflowPlugin

Type Hierarchy

Constructors

public FormsPlugin(FormsPluginSettings settings) #
Represents a plugin that executes forms along with process instances.

Parameters

Name
Type
Description
settings
FormsPluginSettings

Properties

public string Name { get; } #
The plugin name.
public bool Disabled { get; set; } #
Flag to disable plugin, if true - plugin is disabled, false otherwise.
[Obsolete("Use the Settings property instead.")] public Dictionary<string, string> PluginSettings { get; } Obsolete #
The plugin settings.
public FormsPluginSettings Settings { get; } #
Gets the plugin settings for configuring the behavior and properties of the FormsPlugin.

Methods

public void OnPluginAdd(WorkflowRuntime runtime, List<string>? schemes = null) #
Called when a plugin is added to a runtime.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime.
schemes
List<String>
The list of schemes for which the plugin is being added.
public Task OnRuntimeStartAsync(WorkflowRuntime runtime) #
Called when the runtime is started.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime.

Returns

Type
Description
Task
A task that represents the asynchronous operation.