Obtenir l'objet client

Preview développeur:disponible dans le cadre du programme Preview développeur Google Workspace, qui accorde un accès anticipé à certaines fonctionnalités.

Cette page explique comment obtenir l'objet client dont un module complémentaire a besoin pour communiquer avec Google Meet.

Tout d'abord, le module complémentaire doit établir une session:

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
    });

À partir de la session, deux objets client peuvent être créés:

• Le MeetMainStageClient d'un module complémentaire exécuté à l'étape principale, pouvant être récupéré à l'aide de await session.createMainStageClient().

• Le MeetSidePanelClient d'un module complémentaire exécuté dans le panneau latéral, pouvant être récupéré à l'aide de await session.createSidePanelClient().

Il est important de récupérer l'objet client approprié pour la scène principale ou le panneau latéral. Si le mauvais client est récupéré, le SDK des modules complémentaires Google Meet génère une exception. Pour vérifier dans quel iFrame (l'espace de création principal ou le panneau latéral) le module complémentaire s'exécute, utilisez la méthode MeetAddon.getFrameType.

L'exemple de code suivant montre comment instancier l'objet client de l'étape principale:

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
    });
  const mainStageClient = await session.createMainStageClient();

Fonctionnalité partagée

Certaines fonctionnalités sont disponibles à la fois dans MeetMainStageClient et MeetSidePanelClient, tandis que d'autres sont spécifiques à un client donné.

Voici quelques exemples de fonctionnalités disponibles dans les deux clients:

• Méthode MeetAddonClient.getCollaborationStartingState qui obtient des informations sur l'état initial du module complémentaire lorsque le participant accepte l'invitation à collaborer.
• La méthode MeetAddonClient.getMeetingInfo, qui permet d'obtenir des informations sur la réunion dans laquelle le module complémentaire est en cours d'exécution.
• La méthode MeetAddonClient.getMeetPlatformInfo, qui permet d'obtenir des informations sur la plate-forme de réunion sur laquelle le module complémentaire s'exécute.
• Le MeetAddonClient.setCollaborationStartingState qui définit l'état initial du module complémentaire lorsque le participant accepte l'invitation à collaborer.
• Pour obtenir la liste complète des fonctionnalités des deux clients, consultez l'objet MeetAddonClient.

Fonctionnalité propre au client

Fonctionnalité disponible uniquement dans MeetMainStageClient:

• Le MeetMainStageClient.notifySidePanel envoie un message au panneau latéral. Vous pouvez recevoir le message en vous abonnant au rappel frameToFrameMessage dans le panneau latéral.

• La méthode MeetMainStageClient.loadSidePanel ouvre l'iFrame du panneau latéral. La source de l'iFrame est définie sur l'URL du panneau latéral du fichier manifeste.

• La méthode MeetMainStageClient.unloadSidePanel ferme l'iFrame du panneau latéral. L'état du module complémentaire n'est pas conservé dans Meet lorsque la méthode est appelée. Il appartient au module complémentaire de conserver tout état du module avant que cette méthode ne soit appelée.

Fonctionnalité disponible uniquement dans MeetSidePanelClient:

• Le MeetSidePanelClient.notifyMainStage envoie un message à mainStage. Le message peut être reçu en s'abonnant au rappel frameToFrameMessage dans l'espace principal.