使用畫面框訊息功能

本頁面說明如何透過在側邊面板 iframe 執行的外掛程式,在用戶端傳送訊息,傳送至在「主階段」iframe 中執行的外掛程式。頁框對頁框訊息只會在用戶端執行,因此訊息傳送速度幾乎在近乎即時。

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

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

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

如要接收訊息,外掛程式必須訂閱 frameToFrameMessage 回呼。以下程式碼範例說明如何訂閱 frameToFrameMessage 回呼:

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

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

附註

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

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