בדף הזה מוסבר איך לשלוח הודעות בצד הלקוח מתוסף שפועל ב-iframe של החלונית הצדדית לתוסף שפועל ב-iframe של השלב הראשי. העברת הודעות מפריים לפריים מתרחשת רק בצד הלקוח, ולכן מסירת ההודעות היא כמעט מיידית.
כדי לשלוח הודעה:
- כדי להעביר את התצוגה מהחלונית הצדדית לשידור הראשי, משתמשים בשיטה
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- כדי להעביר מהבמה הראשית לחלונית הצדדית, משתמשים בשיטה
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
האורך של payload חייב להיות בהתאם למגבלת הגודל שצוינה.
כדי לקבל את ההודעה, התוסף צריך להירשם לקריאה חוזרת (callback) של frameToFrameMessage. בדוגמת הקוד הבאה אפשר לראות איך נרשמים לקריאה חוזרת (callback) של frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
התוסף לדוגמה 'אנימציה' ב-GitHub
כולל דוגמה מלאה להעברת הודעות בין פריים לפריים. אחרי שהפעילות מתחילה, המשתמש מקבל הודעה בחלונית הצדדית בכל פעם שהוא משנה קלט.
הבמה המרכזית גם נרשמת לקבלת frameToFrameMessageקריאה חוזרת (callback)
כדי לקבל עדכונים על הסטטוס.
הערות
הודעות שנשלחות על ידי משתתף מסוים במהלך השיחה גלויות רק לאותו משתתף. כדי לשלוח הודעות או מצב למשתתפים אחרים, כדאי לקרוא איך משתפים את מצב התוסף.
המערכת מנסה למסור את ההודעה רק פעם אחת. כדי לקבל הודעות, החלונית המקבלת צריכה להיות פתוחה והאפליקציה צריכה להירשם לקריאה חוזרת לפני שההודעה נשלחת.