Clientobjekte verwalten

Auf dieser Seite wird beschrieben, wie Sie Clientobjekte verwalten, die ein Add-on für die Kommunikation mit Google Meet benötigt.

Zuerst muss das Add-on eine Sitzung einrichten:

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

Ersetzen Sie CLOUD_PROJECT_NUMBER durch die Projektnummer Ihres Google Cloud-Projekts.

Aus der Sitzung können zwei Clientobjekte erstellt werden:

  • Die MeetMainStageClient für ein Add-on, das in der Hauptphase ausgeführt wird und mit await session.createMainStageClient() abgerufen werden kann.

  • Die MeetSidePanelClient für ein Add-on, das in der Seitenleiste ausgeführt wird und mit await session.createSidePanelClient() abgerufen werden kann.

Es ist wichtig, das richtige Client-Objekt für die Hauptbühne oder die Seitenleiste abzurufen. Wenn der falsche Client abgerufen wird, löst das Google Meet Add-ons SDK eine Ausnahme aus. Mit der Methode getFrameType() können Sie prüfen, in welchem iFrame (Hauptbühne oder Seitenleiste) das Add-on ausgeführt wird.

Das folgende Codebeispiel zeigt, wie das Clientobjekt für die Hauptbühne instanziiert wird:

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

Ersetzen Sie CLOUD_PROJECT_NUMBER durch die Projektnummer Ihres Cloud-Projekts.

Gemeinsame Funktionen

Einige Funktionen sind sowohl im MeetMainStageClient- als auch im MeetSidePanelClient-Objekt verfügbar, während andere für einen bestimmten Client spezifisch sind.

Beispiele für Funktionen, die in beiden Clients verfügbar sind:

  • Die Methode getActivityStartingState() ruft Informationen zum ursprünglichen Status des Add-ons ab, wenn der Teilnehmer die Einladung zur Teilnahme an der Aktivität annimmt.
  • Die Methode getMeetingInfo(), mit der Details zur Videokonferenz abgerufen werden, in der das Add-on ausgeführt wird.
  • Die Methode setActivityStartingState(), mit der der Anfangsstatus des Add‑ons festgelegt wird, wenn der Teilnehmer die Einladung zur Teilnahme an der Aktivität annimmt.
  • Eine umfassende Liste der Funktionen in beiden Clients finden Sie im MeetAddonClient-Objekt.

Clientspezifische Funktionen

Funktionen, die nur im Objekt MeetMainStageClient verfügbar sind:

  • Mit der Methode notifySidePanel() wird eine Nachricht an die Seitenleiste gesendet. Die Nachricht kann empfangen werden, indem Sie in der Seitenleiste den frameToFrameMessage-Callback abonnieren.

  • Mit der Methode loadSidePanel() wird der Seitenleisten-iFrame geöffnet. Die iFrame-Quelle wird auf die Seitenleisten-URL aus der Manifestdatei festgelegt.

  • Mit der Methode unloadSidePanel() wird das Seitenleisten-iFrame geschlossen. Der Add‑on-Status wird in Meet nicht beibehalten, wenn die Methode aufgerufen wird. Es liegt am Add-on, den Add-on-Status beizubehalten, bevor diese Methode aufgerufen wird.

Funktionen, die nur im Objekt MeetSidePanelClient verfügbar sind: