Class NotificationTriggerParameter

A base trigger parameter used to create the parameters for an TriggeredActionParameter which can configure the parameters for a custom task to be activated when a trigger is fired

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 BaseTriggerParameter

Notifies any watchers of the current trigger.
Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
BaseTriggerParameter
NotificationTriggerParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters.Triggers
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Run Notifications", "F851EE43-C65C-486A-BB60-750DF2FDAB4B", Description = "Notifies any watchers of the current trigger.")]
public class NotificationTriggerParameter : BaseTriggerParameter, ICloneable, INotifyPropertyChanged

Constructors

NotificationTriggerParameter()

Declaration
public NotificationTriggerParameter()

Fields

UNIQUE_TASK_ID

The unique id of the notification trigger task

Declaration
public const string UNIQUE_TASK_ID = "F851EE43-C65C-486A-BB60-750DF2FDAB4B"
Field Value
Type Description
string

Properties

NotificationTypeID

The UniqueNotificationTypeID of a notification, a class that implements INotificationType

Declaration
public Guid NotificationTypeID { get; set; }
Property Value
Type Description
Guid

NotificationWhen

The formula to use to see if this watcher should be notified. Uses the NotificationContext for formulas.

Declaration
[EntityDescription("The formula to use to see if this watcher should be notified. Uses the NotificationContext for formulas.")]
public string NotificationWhen { get; set; }
Property Value
Type Description
string

NotifyMessage

The message to send when this watcher type is activated. Use {PropName} for the property name of the inserted/modified/deleted item, or {{Formula}} to evaluate a formula within the message. Uses the TriggerContext for formulas.

Declaration
[EntityDescription("The message to send when this watcher type is activated. Use {PropName} for the property name of the inserted/modified/deleted item, or {{Formula}} to evaluate a formula within the message. Uses the TriggerContext for formulas.")]
public string NotifyMessage { get; set; }
Property Value
Type Description
string

NotifySubject

The subject to send when this watcher type is activated. Use {PropName} for the property name of the inserted/modified/deleted item, or {{Formula}} to evaluate a formula within the subject. Uses the TriggerContext for formulas.

Declaration
[EntityDescription("The subject to send when this watcher type is activated. Use {PropName} for the property name of the inserted/modified/deleted item, or {{Formula}} to evaluate a formula within the subject. Uses the TriggerContext for formulas.")]
public string NotifySubject { get; set; }
Property Value
Type Description
string

WatcherTypeID

The type of watcher to notify. Only watchers of this IWatcherType against the trigger action item will be notified

Declaration
public Guid[] WatcherTypeID { get; set; }
Property Value
Type Description
Guid[]

WatcherTypeID_Label

The label of the type of watcher to notify. Only watchers of this IWatcherType against the trigger action item will be notified

Declaration
public string WatcherTypeID_Label { get; set; }
Property Value
Type Description
string

WatcherTypeList

The WatcherTypeID formatted as a comma separated list

Declaration
public string WatcherTypeList { get; set; }
Property Value
Type Description
string

Methods

Clone()

Declaration
public NotificationTriggerParameter Clone()
Returns
Type Description
NotificationTriggerParameter

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(NotificationTriggerParameter)

Declaration
public void CopyFromSource(NotificationTriggerParameter source)
Parameters
Type Name Description
NotificationTriggerParameter source

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a watcher notification recalculation task against an action trigger

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

The server task for processing the action trigger notification
Returns
Type Description
string

A string stating that this is a watcher notification recalculation task against an action trigger
Overrides

Implements

Extension Methods