ビューア SDK 名前空間

最終更新日： 2024年7月22日
  • トピック：

作成対象：

  • 開発者
  • ユーザー

ビューアは、多くの Viewer SDK コンポーネントで構成されています。 通常、web ページは SDK コンポーネント API を直接操作する必要はありません。一般的なニーズはすべて、ビューア API 自体で説明されています。

ただし、高度なユースケースによっては、web ページで getComponent() ビューア API を使用して内部 SDK コンポーネントを参照してから、SDK 自体の API の柔軟性をすべて利用する必要があります。

ビューアによる SDK コンポーネントの読み込みと初期化に使用される名前空間は、ビューアが動作している環境によって異なります。 Adobe Experience Managerでビューアを実行している場合、ビューアは SDK コンポーネントを名前空間 s7viewers.s7sdk 読み込みます。 同様に、Dynamic Media Classicから提供されるビューアは、SDK を s7classic.s7sdk に読み込みます。

どちらの場合でも、ビューア内で SDK によって使用される名前空間には、プレフィックスとして s7viewers または s7classic が付きます。 また、SDK ユーザーガイドや SDK API ドキュメントで使用されるプレーン s7sdk 名前空間とは異なります。 そのため、内部ビューアコンポーネントと通信するカスタムアプリケーションコードを記述する場合は、完全修飾された SDK 名前空間を使用することが重要です。

例えば、イベントをリッスンす StatusEvent.NOTF_VIEW_READY 予定で、ビューアがExperience Managerから提供される場合、完全修飾イベントタイプは s7viewers.s7sdk.event.StatusEvent.NOTF_VIEW_READY であり、イベントリスナーコードは次のようになります。

<instance>.setHandlers({
 "initComplete":function() {
  var spinView = <instance>.getComponent("spinView");
   spinView.addEventListener(s7viewers.s7sdk.event.StatusEvent.NOTF_VIEW_READY, function(e) {
   console.log("view ready");
  }, false);
}
});
The same code for the viewer served from Dynamic Media Classic looks like the following:
<instance>.setHandlers({
 "initComplete":function() {
  var spinView = <instance>.getComponent("spinView");
   spinView.addEventListener(s7classic.s7sdk.event.StatusEvent.NOTF_VIEW_READY, function(e) {
   console.log("view ready");
  }, false);
}
});
前のページフルスクリーンサポート
次のページビデオ

Experience Manager