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

בדף הזה מוסבר איך לנהל אובייקטים של לקוח שנדרשים לתוסף כדי לתקשר עם 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 יוצר חריגה. כדי לבדוק באיזה 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 כשקוראים ל-method. התוסף צריך לשמור את המצב שלו לפני הקריאה לשיטה הזו.

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

• השיטה notifyMainStage() שולחת הודעה ל-mainStage. כדי לקבל את ההודעה, צריך להירשם לנכס frameToFrameMessage callback ב-Mainstage.