Last update: January 30, 2024

Registering New Notification Type

This guide describes the basic steps needed to define a new email notification type, which includes logging it in the notification registry.

For your convenience, you can find the source code of the sample project here.

Prerequisites

Prior to registering your notifications, you need to configure the notification gateway, which we explain here.

Defining Custom Email Notification Type

First, you need to create a notification and give it a name, e.g., SampleEmailNotification, basing it on the EmailNotification class (as opposed to another standard class, SmsNotification):

SampleEmailNotification.cs

public class SampleEmailNotification : EmailNotification
{
    public SampleEmailNotification() : base(nameof(SampleEmailNotification)) {}
    public string Greeting { get; set; }
}

Registration in Notification Registry

Your next step is registering your SampleEmailNotification in the notification registry:

public void PostInitialize(IApplicationBuilder appBuilder)
    {
    ...
    var registrar = appBuilder.ApplicationServices.GetService<INotificationRegistrar>();
    registrar.RegisterNotification<SampleEmailNotification>().WithTemplates(new EmailNotificationTemplate()
            {
                Sample = "",
                Subject = "Hi { greeting }",
                Body = "My cool email body
            });
    ...
    }

Notes to the code:

Line 4: Getting the instance of INotificationRegistrar type that stores all known notification types used in the system.

Line 5: Registering SampleEmailNotification and setting a default template by running the WithTemplates extension method. In Template.Subject, we use the {greeting} liquid expression that will be replaced with the Greeting property value of the SampleEmailNotification class instance after rendering.

Tip

You can register your notification templates as files being part of your solution.

Notification Localization

Virto Platform Manager supports localization resources for notification types. This is achieved by adding a JSON object to the notificationTypes section, the key having the same name as the notification type:

Localization/en.VirtoCommerce.NotificationsExample.json

 "notificationTypes": {
 ...
    "SampleEmailNotification": {
      "displayName": "Sample email notification",
      "description": "Some sample email description"
    },
...
  }

Sending Notifications

In order to send a notification from your code, you need to use two interfaces: INotificationSearchService and INotificationSender.

Let's show how you can send a notification basing on this code sample:

public class SampleSenderService 
{
    private readonly INotificationSearchService _notificationSearchService;
    private readonly INotificationSender _notificationSender;

    public SampleService(INotificationSender notificationSender, INotificationSearchService notificationSearchService)
    {
        _notificationSender = notificationSender;
        _notificationSearchService = notificationSearchService;
    }

   public async Task SendSampleNotification()
   {
     //Resolve the notification instance from known notification types via registry
     var notification = await _notificationSearchService.GetNotificationAsync<SampleEmailNotification>();
     //Set the language code to use template that has this language or left empty, then template with empty language will be used
     notification.LanguageCode = 'en-US';
     notification.From = "[email protected]";
     notification.To = "[email protected]";
     notification.Greeting = "John"
     //Sending notification asynchronously
     await _notificationSender.ScheduleSendNotificationAsync(notification);     
   }
}

Notes to the code:

Line 15: Constructing a new instance of the SampleEmailNotification type by calling the INotificationSearchService.GetNotificationAsync<> extension method.

Lines 16 to 19: Populating the required email notification properties, such as From and To, and setting a value for our custom Greeting property; this value will be eventually interpolated in the email subject, e.g. Hi { greeting } → Hi John.