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 herstellen:

  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 Clientobjekt für die Hauptbühne oder die Seitenleiste abzurufen. Wenn der falsche Client abgerufen wird, wirft das Google Meet Add-ons SDK eine Ausnahme. Mit der Methode getFrameType() können Sie prüfen, in welchem iframe (Hauptbühne oder Seitenleiste) das Add-on ausgeführt wird.

Im folgenden Codebeispiel wird gezeigt, wie das Clientobjekt der 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 Funktionen für einen bestimmten Client spezifisch sind.

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

• Die Methode getActivityStartingState(), mit der Informationen zum ursprünglichen Status des Add-ons abgerufen werden, 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.
• Mit der Methode setActivityStartingState() wird der Anfangszustand des Add-ons festgelegt, wenn der Teilnehmer die Einladung zur Teilnahme an der Aktivität annimmt.
• Eine umfassende Liste der Funktionen in beiden Clients finden Sie im Objekt MeetAddonClient.

Kundenspezifische Funktionen

Features, die nur im MeetMainStageClient-Objekt verfügbar sind:

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

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

• Mit der Methode unloadSidePanel() wird der iFrame in der Seitenleiste geschlossen. Der Status des Add-ons wird beim Aufruf der Methode in Meet nicht beibehalten. Das Add-on muss den Add-on-Status vor dem Aufruf dieser Methode beibehalten.

Nur im Objekt MeetSidePanelClient verfügbare Funktionen:

• Die Methode notifyMainStage() sendet eine Nachricht an die mainStage. Die Nachricht kann empfangen werden, indem in der Mainstage die Callback-Property frameToFrameMessage abonniert wird.