הדף הזה מתאר איך לנהל אובייקטים של לקוח התוסף צריך לתקשר עם 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()
.
חשוב לאחזר את אובייקט הלקוח הנכון בכל השלב הראשי
או בחלונית הצדדית. אם מאחזרים את הלקוח הלא נכון, ה-SDK של Google Meet Add-ups 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 מוגדר כתובת ה-URL של החלונית הצדדית מקובץ המניפסט.unloadSidePanel()
סוגר את ה-iframe של החלונית הצדדית. התוסף המצב לא נשמר ב-Meet כשמפעילים את השיטה. התוסף צריך לשמור את המצב שלו לפני הקריאה לשיטה הזו.
תכונות שזמינות רק באובייקט MeetSidePanelClient
:
- השיטה
notifyMainStage()
שולחת הודעה ל-mainStage. ההודעה יכולה להתקבל על ידי הרשמה להתקשרות חזרהframeToFrameMessage
בשלב הראשי.