Class TriggerActionParameter
The server task parameters for the trigger action processs
Inherits from the item server task parameter which records the id and label of the IActionTrigger this task should be calculated against
Evaluate any triggers setup against the specified data and run associated action.Inherited Members
Namespace: LemonEdge.API.Tasks.Parameters
Assembly: API.dll
Syntax
[DataContract]
[ServerTaskParameters("Run Trigger", "12737356-A000-436B-8640-C18406499341", Description = "Evaluate any triggers setup against the specified data and run associated action.")]
public class TriggerActionParameter : ItemParameter, ICloneable, INotifyPropertyChanged
Constructors
TriggerActionParameter()
Creates a new trigger action server task process parameter
Declaration
public TriggerActionParameter()
Fields
UNIQUE_TASK_ID
The unique id of the trigger action calculation server task
Declaration
public const string UNIQUE_TASK_ID = "12737356-A000-436B-8640-C18406499341"
Field Value
Type | Description |
---|---|
System.String |
Properties
Action
A custom string for matching on custom actions ActionOnActionMatch
Declaration
public string Action { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EntityTypeID
A unique list of entity types that have been modified and should be checked to see if their modification triggers a configured action
Declaration
public Guid[] EntityTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid[] |
FirstEntityTypeID
The entity type id of the first entity type that was modified in the EntityTypeID
Declaration
public Guid FirstEntityTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
SaveSetSTamp
The unique date time stamp the modification occured so the system can check all modified items at that time stamp
Declaration
public DateTimeOffset? SaveSetSTamp { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTimeOffset> |
Methods
AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask)
Returns false - the system should not automatically allow saving without changes
Declaration
public override bool AllowSaveWithNoChangesForTaskCreation(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The trigger action that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | False |
Overrides
Clone()
Declaration
public TriggerActionParameter Clone()
Returns
Type | Description |
---|---|
TriggerActionParameter |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(TriggerActionParameter)
Declaration
public void CopyFromSource(TriggerActionParameter source)
Parameters
Type | Name | Description |
---|---|---|
TriggerActionParameter | source |
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
Type | Description |
---|---|
SerializedParam |
Overrides
DisplayUserParamOnSave(IHasSaveProcessingTask)
Returns false - the system should not automatically display the task parameters during save
Declaration
public override bool DisplayUserParamOnSave(IHasSaveProcessingTask item)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The trigger action that has been modified |
Returns
Type | Description |
---|---|
System.Boolean | False |
Overrides
GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)
Returns that this is a trigger recalculation task against the specified task description
Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type | Name | Description |
---|---|---|
IServerTask | task | The server task for processing the trigger action |
Returns
Type | Description |
---|---|
System.String | A string stating that this is a trigger recalculation task against the specified task description |
Overrides
ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)
Returns false - the system should not automaically create a task when modifying a trigger action
Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type | Name | Description |
---|---|---|
IHasSaveProcessingTask | item | The trigger action that has been modified |
IEntityUpdater | context | The current context that it has been modified within |
Returns
Type | Description |
---|---|
System.Boolean | False |