Les participants à une réunion peuvent collaborer sur une activité de module complémentaire Google Meet. Lorsqu'une activité collaborative démarre, tous les participants à la réunion reçoivent une notification indiquant que l'activité est en cours.
Cette notification est adaptée à la disponibilité et à l'état d'installation du module complémentaire :
Si le module complémentaire est installé sur l'appareil du participant, il peut rejoindre l'activité.
Si le participant n'a pas installé le module complémentaire, il est invité à le faire.
Si le module complémentaire n'est pas disponible pour la plate-forme du participant, celui-ci est informé qu'il ne peut pas participer à l'activité avec son appareil actuel.
Lorsqu'un utilisateur rejoint l'activité, il charge ses propres iFrames avec le contenu de votre module complémentaire. Vous pouvez personnaliser si les nouveaux participants doivent ouvrir l'activité collaborative dans l'espace de création ou dans le panneau latéral.
Démarrer l'activité
Une activité est lancée en appelant la méthode startActivity(), qui utilise l'interface ActivityStartingState.
Étape 1 (facultative) : le module complémentaire définit l'état de départ de l'activité
ActivityStartingState contient des informations sur l'état initial du module complémentaire utilisé lorsque le participant accepte l'invitation à rejoindre l'activité.
Le module complémentaire peut définir ou mettre à jour ActivityStartingState en appelant la méthode setActivityStartingState() à tout moment avant ou pendant l'activité. Les appels à setActivityStartingState() peuvent être omis si ActivityStartingState est exclusivement défini dans l'appel à startActivity().
Étape 2 : Le module complémentaire lance l'activité
L'activité commence lorsque le module complémentaire appelle la méthode startActivity() sur MeetSidePanelClient.
La méthode startActivity() utilise un objet ActivityStartingState comme paramètre. Vous pouvez donc appeler startActivity() au lieu d'appeler setActivityStartingState().
Une fois que l'utilisateur a terminé la sélection du contenu et qu'il est prêt à démarrer une activité, appelez la méthode startActivity() dans votre module complémentaire comme suit :
sidePanelClient.startActivity({
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
Lorsque la méthode startActivity() est appelée, Meet effectue les actions suivantes :
Pour les autres participants : Meet affiche une notification indiquant que l'activité est en cours.
Pour l'initiateur : si une URL de scène principale a été spécifiée dans le
ActivityStartingState, Meet ouvre la scène principale à l'aide de l'URL duActivityStartingState.
Étape 3 : Obtenir l'état de démarrage de l'activité
Lorsqu'un utilisateur rejoint l'activité, il charge votre module complémentaire dans la scène principale ou le panneau latéral, en fonction de l'ActivityStartingState.
La propriété additionalData vous permet de partager des données initiales (également appelées "état") avec les utilisateurs qui rejoignent l'activité. Après avoir initialisé un MainStageClient ou un SidePanelClient, vous pouvez appeler la méthode getActivityStartingState() pour récupérer la propriété additionalData.
const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);
Étape 4 (facultatif) : Partager l'état du module complémentaire dans une activité
Vous pouvez également partager l'état entre les utilisateurs pendant l'activité en créant votre propre backend de synchronisation.
Exemple : Module complémentaire d'animation sur GitHub
L'exemple de module complémentaire "Animation" sur GitHub inclut la collaboration dans un module complémentaire. L'étape 1 de ce guide n'est pas incluse dans l'exemple. Au lieu de cela, lorsque l'initiateur du module complémentaire clique sur le bouton "Démarrer l'animation" dans le panneau latéral, la méthode startActivity() est appelée (étape 2) en renseignant l'état de départ avec la couleur sélectionnée par l'utilisateur. Une fois l'activité démarrée, l'étape principale récupère l'état de départ en appelant la méthode getActivityStartingState() (étape 3). L'étape 4 est omise, car l'état (la couleur sélectionnée) n'est pas partagé entre les participants pendant l'activité dans cet exemple de module complémentaire. Toutefois, les utilisateurs peuvent modifier leur propre état en sélectionnant une couleur, qui est envoyée du cadre du panneau latéral au cadre de la scène principale à l'aide de la messagerie entre cadres.
Contraintes
- Les URL spécifiées dans
ActivityStartingStatedoivent appartenir à la même origine que les origines spécifiées dans le manifeste du module complémentaire. Pour en savoir plus, consultez Sécurité des modules complémentaires. - La longueur des caractères des propriétés
sidePanelUrl,mainStageUrletadditionalDatadoit respecter les limites de taille respectives publiées dans la documentation de référence du SDK.