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

このページでは、プロバイダからクライアントサイドでメッセージを送信する方法について説明します。 Google Kubernetes Engine 上で サイドパネルに 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 回だけ試行されます。メッセージを受信するには、受信側の 通知を受ける前に、アプリでコールバックにサブスクライブする必要があります。 送信されます。