使用畫面框訊息功能

本頁面說明如何從在 側邊面板 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 上的 「Animation」範例外掛程式包含影格對影格訊息傳遞的完整範例。活動啟動後，側邊面板會在使用者變更輸入內容時通知主畫面。主階段也會訂閱 frameToFrameMessage 回呼，以便接收更新的狀態。

附註

• 特定參與者傳送的「影格對影格」訊息，只能由該參與者查看。如要傳送訊息或狀態給其他參與者，請瞭解如何分享外掛程式狀態。

• 系統只會嘗試傳送一次訊息。如要接收訊息，接收面板必須處於開啟狀態，且應用程式必須在訊息傳送前訂閱回呼。

相關主題

• 實作 Co-Doing API