שימוש בהעברת הודעות מהפריים למסגרת

בדף הזה מוסבר איך לשלוח הודעות בצד הלקוח מתוסף שפועל ב-iframe של החלונית הצדדית לתוסף שפועל ב-iframe של השלב הראשי. העברת ההודעות מתבצעת רק מצד הלקוח, כך שהעברת ההודעות היא כמעט מיידית.

כדי לשלוח הודעה:

  • כדי להעביר את התמונה מהחלונית הצדדית לשידור הראשי, משתמשים ב-method‏ 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
});

תוסף לדוגמה 'אנימציה' ב-GitHub כולל דוגמה מלאה לשליחת הודעות מפריים לפריים. אחרי שהפעילות מתחילה, החלונית הצדדית מעדכנת את הבמה הראשית בכל פעם שהמשתמש משנה קלט. הבמה הראשית גם נרשמת לקריאה החוזרת frameToFrameMessage כדי לקבל את המצב המעודכן.

הערות

  • הודעות מסגרת-למסגרת שנשלחות על ידי משתתף מסוים גלויות רק לו. כדי לשלוח הודעות או מצב למשתתפים אחרים, תוכלו לקרוא איך משתפים את המצב של התוסף.

  • המערכת תנסה לשלוח את ההודעה רק פעם אחת. כדי לקבל הודעות, צריך לפתוח את הלוח המקבל והאפליקציה צריכה להירשם לשיחה החוזרת לפני שליחת ההודעה.