Class BaseTriggerParameter
The base action trigger task parameter for the action trigger calculation process
Inherits from the item server task parameter which records the id and label of the item of type RootItemTypeID this task should be calculated against
When a IActionTrigger is activated it can be configured to run any type of trigger task (those that inherit BaseTriggerTask) with associated parameters that inherit these parameters. See NotificationTriggerParameter for an exampleInheritance
Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters.Triggers
Assembly: API.dll
Syntax
[DataContract]
public abstract class BaseTriggerParameter : ItemParameter, ICloneable, INotifyPropertyChanged
Constructors
BaseTriggerParameter()
Creates a new base trigger parameter
Declaration
public BaseTriggerParameter()
Properties
RootItemTypeID
The type of the item that the ID is holding a reference to
Declaration
public Guid RootItemTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
SaveTimeStamp
The timestamp of when this action was triggered
Declaration
public DateTimeOffset? SaveTimeStamp { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTimeOffset> |
TriggeredContexts
The list of triggered actions and their associated contexts
Declaration
public IDictionary<IActionTrigger, List<TriggerContext>> TriggeredContexts { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IDictionary<IActionTrigger, System.Collections.Generic.List<TriggerContext>> |
TrigggerID
The id of the IActionTrigger that triggered this action
Declaration
public Guid TrigggerID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
TrigggerID_Label
The label of the IActionTrigger that triggered this action
Declaration
public string TrigggerID_Label { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask)
This task is configured from, and triggered by, the action trigger task itself. So it should not allow the save to be enabled even with no changes
Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The item that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | false |
Overrides
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(BaseTriggerParameter)
Declaration
public void CopyFromSource(BaseTriggerParameter source)
Parameters
Type | Name | Description |
---|---|---|
BaseTriggerParameter | source |
DisplayUserParamOnSave(IHasSaveProcessingTask)
This task is configured from, and triggered by, the action trigger task itself. So it should not display any parameters on save
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The item that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | false |
Overrides
ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)
This task is configured from, and triggered by, the action trigger task itself. So it should not automatically create a task
Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The item that has been modified |
IEntityUpdater | context | The current context that it has been modified within |
Returns
Type | Description |
---|---|
System.Boolean | false |