Business Messages widget'ı JavaScript kitaplığı, Business Messages widget'ları için etkileşimi programatik olarak başlar ve etkinleştirir.
İşlevler ve özellikler
İşlevler ve özellikler, öğe başlatma üzerinde ayrıntılı bir denetim sağlar.
Başlangıç
Bir Business Messages widget'ı olarak kullanılacak bir HTML öğesini dinamik olarak başlatır. İşlev, ilk kullanıma hazırlama işlemi tamamlandığında çözümlenen bir vaatte bulunur.
window.bmwidget.init(HTMLElement, {agentId, context}):Promise
HTMLElement
, widget olarak başlatılacak öğedir.{agentId, context}
,data-bm-widget-agent-id
vedata-bm-widget-context
HTML özelliklerinin değerleridir.
Dijital izler
Dokümanı, data-bm-widget-agent-id
özelliği içeren HTML öğelerine göre tarar ve bu öğeleri Business Messages widget'larına dönüştürür. window.bmwidget.scan()
, sayfa yüklenirken ve komut dosyası başlatılırken otomatik olarak çağrılır.
window.bmwidget.scan():void
Destekleniyor
Kullanıcının cihazı Business Messages'ı destekliyorsa doğru olan salt okunur boole flag'i.
window.bmwidget.supported:boolean
Etkinlikler
Kitaplık, Business Messages widget'ları olarak ilk kullanıma sunduğu HTML öğelerindeki etkinlikleri tetikler.
Bağlama başarısı
bm-widget-bind-success
etkinliği, bir HTML öğesi başarıyla Business Messages widget'ı olarak bağlandığında ve kullanıma hazır olduğunda tetiklenir.
domNode.addEventListener('bm-widget-bind-success', (event) => {
console.log(event.data);
});
Bağlama başarısız
bm-widget-bind-fail
etkinliği, bir HTML öğesine bağlanma girişimi başarısız olduğunda tetiklenir. Bu durum, URL'nin doğrulanamamasından veya HTML öğesinin alınamamasından kaynaklanan genel bir sorundan kaynaklanabilir. URL, Business Messages widget giriş noktası olarak kayıtlı değilse veya kullanıcının cihazı desteklenmiyorsa doğrulama yapılmaz.
event.data
özelliği, hatanın nedenini ayrıntılarıyla belirtir.
domNode.addEventListener('bm-widget-bind-fail', (event) => {
console.log(event.data);
});
Niyet tetikleyici
bm-widget-intent-trigger
etkinliği, kullanıcı ilk kullanıma hazırlanan bir Business Messages widget giriş noktasına dokunduğunda tetiklenir. Bu olay bir dokunma sinyali sağlar, ancak Business Messages konuşma yüzeyinin başarıyla başlatılıp başlatılmadığını göstermez.
domNode.addEventListener('bm-widget-intent-trigger', (event) => {
console.log(event.data);
});