AnkiIO 1.0.2
Build, validate, import, and export Anki-compatible decks from .NET
Loading...
Searching...
No Matches
AnkiIO.IAnkiVersionAdapter Interface Reference

Describes collection, scheduler, and package capabilities verified for an Anki version family. More...

Inheritance diagram for AnkiIO.IAnkiVersionAdapter:

Public Member Functions

bool Supports (Version version)
 Determines whether this adapter represents the supplied Anki application version.

Properties

string Name [get]
 Gets the stable, human-readable adapter name.
IReadOnlySet< int > CollectionSchemas [get]
 Gets collection schema versions covered by the adapter's evidence.
int SchedulerVersion [get]
 Gets the Anki scheduler generation associated with the verified version family.
IReadOnlySet< string > PackageEntries [get]
 Gets collection and metadata entry names recognized in packages from this version family.

Detailed Description

Describes collection, scheduler, and package capabilities verified for an Anki version family.

An adapter is evidence-backed capability metadata, not an alternate package reader, a database migration, or a promise that every feature of the represented Anki release is supported. Resolving an adapter does not open an installation or bypass the documented safety and format limits of individual AnkiIO operations.

Implementations should make Supports deterministic and expose stable immutable sets. Applications can implement this interface for an independently tested version family and register it ahead of broader fallbacks in an AnkiCompatibilityRegistry.

Definition at line 16 of file IAnkiVersionAdapter.cs.

Member Function Documentation

◆ Supports()

bool AnkiIO.IAnkiVersionAdapter.Supports ( Version version)

Determines whether this adapter represents the supplied Anki application version.

Parameters
versionThe non-null parsed Anki application version to evaluate.
Returns
true only when compatibility evidence covers version .

Implemented in AnkiIO.Anki2605VersionAdapter.

Property Documentation

◆ CollectionSchemas

IReadOnlySet<int> AnkiIO.IAnkiVersionAdapter.CollectionSchemas
get

Gets collection schema versions covered by the adapter's evidence.

A stable, immutable set of numeric Anki collection schema identifiers.

Implemented in AnkiIO.Anki2605VersionAdapter.

Definition at line 29 of file IAnkiVersionAdapter.cs.

◆ Name

string AnkiIO.IAnkiVersionAdapter.Name
get

Gets the stable, human-readable adapter name.

A name suitable for diagnostics and compatibility reports.

Implemented in AnkiIO.Anki2605VersionAdapter.

Definition at line 20 of file IAnkiVersionAdapter.cs.

◆ PackageEntries

IReadOnlySet<string> AnkiIO.IAnkiVersionAdapter.PackageEntries
get

Gets collection and metadata entry names recognized in packages from this version family.

A stable, immutable, case-sensitive set of top-level ZIP entry names.

Recognition metadata records representations encountered in the version family. It does not imply that every AnkiIO writer emits, or every reader fully interprets, each listed representation.

Implemented in AnkiIO.Anki2605VersionAdapter.

Definition at line 41 of file IAnkiVersionAdapter.cs.

◆ SchedulerVersion

int AnkiIO.IAnkiVersionAdapter.SchedulerVersion
get

Gets the Anki scheduler generation associated with the verified version family.

The scheduler generation, such as 3 for Anki's v3 scheduler.

Implemented in AnkiIO.Anki2605VersionAdapter.

Definition at line 33 of file IAnkiVersionAdapter.cs.


The documentation for this interface was generated from the following file: