أداة "الرسائل التجارية"

تعمل مكتبة JavaScript لأداة "الرسائل التجارية" على إعداد ميزة "تتبُّع التفاعل" لأدوات "الرسائل التجارية" وتفعيلها بشكل آلي.

الوظائف والخصائص

توفر الدوال والخصائص التحكم الدقيق في تهيئة العنصر.

Init

تهيئة عنصر HTML ديناميكيًا ليتم استخدامه كأداة رسائل تجارية. تعرض الدالة وعدًا يتم حله عند اكتمال التهيئة.

window.bmwidget.init(HTMLElement, {agentId, context}):Promise
  • HTMLElement هو العنصر المراد إعداده كأداة.
  • {agentId, context} هي قيم السمتين data-bm-widget-agent-id وdata-bm-widget-context.

خطوط مستقيمة

يتم فحص المستند بحثًا عن أي عناصر HTML تحتوي على السمة data-bm-widget-agent-id وتحويل هذه العناصر إلى أدوات رسائل الأنشطة التجارية. يتم استدعاء window.bmwidget.scan() تلقائيًا عند تحميل الصفحة أثناء إعداد النص البرمجي.

window.bmwidget.scan():void

متاح

علامة منطقية فقط للقراءة فقط تكون صحيحة إذا كان جهاز المستخدم يدعم الرسائل التجارية.

window.bmwidget.supported:boolean

الأحداث

تعمل المكتبة على تشغيل الأحداث على عناصر HTML التي تعدها كأدوات "الرسائل التجارية".

تم الربط بنجاح

يتم تشغيل الحدث bm-widget-bind-success عندما يتم ربط أحد عناصر HTML بنجاح كأداة في ميزة "الرسائل التجارية" وعندما يكون جاهزًا للاستخدام.

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

تعذّر الربط

يتم تشغيل حدث bm-widget-bind-fail عند إخفاق محاولة الربط بأحد عناصر HTML. قد يحدث ذلك بسبب الفشل في التحقق من صحة عنوان URL أو لإخفاق عام في الحصول على عنصر HTML. ويحدث عدم التحقّق من الصحة إذا لم يتم تسجيل عنوان URL كنقطة إدخال أداة "الرسائل التجارية" أو كان جهاز المستخدم غير متوافق. تعرض الخاصية event.data تفاصيل سبب الإخفاق.

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

مشغِّل Intent

يتم تشغيل الحدث bm-widget-intent-trigger عندما ينقر المستخدم على نقطة إدخال أداة "الرسائل التجارية" التي تم إعدادها. يشير هذا الحدث إلى نقرة، ولكنه لا يشير إلى ما إذا كانت واجهة محادثة "الرسائل التجارية" قد تم إعدادها بنجاح أم لا.

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