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

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

Présentation de l'état de début 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 celui que le module complémentaire souhaite utiliser lorsque les utilisateurs rejoignent la réunion à l'aide de l'invitation de collaboration. Le CollaborationStartingState permet de spécifier les URL iFrame à charger lorsque les utilisateurs rejoignent la réunion à 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.

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 la section Sécurité des modules complémentaires.

Les longueurs sidePanelUrl, mainStageUrl et additionalData doivent respecter leurs 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.
        })
    });

Obtenez le CollaborationStartingState avec la méthode MeetAddonClient.getCollaborationStartingState.

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

Effacez le CollaborationStartingState avec la méthode MeetAddonClient.clearCollaborationStartingState.

    mainStageClient.clearCollaborationStartingState();