LocalDocs

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Основы Converse.Js ======

**Converse.js** – это JavaScript-библиотека с открытым исходным кодом, предназначенная для создания чат-ботов и интеграции их в веб-приложения. Она предоставляет удобный интерфейс для разработки ботов, которые могут взаимодействовать с пользователями через текстовые сообщения.

==== Применение Converse.js: ====

1. Чат-боты для поддержки клиентов;

2. Внутренние корпоративные мессенджеры;

3. Социальные сети и платформы для общения;

4. Образовательные платформы;

5. Интеграция с системами искусственного интеллекта для создания более сложных ботов.



===== Установка Converse.js: =====

==== Способ 1: Установка через CDN ====

Самый быстрый способ подключить Converse.js к вашему проекту — это использование Content Delivery Network (CDN). Для этого вам нужно просто добавить соответствующие ссылки на CSS и JS файлы в ваш HTML-документ - **Файл: index.html**

**Шаги:**
**Подключите стили Converse.js:**

<code bash>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/converse.js/10.0.9/dist/converse.min.css">
</code>

**Подключите сам скрипт Converse.js:**

<code bash>
<script src="https://cdnjs.cloudflare.com/ajax/libs/converse.js/10.0.9/dist/converse.min.js"></script>
</code>

Теперь вы можете инициализировать Converse.js в вашем JavaScript-коде - **Файл: index.js**

<code bash>
converse.initialize({
    bosh_service_url: 'https://bosh.example.com',
    jid: 'user@example.com',
    password: 'password'
});
</code>


==== Способ 2: Установка через npm ====

**Шаги:**

Установите пакет Converse.js - **Файл: index.js**

<code bash>
npm install converse.js
</code>

==== Импортируйте Converse.js в свой JavaScript-файл: ====

<code bash>
import { initialize } from 'converse.js';

initialize({
    bosh_service_url: 'https://bosh.example.com',
    jid: 'user@example.com',
    password: 'password'
});
</code>

==== Способ 3: Загрузка и подключение вручную ====

