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
System.Object
NotificationTriggerParameter
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: 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
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 |
System.String |
|
Properties
NotificationTypeID
Declaration
public Guid NotificationTypeID { get; set; }
Property Value
Type |
Description |
System.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 |
System.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 |
System.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 |
System.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 |
System.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 |
System.String |
|
WatcherTypeList
Declaration
public string WatcherTypeList { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
Clone()
Declaration
public NotificationTriggerParameter Clone()
Returns
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Overrides
CopyFromSource(NotificationTriggerParameter)
Declaration
public void CopyFromSource(NotificationTriggerParameter source)
Parameters
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
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 |
System.String |
A string stating that this is a watcher notification recalculation task against an action trigger
|
Overrides
Implements
System.ComponentModel.INotifyPropertyChanged
Extension Methods