המשתתפים בפגישה יכולים לעבוד ביחד על פעילות בתוסף של Google Meet. כשפעילות משותפת מתחילה, כל המשתתפים בפגישה מקבלים התראה על כך.
ההתראה הזו מותאמת לזמינות ולסטטוס ההתקנה של התוסף:
אם התוסף מותקן אצל המשתתף, הוא יכול להצטרף לפעילות.
אם התוסף לא מותקן אצל המשתתף: הוא יתבקש להתקין אותו.
אם התוסף לא זמין בפלטפורמה של המשתתף: תופיע הודעה שאי אפשר להצטרף לפעילות במכשיר הנוכחי.
כשמשתמש מצטרף לפעילות, הוא טוען את מסגרות ה-iframe שלו עם התוכן של התוסף שלכם. אתם יכולים להחליט אם הפעילות המשותפת תיפתח למשתתפים חדשים בשלב הראשי או בחלונית הצדדית.
התחלת הפעילות
כדי להתחיל פעילות, קוראים ל-method startActivity(), שמשתמש בממשק ActivityStartingState.
שלב 1 (אופציונלי): התוסף מגדיר את מצב ההתחלה של הפעילות
השדה ActivityStartingState מכיל מידע על המצב הראשוני של התוסף, שמשמש כשהמשתתף מאשר את ההזמנה להצטרף לפעילות.
התוסף יכול להגדיר או לעדכן את ActivityStartingState באמצעות קריאה ל-method setActivityStartingState() בכל שלב לפני הפעילות או במהלכה. אפשר להשמיט קריאות ל-setActivityStartingState() אם ActivityStartingState מוגדר באופן בלעדי בקריאה ל-startActivity().
שלב 2: התוסף מתחיל את הפעילות
הפעילות מתחילה כשהתוסף מפעיל את ה-method startActivity() ב-MeetSidePanelClient.
ה-method startActivity() מקבלת אובייקט ActivityStartingState כפרמטר, כך שאפשר לקרוא ל-startActivity() במקום ל-setActivityStartingState().
אחרי שהמשתמש מסיים לבחור את התוכן ומוכן להתחיל פעילות, צריך להפעיל את ה-method startActivity() בתוסף באופן הבא:
sidePanelClient.startActivity({
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
כשמפעילים את השיטה startActivity(), מתבצעות הפעולות הבאות ב-Meet:
לשאר המשתתפים: תופיע ב-Meet הודעה שהפעילות נמשכת.
למשתמש שהתחיל את הפעילות: אם צוינה כתובת URL של הבמה הראשית ב-
ActivityStartingState, אפליקציית Meet פותחת את הבמה הראשית באמצעות כתובת ה-URL מה-ActivityStartingState.
שלב 3: קבלת מצב ההתחלה של הפעילות
כשמשתמש מצטרף לפעילות, התוסף נטען באזור הראשי או בחלונית הצדדית, בהתאם ל-ActivityStartingState.
המאפיין additionalData מאפשר לכם לשתף נתונים ראשוניים (שנקראים גם מצב) עם משתמשים שמצטרפים לפעילות. אחרי ההפעלה של MainStageClient או SidePanelClient, אפשר להפעיל את ה-method getActivityStartingState() כדי לאחזר את המאפיין additionalData.
const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);
שלב 4 (אופציונלי): שיתוף מצב התוסף בפעילות
אתם יכולים גם לשתף את המצב בין המשתמשים בזמן שהפעילות מתבצעת, על ידי יצירת קצה עורפי משלכם לסנכרון.
דוגמה: תוסף אנימציה ב-GitHub
התוסף לדוגמה "Animation" ב-GitHub כולל פעילות משותפת בתוסף. שלב 1 במדריך הזה לא נכלל בדוגמה. במקום זאת, כשמי שהתחיל את התוסף לוחץ על הכפתור "התחלת האנימציה" בחלונית הצדדית, מתבצעת קריאה ל-method startActivity() (שלב 2) על ידי אכלוס המצב ההתחלתי בצבע שהמשתמש בחר. אחרי שהפעילות מתחילה, הבמה הראשית מאחזרת את מצב ההתחלה על ידי קריאה ל-method getActivityStartingState() (שלב 3). שלב 4 לא מופיע, כי המצב (הצבע שנבחר) לא משותף בין המשתתפים במהלך הפעילות בתוסף לדוגמה הזה. עם זאת, משתמשים בודדים יכולים לשנות את המצב שלהם על ידי בחירת צבע, שנשלח מהפריים של החלונית הצדדית לפריים של הבמה הראשית באמצעות העברת הודעות מפריים לפריים.
מגבלות
- כתובות ה-URL שצוינו ב-
ActivityStartingStateצריכות להיות שייכות לאותו מקור כמו המקורות שצוינו במניפסט של התוסף. מידע נוסף זמין במאמר אבטחת תוספים. - אורך התווים של המאפיינים
sidePanelUrl,mainStageUrlו-additionalDataחייב לעמוד במגבלות הגודל המתאימות, כפי שפורסמו במסמכי העזר של ה-SDK.