https://github.com/i-rzr-i/aggregatedgenericresultmessage

This repository can help you to aggregate all results from an API or method in one. So as a result of this, you will have control over all responses given to the caller.
https://github.com/i-rzr-i/aggregatedgenericresultmessage

api error framework info message net response result resultmessage returnmessage service soap

Last synced: 3 days ago
JSON representation

This repository can help you to aggregate all results from an API or method in one. So as a result of this, you will have control over all responses given to the caller.

• Host: GitHub
• URL: https://github.com/i-rzr-i/aggregatedgenericresultmessage
• Owner: I-RzR-I
• License: mit
• Created: 2022-07-10T13:22:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-24T11:12:43.000Z (22 days ago)
• Last Synced: 2024-12-24T11:43:27.655Z (22 days ago)
• Topics: api, error, framework, info, message, net, response, result, resultmessage, returnmessage, service, soap
• Language: C#
• Homepage:
• Size: 846 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> **Note** This repository is developed in .netstandard2+ with support for SOAP service results mainly used in the .net framework (current support 4.5, 4.6.1 - 4.8)

[![NuGet Version](https://img.shields.io/nuget/v/AggregatedGenericResultMessage.svg?style=flat&logo=nuget)](https://www.nuget.org/packages/AggregatedGenericResultMessage/)

[![Nuget Downloads](https://img.shields.io/nuget/dt/AggregatedGenericResultMessage.svg?style=flat&logo=nuget)](https://www.nuget.org/packages/AggregatedGenericResultMessage)

The goal of this repository is to offer the possibility to manage and agree on the answers received as a result of the execution of a method or a process.

In other words, it offers the possibility to use a single(general) response, structured and easier parsed model for the executed methods.

As a result, you can have control over the messages and types of messages that will be obtained.

By currently following, 6 general types of messages (`Info`, `Warning`, `Error`, `NotFound`, `AccessDenied`, `Exception`) are implemented that can be returned to the caller.

As you can see in the `MessageType` enum, there are 9 types of messages, for all 3 (`Info`, `Warning`, `Error`) types previously specified exists with new ends `Confirm`. The idea of all of them is to inform UI (or caller) that returned message will be parsed/used as a dialog box/popup/modal.

For more flexible and intuitive use, in solution persist extension method like fluent access to set message, error, etc (`WithMessage`, `WithKeyCode`, `WithCodeMessage`, `WithError`, `WithErrors`). In some cases when you may have the necessity to add in the result additional information like the link between the code execution method and data store name: stored procedure, function or table, etc; in code/result is defined object `RelatedObject` where this information can be stored and returned to the caller.

For more efficiently using, when in some cases when you may need to execute some custom actions/functions after a successful or failed execution request. In that case was added extension methods (`ActionOnSuccess`, `ActionOnFailure`, `ActionOn`, `ExecuteAction`, `FunctionOnSuccess`, `FunctionOnFailure`, `FunctionOn`, `ExecuteFunction`) which allow you to execute this action/function like insert log when execution has a status equal to failure.

No additional components or packs are required for use. So, it only needs to be added/installed in the project and can be used instantly.

**In case you wish to use it in your project, u can install the package from nuget.org** or specify what version you want:

> `Install-Package AggregatedGenericResultMessage -Version x.x.x.x`

## Content

1. [USING](docs/usage.md)

1. [CHANGELOG](docs/CHANGELOG.md)

1. [BRANCH-GUIDE](docs/branch-guide.md)