Utiliser l'état de début de la collaboration

Cette page décrit la fonction de CollaborationStartingState et explique comment la configurer et la récupérer à partir du SDK des modules complémentaires Google Meet.

Présentation de l'état de départ de la collaboration

Lorsqu'un module complémentaire est ouvert pour la première fois, l'iFrame du panneau latéral charge l'URL spécifiée dans le fichier manifeste du module complémentaire. Cet état initial peut être différent de l'état de départ que le module complémentaire souhaite utiliser lorsque des utilisateurs rejoignent la réunion à l'aide de l'invitation de la collaboration. L'élément CollaborationStartingState permet de spécifier les URL iFrame à charger lorsque des utilisateurs rejoignent la collaboration à l'aide de l'invitation de collaboration. En outre, le champ additional_data peut être utilisé par le module complémentaire pour stocker toutes les données dont il pourrait avoir besoin pour son initialisation.

Définir, obtenir et effacer l'état de départ de la collaboration

Vous pouvez gérer CollaborationStartingState à l'aide des méthodes suivantes.

Définissez CollaborationStartingState à l'aide de la méthode MeetAddonClient.setCollaborationStartingState. Le module complémentaire peut définir CollaborationStartingState à tout moment, avant ou pendant la collaboration.

Les URL spécifiées dans la méthode MeetAddonClient.setCollaborationStartingState doivent appartenir à la même origine que les origines spécifiées dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Sécurité des modules complémentaires.

La longueur des caractères CollaborationStartingState.sidePanelUrl, CollaborationStartingState.mainStageUrl et CollaborationStartingState.additionalData doit respecter les limites de taille respectives, telles que publiées dans la documentation de référence du SDK.

    mainStageClient.setCollaborationStartingState({
        sidePanelUrl: "https://app.example.com/sidepanel",
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
        // State to send to participants.
        })
    });

Récupérez CollaborationStartingState à l'aide de la méthode MeetAddonClient.getCollaborationStartingState.

    const startingState = mainStageClient.getCollaborationStartingState();
    const additionalData = JSON.parse(startingState.additionalData);

Effacez CollaborationStartingState avec la méthode MeetAddonClient.clearCollaborationStartingState.

    mainStageClient.clearCollaborationStartingState();