שימוש במצב ההתחלה של שיתוף הפעולה

בדף הזה מתוארת המטרה של CollaborationStartingState ואיך להגדיר ולאחזר אותו מה-SDK של Google Meet לתוספים.

סקירה כללית של מצב ההתחלה של שיתוף הפעולה

כשפותחים תוסף, הוא ה-iframe side-panel טוען את כתובת ה-URL שצוין בתוסף מניפסט. האות שמייצגת אותו יכול להיות שונה מהמצב ההתחלתי שרוצים להשתמש בו כשמשתמשים מצטרפים באמצעות להזמנה לשיתוף פעולה. CollaborationStartingState יכול לשמש כדי לציין את כתובות ה-URL של ה-iframe שאמורות להיטען כשמשתמשים מצטרפים באמצעות ההזמנה לשיתוף הפעולה. בנוסף, השדה additional_data יכול להיות משמש את התוסף כדי לאחסן את הנתונים שהוא עשוי להזדקק לו לאתחול שלו.

הגדרה, קבלה וניקוי של מצב ההתחלה של שיתוף הפעולה

אפשר לנהל את CollaborationStartingState בשיטות הבאות.

מגדירים את CollaborationStartingState באמצעות 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, באמצעות MeetAddonClient.clearCollaborationStartingState .

    mainStageClient.clearCollaborationStartingState();