5MInnov.Tools.WebhookNotification.Ports 1.0.2

5M Innov Webhook Notification Ports

Description

5M Innov Webhook Notification Ports allows you to create your own adapter and use it within 5MInnov.Tools.WebhookNotification.Domain by injecting it.

Prerequisites

• .NET 8.0 or later

Installation

You can install this package via the NuGet Package Manager Console:

Install-Package 5MInnov.Tools.WebhookNotification.Ports

or via the .NET CLI:

dotnet add package 5MInnov.Tools.WebhookNotification.Ports

Example of Use

Here is a basic example :

using _5MInnov.Tools.WebhookNotification.Enums;
using _5MInnov.Tools.WebhookNotification.Ports;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using System.Net.Http.Headers;

namespace CustomWebhook.Adapters
{
    // Defines a class for sending notifications to webhooks.
    public class CustomWebhookNotification : IWebhookNotification
    {
        #region Public Properties
        // Logger instance for logging errors or critical information.
        public readonly ILogger? Logger;
        #endregion

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the CustomWebhookNotification class with a logger.
        /// </summary>
        /// <param name="logger">The logger to use for logging information or errors.</param>
        public CustomWebhookNotification(ILogger<CustomWebhookNotification> logger)
        {
            Logger = logger;
        }
        #endregion

        #region Public Methods
        /// <summary>
        /// Asynchronously posts a notification message to a webhook.
        /// </summary>
        /// <param name="webHookUri">The URI of the webhook.</param>
        /// <param name="message">The message to post, encapsulated in an IMessage interface.</param>
        /// <param name="raiseError">Indicates whether to throw an exception on failure.</param>
        /// <returns>A task that represents the asynchronous operation, containing a boolean indicating success or failure.</returns>
        public async Task<bool> PostNotificationAsync(Uri webHookUri, IMessage message, bool raiseError)
        {
            //To implements
        }

        /// <summary>
        /// Overload of PostNotificationAsync that constructs a CustomNotification object from provided parameters and posts it.
        /// </summary>
        /// <param name="webHookUri">The URI of the webhook.</param>
        /// <param name="notificationType">The type of notification.</param>
        /// <param name="title">The title of the notification.</param>
        /// <param name="message">The message body of the notification.</param>
        /// <param name="subject">Optional subject of the notification.</param>
        /// <param name="description">Optional description of the notification.</param>
        /// <param name="themeColor">Optional theme color of the notification card.</param>
        /// <param name="icon">Optional URI of an icon for the notification.</param>
        /// <param name="informationLink">Optional URI for more information related to the notification.</param>
        /// <param name="raiseError">Indicates whether to throw an exception on failure.</param>
        /// <returns>A task that represents the asynchronous operation, containing a boolean indicating success or failure.</returns>
        public async Task<bool> PostNotificationAsync(Uri webHookUri, NotificationType notificationType, string title, string message, string? subject = null, string? description = null, string? themeColor = null, Uri? icon = null, Uri? informationLink = null, bool raiseError = false)
        {
            // Create a notification object and post it
            CustomNotification notification = new CustomNotification(notificationType, title, message, subject, description, themeColor, icon, informationLink);
            bool result = await PostNotificationAsync(webHookUri, notification, raiseError);
            return result;
        }
        #endregion
    }
}

Contributors

• Maxime TREZIERES

License

This project is licensed under 5M Innov.

Other Relevant Information

For any questions or suggestions, please contact mtrezieres@5minnov.fr.

Useful Links

• NuGet Gallery
• Documentation