Questa pagina descrive come inviare messaggi lato client da un componente aggiuntivo in esecuzione nell'iframe del riquadro laterale a un componente aggiuntivo in esecuzione nell'iframe della fase principale. La messaggistica tra frame avviene solo sul lato client, quindi la consegna dei messaggi è quasi istantanea.
Per inviare un messaggio:
- Dal riquadro laterale alla fase principale, utilizza il metodo
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Dalla fase 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 callback frameToFrameMessage:
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 notifica alla fase principale ogni volta che l'utente modifica un input.
Inoltre, la fase principale si iscrive al callback frameToFrameMessage per ricevere lo stato aggiornato.
Note
I messaggi frame-to-frame inviati da un determinato partecipante sono visibili solo a quel partecipante. Per inviare messaggi o lo stato ad altri partecipanti, scopri come condividere lo stato del componente aggiuntivo.
La consegna dei messaggi viene tentata una sola volta. Per ricevere i messaggi, il riquadro di ricezione deve essere aperto e l'app deve iscriversi al callback prima che il messaggio venga inviato.