Skip to content
Documentation

IVersion Interface

Describes the version of a piece of software.

public interface IVersion : System.IEquatable<HAKOM.Versioning.Core.Net.Api.IVersion>, System.IComparable<HAKOM.Versioning.Core.Net.Api.IVersion>

Implements System.IEquatable<IVersion>, System.IComparable<IVersion>

The default name to use for version parameters (i.e. the key in parameter collections).

const string PARAMETER_NAME = "api-version";

System.String

IVersion.IsCompatibleWith(IVersion) Method

Section titled “IVersion.IsCompatibleWith(IVersion) Method”

Returns whether or not software with this version should be compatible with software having the version given in other.

bool IsCompatibleWith(HAKOM.Versioning.Core.Net.Api.IVersion other);

other IVersion

The other version to check compatibility with.

System.Boolean
True if this version is compatible with the other.

Whether or not this version should be considered a - possibly unstable - prerelease or not.

bool IsPrerelease();

System.Boolean
True if this version is a prerelease and may contain unstable features.

Returns whether this version describes one exact version or a range of versions.

bool IsRange();

System.Boolean
True if this instance describes a range of versions. False if it describes an exact version.

Produces a string representation of this version instance.

string? ToString();

System.String
The string describing this version.

This is the same as calling ToString(bool, bool) with both parameters set to true.

Produces a string representation of this version instance. With the parameters the format of the string can be modified.

string ToString(bool includePrereleaseInformation, bool includeWildcards);

includePrereleaseInformation System.Boolean

Produces a string representation of this version with the prerelease information, if set to true.

includeWildcards System.Boolean

Produces a string representation of this version, where wildcards are ignored, if set to false.

System.String
The string describing this version.

© 2026 Volue.Version v0.6.38017 November 2026