Frame-to-Frame-Messaging verwenden

Auf dieser Seite wird beschrieben, wie Nachrichten clientseitig von einem das Add-on im side-panel-iFrame in einen das Add-on in der Hauptversion Phase angezeigt. Frame-zu-Frame Messaging findet nur auf der Client-Seite statt, sodass die Nachrichtenzustellung fast in Sekundenschnelle.

So senden Sie eine Nachricht:

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

Die payload Länge muss der angegebenen Größenbeschränkung entsprechen.

Damit Sie diese Nachricht erhalten, muss das Add-on die frameToFrameMessage Callback des Nutzers an. Das folgende Codebeispiel zeigt, wie Sie ein frameToFrameMessage-Callback:

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

Die „Animation“ Beispiel-Add-on auf GitHub enthält ein vollständiges Beispiel für Frame-zu-Frame-Messaging. Nach Beginn der Aktivität Über die Seitenleiste wird der Hauptbildschirm benachrichtigt, wenn der Nutzer eine Eingabe ändert. Die Hauptphase abonniert auch den frameToFrameMessage-Callback. um den aktualisierten Status zu erhalten.

Hinweise

  • Frame-to-Frame-Nachrichten, die von einem bestimmten Teilnehmer gesendet wurden, sind nur für über dieselbe Person sprechen. Um Nachrichten oder Status an andere Teilnehmer zu senden, Informationen zum Freigeben von Add-ons Bundesstaat.

  • Die Zustellung der Nachricht wird nur einmal versucht. Um Nachrichten zu empfangen, muss der Empfänger muss geöffnet sein und die App muss den Callback abonnieren, bevor der Nachricht gesendet.