umbot
    Preparing search index...

    Interface IAddFormOptions<TBotController>

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

    interface IAddFormOptions<TBotController extends BotController = BotController> {
        cancelCommands?: string[];
        cancelText?: string;
        fields: IAddFormField<TBotController>[];
        onComplete: (
            ctx: TBotController,
            answers: Record<string, string>,
        ) => void | Promise<void>;
    }

    Type Parameters

    Index

    Properties

    cancelCommands? cancelText? fields onComplete

    Properties

    cancelCommands?: string[]

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

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

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

    'Форма отменена.'
    fields: IAddFormField<TBotController>[]

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

    onComplete: (
        ctx: TBotController,
        answers: Record<string, string>,
    ) => void | Promise<void>

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

    Type Declaration

      • (ctx: TBotController, answers: Record<string, string>): void | Promise<void>

      • Parameters

        • ctx: TBotController

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

        • answers: Record<string, string>

          Объект с ответами: ключ — name поля, значение — введённый пользователем текст.

        Returns void | Promise<void>

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

    Settings

    Member Visibility

    On This Page

    Properties