Работа с window.BX24
Консольный вывод: console.log(window.BX24);
window.BX24 — это JavaScript объект, который предоставляет доступ к различным методам интерфейса API Bitrix24. Этот интерфейс позволяет взаимодействовать с платформой Bitrix24 как из внутренних, так и из внешних приложений.
API (Интерфейс программирования приложений) можно представить как запертую дверь, за которой находятся данные портала, его настройки и многое другое. Большинство методов описаны в документации, а именно в разделе «Работа с JS-библиотекой» -> «Дополнительные методы». Наиболее часто используемыми являются REST методы.
Подключение JS библиотеки
Используйте следующий код для подключения библиотеки:
<script src="//api.bitrix24.com/api/v1/"></script> (без атрибута defer!)
Описание функций можно посмотреть в логе объекта. Для этого используйте название функции и её расположение. Обратите внимание, что документация может быть неполной или трудной для понимания, и иногда лучше изучить функцию в библиотеке напрямую. Далее пример с placement.call
Структура запроса
Запросы в основном состоят из трех частей:
- Метод: название метода (как дверь, через которую мы проходим).
- Параметры: настройки выборки данных, которые будут использованы в SQL запросе.
- Функция обратного вызова: функция, которая будет выполнена после завершения запроса.
Функция обратного вызова
Функции можно разделить на синхронные и асинхронные:
- Синхронные: В основном изменяют клиентскую часть приложения (например, настройки).
- Асинхронные: Отправляют запросы к серверу без блокировки интерфейса пользователя.
BX24.isAdmin, getAuth, которая возвращает булево значение (true/false).
Пример асинхронной функции: BX24.callBatch, callMethod, которая принимает функцию обратного вызова, выполняемую после завершения запроса.
Рассмотрим пример использования:
Выполним запрос user.current, сохраняя результат в переменной get_user.
Затем выполним запрос department.get, чтобы вернуть подразделение с ID, равным массиву get_user[UF_DEPARTMENT].
Все действия, которые необходимо выполнить после получения данных, записываются в последние скобки.
Обратиться к результату можно через:
result['имя_переменной']['функция_получения_данных'].