בדף הזה מוסבר מה המטרה של CollaborationStartingState
ואיך להגדיר ולאחזר אותו מ-Google Meet Add-ons SDK.
סקירה כללית של מצב ההתחלה של שיתוף הפעולה
כשפותחים תוסף בפעם הראשונה, ה-iframe של החלונית הצדדית טוען את כתובת ה-URL שצוינה במניפסט של התוסף. המצב הראשוני הזה עשוי להיות שונה ממצב ההתחלה שבו התוסף רוצה להשתמש כאשר משתמשים מצטרפים באמצעות הזמנה לשיתוף פעולה. אפשר להשתמש ב-CollaborationStartingState
כדי לציין את כתובות ה-URL של ה-iframe שיש לטעון כשמשתמשים מצטרפים באמצעות ההזמנה לשיתוף פעולה. בנוסף, התוסף יכול להשתמש בשדה additional_data
כדי לאחסן את כל הנתונים שהוא עשוי להזדקק לו לצורך האתחול.
הגדרה, קבלה וניקוי של מצב ההתחלה של שיתוף הפעולה
אפשר לנהל את CollaborationStartingState
באמצעות השיטות הבאות.
מגדירים את CollaborationStartingState
באמצעות השיטה MeetAddonClient.setCollaborationStartingState
.
כתובות ה-URL שצוינו בשיטה MeetAddonClient.setCollaborationStartingState
חייבות להשתייך לאותו מקור
כמו המקורות שצוינו במניפסט של התוסף. למידע נוסף על אבטחה באמצעות תוספים
האורך של
sidePanelUrl
,
mainStageUrl
ו-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
באמצעות השיטה
MeetAddonClient.clearCollaborationStartingState
.
mainStageClient.clearCollaborationStartingState();