本頁說明如何管理外掛程式與 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
回呼屬性,接收這則訊息。