בדף הזה נסביר את המטרה של CollaborationStartingState ואיך להגדיר ולאחזר אותו מה-SDK של Google Meet לתוספים.
סקירה כללית של מצב ההתחלה של שיתוף הפעולה
כשפותחים תוסף, ה-iframe של החלונית הצדדית טוען את כתובת ה-URL שצוינה במניפסט התוספים. המצב הראשוני עשוי להיות שונה מהמצב ההתחלתי שבו התוסף רוצה להשתמש כשמשתמשים מצטרפים באמצעות ההזמנה לשיתוף פעולה. אפשר להשתמש ב-CollaborationStartingState כדי לציין את כתובות ה-URL של ה-iframe שצריך לטעון כשמשתמשים מצטרפים באמצעות ההזמנה לשיתוף פעולה. כמו כן, התוסף יכול להשתמש בשדה additional_data כדי לאחסן את הנתונים הדרושים לו לאתחול.
הגדרה, קבלה וניקוי של מצב ההתחלה של שיתוף הפעולה
אפשר לנהל את CollaborationStartingState בשיטות הבאות.
מגדירים את CollaborationStartingState באמצעות ה-method MeetAddonClient.setCollaborationStartingState. התוסף יכול להגדיר את CollaborationStartingState בכל שלב לפני שיתוף הפעולה או במהלכו.
כתובות ה-URL שמצוינות ב-method MeetAddonClient.setCollaborationStartingState חייבות להשתייך לאותו מקור כמו המקורות שצוינו במניפסט התוסף. למידע נוסף, ראו אבטחת תוספים.
אורך התווים CollaborationStartingState.sidePanelUrl, CollaborationStartingState.mainStageUrl ו-CollaborationStartingState.additionalData חייב להיות תואם למגבלות הגודל המתאימות, כפי שמופיע במסמכי העזר של ה-SDK.
mainStageClient.setCollaborationStartingState({
sidePanelUrl: "https://app.example.com/sidepanel",
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
מקבלים את CollaborationStartingState, עם השיטה MeetAddonClient.getCollaborationStartingState.
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
מוחקים את השדה CollaborationStartingState באמצעות ה-method MeetAddonClient.clearCollaborationStartingState.
mainStageClient.clearCollaborationStartingState();