1. JavaScript SDK

バージョンチェッカー

日本語翻訳に関する免責事項

このページの翻訳は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のバージョンです。

この記事を改善するための提案がある場合は、 お知らせください!