CodexIT.OmrKit.Abstractions 3.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CodexIT.OmrKit.Abstractions --version 3.0.0
                    


                    

                
NuGet\Install-Package CodexIT.OmrKit.Abstractions -Version 3.0.0
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="CodexIT.OmrKit.Abstractions" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CodexIT.OmrKit.Abstractions" Version="3.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CodexIT.OmrKit.Abstractions" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CodexIT.OmrKit.Abstractions --version 3.0.0
                    


                    

                
#r "nuget: CodexIT.OmrKit.Abstractions, 3.0.0"
#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. 
#:package CodexIT.OmrKit.Abstractions@3.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CodexIT.OmrKit.Abstractions&version=3.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CodexIT.OmrKit.Abstractions&version=3.0.0
                    


                            Install as a Cake Tool

CodexIT.OmrKit.Abstractions

Stable public contracts for Codex OMR Kit package consumers.

NuGet package ID: CodexIT.OmrKit.Abstractions
C# namespace remains Codex.OmrKit.Abstractions.

Package Purpose

This is the shared contract layer used by:

  • CodexIT.OmrKit.Core
  • consumer applications (such as SmartSchool)

Contains

  • Input contracts (TestSheetSpec, OmrQuestion, InstitutionInfo, StudentInfo)
  • Output contracts (OmrScanResult, ScanEngineResult, ScannedQuestion)
  • Enums (PaperLanguage, QuestionType, ChoiceOption, AnswerMarkStatus, OmrEngineKind)
  • Typed exceptions (OmrKitException and derived classes)

Migration Notes (v3.0.0)

  • Breaking: QuestionType.YesNo is now QuestionType.TrueFalse.
  • Breaking: ChoiceOption.Yes / ChoiceOption.No are now ChoiceOption.True / ChoiceOption.False.
  • Numeric values are unchanged (TrueFalse = 1, True = 1, False = 2).
  • Added permanent LicenseKey support. To request a license, contact WhatsApp: 00218917128473.
  • Use only:
    • QuestionType.MultipleChoice
    • QuestionType.TrueFalse
  • Exception model now includes:
    • Code (stable machine-readable key)
    • MessageKey (localization key)
    • Context (diagnostic metadata such as stage and engine kind)

Exception Contract

Always catch OmrKitException in consumer code and branch on Code.

Common codes:

  • validation_error
  • quality_gate_rejected
  • alignment_failed
  • decode_error
  • configuration_error
  • payload_error

Localization behavior:

  • Exception messages are localized to English/Arabic.
  • Language source is DefaultLanguage configured through AddCodexOmrKit(...) in CodexIT.OmrKit.Core.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net10.0

    • No dependencies.

  • net8.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on CodexIT.OmrKit.Abstractions:

Package Downloads
CodexIT.OmrKit.Core

Core OMR generation and scanning engine for Codex OMR Kit.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.0.0 124 9/27/2026
3.0.0 111 9/21/2026
2.0.0 121 9/16/2026

3.0.0 - Breaking release.
- Renamed QuestionType.YesNo to QuestionType.TrueFalse.
- Renamed ChoiceOption.Yes/No to ChoiceOption.True/False (numeric values unchanged).
- Added CreateLicenseRequest and LicenseDto for permanent license keys.