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 giữa các khung hình chỉ diễn ra ở phía máy khách, vì vậy, việc gửi tin nhắn gần như diễn ra ngay lập tức.
Để gửi tin nhắn:
- Để chuyển từ bảng điều khiển bên sang giai đoạn 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");
Độ dài của payload phải tuân thủ giới hạn kích thước đã chỉ định.
Để nhận được 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ề tính năng nhắn tin giữa các 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 giai đoạn chính bất cứ khi nào người dùng thay đổi dữ liệu đầu vào.
Sân khấu 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 giữa các khung hình do một người tham gia nhất định gửi chỉ hiển thị với 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, hãy tìm hiểu cách chia sẻ trạng thái của tiện ích bổ sung.
Tin nhắn chỉ được gửi một lần. Để nhận được thông báo, 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 thông báo được gửi.