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, quindi la consegna dei messaggi è quasi istantanea.
Per inviare un messaggio:
- Dal riquadro laterale allo stage principale, utilizza il metodo
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Dallo stage principale al riquadro laterale, utilizza la
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
La payload
deve essere conforme al limite di dimensioni specificato.
Per ricevere il messaggio, il componente aggiuntivo deve iscriversi a
il
frameToFrameMessage
di Google. Il seguente esempio di codice mostra come iscriversi a un callbackframeToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
L'componente aggiuntivo di esempio "Animation" su GitHub include un esempio completo di messaggistica frame-to-frame. Dopo l'inizio dell'attività,
Il riquadro laterale informa la fase principale ogni volta che l'utente modifica un input.
Anche la schermata 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 lo stesso partecipante. Per inviare messaggi o lo stato ad altri partecipanti: scopri come condividere un componente aggiuntivo .
Il tentativo di consegna dei messaggi viene effettuato 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.