Получить настройки приложения BX24.appOption.get

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

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

Метод BX24.appOption.get возвращает настройку по ее коду.

Метод работает после BX24.init и читает настройки приложения, загруженные при инициализации библиотеки.

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

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

Название
тип

Описание

name*
string

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

Пример кода

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

    console.log(BX24.appOption.get('param_str')); // вернет str1
    console.log(BX24.appOption.get('param_numb')); // вернет 1
    console.log(BX24.appOption.get('unknown')); // вернет undefined
});

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

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

Метод синхронно возвращает значение настройки приложения.

Возвращаемые данные

Название
тип

Описание

result
any|undefined

Если настройка с именем name сохранена, метод возвращает ее значение. Тип зависит от значения, переданного в BX24.appOption.set. Если настройка не сохранена, возвращает undefined

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

Кодов ошибок метод не возвращает. Отсутствие настройки не считается ошибкой — метод возвращает undefined.

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

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