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