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

Cette page décrit l'objectif CollaborationStartingState et comment les configurer et les 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 side-panel charge l'URL spécifiés dans le module complémentaire fichier manifeste. Cette initiale peut être différent de l'état de départ auquel à utiliser lorsque des utilisateurs rejoignent la réunion via une invitation à collaborer. La CollaborationStartingState permet de spécifier les URL iFrame à charger lorsque des utilisateurs rejoignent à l'aide de l'invitation de collaboration. De plus, le champ additional_data peut être utilisé par le module complémentaire pour stocker 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 commande MeetAddonClient.setCollaborationStartingState . Le module complémentaire peut définir CollaborationStartingState à tout moment avant le ou pendant la collaboration.

URL spécifiées dans la méthode MeetAddonClient.setCollaborationStartingState doit appartenir à la même origine que origines spécifiées dans le fichier manifeste du module complémentaire. Pour en savoir plus, consultez Module complémentaire sécurité.

La CollaborationStartingState.sidePanelUrl, CollaborationStartingState.mainStageUrl, et CollaborationStartingState.additionalData doivent respecter les limites de taille respectives, telles qu'elles sont 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 le MeetAddonClient.getCollaborationStartingState .

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

Effacez le CollaborationStartingState avec MeetAddonClient.clearCollaborationStartingState .

    mainStageClient.clearCollaborationStartingState();