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>
Fields
Section titled “Fields”IVersion.PARAMETER_NAME Field
Section titled “IVersion.PARAMETER_NAME Field”The default name to use for version parameters (i.e. the key in parameter collections).
const string PARAMETER_NAME = "api-version";Field Value
Section titled “Field Value”Methods
Section titled “Methods”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);Parameters
Section titled “Parameters”other IVersion
The other version to check compatibility with.
Returns
Section titled “Returns”System.Boolean
True if this version is compatible with the other.
IVersion.IsPrerelease() Method
Section titled “IVersion.IsPrerelease() Method”Whether or not this version should be considered a - possibly unstable - prerelease or not.
bool IsPrerelease();Returns
Section titled “Returns”System.Boolean
True if this version is a prerelease and may contain unstable features.
IVersion.IsRange() Method
Section titled “IVersion.IsRange() Method”Returns whether this version describes one exact version or a range of versions.
bool IsRange();Returns
Section titled “Returns”System.Boolean
True if this instance describes a range of versions. False if it describes an exact version.
IVersion.ToString() Method
Section titled “IVersion.ToString() Method”Produces a string representation of this version instance.
string? ToString();Returns
Section titled “Returns”System.String
The string describing this version.
Remarks
Section titled “Remarks”This is the same as calling ToString(bool, bool) with both parameters set to true.
IVersion.ToString(bool, bool) Method
Section titled “IVersion.ToString(bool, bool) Method”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);Parameters
Section titled “Parameters”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.
Returns
Section titled “Returns”System.String
The string describing this version.