Startstatus der Zusammenarbeit verwenden

Auf dieser Seite wird der Zweck von CollaborationStartingState beschrieben. Außerdem wird beschrieben, wie Sie ihn im Google Meet Add-ons SDK festlegen und abrufen können.

Startstatus der Zusammenarbeit

Wenn ein Add-on zum ersten Mal geöffnet wird, lädt der iFrame im Seitenbereich die im Add-on-Manifest angegebene URL. Dieser Anfangszustand kann sich vom Ausgangsstatus unterscheiden, den das Add-on verwenden möchte, wenn Nutzer über die Einladung zur Zusammenarbeit beitreten. Mit CollaborationStartingState können die iFrame-URLs angegeben werden, die geladen werden sollen, wenn Nutzer über die Einladung zur Zusammenarbeit beitreten. Außerdem kann das Feld additional_data vom Add-on verwendet werden, um alle Daten zu speichern, die es möglicherweise für die Initialisierung benötigt.

Startstatus der Zusammenarbeit festlegen, abrufen und löschen

Sie können CollaborationStartingState mit den folgenden Methoden verwalten.

Legen Sie den CollaborationStartingState mit der Methode MeetAddonClient.setCollaborationStartingState fest. Das Add-on kann die CollaborationStartingState jederzeit vor oder während der Zusammenarbeit festlegen.

Die in der Methode MeetAddonClient.setCollaborationStartingState angegebenen URLs müssen zum selben Ursprung gehören wie die im Add-on-Manifest angegebenen Ursprünge. Weitere Informationen finden Sie unter Add-on-Sicherheit.

Die Zeichenlänge CollaborationStartingState.sidePanelUrl, CollaborationStartingState.mainStageUrl und CollaborationStartingState.additionalData muss den jeweiligen Größenbeschränkungen entsprechen, die in der SDK-Referenzdokumentation veröffentlicht sind.

    mainStageClient.setCollaborationStartingState({
        sidePanelUrl: "https://app.example.com/sidepanel",
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
        // State to send to participants.
        })
    });

Rufen Sie das CollaborationStartingState mit der Methode MeetAddonClient.getCollaborationStartingState ab.

    const startingState = mainStageClient.getCollaborationStartingState();
    const additionalData = JSON.parse(startingState.additionalData);

Löschen Sie die CollaborationStartingState mit der Methode MeetAddonClient.clearCollaborationStartingState.

    mainStageClient.clearCollaborationStartingState();