Trang này mô tả cách gửi thông báo ở phía máy khách từ một tiện ích bổ sung đang chạy trong iframe bảng điều khiển bên đến một tiện ích bổ sung đang chạy trong iframe giai đoạn chính. Tính năng nhắn tin khung hình với khung hình chỉ xảy ra ở phía máy khách, vì vậy, việc phân phối tin nhắn gần như 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ừ giai đoạn chính đến bảng điều khiển bên, hãy sử dụng phương thức
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
Chiều dài của payload phải tuân thủ giới hạn kích thước đã chỉ định.
Để nhận thông báo, tiện ích bổ sung phải đăng ký lệnh gọi lại 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
});
Tiện ích bổ sung mẫu"Ảnh động" trên GitHub bao gồm một ví dụ đầy đủ về việc gửi thông báo từ khung này sang khung khác. 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ý lệnh gọi lại frameToFrameMessage để nhận trạng thái đã cập nhật.
Ghi chú
Tin nhắn khung hình với khung hình do một người tham gia cụ thể gửi chỉ chỉ người tham gia đó mới nhìn thấy. Để gửi thông báo hoặc trạng thái cho những người tham gia khác, hãy tìm hiểu cách chia sẻ trạng thái của tiện ích bổ sung.
Hệ thống chỉ cố gắng gửi tin nhắn một lần. Để nhận tin nhắn, bảng điều khiển nhận phải mở và ứng dụng phải đăng ký lệnh gọi lại trước khi gửi tin nhắn.