Notie 1.0.2

✌ Hello!

Notie is a simple way to implement the Notification Pattern to notify your validations. A difference is that it is multi-purpose, so you can use it for notifications in any class or layer you want. Do what you want! 😄

🛠 Install

Use the installation means below.

CLI (Linux/Windows/Mac)

To install via the command line (CLI), just run the following command in your project folder:

  dotnet add package Notie

NuGet packages managers (Windows/Mac/Linux)

Just search for "Notie" in your Visual Studio/Rider and click on add package.

💻 Usage

Notie is intuitive and you can use the documentation provided by the code to help you, but I will also leave examples here.

Quick Examples

You can use it in several ways, but here is an example of what it is like to save your notifications:

using Notie;

// your validation here...

var notification = new Notification(key: "any_key", message: "any_message");
var notificator = new Notificator();

notificator.AddNotification(notification);

if (_sut.HasNotifications)
{
  // Handle...
}

You can even receive a list of notifications via the AddNotifications method. If notifications already exist in the notifier object, they will be merged by default. See example:

using Notie;

// your validation here...

List<Notification> notifications = new()
{
  new("any_key", "any_message"),
  new("other_key", "other_message")
};

var notificator = new Notificator();

notificator.AddNotifications(notifications);

if (_sut.HasNotifications)
{
  // Handle...
}

if you want to overwrite previous notifications, just set the overwrite parameter to true, as shown below.

using Notie;

// your validation here...
var notificator = new Notificator();
var notification = new Notification(key: "any_key", message: "any_message");
notificator.AddNotification(notification);

List<Notification> notifications = new()
{
  new("any_key", "any_message"),
  new("other_key", "other_message")
};

var notificator = new Notificator();

notificator.AddNotifications(notifications, true);

if (_sut.HasNotifications)
{
  // Handle...
}

if you want to clear all notifications you can do so using the Clear method.

Using with FluentValidation

You can also receive notifications from FluentValidation through the AddNotificationsByFluent method:

using Notie;

Entity entity = new Entity();
EntityValidator validator = new EntityValidator();
ValidationResult result = validator.Validate(entity);

var notificator = new Notificator();
notificator.AddNotificationsByFluent(result);

if (_sut.HasNotifications)
{
  // Handle...
}

Defining notification types

Each notifier can be in a different context, and for that we can define types for it through the NotificationType property. You can have notifications from repository, validation or any other service you need, so you can separate the notifications from each context and understand which part of the application is bringing the notifications. initial type of NotificationType is "Default". See example below:

using Notie;

// In the repository

var notificator = new Notificator();
notificator.SetNotificationType(new("Repository"));

// In the Domain

var notificator = new Notificator();
notificator.SetNotificationType(new("Validation"));

// In the user service

var notificator = new Notificator();
notificator.SetNotificationType(new("Service"));

This documentation will be increased as the project progresses, but issues can open, which I will answer as quickly as I can, I am happy with your comment. 😄

👋 See my Github!