Badaching.Extensions.Plugins.Abstractions 1.0.2

dotnet add package Badaching.Extensions.Plugins.Abstractions --version 1.0.2                
NuGet\Install-Package Badaching.Extensions.Plugins.Abstractions -Version 1.0.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Badaching.Extensions.Plugins.Abstractions" Version="1.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Badaching.Extensions.Plugins.Abstractions --version 1.0.2                
#r "nuget: Badaching.Extensions.Plugins.Abstractions, 1.0.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Badaching.Extensions.Plugins.Abstractions as a Cake Addin
#addin nuget:?package=Badaching.Extensions.Plugins.Abstractions&version=1.0.2

// Install Badaching.Extensions.Plugins.Abstractions as a Cake Tool
#tool nuget:?package=Badaching.Extensions.Plugins.Abstractions&version=1.0.2                

BadaChing Plugin Architecture

BadaChing supports a plugin architecture to help with building out importers for various different bank statements. This package provides the abstractions to build such plugins.

What does it provide?

IPlugin is a general interface that signals a plugin. It does not define any specific functionality, apart from the name and version of a plugin.

IStatementReader is a specific abstraction that implements IPlugin, but declares two additional items:

  • FileExtension is the type of file that this reader supports. Implement it in the traditional Windows way, e.g. ".csv"
  • Task<Statement> ReadAsync(Stream s) is the entry point into your code.
  • Statement is an object that represents the statement read in by your code, and returned to the app. While there isn't validation applied to your result, and the app handles most values being missing or empty (not all banks provides all the details), you are encouraged to complete as many properties as you can to make your plugin usefull to the users.

I've built something, how do I test it?

Locate the "Plugin" folder in the BadaChing application folder. Place your DLL into this location and restart the application.

Some more detail

Why a Stream? Can't I load the file myself?

Windows restricts what I/O access your code has in the UWP app environment, and unfeterred disk access is not possible. The application provides the stream by way of loading it via the StorageFile class.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 103 8/13/2024
1.0.1 446 7/11/2020
1.0.0 395 7/11/2020