Tiện ích Business Messages

Thư viện JavaScript của tiện ích Business Messages có lập trình sẽ khởi chạy và cho phép theo dõi mức độ tương tác cho các tiện ích Business Messages theo phương thức lập trình.

Hàm và thuộc tính

Các hàm và thuộc tính cung cấp quyền kiểm soát chi tiết việc khởi chạy thành phần.

Init

Tự động khởi chạy một phần tử HTML để dùng làm tiện ích Business Messages. Hàm này trả về một lời hứa sẽ phân giải khi quá trình khởi chạy hoàn tất.

window.bmwidget.init(HTMLElement, {agentId, context}):Promise
  • HTMLElement là phần tử để khởi chạy như một tiện ích.
  • {agentId, context} là các giá trị cho thuộc tính HTML data-bm-widget-agent-id và data-bm-widget-context.

Quét

Quét tài liệu để tìm các phần tử HTML chứa thuộc tính data-bm-widget-agent-id và chuyển đổi các phần tử đó thành các tiện ích Business Messages. window.bmwidget.scan() được tự động gọi khi tải trang và trong quá trình khởi chạy tập lệnh.

window.bmwidget.scan():void

Có thể làm

Cờ boolean chỉ đọc đúng nếu thiết bị của người dùng hỗ trợ Business Messages.

window.bmwidget.supported:boolean

Sự kiện

Thư viện kích hoạt các sự kiện trên các phần tử HTML mà thư viện khởi chạy dưới dạng tiện ích Business Messages.

Liên kết thành công

Sự kiện bm-widget-bind-success kích hoạt khi một phần tử HTML được liên kết thành công dưới dạng một tiện ích Business Messages và sẵn sàng để sử dụng.

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

Liên kết không thành công

Sự kiện bm-widget-bind-fail kích hoạt khi cố gắng liên kết với một phần tử HTML không thành công. Điều này có thể xảy ra do không xác thực được URL hoặc do không lấy được phần tử HTML nói chung. Không xác thực được nếu URL chưa được đăng ký làm điểm truy cập tiện ích Business Messages hoặc thiết bị của người dùng không được hỗ trợ. Thuộc tính event.data nêu chi tiết nguyên nhân lỗi.

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

Trình kích hoạt ý định

Sự kiện bm-widget-intent-trigger kích hoạt khi người dùng nhấn vào một điểm truy cập vào tiện ích Tin nhắn cho doanh nghiệp đã khởi chạy. Sự kiện này báo hiệu một lần nhấn nhưng không cho biết nền tảng trò chuyện của Business Messages đã khởi chạy thành công hay chưa.

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