Class ApprovalPlugin

Inheritance

↳ object

    ↳ WorkflowActionProvider<ActionsApprovalPlugin,ActionsAsyncApprovalPlugin,ConditionsApprovalPlugin,ConditionsAsyncApprovalPlugin>

        ↳ WorkflowActionAndDesignerParameterFormatProvider<ActionsApprovalPlugin,ActionsAsyncApprovalPlugin,ConditionsApprovalPlugin,ConditionsAsyncApprovalPlugin>

            ↳ CustomMixProvider<ActionsApprovalPlugin,ActionsAsyncApprovalPlugin,ConditionsApprovalPlugin,ConditionsAsyncApprovalPlugin>

                ↳ WorkflowPlugin<ActionsApprovalPlugin,ActionsAsyncApprovalPlugin,ConditionsApprovalPlugin,ConditionsAsyncApprovalPlugin>

                    ↳ ApprovalPlugin

Implements

ICustomMixProvider

ICustomWorkflowActionProvider

IWorkflowActionProvider

IDisableProvider

ICustomDesignerParameterFormatProvider

IDesignerParameterFormatProvider

ICustomActivityProvider

ICustomConditionProvider

IWorkflowPlugin

Inherited Members

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Disabled

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.DefaultValues

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Name

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ShowSettingsParameters

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.PluginSettings

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.OnPluginAdd(WorkflowRuntime, List<string>)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.OnRuntimeStartAsync(WorkflowRuntime)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameterOrFromSettingsOrDefault<TParameter>(Dictionary<string, string>, TParameter, string, bool)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IfSettingNotSetOrShowSettingsParameters(Action, Enum)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SetSettingDefaultValue(Enum, string)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SettingValue(Enum, string)

WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.SetSettingNewValue(Enum, string)

CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>.GetCustomActivities()

CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>.GetCustomConditions()

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncFormats

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameter<TParameter>(Dictionary<string, string>, TParameter)

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetParameterOrDefault<TParameter>(Dictionary<string, string>, TParameter, string, bool)

WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetFormat(CodeActionType, string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Actions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsync

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.Conditions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsync

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncTemplates

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncDescriptions

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncTemplates

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionsAsyncExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ConditionsAsyncExcludeRule

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExcludeAction(string, ExcludeRule)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExcludeCondition(string, ExcludeRule)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ActionParameter

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteAction(string, ProcessInstance, WorkflowRuntime, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteActionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteCondition(string, ProcessInstance, WorkflowRuntime, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ExecuteConditionAsync(string, ProcessInstance, WorkflowRuntime, string, CancellationToken)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActions(string, NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditions(string, NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IsActionAsync(string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActionsAsync(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetActions(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditions(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.GetConditionsAsync(NamesSearchType)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.IsConditionAsync(string, string)

WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>.ToParameters(string)

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Plugins

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public class ApprovalPlugin : WorkflowPlugin<ActionsApprovalPlugin, ActionsAsyncApprovalPlugin, ConditionsApprovalPlugin, ConditionsAsyncApprovalPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin

Constructors

ApprovalPlugin()

Declaration

public ApprovalPlugin()

Properties

AllowedActorsFilter

The filter for allowed actors. When applied, only actors that meet the specified criteria will be included. Restricted actors remain unaffected by this filter.

Declaration

public Func<string, bool> AllowedActorsFilter { get; set; }

Property value

Type	Description
Func<string, bool>

DisableApprovalHistory

Disables Approval History, preventing the creation of records in the approval history table.

Declaration

public bool DisableApprovalHistory { get; set; }

Property value

Type	Description
bool

DisableInbox

Disables the inbox, preventing access to the list of users and available commands for the current approval stage.

Declaration

public bool DisableInbox { get; set; }

Property value

Type	Description
bool

Name

Declaration

public override string Name { get; protected set; }

Property value

Type	Description
string

Methods

InitialActions()

Declaration

protected virtual void InitialActions()

InitialActionsAsync()

Declaration

protected virtual void InitialActionsAsync()

ActionGetApprovalHistoryAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration

public virtual Task ActionGetApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
Dictionary<string, string>	parameters
CancellationToken	token

Returns

Type	Description
Task

ActionGetInboxAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration

public virtual Task ActionGetInboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
Dictionary<string, string>	parameters
CancellationToken	token

Returns

Type	Description
Task

ActionGetOutboxAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration

public virtual Task ActionGetOutboxAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
Dictionary<string, string>	parameters
CancellationToken	token

Returns

Type	Description
Task

ActionFillApprovalHistoryAsync(ProcessInstance, WorkflowRuntime, Dictionary<string, string>, CancellationToken)

Declaration

public virtual Task ActionFillApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
Dictionary<string, string>	parameters
CancellationToken	token

Returns

Type	Description
Task

InitialExclude()

Declaration

protected virtual void InitialExclude()

OnPluginAdd(WorkflowRuntime, List<string>)

Declaration

public override void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
List<string>	schemes

OnPluginRemoveAsync(WorkflowRuntime)

Declaration

public Task OnPluginRemoveAsync(WorkflowRuntime runtime)

Parameters

Type	Name	Description
WorkflowRuntime	runtime

Returns

Type	Description
Task

OnProcessActivityChangedAsync(WorkflowRuntime, ProcessInstance, CancellationToken)

Declaration

protected virtual Task OnProcessActivityChangedAsync(WorkflowRuntime runtime, ProcessInstance processInstance, CancellationToken token)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
ProcessInstance	processInstance
CancellationToken	token

Returns

Type	Description
Task

GetNextOrderForApprovalHistoryAsync(ProcessInstance, WorkflowRuntime)

Declaration

protected virtual Task<long> GetNextOrderForApprovalHistoryAsync(ProcessInstance processInstance, WorkflowRuntime runtime = null)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime

Returns

Type	Description
Task<long>

InitialConditions()

Declaration

protected virtual void InitialConditions()

InitialConditionsAsync()

Declaration

protected virtual void InitialConditionsAsync()

InitialActionsDescriptions()

Declaration

protected virtual void InitialActionsDescriptions()

InitialActionsAsyncDescriptions()

Declaration

protected virtual void InitialActionsAsyncDescriptions()

InitialConditionsDescriptions()

Declaration

protected virtual void InitialConditionsDescriptions()

InitialConditionsAsyncDescriptions()

Declaration

protected virtual void InitialConditionsAsyncDescriptions()

InitialFormatsActions()

Declaration

protected virtual void InitialFormatsActions()

InitialFormatsActionsAsync()

Declaration

protected virtual void InitialFormatsActionsAsync()

InitialFormatsConditions()

Declaration

protected virtual void InitialFormatsConditions()

InitialFormatsConditionsAsync()

Declaration

protected virtual void InitialFormatsConditionsAsync()

FormatFillApprovalHistory()

Declaration

public virtual List<CodeActionParameterDefinition> FormatFillApprovalHistory()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatGetApprovalHistory()

Declaration

public virtual List<CodeActionParameterDefinition> FormatGetApprovalHistory()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatGetInbox()

Declaration

public virtual List<CodeActionParameterDefinition> FormatGetInbox()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatGetOutbox()

Declaration

public virtual List<CodeActionParameterDefinition> FormatGetOutbox()

Returns

Type	Description
List<CodeActionParameterDefinition>

Fields

GetUserNamesByIds

Declaration

public Func<List<string>, List<string>> GetUserNamesByIds

Returns

Type	Description
Func<List<string>, List<string>>

InboxActorsWithOnlyRejectCommands

Declaration

public bool InboxActorsWithOnlyRejectCommands

Returns

Type	Description
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.

Declaration

public bool InboxCheckConditions

Returns

Type	Description
bool

AutoApprovalHistory

Declaration

public bool AutoApprovalHistory

Returns

Type	Description
bool

NameParameterForComment

Declaration

public string NameParameterForComment

Returns

Type	Description
string

Extension Methods

• ICustomMixProviderExtension.ValidateActionsConditionsAndFormats(ICustomMixProvider)
• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)