הווידג'ט של 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 וממיר את הרכיבים האלה ל'עסק' ווידג'טים של Messages. window.bmwidget.scan() מופעלת באופן אוטומטי בטעינת דף ובמהלך אתחול הסקריפט.

window.bmwidget.scan():void

נתמך

סימון בוליאני לקריאה בלבד שמתקיים אם המכשיר של המשתמש תומך 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 הרכיב נכשל. הדבר עשוי לקרות בגלל כשל באימות כתובת האתר או בגלל כשל כללי בקבלת רכיב ה-HTML. האימות נכשל אם כתובת ה-URL לא נרשמה כרשומה בווידג'ט של Business Messages או שהמכשיר של המשתמש אינו נתמך. פרטי הנכס event.data הגורם לכשל.

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

טריגר של Intent

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

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