umbot
    Preparing search index...

    Interface IAppParam

    IAppParam Параметры приложения для платформ

    Содержит дополнительные параметры для платформ, а также тексты приветствия и помощи.

    const params: IAppParam = {
      welcome_text: 'Привет! Чем могу помочь?',
      help_text: 'Список доступных команд: ...',
      intents: [
        {
          name: 'greeting',
          slots: ['привет', 'здравствуй'],
          is_pattern: false
        }
      ]
    };
    interface IAppParam {
        empty_text?: string | string[];
        help_text?: string | string[];
        intents: IAppIntent[] | null;
        isAuthUser?: boolean;
        utm_text?: string | null;
        welcome_text?: string | string[];
    }
    Index

    Properties

    empty_text? help_text? intents isAuthUser? utm_text? welcome_text?

    Properties

    Optionalempty_text

    empty_text?: string | string[]

    Текст, который будет показан, если подходящие команды не найдены

    Может быть строкой или массивом вариантов.

    Optionalhelp_text

    help_text?: string | string[]

    Текст помощи

    Может быть строкой или массивом вариантов.

    intents: IAppIntent[] | null

    Массив интентов (команд) приложения

    intents: [
      {
        name: 'greeting',
        slots: [
          '\\bпривет\\b',                // Точное совпадение слова
          '\\bпривет[^\\s]+\\b',         // Начало слова (например, "привет" найдет "приветствие")
          '\\b(\\d{3})\\b',              // Числа от 100 до 999
          'привет \\d друг',             // Шаблон с числом между словами
          /\d{0,3}/i                     // Поиск числа от 0 до 999
        ],
        is_pattern: true
      }
    ]

    Внимание к безопасности регулярных выражений: Для интентов с is_pattern: true фреймворк автоматически проверяет все слоты (и строки, и RegExp) на уязвимости типа ReDoS. В зависимости от режима работы приложения:

    • strict_prod — опасные слоты отключаются (исключаются) с ошибкой в логах; интент сохраняется с безопасными слотами, а если опасны все — интент отбрасывается целиком.
    • prod — проверка выполняется, но выражение не удаляется и используется как есть (предупреждение при установленном re2, ошибка в логах без него).
    • dev — то же, что и prod: проверка выполняется, выражение не удаляется.

    RegExp-слоты интентов без is_pattern этой проверкой не фильтруются.

    Рекомендуется тестировать регулярные выражения в режиме dev перед выкаткой в продакшн.

    Bot.setAppMode() — метод для настройки режима работы приложения.

    isAuthUser?: boolean

    Флаг, указывающий на то, что для работы приложения необходима авторизация. Сам способ авторизации обрабатывается на стороне платформы. В случае если платформа не поддерживает механизм авторизации, саму авторизацию может реализовать разработчик приложения

    Optionalutm_text

    utm_text?: string | null

    UTM-метка для ссылок

    null — при этом к кнопкам-ссылкам автоматически добавляется utm_source=umbot&utm_medium=cpc&utm_campaign=phone

    Optionalwelcome_text

    welcome_text?: string | string[]

    Текст приветствия

    Может быть строкой или массивом вариантов.

    Settings

    Member Visibility

    On This Page

    Properties