Halaman ini menjelaskan cara mengirim pesan di sisi klien dari add-on yang berjalan di iframe panel samping ke add-on yang berjalan di iframe tahap utama. Pesan frame-to-frame hanya terjadi di sisi klien, sehingga pengiriman pesan hampir seketika.
Untuk mengirim pesan:
- Dari panel samping ke panggung utama, gunakan
metode
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Dari panggung utama ke panel samping, gunakan metode
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
Panjang payload
harus sesuai dengan batas ukuran yang ditentukan.
Untuk menerima pesan, add-on harus berlangganan callback frameToFrameMessage. Contoh kode berikut menunjukkan cara berlangganan callback
frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
Add-on contoh"Animation" di GitHub
menyertakan contoh lengkap pesan frame-to-frame. Setelah aktivitas dimulai,
panel samping akan memberi tahu panggung utama setiap kali pengguna mengubah input.
Tahap utama juga berlangganan callback frameToFrameMessage
untuk menerima status yang diperbarui.
Catatan
Pesan frame-to-frame yang dikirim oleh peserta tertentu hanya dapat dilihat oleh peserta yang sama. Untuk mengirim pesan atau status kepada peserta lain, pelajari cara membagikan status add-on.
Pengiriman pesan hanya dicoba satu kali. Untuk menerima pesan, panel penerima harus terbuka dan aplikasi harus berlangganan callback sebelum pesan dikirim.