Class ApprovalPlugin
OptimaJet.Workflow.Plugins.ApprovalPlugin
Namespace: OptimaJet.Workflow.Plugins
public class ApprovalPlugin : WorkflowPlugin<ActionsApprovalPlugin, ActionsAsyncApprovalPlugin, ConditionsApprovalPlugin, ConditionsAsyncApprovalPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPluginType Hierarchy
- WorkflowActionProvider<ActionsApprovalPlugin, ActionsAsyncApprovalPlugin, ConditionsApprovalPlugin, ConditionsAsyncApprovalPlugin>
- WorkflowActionAndDesignerParameterFormatProvider<ActionsApprovalPlugin, ActionsAsyncApprovalPlugin, ConditionsApprovalPlugin, ConditionsAsyncApprovalPlugin>
Constructors
public ApprovalPlugin() #Properties
public Func<string, bool> AllowedActorsFilter { get; set; } #The filter for allowed actors. When applied, only actors that meet the specified criteria will be included. Restricted actors remain unaffected by this filter.
public bool DisableApprovalHistory { get; set; } #Disables Approval History, preventing the creation of records in the approval history table.
public bool DisableInbox { get; set; } #Disables the inbox, preventing access to the list of users and available commands for the current approval stage.
public bool UseLocalizedNamesInApprovalHistory { get; set; } #When enabled, localized state and command names are written to approval history.
public override string Name { get; protected set; } #The plugin name.
Methods
protected virtual void InitialActions() #protected virtual void InitialActionsAsync() #public virtual Task ActionGetApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #Parameters
Name
Type
Description
processInstanceProcessInstanceruntimeWorkflowRuntimeparametersDictionary<String, String>tokenCancellationTokenReturns
Type
Description
Taskpublic virtual Task ActionGetInboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #Parameters
Name
Type
Description
processInstanceProcessInstanceruntimeWorkflowRuntimeparametersDictionary<String, String>tokenCancellationTokenReturns
Type
Description
Taskpublic virtual Task ActionGetOutboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #Parameters
Name
Type
Description
processInstanceProcessInstanceruntimeWorkflowRuntimeparametersDictionary<String, String>tokenCancellationTokenReturns
Type
Description
Taskpublic virtual Task ActionFillApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #Parameters
Name
Type
Description
processInstanceProcessInstanceruntimeWorkflowRuntimeparametersDictionary<String, String>tokenCancellationTokenReturns
Type
Description
Taskprotected virtual void InitialExclude() #public override 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 OnPluginRemoveAsync(WorkflowRuntime runtime) #Parameters
Name
Type
Description
runtimeWorkflowRuntimeReturns
Type
Description
Taskprotected virtual Task OnProcessActivityChangedAsync(WorkflowRuntime runtime, ProcessInstance processInstance, CancellationToken token) #Parameters
Name
Type
Description
runtimeWorkflowRuntimeprocessInstanceProcessInstancetokenCancellationTokenReturns
Type
Description
Taskprotected virtual Task<long> GetNextOrderForApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime = null) #Parameters
Name
Type
Description
processInstanceProcessInstanceruntimeWorkflowRuntimeReturns
Type
Description
Task<Int64>protected virtual void InitialConditions() #protected virtual void InitialConditionsAsync() #protected virtual void InitialActionsDescriptions() #protected virtual void InitialActionsAsyncDescriptions() #protected virtual void InitialConditionsDescriptions() #protected virtual void InitialConditionsAsyncDescriptions() #protected virtual void InitialFormatsActions() #protected virtual void InitialFormatsActionsAsync() #protected virtual void InitialFormatsConditions() #protected virtual void InitialFormatsConditionsAsync() #public virtual List<CodeActionParameterDefinition> FormatFillApprovalHistory() #Returns
Type
Description
List<CodeActionParameterDefinition>public virtual List<CodeActionParameterDefinition> FormatGetApprovalHistory() #Returns
Type
Description
List<CodeActionParameterDefinition>public virtual List<CodeActionParameterDefinition> FormatGetInbox() #Returns
Type
Description
List<CodeActionParameterDefinition>public virtual List<CodeActionParameterDefinition> FormatGetOutbox() #Returns
Type
Description
List<CodeActionParameterDefinition>Fields
public Func<List<string>, List<string>> GetUserNamesByIds #public bool InboxActorsWithOnlyRejectCommands #public bool InboxCheckConditions #When this setting is enabled, transition conditions will be checked during inbox filling, and only transitions for which the conditions are met will be included in the inbox.
public bool AutoApprovalHistory #public string NameParameterForComment #