Cette page explique comment envoyer des messages côté client à partir d'un module complémentaire exécuté dans l'iframe du panneau latéral à un module complémentaire exécuté dans l'iframe de la plate-forme principale. La messagerie de frame à frame ne se produit que côté client. La distribution des messages est donc quasi instantanée.
Pour envoyer un message, procédez comme suit :
- Pour passer du panneau latéral à la scène principale, utilisez la méthode
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- De l'étape principale au panneau latéral, utilisez la méthode
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
La longueur de payload doit respecter la limite de taille spécifiée.
Pour recevoir le message, le module complémentaire doit s'abonner au rappel frameToFrameMessage. L'exemple de code suivant montre comment s'abonner à un rappel frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
L'exemple de module complémentaire "Animation" sur GitHub inclut un exemple complet de messagerie image par image. Une fois l'activité lancée, le panneau latéral informe la scène principale chaque fois que l'utilisateur modifie une entrée.
La scène principale s'abonne également au rappel frameToFrameMessage pour recevoir l'état mis à jour.
Remarques
Les messages de frame à frame envoyés par un participant donné ne sont visibles que par ce même participant. Pour envoyer des messages ou des états à d'autres participants, découvrez comment partager l'état du module complémentaire.
La distribution du message n'est tentée qu'une seule fois. Pour recevoir des messages, le panneau de réception doit être ouvert et l'application doit s'abonner au rappel avant l'envoi du message.