Teilnehmer einer Besprechung können gemeinsam an einer Google Meet-Add‑on-Aktivität arbeiten. Wenn eine gemeinsame Aktivität gestartet wird, erhalten alle Teilnehmer der Besprechung eine Benachrichtigung, dass die Aktivität läuft.
Diese Benachrichtigung wird an die Verfügbarkeit und den Installationsstatus des Add‑ons angepasst:
Wenn das Add‑on beim Teilnehmer installiert ist: Er kann an der Aktivität teilnehmen.
Wenn das Add‑on beim Teilnehmer nicht installiert ist: Er wird aufgefordert, das Add‑on zu installieren.
Wenn das Add‑on für die Plattform des Teilnehmers nicht verfügbar ist: Er wird darüber informiert, dass er mit seinem aktuellen Gerät nicht an der Aktivität teilnehmen kann.
Wenn ein Nutzer an der Aktivität teilnimmt, werden seine eigenen iFrames mit Ihren Add‑on-Inhalten geladen. Sie können festlegen, ob neue Teilnehmer die gemeinsame Aktivität in der Hauptansicht oder in der Seitenleiste öffnen sollen.
Aktivität starten
Eine Aktivität wird durch Aufrufen der
startActivity()
Methode gestartet, die die
ActivityStartingState
Schnittstelle verwendet.
Schritt 1 (optional): Add‑on legt den Startstatus der Aktivität fest
Das ActivityStartingState
enthält Informationen zum Anfangsstatus des
Add‑ons, das verwendet wird, wenn der Teilnehmer die
Einladung zur Teilnahme an der Aktivität annimmt.
Das Add‑on kann die
ActivityStartingState jederzeit vor oder während der Aktivität festlegen oder aktualisieren, indem es die setActivityStartingState()
Methode aufruft. Aufrufe von
setActivityStartingState() können weggelassen werden, wenn die ActivityStartingState
ausschließlich im Aufruf von startActivity() festgelegt wird.
Schritt 2: Add‑on startet die Aktivität
Die Aktivität beginnt, wenn das Add‑on die
startActivity()
Methode für MeetSidePanelClient aufruft.
Die startActivity() Methode verwendet ein ActivityStartingState Objekt als
Parameter. Daher kann startActivity() anstelle von
setActivityStartingState() aufgerufen werden.
Sobald der Nutzer die Auswahl der Inhalte abgeschlossen hat und bereit ist, eine Aktivität zu starten, rufen Sie die Methode startActivity() in Ihrem Add‑on so auf:
sidePanelClient.startActivity({
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
Wenn die Methode startActivity() aufgerufen wird, führt Meet die folgenden Aktionen aus:
Für andere Teilnehmer: In Meet wird eine Benachrichtigung angezeigt, dass die Aktivität läuft.
Für den Initiator: Wenn in
ActivityStartingStateeine URL für die Hauptansicht angegeben wurde, öffnet Meet die Hauptansicht mit der URL ausActivityStartingState.
Schritt 3: Startstatus der Aktivität abrufen
Wenn ein Nutzer an der Aktivität teilnimmt, wird Ihr Add‑on je nach ActivityStartingState in die Hauptansicht oder die Seitenleiste geladen.
Mit der Property additionalData können Sie Anfangsdaten (auch als Status bezeichnet) für Nutzer freigeben, die an der Aktivität teilnehmen. Nachdem Sie initializing a
MainStageClient oder SidePanelClient initialisiert haben, können Sie die Methode
getActivityStartingState() aufrufen, um die Property additionalData abzurufen.
const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);
Schritt 4 (optional): Add‑on-Status in einer Aktivität freigeben
Sie können den Status auch während der Aktivität für andere Nutzer freigeben. Dazu haben Sie zwei Möglichkeiten:
- Sie können den Status selbst verwalten, indem Sie ein eigenes Synchronisierungs-Back-End erstellen.
- Sie können die Co-Doing API verwenden, mit der Sie beliebige Daten schnell und einfach für andere Nutzer freigeben können.
Beispiel: Animations-Add‑on auf GitHub
Das Beispiel-Add‑on „Animation“ auf GitHub
enthält die Zusammenarbeit in einem Add‑on. Schritt 1
aus dieser Anleitung ist nicht im Beispiel enthalten. Wenn der Initiator des Add‑ons in der Seitenleiste auf die Schaltfläche „Start the Animation“ (Animation starten) klickt, wird stattdessen die Methode startActivity() aufgerufen (Schritt 2). Dabei wird der Startstatus mit der vom Nutzer ausgewählten Farbe gefüllt. Nachdem die
Aktivität gestartet wurde, ruft die Hauptansicht den Startstatus ab, indem sie
die getActivityStartingState() Methode
(Schritt 3) aufruft. Schritt 4 wird übersprungen, da der Status (die
ausgewählte Farbe) in diesem
Beispiel-Add‑on nicht während der Aktivität für andere Teilnehmer freigegeben wird. Einzelne Nutzer können ihren eigenen Status jedoch ändern, indem sie eine Farbe auswählen. Diese wird über die Frame-to-Frame-Messaging vom Seitenleisten-Frame an den Hauptansichts-Frame gesendet.
Einschränkungen
- Die in der
ActivityStartingStateangegebenen URLs müssen zur selben Quelle gehören wie die in dem Add‑on-Manifest angegebenen Quellen. Weitere Informationen finden Sie unter Add‑on-Sicherheit. - Die
sidePanelUrlProperty,mainStageUrlProperty undadditionalDataProperty Zeichenlängen müssen den jeweiligen Größenbeschränkungen entsprechen, die in der SDK-Referenzdokumentation veröffentlicht sind.
Weitere Informationen
- Startstatus der Aktivität verwenden
- Meet-Add‑on verwenden
- Co-Doing API implementieren
- Add‑on-Sicherheit