Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>

OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>

Namespace: OptimaJet.Workflow.Plugins.CustomWorkflowProviders

public abstract class WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync> : CustomMixProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin where TEnumActions : struct where TEnumActionsAsync : struct where TEnumConditions : struct where TEnumConditionsAsync : struct

Inheritance

  • System.Object
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionProvider{{TEnumActions},{TEnumActionsAsync},{TEnumConditions},{TEnumConditionsAsync}}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionAndDesignerParameterFormatProvider{{TEnumActions},{TEnumActionsAsync},{TEnumConditions},{TEnumConditionsAsync}}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.CustomMixProvider{{TEnumActions},{TEnumActionsAsync},{TEnumConditions},{TEnumConditionsAsync}}

Implemented Interfaces

Properties

Name
Type
Disabled #
Boolean
DefaultValues #
Dictionary<String>
Name #
String
The plugin name.
ShowSettingsParameters #
Boolean
PluginSettings #
Dictionary<String>
The plugin settings.

Methods

public abstract 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 virtual 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.
protected string GetParameterOrFromSettingsOrDefault<TParameter>(Dictionary<string, string> parameters, TParameter parameterName, string defaultValue, bool canBeNullOrEmpty = true) where TParameter : struct #

Parameters

Name
Type
Description
parameters
Dictionary<String>
parameterName
{TParameter}
defaultValue
String
canBeNullOrEmpty
Boolean

Returns

Type
Description
String
protected void IfSettingNotSetOrShowSettingsParameters(Action action, Enum parameter) #

Parameters

Name
Type
Description
action
Action
parameter
Enum
public virtual void SetSettingDefaultValue(Enum parameter, string value) #

Parameters

Name
Type
Description
parameter
Enum
value
String
public virtual string SettingValue(Enum parameter, string defaultValue = null) #

Parameters

Name
Type
Description
parameter
Enum
defaultValue
String

Returns

Type
Description
String
public virtual void SetSettingNewValue(Enum parameter, string value) #

Parameters

Name
Type
Description
parameter
Enum
value
String