Class BasicPlugin

Inheritance

↳ object

    ↳ WorkflowActionProvider<ActionsBasicPlugin,ActionsAsyncBasicPlugin,ConditionsBasicPlugin,ConditionsAsyncBasicPlugin>

        ↳ WorkflowActionAndDesignerParameterFormatProvider<ActionsBasicPlugin,ActionsAsyncBasicPlugin,ConditionsBasicPlugin,ConditionsAsyncBasicPlugin>

            ↳ CustomMixProvider<ActionsBasicPlugin,ActionsAsyncBasicPlugin,ConditionsBasicPlugin,ConditionsAsyncBasicPlugin>

                ↳ WorkflowPlugin<ActionsBasicPlugin,ActionsAsyncBasicPlugin,ConditionsBasicPlugin,ConditionsAsyncBasicPlugin>

                    ↳ WorkflowPluginWithRuleProvider<ActionsBasicPlugin,ActionsAsyncBasicPlugin,ConditionsBasicPlugin,ConditionsAsyncBasicPlugin,RulesBasicPlugin,RulesAsyncBasicPlugin>

                        ↳ BasicPlugin

Implements

ICustomMixProvider

ICustomWorkflowActionProvider

IWorkflowActionProvider

IDisableProvider

ICustomDesignerParameterFormatProvider

IDesignerParameterFormatProvider

ICustomActivityProvider

ICustomConditionProvider

IWorkflowPlugin

ICustomWorkflowRuleProvider

IWorkflowRuleProvider

Inherited Members

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesExcludeRule

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesAsyncExcludeRule

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesCheck

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesCheckAsync

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesGetIdentities

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.RulesGetIdentitiesAsync

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.GetRules(NamesSearchType)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.GetRulesAsync(NamesSearchType)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.GetRules(string, NamesSearchType)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.Check(ProcessInstance, WorkflowRuntime, string, string, string)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.CheckAsync(ProcessInstance, WorkflowRuntime, string, string, string, CancellationToken)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.GetIdentities(ProcessInstance, WorkflowRuntime, string, string)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.GetIdentitiesAsync(ProcessInstance, WorkflowRuntime, string, string, CancellationToken)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.IsCheckAsync(string, string)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.IsGetIdentitiesAsync(string, string)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.ExcludeRule(string, ExcludeRule)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.ValidateRules(out List<string>, bool)

WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>.ValidateRulesAsync(out List<string>, bool)

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 BasicPlugin : WorkflowPluginWithRuleProvider<ActionsBasicPlugin, ActionsAsyncBasicPlugin, ConditionsBasicPlugin, ConditionsAsyncBasicPlugin, RulesBasicPlugin, RulesAsyncBasicPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin, ICustomWorkflowRuleProvider, IWorkflowRuleProvider

Constructors

BasicPlugin()

Declaration

public BasicPlugin()

BasicPlugin(Dictionary<string, string>)

Declaration

public BasicPlugin(Dictionary<string, string> pluginSettings)

Parameters

Type	Name	Description
Dictionary<string, string>	pluginSettings

Properties

Name

Declaration

public override string Name { get; protected set; }

Property value

Type	Description
string

UsersInRoleAsync

Declaration

public UsersInRoleAsyncDelegate UsersInRoleAsync { get; set; }

Property value

Type	Description
UsersInRoleAsyncDelegate

Setting_Mailserver

Declaration

public string Setting_Mailserver { get; set; }

Property value

Type	Description
string

Setting_MailserverPort

Declaration

public int Setting_MailserverPort { get; set; }

Property value

Type	Description
int

Setting_MailserverFrom

Declaration

public string Setting_MailserverFrom { get; set; }

Property value

Type	Description
string

Setting_MailserverLogin

Declaration

public string Setting_MailserverLogin { get; set; }

Property value

Type	Description
string

Setting_MailserverPassword

Declaration

public string Setting_MailserverPassword { get; set; }

Property value

Type	Description
string

Setting_MailserverSsl

Declaration

public bool Setting_MailserverSsl { get; set; }

Property value

Type	Description
bool

Setting_DontCompileExpressions

Use this setting for compatibility only

Declaration

[Obsolete]
public bool Setting_DontCompileExpressions { get; set; }

Property value

Type	Description
bool

Methods

InitialActions()

Declaration

protected virtual void InitialActions()

InitialActionsAsync()

Declaration

protected virtual void InitialActionsAsync()

ActionAsyncSetActivity(ProcessInstance, WorkflowRuntime, Dictionary<string, string>)

Declaration

protected virtual void ActionAsyncSetActivity(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters)

Parameters

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

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

Declaration

