SenderWidget API JS


 SenderWidget.init(options);

Class: SenderWidget

SenderWidget это класс, необходимый для инициализации виджета и предоставляющий внешние методы для работы с виджетом.

SenderWidget.init(options)

options Object, properties:

  • companyId String (обязательный) - Уникальный идентификатор компании.
  • embedTo String (необязательный) - CSS-селектор, в который будет встроен виджет. При включении этой опции отключается возможность drag-and-drop виджета и абсолютное позиционирование виджета. По умолчанию пустая строка.
  • lang String (необязательный) - Локализация виджета. Возможные значения - ru, en или uk. По умолчанию ru.
  • draggable Boolean (необязательный) - Включает/выключает возможность drag-and-drop виджета. По умолчанию true.
  • resizable Boolean (необязательный) - Включает/выключает возможность изменения пользователем размера виджета. По умолчанию true.
  • showButton Boolean (необязательный) - Показывает/скрывает кнопку виджета на вашем сайте. По умолчанию true.
  • template String (необязательный) - Цветовая схема виджета. Возможные значения - red, green, blue, dark, orange, pink, purple, grey. По умолчанию purple.
  • autostart Boolean (необязательный) - Опция, ответственная за автоматическое отбражение виджета на вашей странице. По умолчанию false.
  • extCSSLink String (необязательный) - Путь к внешнему CSS-файлу, с помощью которого возможно кастомизировать виджет.
  • cleanHistory Boolean (необязательный) - Очищать историю переписки после переинициализации виджета. По умолчанию false.
  • height Number (необязательный) - Высота виджета при старте, значение опции должно быть не менее 480.
  • width Number (необязательный) - Ширина виджета при старте, значение опции должно быть не менее 360.
  • auth String (необязательный) - SSO-строка авторизации, сформированная по описанию: https://doc.sender.mobi/tehnologiya_edinogo_vhoda_sso.html.
  • welcomeRobotId String (необязательный) - RobotId вашего "Виджет:приветствие"-робота, с которым он будет вызван.

Instance Methods

Объект SenderWidget имеет следующие методы:

SenderWidget.on(event, handler)

  • event String - Имя события, на которое происходит подписка.
  • handler Function - Обработчик события.

Подписаться на событие виджета.

SenderWidget.off(event, handler)

  • event String - Имя события, от которого отписываются.
  • handler Function - Обработчик события.

Отписаться от события виджета.

SenderWidget.trigger(event)

  • event String - Имя события, которое необходимо вызвать.

Вызвать событие виджета.

SenderWidget.showWidget()

Показать виджет.

SenderWidget.hideWidget()

Скрыть виджет.

SenderWidget.toggleWidget(state)

  • state Boolean - Необязательный параметр, если значение равно true - приводит к открытию виджета.

Показывает либо скрывает виджет.

SenderWidget.sendTextMessage(text)

  • text String - Значение текстового сообщения пользователя.

Посылает текстовое сообщение от пользователя в чат с оператором.

SenderWidget.restart(options)

  • options Object - Значение опций при переинициализации виджета.

Вызов метода приводит к удалению старого виджета на странице и инициализации нового с переданными опциями.