Skip to main content

Introducing Formengine - The New Formbuilder, try for FREE formengine.io.

Class TriggerDefinition

Represent a transition's trigger in a process scheme

Inheritance

↳ object

    ↳ TriggerDefinition

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Model

Assembly: OptimaJet.Workflow.Core.dll

Syntax
public class TriggerDefinition

Constructors

TriggerDefinition(TriggerType)

Create TriggerDefinition object

Declaration
public TriggerDefinition(TriggerType type)
Parameters
TypeNameDescription
TriggerTypetypeType of the trigger <xref href="OptimaJet.Workflow.Core.Model.TriggerType" data-throw-if-not-resolved="false"></xref>

Properties

Type

Type of the trigger TriggerType

Declaration
[JsonConverter(typeof(StringEnumConverter))]
public TriggerType Type { get; set; }
Property value
TypeDescription
TriggerType

NameRef

Returns the name of the object in scheme which start the trigger

Declaration
public string NameRef { get; }
Property value
TypeDescription
string

Command

Command which start the trigger if the type of the trigger is command TriggerType.Command

Declaration
public CommandDefinition Command { get; set; }
Property value
TypeDescription
CommandDefinition

Timer

Timer which start the trigger if the type of the trigger is timer TriggerType.Timer

Declaration
public TimerDefinition Timer { get; set; }
Property value
TypeDescription
TimerDefinition

Auto

Create the instance of TriggerDefinition object with auto trigger type TriggerType.Auto

Declaration
public static TriggerDefinition Auto { get; }
Property value
TypeDescription
TriggerDefinition

Methods

Create(string)

Create TriggerDefinition object

Declaration
public static TriggerDefinition Create(string type)
Parameters
TypeNameDescription
stringtypeType of the trigger <xref href="OptimaJet.Workflow.Core.Model.TriggerType" data-throw-if-not-resolved="false"></xref>
Returns
TypeDescription
TriggerDefinitionTriggerDefinition object

CreateTimerTrigger(TimerDefinition)

Creates timer trigger

Declaration
public static TriggerDefinition CreateTimerTrigger(TimerDefinition timer)
Parameters
TypeNameDescription
TimerDefinitiontimerTimer definition
Returns
TypeDescription
TriggerDefinition

CreateCommandTrigger(CommandDefinition)

Creates command trigger

Declaration
public static TriggerDefinition CreateCommandTrigger(CommandDefinition command)
Parameters
TypeNameDescription
CommandDefinitioncommandCommand definition
Returns
TypeDescription
TriggerDefinition

Clone()

Declaration
public TriggerDefinition Clone()
Returns
TypeDescription
TriggerDefinition

Clone(List<CommandDefinition>, List<TimerDefinition>)

Clones TriggerDefinition object replacing references to the references to the specific objects

Declaration
public TriggerDefinition Clone(List<CommandDefinition> commandDefinitions, List<TimerDefinition> timerDefinitions)
Parameters
TypeNameDescription
List<CommandDefinition>commandDefinitionsList of the commands to replace
List<TimerDefinition>timerDefinitionsList of the timers to replace
Returns
TypeDescription
TriggerDefinitionCloned TriggerDefinition object

Extension Methods