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

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

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

Метод BX24.userOption.set устанавливает значение value настройки с именем name для текущего пользователя. Установка значения происходит сразу.

Массивы и объекты сохраняются в составе набора настроек пользователя. Перед записью набор сериализуется, а при чтении восстанавливается, поэтому структуру можно получить методом BX24.userOption.get.

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

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

Название
тип

Описание

name*
string

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

value*
any

Значение настройки. Можно передать примитивное значение, массив или объект

Метод предназначен для хранения небольших значений конфигурации. Не сохраняйте с его помощью большие объемы данных.

Пример кода

BX24.init(() => {
    BX24.userOption.set('param_str', 'str');
    BX24.userOption.set('param_numb', 1);
    BX24.userOption.set('param_obj', {foo: 'bar'});

    console.log(BX24.userOption.get('param_obj')); // вернет {foo: 'bar'}
});

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

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

Метод ничего не возвращает. После вызова сохраненное значение доступно через BX24.userOption.get.

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

Метод не возвращает коды ошибок и не принимает обработчик завершения.

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

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