バージョン チェッカー

Current version: 4.0

この SDK には、Javascript SDK バージョンと Sitecore Content Hub インスタンス バージョンの互換性をチェックするためのバージョン チェッカーが用意されています。

[!注] 次のコード例の client 変数は、ContentHubClient のインスタンスを参照します。 JavaScript SDK を使用する場合、変数名は自由に選択できますが、ドキュメントの例では client という名前が使われています。

Content Hub インスタンスと必要な最小バージョンとの互換性を確認する

たとえば、次のスニペットは、Content Hub インスタンスがバージョン 4.0.0 を実行しているかどうかを確認します。

RequestResponse
await client.versionChecker.compatibilityCheckAsync(new FileVersion(4, 0, 0, 0));

[!警告] Content Hub インスタンスがバージョン 4.0.0 を実行していない場合、呼び出しは NotSupportedError をスローします。

Content Hub インスタンスと SDK 間の互換性を取得する

たとえば、次のスニペットは、Content Hub インスタンスと SDK 間の互換性を取得します。

RequestResponse
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 バージョンと互換性があるかどうかを確認します。

RequestResponse
const isCompatible = await client.versionChecker.isCompatibleAsync(new FileVersion(1, 0, 0, 0));

FileVersion は SDK のバージョンです。

Do you have some feedback for us?

If you have suggestions for improving this article,