本頁說明如何管理外掛程式與 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
回呼 屬性。