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