توضّح هذه الصفحة كيفية إرسال الرسائل من جهة العميل من إضافة تعمل في إطار iframe اللوحة الجانبية إلى إضافة تعمل في إطار iframe المرحلة الرئيسية. لا تتم المراسلة من إطار إلى إطار إلا من جهة العميل، لذا يتم تسليم الرسائل بشكل فوري تقريبًا.
يُرجى اتّباع الخطوات التالية لإرسال رسالة:
- من اللوحة الجانبية إلى المسرح الرئيسي، استخدِم الطريقة
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- من الشاشة الرئيسية إلى اللوحة الجانبية، استخدِم الطريقة
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
يجب أن يتوافق طول payload مع الحدّ الأقصى المحدّد للحجم.
لتلقّي الرسالة، يجب أن تشترك الإضافة في دالة الاستدعاء frameToFrameMessage. يوضّح نموذج الرمز البرمجي التالي كيفية الاشتراك في دالة استدعاء frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
تتضمّن الإضافة النموذجية "Animation" على GitHub مثالاً كاملاً على المراسلة من إطار إلى آخر. بعد بدء النشاط،
تُرسل اللوحة الجانبية إشعارًا إلى العرض الرئيسي كلما غيّر المستخدم أحد المدخلات.
تتولّى المرحلة الرئيسية أيضًا الاشتراك في دالة ردّ الاتصال frameToFrameMessage
لتلقّي الحالة المعدَّلة.
ملاحظات
الرسائل المرسَلة من إطار إلى آخر من قِبل مشارك معيّن تكون مرئية فقط للمشارك نفسه. لإرسال رسائل أو حالة إلى المشاركين الآخرين، يمكنك الاطّلاع على كيفية مشاركة حالة الإضافة.
تتم محاولة تسليم الرسالة مرة واحدة فقط. لتلقّي الرسائل، يجب أن تكون لوحة الاستلام مفتوحة ويجب أن يشترك التطبيق في معاودة الاتصال قبل إرسال الرسالة.