Widget Business Messages

Library JavaScript widget Business Messages secara terprogram menginisialisasi dan mengaktifkan pelacakan interaksi untuk widget Business Messages.

Fungsi dan properti

Fungsi dan properti memberikan kontrol terperinci atas inisialisasi elemen.

Init

Melakukan inisialisasi elemen HTML secara dinamis untuk digunakan sebagai widget Business Messages. Fungsi ini menampilkan promise yang akan di-resolve saat inisialisasi selesai.

window.bmwidget.init(HTMLElement, {agentId, context}):Promise
  • HTMLElement adalah elemen untuk diinisialisasi sebagai widget.
  • {agentId, context} adalah nilai untuk atribut HTML data-bm-widget-agent-id dan data-bm-widget-context.

Periksa

Memindai dokumen untuk menemukan elemen HTML yang berisi atribut data-bm-widget-agent-id dan mengonversi elemen tersebut menjadi widget Business Messages. window.bmwidget.scan() secara otomatis dipanggil saat halaman dimuat dan selama inisialisasi skrip.

window.bmwidget.scan():void

Didukung

Flag boolean hanya baca yang benar jika perangkat pengguna mendukung Business Messages.

window.bmwidget.supported:boolean

Peristiwa

Library memicu peristiwa pada elemen HTML yang diinisialisasi sebagai widget Business Messages.

Pengikatan berhasil

Peristiwa bm-widget-bind-success dipicu saat elemen HTML berhasil diikat sebagai widget Business Messages dan siap digunakan.

domNode.addEventListener('bm-widget-bind-success', (event) => {
  console.log(event.data);
});

Pengikatan gagal

Peristiwa bm-widget-bind-fail dipicu saat upaya untuk mengikat ke elemen HTML gagal. Hal ini dapat terjadi karena kegagalan untuk memvalidasi URL atau karena kegagalan umum untuk mendapatkan elemen HTML. Kegagalan untuk memvalidasi hal ini akan terjadi jika URL belum terdaftar sebagai titik entri widget Business Messages atau perangkat pengguna tidak didukung. Properti event.data menjelaskan penyebab kegagalan.

domNode.addEventListener('bm-widget-bind-fail', (event) => {
  console.log(event.data);
});

Pemicu intent

Peristiwa bm-widget-intent-trigger dipicu saat pengguna mengetuk titik entri widget Business Messages yang diinisialisasi. Peristiwa ini menandakan ketukan, tetapi tidak menunjukkan apakah platform percakapan Business Messages berhasil diinisialisasi.

domNode.addEventListener('bm-widget-intent-trigger', (event) => {
  console.log(event.data);
});