Notification Configuration Library

• Notification Configuration Library
• 📝 Overview
• ⚙️ Configuration
• 📖 Usage
  • Placeholders
    • Derived placeholders
    • Custom placeholders
• 👥 Contributing
• 📄 License
• 🆘 Support
• 📦 Release & Changelog

📝 Overview

The NotificationConfiguration library for .NET provides a set of configurations for actions and channels used in the notification system within Coscine, allowing for easy customization and management of various notifications across different applications and services.

⚙️ Configuration

To install this library, you can use the NuGet package manager or you can install it using the .NET CLI.

Install-Package Coscine.NotificationConfiguration

or using the .NET CLI

dotnet add package Coscine.NotificationConfiguration

📖 Usage

For examples on how we use this library, look into the source code of the following open-source Coscine APIs found in our public GitLab repository:

• Notification ... and others.

Placeholders

Placeholders can be used to extend the the provided texts with custom information. This is done be including the place holder within the language specific template, like this {{examplePlaceholder}} There are two types of placeholders that can be used: derived placeholders and custom placeholders.

Derived placeholders

Derived placeholders are taken from the affected user or the project, currently the following information can be used, they are identified by an underscore:

- _targetUserName
- _projectName

Custom placeholders

Custom placeholders must be provided in a JObject that is sent to the Notification API:

var obj = new JObject
{
    ["args"] = new JObject
    {
        ["placeholder"] = new JObject
        {
            ["examplePlaceholder"] = "exampleText"
        }
    }
};

To provide a clear distinction they should not use an underscore. Keep in mind that placeholders are not localized.

👥 Contributing

As an open source plattform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our Contributing Guideline.

📄 License

The current open source repository is licensed under the MIT License, which is a permissive license that allows the software to be used, modified, and distributed for both commercial and non-commercial purposes, with limited restrictions (see LICENSE file)

The MIT License allows for free use, modification, and distribution of the software and its associated documentation, subject to certain conditions. The license requires that the copyright notice and permission notice be included in all copies or substantial portions of the software. The software is provided "as is" without any warranties, and the authors or copyright holders cannot be held liable for any damages or other liability arising from its use.

🆘 Support

1. Check the documentation: Before reaching out for support, check the help pages provided by the team at https://docs.coscine.de/en/. This may have the information you need to solve the issue.
2. Contact the team: If the documentation does not help you or if you have a specific question, you can reach out to our support team at servicedesk@itc.rwth-aachen.de 📧. Provide a detailed description of the issue you're facing, including any error messages or screenshots if applicable.
3. Be patient: Our team will do their best to provide you with the support you need, but keep in mind that they may have a lot of requests to handle. Be patient and wait for their response.
4. Provide feedback: If the support provided by our support team helps you solve the issue, let us know! This will help us improve our documentation and support processes for future users.

By following these simple steps, you can get the support you need to use Coscine's services as an external user.

📦 Release & Changelog

External users can find the Releases and Changelog inside each project's repository. The repository contains a section for Releases (Deployments > Releases), where users can find the latest release changelog and source. Withing the Changelog you can find a list of all the changes made in that particular release and version.
By regularly checking for new releases and changes in the Changelog, you can stay up-to-date with the latest improvements and bug fixes by our team and community!