バージョン チェッカー
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
この SDK には、Javascript SDK バージョンと Sitecore Content Hub インスタンス バージョンの互換性をチェックするためのバージョン チェッカーが用意されています。
[!注] 次のコード例の
client
変数は、ContentHubClient
のインスタンスを参照します。 JavaScript SDK を使用する場合、変数名は自由に選択できますが、ドキュメントの例ではclient
という名前が使われています。
Content Hub インスタンスと必要な最小バージョンとの互換性を確認する
たとえば、次のスニペットは、Content Hub インスタンスがバージョン 4.0.0
を実行しているかどうかを確認します。
await client.versionChecker.compatibilityCheckAsync(new FileVersion(4, 0, 0, 0));
[!警告] Content Hub インスタンスがバージョン
4.0.0
を実行していない場合、呼び出しはNotSupportedError
をスローします。
Content Hub インスタンスと SDK 間の互換性を取得する
たとえば、次のスニペットは、Content Hub インスタンスと SDK 間の互換性を取得します。
const compatibility = client.versionChecker.getCompatibility(
new FileVersion(3, 0, 0),
new FileVersion(4, 0, 0),
new FileVersion(3, 0, 0)
);
まず、Content Hub の FileVersion
、次に SDK の FileVersion
、最後に Content Hub インスタンスによって指定された SDK の最小バージョンを渡します。
呼び出しは次のように返します。
Compatibility.Ok
: Content Hub インスタンスと SDK に互換性がある場合。Compatibility.SdkOld
: Content Hub インスタンスのバージョンが SDK よりも新しい場合。Compatibility.SdkNew
: Content Hub インスタンスのバージョンが SDK よりも古い場合。
Content Hub インスタンスが SDK バージョンと互換性があるかどうかを確認する
たとえば、次のスニペットは、Content Hub インスタンスが SDK バージョンと互換性があるかどうかを確認します。
const isCompatible = await client.versionChecker.isCompatibleAsync(new FileVersion(1, 0, 0, 0));
FileVersion
は SDK のバージョンです。