フレーム間メッセージを使用する

このページでは、サイドパネル iframe で実行されているアドオンから、メインステージ iframe で実行されているアドオンにクライアントサイドでメッセージを送信する方法について説明します。フレーム間メッセージはクライアント側でのみ行われるため、メッセージの配信はほぼ瞬時に行われます。

メールを送信するには:

  • サイドパネルからメインステージに移動するには、notifyMainStage() メソッドを使用します。
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • メインステージからサイドパネルに移動するには、notifySidePanel() メソッドを使用します。
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload の長さは、指定されたサイズの上限に準拠している必要があります。

メッセージを受信するには、アドオンが frameToFrameMessage コールバックに登録する必要があります。次のコードサンプルは、frameToFrameMessage コールバックをサブスクライブする方法を示しています。

sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
    // YOUR_CODE
});

GitHub の「アニメーション」サンプル アドオンには、フレーム間メッセージの完全な例が含まれています。アクティビティの開始後、サイドパネルはユーザーが入力を変更するたびにメインステージに通知します。メインステージは、frameToFrameMessage コールバックに登録して、更新された状態を受け取ります。

メモ

  • 特定の参加者から送信されたフレーム間メッセージは、その参加者のみに表示されます。他の参加者にメッセージや状態を送信するには、アドオンの状態を共有する方法をご覧ください。

  • メッセージの配信は 1 回のみ試行されます。メッセージを受信するには、受信パネルを開いて、メッセージが送信される前にアプリがコールバックをサブスクライブする必要があります。