Clientobjekt abrufen

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen gewährt.

Auf dieser Seite wird beschrieben, wie Sie das Clientobjekt abrufen, das ein Add-on mit Google Meet kommunizieren muss.

Zuerst muss das Add-on eine Sitzung einrichten:

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

In der Sitzung können zwei Clientobjekte erstellt werden:

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

• Das 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 den Hauptbereich oder die Seitenleiste abzurufen. Wenn der falsche Client abgerufen wird, gibt das Google Meet Add-ons SDK eine Ausnahme aus. Mit der Methode MeetAddon.getFrameType können Sie prüfen, in welchem iFrame (Hauptbereich oder Seitenleiste) das Add-on ausgeführt wird.

Das folgende Codebeispiel zeigt, wie das Clientobjekt im Hauptbereich instanziiert wird:

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

Gemeinsame Funktionen

Einige Funktionen sind sowohl in MeetMainStageClient als auch in MeetSidePanelClient verfügbar, während andere nur für einen bestimmten Client verfügbar sind.

Zu den Funktionen, die in beiden Clients verfügbar sind, gehören beispielsweise:

• Die Methode MeetAddonClient.getCollaborationStartingState, mit der Informationen zum Anfangszustand des Add-ons abgerufen werden, wenn der Teilnehmer die Einladung zur Zusammenarbeit annimmt.
• Die Methode MeetAddonClient.getMeetingInfo, mit der Details zur Besprechung abgerufen werden, in der das Add-on ausgeführt wird.
• Die Methode MeetAddonClient.getMeetPlatformInfo, mit der Details zur Besprechungsplattform abgerufen werden, auf der das Add-on ausgeführt wird.
• Das MeetAddonClient.setCollaborationStartingState, das den Anfangszustand des Add-ons festlegt, wenn der Teilnehmer die Einladung zur Zusammenarbeit annimmt.
• Eine umfassende Liste der Funktionen in beiden Clients finden Sie im MeetAddonClient-Objekt.

Kundenspezifische Funktionen

Diese Funktion ist nur in MeetMainStageClient verfügbar:

• Mit dem MeetMainStageClient.notifySidePanel wird eine Nachricht an die Seitenleiste gesendet. Sie können die Nachricht empfangen, indem Sie in der Seitenleiste den frameToFrameMessage-Callback abonnieren.

• Mit der Methode MeetMainStageClient.loadSidePanel wird der iFrame der Seitenleiste geöffnet. Die iFrame-Quelle wird auf die URL des seitlichen Steuerfelds aus der Manifestdatei festgelegt.

• Mit der Methode MeetMainStageClient.unloadSidePanel wird der iFrame der Seitenleiste geschlossen. Der Add-on-Status wird in Meet nicht beibehalten, wenn die Methode aufgerufen wird. Das Add-on muss den Status des Add-ons beibehalten, bevor diese Methode aufgerufen wird.

Diese Funktion ist nur in MeetSidePanelClient verfügbar:

• Der MeetSidePanelClient.notifyMainStage sendet eine Nachricht an „mainStage“. Die Nachricht kann durch Abonnieren des frameToFrameMessage-Callbacks im Mainstage-Bereich empfangen werden.