本頁面說明如何管理外掛程式與 Google Meet 通訊時所需的用戶端物件。
首先,外掛程式必須建立工作階段:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
將 CLOUD_PROJECT_NUMBER 替換為 Google Cloud 專案的專案編號。
您可以從工作階段建立兩個用戶端物件:
在主要階段執行的外掛程式的
MeetMainStageClient
,可使用await session.createMainStageClient()
擷取。在側邊面板中執行的外掛程式的
MeetSidePanelClient
,可使用await session.createSidePanelClient()
擷取。
請務必為主要舞台或側邊面板擷取正確的用戶端物件。如果擷取到錯誤的用戶端,Google Meet 外掛程式 SDK 會擲回例外狀況。如要檢查外掛程式在哪個 iframe (主舞台或側邊面板) 中執行,請使用 getFrameType()
方法。
下列程式碼範例說明如何例項化主要階段用戶端物件:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
});
const mainStageClient = await session.createMainStageClient();
將 CLOUD_PROJECT_NUMBER 替換為 Cloud 專案的專案編號。
共用功能
部分功能適用於 MeetMainStageClient
和 MeetSidePanelClient
物件,其他功能則專用於特定用戶端。
舉例來說,兩個用戶端都支援的功能包括:
- 當參與者接受加入活動的邀請時,
getActivityStartingState()
方法會取得外掛程式的初始狀態資訊。 getMeetingInfo()
方法,可取得外掛程式執行所在會議的詳細資料。setActivityStartingState()
方法會在參與者接受加入活動的邀請時,設定外掛程式的初始狀態。- 如需這兩個用戶端的功能完整清單,請參閱
MeetAddonClient
物件。
客戶專屬功能
僅適用於
MeetMainStageClient
物件的功能:
notifySidePanel()
方法會將訊息傳送至側邊面板。如要接收訊息,請在側邊面板中訂閱frameToFrameMessage
回呼。loadSidePanel()
方法會開啟側邊面板 iframe。iframe 來源會設為資訊清單檔案中的側邊面板網址。unloadSidePanel()
方法會關閉側邊面板 iframe。呼叫方法時,外掛程式狀態不會保留在 Meet 中。在呼叫這個方法之前,外掛程式必須保留任何外掛程式狀態。
僅適用於
MeetSidePanelClient
物件的功能:
notifyMainStage()
方法會將訊息傳送至 mainStage。如要接收訊息,請在主舞台中訂閱frameToFrameMessage
回呼屬性。