umbot
    Preparing search index...

    Interface IAddFormOptions<TBotController, TAnswers>

    Ключевые параметры метода Bot.addForm — регистрации многошаговой формы.

    interface IAddFormOptions<
        TBotController extends BotController = BotController,
        TAnswers extends Record<string, unknown> = Record<string, string>,
    > {
        cancelCommands?: string[];
        cancelText?: string;
        escape?: boolean;
        fields: IAddFormField<TBotController>[];
        invalidOptionText?: string;
        onComplete: (
            ctx: TBotController,
            answers: TAnswers,
            context: TFormContext,
        ) => void | Promise<void>;
        skipText?: string;
    }

    Type Parameters

    • TBotController extends BotController = BotController

      Контроллер

    • TAnswers extends Record<string, unknown> = Record<string, string>

      Тип ответов в onComplete (по умолчанию — строки)

    Index
    cancelCommands?: string[]

    Список команд, которые отменяют форму. Работают в любом регистре.

    ['отмена', 'cancel']
    
    cancelText?: string

    Текст, который получит пользователь при отмене формы.

    'Форма отменена.'
    
    escape?: boolean

    Выход по чужой кнопке или команде: нажатие callback-кнопки или текст, точно совпавший с зарегистрированной командой (addCommand/addAction), если это не вариант ответа поля, завершает форму без onComplete, и запрос уходит обычному конвейеру (команды, интенты). Без опции такой ввод считается ответом на вопрос.

    false
    

    Список полей формы. Обрабатываются последовательно — каждое поле становится своим шагом.

    invalidOptionText?: string

    Текст ошибки, когда ответ не совпал ни с одним из options поля.

    'Выберите один из вариантов.'
    
    onComplete: (
        ctx: TBotController,
        answers: TAnswers,
        context: TFormContext,
    ) => void | Promise<void>

    Колбек, вызываемый после того как заполнены ВСЕ поля. Может быть синхронным или асинхронным — фреймворк дождётся его завершения перед формированием ответа.

    Type Declaration

      • (
            ctx: TBotController,
            answers: TAnswers,
            context: TFormContext,
        ): void | Promise<void>
      • Parameters

        • ctx: TBotController

          BotController — имеет доступ к userData, тексту, кнопкам и т.д.

        • answers: TAnswers

          Объект с ответами: ключ — name поля, значение — введённый текст (или результат parse). Пропущенных необязательных полей в нём нет.

        • context: TFormContext

          Контекст, переданный в Bot.startForm ({}, если форма запущена иначе)

        Returns void | Promise<void>

    onComplete: (ctx, answers) => {
    ctx.text = `Спасибо, ${answers.name}! Мы вас записали (${answers.email}).`;
    }
    skipText?: string

    Надпись кнопки пропуска необязательного поля (optional). Работает и как текст ответа.

    'Пропустить'