این صفحه نحوه ارسال پیام در سمت کلاینت از یک افزونه در حال اجرا در iframe پنل کناری به یک افزونه در حال اجرا در iframe صحنه اصلی را شرح میدهد. پیامرسانی فریم به فریم فقط در سمت کلاینت رخ میدهد، بنابراین تحویل پیام تقریباً آنی است.
برای ارسال پیام:
- از پنل کناری تا صحنه اصلی، از متد
notifyMainStage()استفاده کنید.
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- از مرحله اصلی تا پنل کناری، از متد
notifySidePanel()استفاده کنید.
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
طول بار payload باید با محدودیت اندازه مشخص شده آن مطابقت داشته باشد.
برای دریافت پیام، افزونه باید در فراخوانی frameToFrameMessage مشترک شود. نمونه کد زیر نحوه اشتراک در فراخوانی frameToFrameMessage را نشان میدهد:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
افزونه نمونه "انیمیشن" در گیتهاب شامل یک مثال کامل از پیامرسانی فریم به فریم است. پس از شروع فعالیت، هر زمان که کاربر ورودی را تغییر دهد، پنل کناری به مرحله اصلی اطلاع میدهد . مرحله اصلی همچنین برای دریافت وضعیت بهروز شده، در فراخوانی frameToFrameMessage مشترک میشود .
یادداشتها
پیامهای فریم به فریم ارسال شده توسط یک شرکتکننده مشخص، فقط توسط همان شرکتکننده قابل مشاهده هستند. برای ارسال پیام یا وضعیت به سایر شرکتکنندگان، نحوه اشتراکگذاری وضعیت افزونه را بیاموزید.
ارسال پیام فقط یک بار انجام میشود. برای دریافت پیامها، پنل دریافت باید باز باشد و برنامه قبل از ارسال پیام، باید در فراخوان مشترک شود.