ใช้การรับส่งข้อความเฟรมต่อเฟรม

หน้านี้จะอธิบายวิธีส่งข้อความในฝั่งไคลเอ็นต์จากส่วนเสริมที่ทำงานใน iframe ของแผงด้านข้างไปยังส่วนเสริมที่ทำงานใน iframe ของสเตจหลัก การรับส่งข้อความแบบเฟรมต่อเฟรมจะเกิดขึ้นที่ฝั่งไคลเอ็นต์เท่านั้น ดังนั้นการนำส่งข้อความจึงเกิดขึ้นแทบจะทันที

วิธีการส่งข้อความ

  • ใช้เมธอด notifyMainStage() จากแผงด้านข้างไปยังเวทีหลัก
    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
  • ใช้เมธอด notifySidePanel() จากเวทีหลักไปยังแผงด้านข้าง
    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

payload ความยาวต้องเป็นไปตามขีดจำกัดของขนาดที่ระบุ

ส่วนเสริมต้องติดตาม frameToFrameMessage การเรียกกลับจึงจะรับข้อความได้ ตัวอย่างโค้ดต่อไปนี้แสดงวิธีสมัครใช้frameToFrameMessageการเรียกกลับ 

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

ส่วนเสริมตัวอย่าง"ภาพเคลื่อนไหว" ใน GitHub มีตัวอย่างการรับส่งข้อความแบบเฟรมต่อเฟรมแบบเต็ม หลังจากกิจกรรมเริ่มขึ้น แผงด้านข้างจะแจ้งเตือนสเตจหลักทุกครั้งที่ผู้ใช้เปลี่ยนอินพุต นอกจากนี้ เวทีหลักยังสมัครใช้frameToFrameMessageการเรียกกลับ เพื่อรับสถานะที่อัปเดตแล้วด้วย

หมายเหตุ

  • ข้อความแบบเฟรมต่อเฟรมที่ผู้เข้าร่วมส่งจะปรากฏให้เฉพาะผู้เข้าร่วมคนนั้นเห็นเท่านั้น หากต้องการส่งข้อความหรือสถานะให้ผู้เข้าร่วมคนอื่นๆ ดูวิธีแชร์สถานะ ของส่วนเสริม

  • ระบบจะพยายามนำส่งข้อความเพียงครั้งเดียว หากต้องการรับข้อความ แผงรับต้องเปิดอยู่และแอปต้องสมัครใช้แฮนเดิลการเรียกกลับก่อนที่จะส่งข้อความ