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

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 từng 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 tức thì.

Để gửi tin nhắn:

  • Từ bảng điều khiển bên đến vùng hiển thị chính, hãy sử dụng phương thức notifyMainStage().
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • Từ sân khấu 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 payload phải tuân thủ giới hạn kích thước đượ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ẫu mã sau đây cho thấy cách đăng ký nhận lệnh gọi lại frameToFrameMessage:

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

Tiện ích bổ sung "Animation" mẫu trên GitHub có một ví dụ đầy đủ về việc truyền thông báo theo 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 giai đoạn 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ú

  • Chỉ người tham gia đã gửi tin nhắn mới nhìn thấy được tin nhắn theo từng khung hình. Để 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 đang mở và ứng dụng phải đăng ký lệnh gọi lại trước khi tin nhắn được gửi.