Вы также можете скачать архив с последней версией **Converse.js** с официального репозитория на [[https://github.com/conversejs/converse.js/releases|GitHub]] и подключить его вручную.

**Шаги:**
Скачайте последнюю версию **Converse.js** с GitHub.
Распакуйте архив и поместите файлы //converse.min.css// и //converse.min.js// в папку вашего проекта.
Подключите эти файлы в вашем HTML-документе:
<code bash>
<link rel="stylesheet" href="/path/to/converse.min.css">
<script src="/path/to/converse.min.js"></script>
</code>
Выбор способа установки зависит от особенностей вашего проекта. Если вы хотите быстро протестировать функциональность Converse.js, лучше всего воспользоваться подключением через **CDN**. Если же проект требует более сложной настройки и интеграции, установка через **npm** будет лучшим вариантом.

===== Настройка Converse.js =====

Настройка **Converse.js** включает несколько ключевых параметров, которые позволяют адаптировать библиотеку под ваши потребности. Ниже приведены основные параметры конфигурации и примеры их использования.

==== Базовая настройка ====

Для начала работы с **Converse.js** необходимо указать базовые параметры, такие как URL сервиса BOSH, Jabber ID (JID) и пароль пользователя.

<code bash>
converse.initialize({
    bosh_service_url: 'https://bosh.example.com', // URL вашего BOSH-сервиса
    jid: 'user@example.com',                      // Ваш JID
    password: 'password',                         // Ваш пароль
    auto_login: true                              // Автоматический вход после загрузки страницы
});
</code>

===== Дополнительные параметры =====

Помимо базовых настроек, есть множество других опций, которые помогут вам настроить внешний вид и поведение **Converse.js**.

==== Внешний вид и UI ====
**show_controlbox_by_default:** Определяет, показывать ли панель управления сразу после загрузки страницы.

**auto_subscribe:** Автоматически подписываться на контакты, добавленные пользователем.

**allow_contact_requests:** Разрешить запросы контактов.

**hide_muc_server:** Скрыть имя сервера мультичатов в списке комнат.

==== Пример: ====

<code bash>
converse.initialize({
    ...,
    show_controlbox_by_default: true,
    auto_subscribe: true,
    allow_contact_requests: false,
    hide_muc_server: true
});
</code>


==== Локализация ====

**i18n:** Настройки локализации. Вы можете задать язык интерфейса и предоставить собственные переводы.
Пример:

<code bash>
converse.initialize({
    ...,
    i18n: {
        locale: 'ru',
        translations: {
            ru: {
                "Login": "Вход",
                "Password": "Пароль"
            }
        }
    }
});
</code>

===== Работа с Converse.JS =====

Работа с ** Converse.js** включает в себя интеграцию библиотеки в ваше веб-приложение, настройку основных параметров, а также использование различных методов и событий для управления поведением чата. Рассмотрим ключевые аспекты работы с **Converse.js.**

==== 1. Инициализация Converse.js ====

Первым шагом является инициализация **Converse.js** с необходимыми параметрами. Как уже упоминалось ранее, это можно сделать следующим образом:

<code bash>
converse.initialize({
    bosh_service_url: 'https://bosh.example.com',
    jid: 'user@example.com',
    password: 'password',
    auto_login: true
});
</code>

===== 2. Работа с контактами =====

==== Добавление контакта ====

Чтобы добавить новый контакт, используйте метод **addContact:**

<code bash>
converse.api.contacts.add('newcontact@example.com');
</code>

==== Удаление контакта ====

Для удаления контакта используется метод **removeContact:**

<code bash>
converse.api.contacts.remove('contacttobedeleted@example.com');
</code>

==== Получение списка контактов ====

Чтобы получить список текущих контактов, вызовите метод **getContacts:**


<code bash>
var contacts = converse.api.contacts.get();
console.log(contacts);
</code>
===== 3. Работа с сообщениями =====
==== Отправка сообщения ====
Отправить сообщение контакту можно с помощью метода **sendMessage:**

<code bash>
converse.api.chats.open('recipient@example.com').then((chat) => {
    chat.sendMessage('Hello, world!');
});
</code>
==== Получение истории сообщений ====
История сообщений доступна через метод **getMessages:**

<code bash>
var messages = converse.api.chats.get('recipient@example.com').getMessages();
console.log(messages);
</code>

===== 4. Работа с комнатами (мультичатами) =====
==== Присоединение к комнате ====
Присоединиться к существующей комнате можно с помощью метода **join:**

<code bash>
converse.api.rooms.join('roomname@conference.example.com');
</code>
==== Создание новой комнаты ====

Создать новую комнату можно методом **create:**

<code bash>
converse.api.rooms.create('newroomname@conference.example.com');
</code>

==== Выход из комнаты ====
Для выхода из комнаты используйте метод **leave:**

<code bash>
converse.api.rooms.leave('roomname@conference.example.com');
</code>

===== 5. События =====

**Converse.js** предоставляет множество событий, которые можно отслеживать и реагировать на них. Например, событие message вызывается каждый раз, когда приходит новое сообщение:

<code bash>
converse.on('message', (message) => {
    console.log(`Received message: ${message.body}`);
});
</code>

==== Другие полезные события включают: ====

**connected:** соединение установлено успешно.

**disconnected:** потеряно соединение.

**rosterContactsFetched:** список контактов загружен.

**roomCreated:** создана новая комната.

===== Заключение =====
**Converse.js** – мощный инструмент для создания веб-чатов и мессенджеров. Он предоставляет богатый набор функций и возможностей, позволяя разработчикам быстро и эффективно внедрять чат-функционал в свои проекты. Независимо от уровня подготовки, любой разработчик сможет освоить Converse.js благодаря его простоте и обширной документации.

**Полезные ресурсы:**

**Документация и примеры кода:**
Официальная документация **Converse.js** содержит подробные инструкции и примеры использования всех возможностей библиотеки.

https://m.conversejs.org/docs/html/index.html

https://m.conversejs.org/docs/html/quickstart.html


**Книги:**

Книга по JavaScript (подробное руководство)

http://kharchuk.ru/JavaScript.pdf


**Форумы и сообщества поддержки:** 
На форумах и в сообществах поддержки можно найти ответы на вопросы и обсудить проблемы с другими разработчиками.

Например:

https://forum.yunohost.org/t/fast-and-dirty-install-of-converse-js-xmpp-client-as-a-replacement-of-jappix/6255

https://github.com/conversejs/converse.js/issues/2788

**Курсы и видеоуроки:** 
Существует множество курсов и видеоуроков, посвященных работе с **Converse.js**, которые помогут вам глубже понять эту библиотеку.



Используйте эти ресурсы для дальнейшего изучения и освоения **Converse.js!**