Xecrets.Sdk.XfSdkVersion.md
May 26, 2026 · View on GitHub
Xecrets.Sdk
Xecrets.Sdk
XfSdkVersion Class
Helper to determine if the current SDK version is compatible with a given command line tool API version.
public static class XfSdkVersion
Inheritance System.Object → XfSdkVersion
Properties
XfSdkVersion.SdkVersion Property
The API version is to be updated when the command line options are updated in an incompatible way. The minor version is increased if changes do not change the meaning or syntax of any pre-existing options, i.e. purely new additional capabilities. The major version is increased if changes in any way changes an existing option so it may not work as expected by an older consumer. The consumer should thus only accept an export version that has the same Major version, and a minor version greather than or equal to it's known version.
public static System.Version SdkVersion { get; }
Property Value
Remarks
Changes includes not only syntax and semantics, but also actual numerical values assigned to
Methods
XfSdkVersion.IsSdkCompatibleWith(Version) Method
A predicate determining if this SDK is compatible with a given command line tool API version.
public static bool IsSdkCompatibleWith(System.Version cliApiVersion);
Parameters
cliApiVersion System.Version
The command line tool API version
Returns
System.Boolean
true if this SDK is compatible with the command line tool, false otherwise.