本頁面說明 CollaborationStartingState
的用途,以及如何透過 Google Meet 外掛程式 SDK 設定及擷取這個 SDK。
協作起始狀態總覽
使用者首次開啟外掛程式時,側邊面板 iframe 會載入外掛程式資訊清單中指定的網址。這個初始狀態可能與外掛程式想透過協作邀請加入的使用者要使用的起始狀態不同。CollaborationStartingState
可用來指定當使用者透過協作邀請加入時,應載入的 iframe 網址。此外,外掛程式也可以使用 additional_data
欄位來儲存其初始化所需的任何資料。
設定、取得及清除協作的開始狀態
您可以使用下列方法管理 CollaborationStartingState
。
使用 MeetAddonClient.setCollaborationStartingState
方法設定 CollaborationStartingState
。這個外掛程式可在協作前或協作期間隨時設定 CollaborationStartingState
。
MeetAddonClient.setCollaborationStartingState
方法中指定的網址必須與外掛程式資訊清單中指定的來源來源相同。詳情請參閱「外掛程式安全防護」。
CollaborationStartingState.sidePanelUrl
、CollaborationStartingState.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.
})
});
使用 MeetAddonClient.getCollaborationStartingState
方法取得 CollaborationStartingState
。
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
使用 MeetAddonClient.clearCollaborationStartingState
方法清除 CollaborationStartingState
。
mainStageClient.clearCollaborationStartingState();