orchardcore-notifications

Orchard Core Notifications - Prompt Templates

Create and Manage Notifications

Use INotificationService to create a persistent notification and dispatch it through every delivery method available for the recipient. The service contract is SendAsync(object notify, INotificationMessage message, CancellationToken); it returns a NotificationSendResult.

Guidelines

• Enable OrchardCore.Notifications before using notification services.
• Enable OrchardCore.Notifications.Email only when email delivery is needed.
• Send a NotificationMessage, not a Notification; the service creates the Notification entity.
• Pass the recipient as the notify object. Use application users when sending user notifications.
• Inspect NotificationSendResult.Status, counts, and errors when delivery outcomes affect application flow.
• Implement INotificationMethodProvider for a delivery method. Its SendAsync returns Task<Result>.
• Derive lifecycle handlers from NotificationEventsHandler.
• The module provides the ManageNotifications permission. Do not invent additional notification permissions.
• NotifyUserTask and NotifyContentOwnerTask are workflow activities registered when their required features are enabled.

Enabling Notifications

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Notifications",
        "OrchardCore.Notifications.Email"
      ],
      "disable": []
    }
  ]
}

Notification and Message Models

NotificationMessage supplies the delivery content:

Property	Purpose
Subject	Delivery subject, such as an email subject.
Summary	Short persistent notification summary.
TextBody	Plain-text body.
HtmlBody	HTML body when a provider supports it.
IsHtmlPreferred	Requests HTML when HtmlBody is available.

The persisted Notification entity has NotificationId, Subject, Summary, UserId, and CreatedUtc. The core event handler stores the message text and HTML body as notification metadata.