使用畫面框訊息功能

本頁說明如何在用戶端透過 外掛程式 側邊面板 iframe 指派給 外掛程式中, 階段 iframe。畫面對應 訊息只會在用戶端進行,因此訊息傳送作業靠近用戶端 同步執行。

如要傳送訊息,請按照下列步驟操作:

    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload 長度必須符合指定的大小限制。

如要接收訊息,外掛程式必須訂閱 這個 frameToFrameMessage敬上 回呼。以下程式碼範例顯示如何訂閱 frameToFrameMessage 回呼:

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

「Animation」GitHub 上的外掛程式範例 也包含了影格到影格的完整訊息範例活動開始後 側邊面板會在使用者變更輸入內容時通知主要階段。 主階段也會訂閱 frameToFrameMessage 回呼 以便接收更新後的狀態

附註

  • 只有可以看到指定參與者傳送的頁框對頁框訊息 同一個參與者如要傳送訊息給其他參與者,請按照下列指示操作: 瞭解如何分享外掛程式 狀態

  • 系統只會嘗試傳送訊息一次。為了接收訊息,寄件備份 面板都必須開啟,且應用程式必須先訂閱回呼, 訊息。