Na tej stronie wyjaśniamy, jak wysyłać wiadomości po stronie klienta z poziomu dodatku działającego w elemencie iframe panelu bocznego do dodatku działającego w elemencie iframe głównej sceny. Komunikacja międzyklatkowa odbywa się tylko po stronie klienta, więc dostarczanie wiadomości jest niemal natychmiastowe.
Aby wysłać wiadomość:
- Z panelu bocznego do głównego widoku używaj metody
notifyMainStage()
.
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Z głównego widoku do panelu bocznego używaj metody
notifySidePanel()
.
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
Długość payload
musi być zgodna z określonym limitem rozmiaru.
Aby otrzymywać te wiadomości, dodatek musi subskrybować wywołanie frameToFrameMessage
. Poniższy przykładowy kod pokazuje, jak subskrybować wywołanie zwrotne frameToFrameMessage
:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
Przykładowy dodatek „Animation” na GitHubie zawiera pełny przykład przesyłania wiadomości z ramki na ramkę. Po rozpoczęciu aktywności panel boczny powiadamia główną scenę o każdej zmianie wprowadzonej przez użytkownika.
Etap główny subskrybuje również wywołanie zwrotne frameToFrameMessage
, aby otrzymywać zaktualizowany stan.
Uwagi
Wiadomości wysyłane przez danego uczestnika w trybie klatki po klatce są tylko widoczne dla tego uczestnika. Aby wysyłać wiadomości lub stan do innych uczestników, dowiedz się, jak udostępniać stan.
Próba dostarczenia wiadomości jest podejmowana tylko raz. Aby otrzymywać wiadomości, panel odbiorczy musi być otwarty, a aplikacja musi zasubskrybować wywołanie zwrotne przed wysłaniem wiadomości.