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

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

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

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

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

• השיטה notifyMainStage() שולחת הודעה לבמה הראשית. כדי לקבל את ההודעה, צריך להירשם למאפיין frameToFrameMessage של התקשרות חזרה בבמה המרכזית.