Questa pagina descrive come inviare messaggi lato client da un plug-in in esecuzione nell'iframe del riquadro laterale a un plug-in in esecuzione nell'iframe della fase principale. La messaggistica frame-to-frame avviene solo lato client, pertanto la consegna dei messaggi è quasi istantanea.
Per inviare un messaggio:
- Per passare dal riquadro laterale alla schermata principale, utilizza il metodo
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Per passare dalla schermata principale al riquadro laterale, utilizza il metodo
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
La lunghezza di payload deve essere conforme al limite di dimensioni specificato.
Per ricevere il messaggio, il componente aggiuntivo deve iscriversi al callback
frameToFrameMessage. Il seguente esempio di codice mostra come iscriversi a un callbackframeToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
Il componente aggiuntivo di esempio"Animation" su GitHub include un esempio completo di messaggistica frame-to-frame. Dopo l'avvio dell'attività, il riquadro laterale invia una notifica al riquadro principale ogni volta che l'utente modifica un input.
La fase principale si abbona anche al callback frameToFrameMessage per ricevere lo stato aggiornato.
Note
I messaggi frame-to-frame inviati da un determinato partecipante sono visibili solo allo stesso partecipante. Per inviare messaggi o stato ad altri partecipanti, scopri come condividere lo stato del componente aggiuntivo.
La consegna del messaggio viene tentata una sola volta. Per ricevere i messaggi, il riquadro di ricezione deve essere aperto e l'app deve iscriversi al callback prima dell'invio del messaggio.