protected virtual Task ActionAsyncExecuteCommand(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

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

Declaration

protected virtual Task ActionAsyncSetState(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

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

Declaration

public virtual Task ActionSetParameterAsync(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

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

Declaration

public virtual Task ActionSendEmailAsync(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

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

Declaration

public virtual Task ActionCreateProcessAsync(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

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

Declaration

public virtual Task ActionHttpRequestAsync(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

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

Declaration

public virtual Task ActionFillApproversUsersAsync(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

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

Declaration

public virtual Task ActionFillApproversRolesAsync(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

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

Declaration

public virtual Task ActionRemoveParameterAsync(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

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

Declaration

public virtual Task ActionDeleteSubprocessesAsync(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

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

Declaration

public virtual Task ActionClearApproversAsync(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

StoreResponse(HttpResponseMessage, ProcessInstance, Dictionary<string, string>)

Declaration

protected virtual Task StoreResponse(HttpResponseMessage res, ProcessInstance processInstance, Dictionary<string, string> parameters)

Parameters

Type	Name	Description
HttpResponseMessage	res
ProcessInstance	processInstance
Dictionary<string, string>	parameters

Returns

Type	Description
Task

StoreResponse(string, ProcessInstance, Dictionary<string, string>)

Declaration

protected virtual Task StoreResponse(string data, ProcessInstance processInstance, Dictionary<string, string> parameters)

Parameters

Type	Name	Description
string	data
ProcessInstance	processInstance
Dictionary<string, string>	parameters

Returns

Type	Description
Task

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

InitialExclude()

Declaration

protected virtual void InitialExclude()

InitialSettings()

Declaration

protected virtual void InitialSettings()

WithActor(string, List<string>)

Adds an actor to the collection of predefined actors in all schemes specified in the collection. It is supposed to be used before plugin initialization.

Declaration

public void WithActor(string actor, List<string> schemes = null)

Parameters

Type	Name	Description
string	actor	Actor name.
List<string>	schemes	Collection of scheme codes for adding an actor.

WithActors(List<string>, List<string>)

Adds an actors collection to the collection of predefined actors in all schemes specified in the collection. It is supposed to be used before plugin initialization.

Declaration

public void WithActors(List<string> actors, List<string> schemes = null)

Parameters

Type	Name	Description
List<string>	actors	Collection of actors names.
List<string>	schemes	Collection of scheme codes for adding an actor.

GetApprovers(ProcessInstance, string)

Declaration

public static Approvers GetApprovers(ProcessInstance processInstance, string name)

Parameters

Type	Name	Description
ProcessInstance	processInstance
string	name

Returns

Type	Description
Approvers

OnProcessStatusChangedAsync(object, ProcessStatusChangedEventArgs, CancellationToken)

Declaration

protected virtual Task OnProcessStatusChangedAsync(object handler, ProcessStatusChangedEventArgs e, CancellationToken token)

Parameters

Type	Name	Description
object	handler
ProcessStatusChangedEventArgs	e
CancellationToken	token

Returns

Type	Description
Task

RuleGetApprovers(ProcessInstance)

Declaration

protected virtual Task<IEnumerable<string>> RuleGetApprovers(ProcessInstance processInstance)

Parameters

Type	Name	Description
ProcessInstance	processInstance

Returns

Type	Description
Task<IEnumerable<string>>

GetAutocompleteSuggestions(SuggestionCategory, string, string)

Declaration

public virtual List<string> GetAutocompleteSuggestions(SuggestionCategory category, string value, string schemeCode)

Parameters

Type	Name	Description
SuggestionCategory	category
string	value
string	schemeCode

Returns

Type	Description
List<string>

GetCustomActivities()

Declaration

public override List<ActivityBase> GetCustomActivities()

Returns

Type	Description
List<ActivityBase>

InitialConditions()

Declaration

protected virtual void InitialConditions()

InitialConditionsAsync()

Declaration

protected virtual void InitialConditionsAsync()

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

Declaration

public virtual Task<bool> ConditionCheckParameterAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionCheckApproversExistAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionCheckAllSubprocessesCompletedAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionIsProcessFinishAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionIsApprovedByRolesAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionIsApprovedByUsersAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionCheckHttpRequestAsync(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<bool>

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

Declaration

public virtual Task<bool> ConditionIsApproveCompleteAsync(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<bool>

InitialActionsDescriptions()

Declaration

protected virtual void InitialActionsDescriptions()

InitialActionsAsyncDescriptions()

Declaration

protected virtual void InitialActionsAsyncDescriptions()

InitialActionsAsyncTemplates()

Declaration

protected virtual void InitialActionsAsyncTemplates()

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()

FormatSetActivity()

Declaration

public virtual List<CodeActionParameterDefinition> FormatSetActivity()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatsExecuteCommand()

Declaration

public virtual List<CodeActionParameterDefinition> FormatsExecuteCommand()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatsSetState()

Declaration

public virtual List<CodeActionParameterDefinition> FormatsSetState()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatRemoveParameter()

Declaration

public virtual List<CodeActionParameterDefinition> FormatRemoveParameter()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatSetParameter()

Declaration

public virtual List<CodeActionParameterDefinition> FormatSetParameter()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatSendEmail()

Declaration

public virtual List<CodeActionParameterDefinition> FormatSendEmail()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatCreateProcess()

Declaration

public virtual List<CodeActionParameterDefinition> FormatCreateProcess()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatHTTPRequest()

Declaration

public virtual List<CodeActionParameterDefinition> FormatHTTPRequest()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatFillApproversUsers()

Declaration

public virtual List<CodeActionParameterDefinition> FormatFillApproversUsers()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatFillApproversRoles()

Declaration

public virtual List<CodeActionParameterDefinition> FormatFillApproversRoles()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatCheckParameter()

Declaration

public virtual List<CodeActionParameterDefinition> FormatCheckParameter()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatCheckApproversExist()

Declaration

public virtual List<CodeActionParameterDefinition> FormatCheckApproversExist()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatCheckHTTPRequest()

Declaration

public virtual List<CodeActionParameterDefinition> FormatCheckHTTPRequest()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatIsApprovedByUsers()

Declaration

public virtual List<CodeActionParameterDefinition> FormatIsApprovedByUsers()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatIsApprovedByRoles()

Declaration

public virtual List<CodeActionParameterDefinition> FormatIsApprovedByRoles()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatIsApproveComplete()

Declaration

public virtual List<CodeActionParameterDefinition> FormatIsApproveComplete()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatIsProcessFinish()

Declaration

public virtual List<CodeActionParameterDefinition> FormatIsProcessFinish()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatCheckAllSubprocessesCompleted()

Declaration

public virtual List<CodeActionParameterDefinition> FormatCheckAllSubprocessesCompleted()

Returns

Type	Description
List<CodeActionParameterDefinition>

FormatDeleteSubprocesses()

Declaration

public virtual List<CodeActionParameterDefinition> FormatDeleteSubprocesses()

Returns

Type	Description
List<CodeActionParameterDefinition>

InitialRulesCheck()

Declaration

protected virtual void InitialRulesCheck()

InitialRulesCheckAsync()

Declaration

protected virtual void InitialRulesCheckAsync()

InitialRulesGetIdentities()

Declaration

protected virtual void InitialRulesGetIdentities()

InitialRulesGetIdentitiesAsync()

Declaration

protected virtual void InitialRulesGetIdentitiesAsync()

ApproverCheckAsync(ProcessInstance, WorkflowRuntime, string, string, string, CancellationToken)

Declaration

public virtual Task<bool> ApproverCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	identityId
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<bool>

PredefinedCheckAsync(ProcessInstance, WorkflowRuntime, string, string, string, CancellationToken)

Declaration

public virtual Task<bool> PredefinedCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	identityId
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<bool>

CheckRoleCheckAsync(ProcessInstance, WorkflowRuntime, string, string, string, CancellationToken)

Declaration

public virtual Task<bool> CheckRoleCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string identityId, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	identityId
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<bool>

ApproverCheckAsync(ProcessInstance, WorkflowRuntime, string, string, CancellationToken)

Declaration

public virtual Task<IEnumerable<string>> ApproverCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<IEnumerable<string>>

PredefinedCheckAsync(ProcessInstance, WorkflowRuntime, string, string, CancellationToken)

Declaration

public virtual Task<IEnumerable<string>> PredefinedCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<IEnumerable<string>>

CheckRoleCheckAsync(ProcessInstance, WorkflowRuntime, string, string, CancellationToken)

Declaration

public virtual Task<IEnumerable<string>> CheckRoleCheckAsync(ProcessInstance processInstance, WorkflowRuntime runtime, string ruleName, string parameter, CancellationToken token)

Parameters

Type	Name	Description
ProcessInstance	processInstance
WorkflowRuntime	runtime
string	ruleName
string	parameter
CancellationToken	token

Returns

Type	Description
Task<IEnumerable<string>>

Fields

PredefinedActorProvider

Allows to thread-safely control collections of predefined actors.

Declaration

public readonly IActorProvider PredefinedActorProvider

Returns

Type	Description
IActorProvider

RequestHeaders

Declaration

public Dictionary<string, string> RequestHeaders

Returns

Type	Description
Dictionary<string, string>

ApproversInStageAsync

Declaration

public ApproversInStageAsyncDelegate ApproversInStageAsync

Returns

Type	Description
ApproversInStageAsyncDelegate

CheckPredefinedActorAsync

Declaration

public CheckPredefinedActorAsyncDelegate CheckPredefinedActorAsync

Returns

Type	Description
CheckPredefinedActorAsyncDelegate

GetPredefinedIdentitiesAsync

Declaration

public GetPredefinedIdentitiesAsyncDelegate GetPredefinedIdentitiesAsync

Returns

Type	Description
GetPredefinedIdentitiesAsyncDelegate

UpdateDocumentStateAsync

Declaration

public UpdateDocumentStateDelegate UpdateDocumentStateAsync

Returns

Type	Description
UpdateDocumentStateDelegate

Extension Methods

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