Korzystanie z funkcji przesyłania wiadomości między ramkami

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. Klatka do ramki przesyłanie wiadomości odbywa się tylko po stronie klienta, więc jest blisko natychmiast.

Aby wysłać wiadomość:

    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • Przejdź ze sceny głównej do panelu bocznego, korzystając z przycisku notifySidePanel() .
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload długość musi być zgodna z określonym limitem rozmiaru.

Aby otrzymać tę wiadomość, dodatek musi subskrybować frameToFrameMessage oddzwanianie. Poniższy przykładowy kod pokazuje, jak zasubskrybować frameToFrameMessage oddzwonienie:

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 też wywołanie zwrotne frameToFrameMessage aby otrzymać zaktualizowany stan.

Uwagi

  • Wiadomości klatkowe wysyłane przez danego uczestnika są widoczne tylko dla: dane tego samego uczestnika. Aby wysyłać wiadomości lub stany do innych uczestników: dowiedz się, jak udostępnić dodatek stanu.

  • Podjęto próbę dostarczenia wiadomości tylko raz. Aby otrzymywać wiadomości, panel odbiorczy musi być otwarty, a aplikacja musi subskrybować wywołanie zwrotne przed wysłaniem wiadomości.