本頁說明如何從 側邊面板 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
回呼,以接收更新的狀態。
附註
特定參與者傳送的逐格訊息只會顯示給該參與者。如要傳送訊息或狀態給其他參與者,請瞭解如何分享外掛程式狀態。
系統只會嘗試傳送訊息一次。如要接收訊息,接收端面板必須開啟,且應用程式必須先訂閱回呼,才能傳送訊息。