Перейти до вмісту
Kite Chat

Приклад бекенду

Встановлення

Перш ніж почати використовувати приклад бекенду Kite Chat, будь ласка, виконайте наведені нижче інструкції:

Додайте наступний фрагмент всередині тега <body> вашого сайту:

<script type="module">
    import { KiteChat } from 'https://unpkg.com/@pragmasoft-ukraine/kite-chat/dist/kite-chat.js';
    
    new KiteChat({endpoint});
</script>

Параметри

  • endpoint (обов’язковий): Це рядок, який вказує кінцеву точку WebSocket для підключення. Він являє собою URL-адресу, де розміщено сервер WebSocket, який буде використовуватися для зв’язку.

  • eagerlyConnect (необов’язково): Це прапор, який вказує, чи повинен екземпляр KiteChat з’єднуватися з сервером WebSocket під час ініціалізації. Якщо встановлено в true, то він встановить з’єднання одразу після створення. Якщо встановлено в false або пропущено, з’єднання буде встановлено за необхідності.

  • createIfMissing (необов’язково): Ще прапор, який визначає, чи потрібно створювати HTML-елемент KiteChat і додавати його до тіла документа, якщо він ще не існує. Якщо встановлено в true, буде створено елемент KiteChat, якщо його не буде знайдено. Якщо встановлено в false або пропущено, елемент не буде створено.

  • open (необов’язково): Цей прапор визначає, чи повинен елемент KiteChat бути спочатку відкритим або закритим при створенні. Якщо встановлено у true, вікно чату буде відкрито. Якщо встановлено в false або пропущено, вікно чату буде закрито.

  • userId (необов’язково): Рядок, який представляє унікальний ідентифікатор користувача. Якщо не вказано, буде згенеровано випадковий ідентифікатор користувача, який зберігатиметься постійно, тому один і той самий користувач матиме однаковий ідентифікатор у різних сеансах.

  • userName (необов’язково): Рядок, який визначає ім’я користувача. Це необов’язковий параметр, щоб надати користувачеві зручне ім’я для відображення в чаті.

Методи

  • connect(): Цей метод встановлює з’єднання з сервером WebSocket, вказаним кінцевою точкою в параметрах. Зазвичай він викликається автоматично, коли створюється новий екземпляр KiteChat. Вам не потрібно викликати цей метод явно, якщо ви не хочете відновити з’єднання після розриву.

  • disconnect(): Цей метод від’єднує екземпляр KiteChat від сервера WebSocket. Він надсилає повідомлення про роз’єднання на сервер і закриває WebSocket-з’єднання. Ви можете викликати цей метод, коли ви хочете вручну від’єднатися від сервера чату, наприклад, коли користувач виходить з системи або переходить зі сторінки чату.

Вітаємо в Kite Chat!