استخدام ميزة "المراسلة من إطار إلى إطار"

تصف هذه الصفحة كيفية إرسال الرسائل إلى جانب العميل من التي يتم تشغيلها في اللوحة الجانبية 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 طلب معاودة الاتصال لتلقّي الحالة المعدَّلة.

ملاحظات

  • إنّ الرسائل التي يرسلها مشارك محدد من إطار إلى إطار تكون مرئية فقط من قِبل نفس المشارك. لإرسال الرسائل أو الحالة إلى مشاركين آخرين، تعرف على كيفية مشاركة إضافة الولاية.

  • تتم محاولة تسليم الرسالة مرة واحدة فقط. لتلقّي الرسائل، يجب أن تكون لوحة الاستقبال مفتوحة وأن يشترك التطبيق في طلب إعادة الاتصال قبل إرسال الرسالة.