umbot
    Preparing search index...

    Interface IStepParam<TBotController>

    Параметры конфигурации шага диалога.

    Используется для регистрации шагов в системе. Шаги сохраняются между сессиями и автоматически восстанавливаются при повторном входе пользователя в навык.

    // Обычный шаг
    const step: IStepParam = {
      stepName: 'hello',
      cb: (ctx) => {
        ctx.text = 'Привет! Рад вас видеть!';
      }
    };

    // Шаг с условием пропуска (возврат false)
    const stepWithFallback: IStepParam = {
      stepName: 'expired_game',
      cb: (ctx) => {
        if (ctx.messageId === 0) {
             return false; // Пропустить шаг
        }
        ctx.text = 'Продолжаем игру...';
      }
    };
    interface IStepParam<TBotController extends BotController = BotController> {
        cb: (botController: TBotController) => false | void | Promise<void>;
        stepName: string;
    }

    Type Parameters

    Index

    Properties

    cb stepName

    Properties

    cb: (botController: TBotController) => false | void | Promise<void>

    Функция-обработчик шага. Вызывается при активации шага. Если шаг обрабатывать не нужно, то можно вернуть false. В таком случае фреймворк посчитает что шаг не был найден, и продолжит выполнение своей логики с поиском команд.

    Type Declaration

      • (botController: TBotController): false | void | Promise<void>

      • Parameters

        • botController: TBotController

          Контроллер с бизнес-логикой приложения для управления ответом

        Returns false | void | Promise<void>

        • void или undefined — шаг активен. Обработка останавливается на этом шаге, ожидается ввод пользователя.
        • false — шаг игнорируется. Фреймворк считает, что шаг не применим, и передаёт управление дальше.
    stepName: string

    Уникальное имя шага. Используется для идентификации и сохранения в сессии.

    Settings

    Member Visibility

    On This Page

    Properties