Utiliser le chat entre images

Cette page explique comment envoyer des messages côté client depuis un module complémentaire s'exécutant dans l'iframe du panneau latéral vers un module complémentaire s'exécutant dans l'iframe de la zone principale. La messagerie frame par frame n'a lieu que côté client. La distribution des messages est donc quasi instantanée.

Pour envoyer un message, procédez comme suit :

  • Utilisez la méthode notifyMainStage() pour passer du panneau latéral à la scène principale.
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • De la scène 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 frame par frame. 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 image par image envoyés par un participant donné ne sont visibles que par ce même participant. Pour envoyer des messages ou un état à d'autres participants, découvrez comment partager l'état d'un module complémentaire.

  • Une seule tentative d'envoi du message est effectuée. 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.