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

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

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

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

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

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

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

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

หมายเหตุ

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

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