umbot
    Preparing search index...

    Interface IButtonAction<TData, TBotController>

    Действие кнопки с данными — результат Bot.defineAction. Одно описание служит и для создания кнопки (payload { action: name, ...data }), и для обработчика нажатия, который получает уже разобранные данные.

    const kick = bot.defineAction<{ p: string }>('kick');
    kick.handle((data, ctx) => {
    ctx.text = `Исключаем участника ${data.p}`;
    });
    // в обработчике, который показывает список участников:
    kick.addBtn(ctx.buttons, 'Исключить', { p: participant.id });
    interface IButtonAction<
        TData extends TActionData = TActionData,
        TBotController extends BotController = BotController,
    > {
        name: string;
        addBtn(
            buttons: Buttons,
            title: string,
            data?: TData,
            options?: IButtonOptions,
        ): Buttons;
        handle(
            cb: (
                data: TData,
                ctx: TBotController,
            ) => string | void | Promise<string | void>,
        ): IButtonAction<TData, TBotController>;
        payload(data?: TData): Record<string, unknown>;
    }

    Type Parameters

    Index
    • Добавляет кнопку действия. Если payload длиннее 64 байт и подключён Telegram, пишет предупреждение: Telegram такую кнопку не примет.

      Parameters

      • buttons: Buttons

        Кнопки ответа (ctx.buttons)

      • title: string

        Текст кнопки

      • Optionaldata: TData

        Данные кнопки

      • Optionaloptions: IButtonOptions

        Опции кнопки (как у buttons.addBtn)

      Returns Buttons

      buttons для цепочки

    • Payload кнопки этого действия — для card.addButton() и других мест, где кнопка создаётся не через IButtonAction.addBtn. Зарезервированные ключи action и command из данных исключаются: маршрутизация нажатия всегда ведёт на это действие.

      Parameters

      • Optionaldata: TData

        Данные кнопки

      Returns Record<string, unknown>

      { action: name, ...data } без зарезервированных ключей

    name: string

    Имя действия