Sử dụng tính năng nhắn tin theo khung hình

Trang này mô tả cách gửi thư ở phía máy khách từ một tiện ích bổ sung đang chạy trong iframe side-panel (bảng điều khiển bên) vào một tiện ích bổ sung chạy trong chính iframe của giai đoạn. Khung với khung việc nhắn tin chỉ xảy ra ở phía máy khách, vì vậy việc gửi tin nhắn sắp diễn ra tức thì.

Để gửi tin nhắn:

  • Từ bảng điều khiển bên đến sân khấu chính, hãy sử dụng phương thức notifyMainStage().
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • Từ màn hình chính đến bảng điều khiển bên, hãy sử dụng notifySidePanel() .
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload chiều dài phải tuân theo giới hạn kích thước đã chỉ định.

Để nhận tin nhắn, tiện ích bổ sung phải đăng ký thời gian frameToFrameMessage . Mã mẫu sau đây cho biết cách đăng ký Lệnh gọi lại frameToFrameMessage:

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

"Ảnh động" tiện ích bổ sung mẫu trên GitHub có một ví dụ đầy đủ về thông báo chuyển khung hình đến từng khung hình. Sau khi hoạt động bắt đầu, bảng điều khiển bên sẽ thông báo cho sân khấu chính bất cứ khi nào người dùng thay đổi dữ liệu đầu vào. Giai đoạn chính cũng đăng ký nhận lệnh gọi lại frameToFrameMessage để nhận trạng thái đã cập nhật.

Ghi chú

  • Tin nhắn được chuyển từ khung hình sang khung hình do một người tham gia nhất định gửi chỉ mới có thể xem chính người tham gia đó. Để gửi tin nhắn hoặc trạng thái cho những người tham gia khác, tìm hiểu cách chia sẻ tiện ích bổ sung trạng thái.

  • Chỉ được gửi thư một lần. Để nhận được thông báo, trình xử lý phải mở và ứng dụng phải đăng ký lệnh gọi lại trước tin nhắn đã được gửi.