Questa pagina descrive come inviare messaggi sul lato client da un componente aggiuntivo in esecuzione nell' iframe del riquadro laterale a un componente aggiuntivo in esecuzione nell'iframe dello stage principale. La messaggistica da frame a frame avviene solo sul lato client, quindi la consegna dei messaggi è quasi istantanea.
Per inviare un messaggio:
- Dal riquadro laterale allo stage principale, utilizza il
notifyMainStage()metodo.
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Dallo stage principale al riquadro laterale, utilizza il
notifySidePanel()metodo.
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
La payload
lunghezza deve rispettare il limite di dimensioni specificato.
Per ricevere il messaggio, il componente aggiuntivo deve sottoscrivere
il
frameToFrameMessage
callback. Il seguente esempio di codice mostra come sottoscrivere un callback frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
Il componente aggiuntivo di esempio "Animazione" su GitHub
include un esempio completo di messaggistica da frame a frame. Dopo l'avvio dell'attività,
il riquadro laterale notifica allo stage principale ogni volta che l'utente modifica un input.
Lo stage principale sottoscrive anche il callback frameToFrameMessage
per ricevere lo stato aggiornato.
Note
I messaggi da frame a frame inviati da un determinato partecipante sono visibili solo dallo stesso partecipante. Per inviare messaggi o stati 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 sottoscrivere il callback prima dell'invio del messaggio.