本頁面說明如何在用戶端傳送訊息,從在側邊面板 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 回呼,接收更新後的狀態。
附註
特定參與者傳送的影格間訊息僅該參與者可見。如要傳送訊息或狀態給其他參與者,請參閱這篇文章,瞭解如何分享外掛程式狀態。
系統只會嘗試傳送訊息一次。如要接收訊息,接收面板必須開啟,且應用程式必須在訊息傳送前訂閱回呼。