Używanie stanu rozpoczęcia współpracy

Na tej stronie opisujemy przeznaczenie CollaborationStartingState oraz sposób konfigurowania go i pobierania za pomocą pakietu SDK dodatków do Google Meet.

Omówienie stanu rozpoczęcia współpracy

Przy pierwszym otwarciu dodatku element iframe panelu bocznego wczytuje adres URL określony w pliku manifestu dodatku. Ten stan początkowy może się różnić od stanu początkowego, którego dodatek chce używać, gdy użytkownicy dołączają za pomocą zaproszenia do współpracy. Za pomocą właściwości CollaborationStartingState można określić adresy URL elementów iframe, które mają być ładowane, gdy użytkownicy dołączają za pomocą zaproszenia do współpracy. Dodatek może też używać pola additional_data do przechowywania danych potrzebnych do zainicjowania.

Ustawianie, pobieranie i usuwanie stanu rozpoczęcia współpracy

Możesz zarządzać domeną CollaborationStartingState za pomocą poniższych metod.

Ustaw CollaborationStartingState za pomocą metody MeetAddonClient.setCollaborationStartingState. Dodatek może skonfigurować CollaborationStartingState w dowolnym momencie przed współpracą lub w jej trakcie.

Adresy URL określone w metodzie MeetAddonClient.setCollaborationStartingState muszą należeć do tej samej wartości origin co źródła określone w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule o zabezpieczeniach dodatków.

Długość CollaborationStartingState.sidePanelUrl, CollaborationStartingState.mainStageUrl i CollaborationStartingState.additionalData znaków musi odpowiadać limitom rozmiaru opublikowanym w dokumentacji referencyjnej pakietu SDK.

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

Pobierz CollaborationStartingState za pomocą metody MeetAddonClient.getCollaborationStartingState.

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

Wyczyść CollaborationStartingState za pomocą metody MeetAddonClient.clearCollaborationStartingState.

    mainStageClient.clearCollaborationStartingState();