Interface INotificationType
An interface that any notification implementation can implement
It is then available as an option wherever Notification Types are used, such as against IActionTrigger with an action of Notification
Namespace: LemonEdge.API.Notifications
Assembly: API.dll
Syntax
public interface INotificationType
Properties
Name
The user friendly name for this notification type.
The system defaults are "Email Notification" and "System Notification"
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
UniqueNotificationTypeID
The unique id for this notification task type
Declaration
Guid UniqueNotificationTypeID { get; }
Property Value
Type | Description |
---|---|
System.Guid |
Methods
SendNotifications(TriggerContext, IEntityUpdater, IEnumerable<IUser>, String, String)
Called by a triggered task to send the specified notification
Declaration
Task SendNotifications(TriggerContext context, IEntityUpdater updater, IEnumerable<IUser> users, string translatedNotificationHeader, string translatedNotificationMessage)
Parameters
Type | Name | Description |
---|---|---|
TriggerContext | context | The context of the Trigger that caused the notification |
IEntityUpdater | updater | A current context for retrieving and interacting with data from LemonEdge |
System.Collections.Generic.IEnumerable<IUser> | users | The users to notify |
System.String | translatedNotificationHeader | The header message for the notification |
System.String | translatedNotificationMessage | The actual message for the notification |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |