Получить настройки пользователя BX24.userOption.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
BX24.userOption.get(string name): any | undefined;
Метод BX24.userOption.get возвращает значение настройки с именем name для текущего пользователя.
Метод работает после BX24.init и читает настройки пользователя, загруженные при инициализации библиотеки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Код параметра |
Пример кода
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_str')); // вернет str
console.log(BX24.userOption.get('param_numb')); // вернет 1
console.log(BX24.userOption.get('param_obj')); // вернет {foo: 'bar'}
console.log(BX24.userOption.get('unknown')); // вернет undefined
});
Как использовать примеры в документации
Обработка ответа
Метод синхронно возвращает значение настройки пользователя.
Возвращаемые данные
|
Название |
Описание |
|
result |
Если настройка с именем |
Например, для несохраненного кода результатом будет:
undefined
Обработка ошибок
Кодов ошибок метод не возвращает. Отсутствие настройки не считается ошибкой — метод возвращает undefined.