ApiAlerts.Common 1.0.0

ApiAlerts NuGet Package

Overview

The ApiAlerts NuGet package simplifies the process of setting up and managing alerts within your API projects. It provides functionalities to activate the package with an API key and offers methods for publishing alerts asynchronously and synchronously.

Installation

To install the ApiAlerts package, simply use NuGet Package Manager or the Package Manager Console:

PM> Install-Package ApiAlerts

Getting Started

1. Activation

Before utilizing any functionalities of the ApiAlerts package, you must activate it by providing the API key obtained from the Magpie Mobile App.

ApiAlerts.Activate(apiKey);

2. Publishing Alerts

To publish alerts, you'll utilize the IAlertService interface.

Synchronous Method

You can publish an alert synchronously using the PublishAlert method, which takes an ApiAlert object and an optional API key.

var alert = new ApiAlert { /* alert properties */ };
IAlertService alertService = new AlertService(); // Instantiate or inject IAlertService
alertService.PublishAlert(alert, optionalApiKey);

Asynchronous Method

Alternatively, you can publish an alert asynchronously using the PublishAlertAsync method, which also takes an ApiAlert object and an optional API key.

var alert = new ApiAlert { /* alert properties */ };
IAlertService alertService = new AlertService(); // Instantiate or inject IAlertService
await alertService.PublishAlertAsync(alert, optionalApiKey);

Contributing

Contributions to the ApiAlerts package are welcome! If you find any issues or have suggestions for improvements, please open an issue on the GitHub repository or submit a pull request.

License

This package is licensed under the MIT License. Feel free to use, modify, and distribute it as per the terms of the license.