הווידג'ט של Business Messages

ספריית ה-JavaScript של הווידג'ט של Business Messages מפעילה ומפעילה באופן פרוגרמטי מעקב התעניינות לווידג'טים של Business Messages.

פונקציות ונכסים

פונקציות ונכסים מאפשרים שליטה פרטנית יותר באתחול של רכיבים.

Init

הסקריפט הזה מפעיל באופן דינמי רכיב HTML שמשמש כווידג'ט של Business Messages. הפונקציה מחזירה הבטחה שמסתיימת כאשר האתחול הושלם.

window.bmwidget.init(HTMLElement, {agentId, context}):Promise

• HTMLElement הוא הרכיב שצריך להפעיל כווידג'ט.
• {agentId, context} הם הערכים של המאפיינים data-bm-widget-agent-id ו-data-bm-widget-context של HTML.

סריקה

סורקת את המסמך כדי לאתר רכיבי HTML שמכילים מאפיין data-bm-widget-agent-id וממירה אותם לווידג'טים של Business Messages. הערך window.bmwidget.scan() נקרא באופן אוטומטי במהלך טעינת הדף ובמהלך הפעלת הסקריפט.

window.bmwidget.scan():void

נתמך

סימון בוליאני לקריאה בלבד (True) אם המכשיר של המשתמש תומך ב-Business Messages.

window.bmwidget.supported:boolean

אירועים

הספרייה מפעילה אירועים ברכיבי HTML שהיא מפעילה כווידג'טים של Business Messages.

הקישור הוגדר

האירוע bm-widget-bind-success מופעל כשרכיב HTML קשור בהצלחה לווידג'ט של Business Messages והוא מוכן לשימוש.

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

הקישור נכשל

האירוע bm-widget-bind-fail מופעל כשניסיון הקישור לאלמנט HTML נכשל. זה יכול לקרות בגלל כשל באימות כתובת ה-URL או בגלל כשל כללי בהשגת רכיב ה-HTML. האימות של כתובת ה-URL לא נרשם כנקודת כניסה לווידג'ט של Business Messages, או שהמכשיר של המשתמש לא נתמך. המאפיין event.data מפרט את סיבת הכשל.

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

טריגר Intent

האירוע bm-widget-intent-trigger מופעל כשמשתמש מקיש על נקודת כניסה לווידג'ט של Business Messages. האירוע הזה מציין הקשה, אבל לא מציין אם משטח השיחה של Business Messages הופעל בהצלחה.

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