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

หน้านี้อธิบายวิธีส่งข้อความในฝั่งไคลเอ็นต์จาก 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 เพื่อรับสถานะที่อัปเดตด้วย

หมายเหตุ

  • ข้อความระหว่างเฟรมที่ผู้เข้าร่วมคนหนึ่งส่งจะแสดงต่อผู้เข้าร่วมคนนั้น เท่านั้น หากต้องการส่งข้อความหรือสถานะไปยังผู้เข้าร่วมคนอื่นๆ โปรดดูวิธีแชร์สถานะของส่วนเสริม

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