Class RealTimeTrackingPlugin
OptimaJet.Workflow.RealTimeTrackingPlugin.RealTimeTrackingPlugin
The RealTimeTrackingPlugin is responsible for providing real-time tracking functionality to the Workflow Engine Designer.
Namespace: OptimaJet.Workflow.RealTimeTrackingPlugin
public class RealTimeTrackingPlugin : IWorkflowPluginType Hierarchy
- RealTimeTrackingPlugin Current type
- Implemented interfaces
Constructors
public RealTimeTrackingPlugin(NotifierService notifierService) #Creates a new instance of the RealTimeTrackingPlugin class.
Parameters
Name
Type
Description
notifierServiceNotifierServiceThe notifier service to use for real-time tracking.
public RealTimeTrackingPlugin(NotifierService notifierService, RealTimeTrackingPluginSettings settings) #Creates a new instance of the RealTimeTrackingPlugin class.
Parameters
Name
Type
Description
notifierServiceNotifierServiceThe notifier service to use for real-time tracking.
settingsRealTimeTrackingPluginSettingsThe settings to use for the real-time tracking plugin.
public RealTimeTrackingPlugin(IServiceProvider serviceProvider) #Creates a new instance of the RealTimeTrackingPlugin class.
Parameters
Name
Type
Description
serviceProviderIServiceProviderThe service provider to get instance of NotifierService for real-time tracking.
public RealTimeTrackingPlugin(IServiceProvider serviceProvider, RealTimeTrackingPluginSettings settings) #Creates a new instance of the RealTimeTrackingPlugin class.
Parameters
Name
Type
Description
serviceProviderIServiceProviderThe service provider to get instance of NotifierService for real-time tracking.
settingsRealTimeTrackingPluginSettingsThe settings to use for the real-time tracking plugin.
Properties
public string Name { get; } #The plugin name.
public bool Disabled { get; set; } #Flag to disable plugin, if true - plugin is disabled, false otherwise.
public Dictionary<string, string> PluginSettings { get; } #The plugin settings.
Methods
public void OnPluginAdd(WorkflowRuntime runtime, List<string>? schemes = null) #Called when a plugin is added to a runtime.
Parameters
Name
Type
Description
runtimeWorkflowRuntimeThe instance of the runtime.
schemesList<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
runtimeWorkflowRuntimeThe instance of the runtime.
Returns
Type
Description
TaskA task that represents the asynchronous operation.