使用協作起始狀態

本頁面將說明 CollaborationStartingState敬上 以及如何透過 Google Meet 外掛程式 SDK 設定及擷取這項功能。

協作起始狀態總覽

外掛程式首次開啟時, 側邊面板 iframe 會載入網址 附加元件中指定的 資訊清單。這個初始 狀態可能會與 外掛程式希望當使用者透過 協作邀請。 CollaborationStartingState敬上 可用於指定使用者加入時,應載入的 iframe 網址 發起合作邀請此外,additional_data 欄位可以是 這個外掛程式能儲存某些可能需要的資料 以便進行初始化

設定、取得及清除協作的開始狀態

您可以使用下列方法管理 CollaborationStartingState

使用CollaborationStartingState MeetAddonClient.setCollaborationStartingState 方法。外掛程式隨時可以設定「CollaborationStartingState」 或合作期間

MeetAddonClient.setCollaborationStartingState 方法中指定的網址 必須與 外掛程式資訊清單中指定的來源。若需更多資訊,請參閲 附加內容 安全性

CollaborationStartingState.sidePanelUrlCollaborationStartingState.mainStageUrl, 和 CollaborationStartingState.additionalData 字元長度必須符合 SDK 參考文件

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

取得 CollaborationStartingState,並使用 MeetAddonClient.getCollaborationStartingState 方法。

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

清除CollaborationStartingState,使用 MeetAddonClient.clearCollaborationStartingState 方法。

    mainStageClient.clearCollaborationStartingState();