Auf dieser Seite wird beschrieben, wie Sie clientseitig Nachrichten von einem Add-on, das im iFrame Seitenleiste ausgeführt wird, an ein Add-on senden, das im iFrame Hauptbühne ausgeführt wird. Frame-to-Frame-Messaging erfolgt nur auf der Clientseite, sodass die Nachrichtenübermittlung nahezu sofort erfolgt.
So senden Sie eine Nachricht:
- Verwenden Sie die Methode
notifyMainStage(), um die App von der Seitenleiste in den Hauptbereich zu verschieben.
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Verwenden Sie die Methode
notifySidePanel(), um die App von der Hauptbühne in die Seitenleiste zu verschieben.
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
Die Länge von payload muss der angegebenen Größenbeschränkung entsprechen.
Damit das Add-on die Nachricht empfangen kann, muss es den Callback frameToFrameMessage abonnieren. Im folgenden Codebeispiel wird gezeigt, wie Sie einen frameToFrameMessage-Callback abonnieren:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
Das Beispiel-Add-on „Animation“ auf GitHub enthält ein vollständiges Beispiel für Frame-zu-Frame-Messaging. Nach dem Start der Aktivität benachrichtigt die Seitenleiste die Hauptbühne, wenn der Nutzer eine Eingabe ändert.
Die Hauptbühne abonniert auch den Callback frameToFrameMessage, um den aktualisierten Status zu erhalten.
Hinweise
Frame-to-Frame-Nachrichten, die von einem bestimmten Teilnehmer gesendet werden, sind nur für diesen Teilnehmer sichtbar. Wenn Sie Nachrichten oder Status an andere Teilnehmer senden möchten, lesen Sie den Hilfeartikel zum Teilen des Add-on-Status.
Die Nachricht wird nur einmal zugestellt. Damit Nachrichten empfangen werden können, muss das Empfängerfeld geöffnet sein und die App muss den Callback abonnieren, bevor die Nachricht gesendet wird.