ניהול אובייקטים של לקוח

המאמר הזה מתאר איך לנהל אובייקטים של לקוחות שהתוסף צריך לתקשר עם Google Meet.

קודם כל, התוסף צריך ליצור סשן:

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
    });

מחליפים את CLOUD_PROJECT_NUMBER במספר הפרויקט ב-Google Cloud.

מהסשן אפשר ליצור שני אובייקטים של לקוח:

חשוב לאחזר את אובייקט הלקוח הנכון לשלב הראשי או לחלונית הצדדית. אם מאחזרים את הלקוח הלא נכון, ערכת ה-SDK של Google Meet לתוספים גורמת לחריגה. כדי לבדוק באיזה iframe (שלב ראשי או חלונית צדדית) התוסף פועל, משתמשים ב-method 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() שולחת הודעה לחלונית הצדדית. כדי לקבל את ההודעה, אפשר להירשם לקריאה חוזרת (callback) של frameToFrameMessage בחלונית הצדדית.

  • השיטה loadSidePanel() פותחת את ה-iframe של החלונית הצדדית. מקור ה-iframe מוגדר ככתובת ה-URL של הלוח הצדדי בקובץ המניפסט.

  • השיטה unloadSidePanel() סוגרת את ה-iframe של החלונית הצדדית. מצב התוסף לא נשמר ב-Meet כשקוראים ל-method. התוסף צריך לשמור את המצב שלו לפני הקריאה לשיטה הזו.

תכונות שזמינות רק באובייקט MeetSidePanelClient: