本頁面說明 CollaborationStartingState
的用途,以及如何從 Google Meet 外掛程式 SDK 設定及擷取。
協作起始狀態總覽
外掛程式初次開啟時,側邊面板 iframe 會載入外掛程式資訊清單中指定的網址。這個初始狀態可能與使用者透過協作邀請加入時要使用的啟動狀態不同。CollaborationStartingState
可用來指定當使用者透過協作邀請加入時,應載入的 iframe 網址。此外,外掛程式也可利用 additional_data
欄位,儲存初始化所需的任何資料。
設定、取得及清除協作開始狀態
您可以使用下列方法管理 CollaborationStartingState
。
使用 MeetAddonClient.setCollaborationStartingState
方法設定 CollaborationStartingState
。
在 MeetAddonClient.setCollaborationStartingState
方法中指定的網址,必須與外掛程式資訊清單中指定的來源相同來源。詳情請參閱附加安全防護機制。
sidePanelUrl
、mainStageUrl
和 additionalData
的長度必須遵守 SDK 參考文件中所述的個別大小限制。
mainStageClient.setCollaborationStartingState({
sidePanelUrl: "https://app.example.com/sidepanel",
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
使用 MeetAddonClient.getCollaborationStartingState
方法取得 CollaborationStartingState
。
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
使用 MeetAddonClient.clearCollaborationStartingState
方法清除 CollaborationStartingState
。
mainStageClient.clearCollaborationStartingState();