Установить настройки для приложения BX24.appOption.set

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
BX24.appOption.set(string name, any value[, Function callback]): void;

Метод BX24.appOption.set устанавливает общие настройки для текущего приложения.

Установка значений настроек приложения доступна только пользователям с правом управления приложениями (см. BX24.isAdmin). Для настроек приложения может потребоваться обработчик завершения (см. ниже параметр callback).

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Код параметра

value*
any

Значение параметра

callback
function

Обработчик, который будет вызван после сохранения. Получает объект с текущими настройками приложения (подробное описание)

Аргумент callback

В callback передается объект с текущими настройками приложения. Имена свойств совпадают с кодами настроек, а значения — со значениями, сохраненными для этих кодов.

Название
тип

Описание

<код настройки>
any

Сохраненное значение настройки. Имя свойства соответствует значению параметра name

Пример кода

BX24.init(() => {
    BX24.appOption.set('param_str', 'str1', () => {
        BX24.appOption.set('param_numb', 1, (options) => {
            console.log(options);
        });
    });
});

В приложении без других сохраненных настроек console.log выведет объект:

{
    param_str: 'str1',
    param_numb: 1
}

Как использовать примеры в документации

Обработка ответа

Метод ничего не возвращает. Результат сохранения можно обработать с помощью параметра callback. В его аргумент будут переданы текущие настройки приложения.

Обработка ошибок

Метод не возвращает коды ошибок. Если у пользователя нет права управления приложениями, настройка не сохраняется и callback не вызывается. Проверить право можно методом BX24.isAdmin.

Продолжите изучение

Предыдущая
Получить настройки пользователя
Следующая
Получить настройки приложения