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

توضّح هذه الصفحة كيفية إرسال الرسائل من جهة العميل من إحدى الإضافات التي تعمل في إطار iframe لمحاولة اللوحة الجانبية إلى إحدى الإضافات التي تعمل في إطار iframe لمحاولةالمرحلة الرئيسية. لا تحدث المراسلة بين اللقطات إلا من جهة العميل، لذا يكون تسليم الرسائل قريباً من التلقائي.

يُرجى اتّباع الخطوات التالية لإرسال رسالة:

  • من اللوحة الجانبية إلى الشاشة الرئيسية، استخدِم الرمز notifyMainStage().
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • من الشاشة الرئيسية إلى اللوحة الجانبية، استخدِم الرمز notifySidePanel().
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

يجب أن يكون طول payload متوافقًا مع الحد الأقصى المسموح به للحجم.

لتلقّي الرسالة، يجب أن تشترك الإضافة في callback frameToFrameMessage. يوضّح نموذج الرمز البرمجي التالي كيفية الاشتراك في callback frameToFrameMessage:

sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
    // YOUR_CODE
});

يتضمّن نموذج إضافة"الرسوم المتحركة" على GitHub مثالاً كاملاً على المراسلة من إطار إلى آخر. بعد بدء النشاط، تُرسِل اللوحة الجانبية إشعارًا إلى المرحلة الرئيسية كلما غيّر المستخدم إدخالًا. تشترك أيضًا المرحلة الرئيسية في frameToFrameMessage طلب معاودة الاتصال لتلقّي الحالة المعدَّلة.

ملاحظات

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

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