Методы BX24 SDK для виджетов

В виджетах можно использовать JS-методы BX24.openApplication, BX24.openPath и BX24.closeApplication. Они помогают открывать интерфейс приложения или стандартные страницы Битрикс24 прямо из встроенного виджета без вызова REST-методов.

Подробное описание синтаксиса, параметров и callback-функций смотрите в разделе Дополнительные функции BX24.js.

Быстрый переход: все методы

Открыть интерфейс в слайдере BX24.openApplicationОткрыть интерфейс в слайдере BX24.openApplication

Используйте BX24.openApplication, когда нужно открыть интерфейс вашего приложения в отдельном слайдере и передать в него произвольные параметры.

Метод используют для настроек приложения, диалогов с пользователем и показа дополнительной информации поверх текущего интерфейса. Если интерфейс виджета ограничен размером iframe, слайдер открывается поверх текущей страницы и позволяет показать отдельный интерфейс приложения без ограничений исходной области встраивания.

Метод работает на стороне интерфейса и не заменяет REST API. Его задача — управлять интерфейсом самого приложения. Подробнее в описании метода BX24.openApplication.

Открыть страницу BX24.openPathОткрыть страницу BX24.openPath

Используйте BX24.openPath, когда нужно открыть стандартную страницу Битрикс24, например карточку CRM, задачу или профиль пользователя.

Метод позволяет не дублировать стандартный интерфейс Битрикс24 внутри приложения. Его задача — навигация внутри интерфейса, а не получение данных со страницы напрямую.

Если после закрытия стандартной страницы нужно обновить данные в виджете, комбинируйте BX24.openPath с обработкой событий и интерактивным взаимодействием.

Подробнее в описании метода BX24.openPath.

Закрыть окно приложения BX24.closeApplicationЗакрыть окно приложения BX24.closeApplication

Используйте BX24.closeApplication, когда нужно закрыть окно приложения, ранее открытое через BX24.openApplication.

Метод работает на стороне интерфейса и управляет только окном приложения. Он не предназначен для закрытия произвольных стандартных слайдеров Битрикс24.

Подробнее в описании метода BX24.closeApplication.

Обзор методовОбзор методов

Scope: placement

Кто может выполнять метод: любой пользователь

Метод	Описание
BX24.openApplication	Открывает интерфейс приложения в отдельном слайдере и передает в него параметры.
BX24.openPath	Открывает стандартную страницу Битрикс24 в слайдере для перехода к готовым объектам и разделам.
BX24.closeApplication	Закрывает окно приложения, открытое через BX24.openApplication.