Открыть всплывающее окно BX24.openApplication
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Метод BX24.openApplication открывает всплывающее окно с фреймом приложения. В открываемое приложение можно передать параметры и обработчик закрытия.
Метод работает только внутри фрейма приложения в Битрикс24. Вызывайте его после инициализации библиотеки в обработчике BX24.init. Собственный scope методу не нужен: он управляет интерфейсом, а не обращается к REST API.
BX24.openApplication(params?: object, closeCallback?: callable, settings?: object): void;
Параметры метода
|
Название |
Описание |
|
params |
Необязательный параметр. Произвольные параметры для открываемого приложения. Ключи и значения объекта определяет разработчик приложения. Данные передаются в параметре запроса |
|
closeCallback |
Необязательный параметр. Функция вызывается без аргументов после закрытия всплывающего окна (подробное описание) |
|
settings |
Необязательный параметр. Дополнительные настройки окна. Ключи из |
Параметр params
Объект params передает данные из исходного приложения в приложение, открытое во всплывающем окне. Например, { opened: true } будет передан как {"opened":true}.
В открытом приложении прочитайте параметр запроса PLACEMENT_OPTIONS и преобразуйте его из JSON. В PHP это можно сделать так:
$params = [];
if (array_key_exists('PLACEMENT_OPTIONS', $_REQUEST))
{
$params = json_decode($_REQUEST['PLACEMENT_OPTIONS'], true);
}
Параметр settings
|
Название |
Описание |
|
width |
Необязательный параметр. Ширина слайдера. Передается как |
|
label |
Необязательный параметр. Параметры плашки окна. Передается как |
|
title |
Необязательный параметр. Заголовок страницы. Передается как |
|
leftBoundary |
Необязательный параметр. Отступ слайдера слева. Передается как |
Параметр label
|
Название |
Описание |
|
bgColor |
Необязательный параметр. Цвет фона плашки в формате CSS, например |
|
text |
Необязательный параметр. Текст плашки |
|
color |
Необязательный параметр. Цвет текста и элементов интерфейса окна в формате CSS, например |
В некоторых контекстах открытия окна параметры bx24_label.bgColor и bx24_label.text могут не применяться. При этом bx24_label.color может влиять на цвет элементов интерфейса окна, например, иконки закрытия.
Примеры кода
Как использовать примеры в документации
Единый пример для BX24.openApplication и BX24.closeApplication:
<script src="//api.bitrix24.tech/api/v1/"></script>
<?
$placementOptions = array();
if (array_key_exists('PLACEMENT_OPTIONS', $_REQUEST))
{
$placementOptions = json_decode($_REQUEST['PLACEMENT_OPTIONS'], true);
}
if (!isset($placementOptions['opened']))
{
?>
<span onclick="openApplication()">Open</span>
<?
}
else
{
?>
<span onclick="closeApplication()">Close</span>
<?
}
?>
<script>
function openApplication()
{
BX24.openApplication(
{
opened: true
},
function()
{
alert('Application closed!');
}
);
setTimeout(closeApplication, 15000);
}
function closeApplication()
{
BX24.closeApplication();
}
</script>
Пример со слайдером
BX24.init(() => {
BX24.openApplication(
{ opened: true },
function () {
console.log('Application closed');
},
{
width: 450,
label: {
bgColor: 'pink',
text: 'my task',
color: '#07ff0e'
},
title: 'my title'
}
);
});
Обработка ответа
Метод не возвращает данные (void). Если передать функцию closeCallback, она будет вызвана без аргументов после закрытия всплывающего окна. Обработчик сообщает только о закрытии окна и не содержит результат работы открытого приложения.
Обработка ошибок
Кодов ошибок метод не возвращает. Функция closeCallback не получает объект результата или ошибки.