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

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

ملاحظات

  • لا يمكن لأي شخص غير المشارك الذي أرسل الرسائل رؤية الرسائل التي أرسلها هذا المشارك في كل إطار. لإرسال رسائل أو حالة إلى المشاركين الآخرين، تعرَّف على كيفية مشاركة حالة الإضافة.

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