Utilizzare i messaggi frame-to-frame

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 del palcoscenico principale. La messaggistica frame per frame avviene solo sul lato client, quindi la consegna dei messaggi è quasi istantanea.

Per inviare un messaggio:

  • Dal riquadro laterale alla schermata principale, utilizza il metodo notifyMainStage().
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");

    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

La lunghezza di payload deve rispettare il limite di dimensioni specificato.

Per ricevere il messaggio, il componente aggiuntivo deve sottoscrivere il callback frameToFrameMessage. Il seguente esempio di codice mostra come registrarsi a un callback frameToFrameMessage:

sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
    // YOUR_CODE
});

Il componente aggiuntivo di esempio"Animazione" su GitHub include un esempio completo di messaggistica frame per frame. Dopo l'avvio dell'attività, il riquadro laterale invia una notifica al palco principale ogni volta che l'utente modifica un input. Il palco principale si iscrive anche al callback frameToFrameMessage per ricevere lo stato aggiornato.

Note

  • I messaggi frame per frame inviati da un determinato partecipante sono visibili solo a questo stesso partecipante. Per inviare messaggi o stati ad altri partecipanti, scopri come condividere lo stato del componente aggiuntivo.

  • Il tentativo di invio del messaggio viene eseguito una sola volta. Per ricevere i messaggi, il pannello di ricezione deve essere aperto e l'app deve sottoscrivere il callback prima dell'invio del messaggio.