استفاده از پیام‌رسانی قاب‌به‌قاب

این صفحه نحوه ارسال پیام در سمت کارخواه را از برافزایی که در iframe پانل کناری اجرا می‌شود به برافزایی که در iframe مرحله اصلی اجرا می‌شود شرح می‌دهد. پیام‌رسانی قاب‌به‌قاب فقط در سمت کارخواه انجام می‌شود، بنابراین تحویل پیام تقریباً آنی است.

برای ارسال پیام:

  • از پانل کناری به صحنه اصلی، از روش notifyMainStage() استفاده کنید.
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • از صحنه اصلی به پانل کناری، از روش notifySidePanel() استفاده کنید.
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

طول payload باید با حد اندازه مشخص‌شده آن مطابقت داشته باشد.

برای دریافت پیام، برافزا باید در frameToFrameMessage فراخوانی برگشتی مشترک شود. نمونه کد زیر نحوه مشترک شدن در frameToFrameMessage callback را نشان می‌دهد:

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

برافزای نمونه «پویانمایی» در GitHub شامل نمونه کاملی از پیام‌رسانی فریم‌به‌فریم است. پس‌از شروع فعالیت، پانل کناری هرگاه کاربر ورودی را تغییر دهد به جایگاه اصلی اطلاع می‌دهد. جایگاه اصلی همچنین در frameToFrameMessage callback مشترک می‌شود تا وضعیت به‌روزشده را دریافت کند.

یادداشت‌ها

  • پیام‌های قاب‌به‌قاب ارسال‌شده توسط یک شرکت‌کننده خاص فقط برای همان شرکت‌کننده قابل‌مشاهده است. برای ارسال پیام یا وضعیت به شرکت‌کنندگان دیگر، با نحوه هم‌رسانی وضعیت برافزا آشنا شوید.

  • فقط یک‌بار برای ارسال پیام تلاش می‌شود. برای دریافت پیام، پانل دریافت‌کننده باید باز باشد و برنامه باید قبل‌از ارسال پیام، در callback مشترک شود.