umbot
    Preparing search index...

    Interface IMenu<TBotController>

    Меню, созданное Bot.defineMenu.

    interface IMenu<TBotController extends BotController = BotController> {
        name: string;
        payload(screen: string): Record<string, unknown>;
        show(ctx: TBotController, screen?: string): void | Promise<void>;
    }

    Type Parameters

    Index
    • Payload кнопки перехода на экран — для кнопок вне меню (buttons.addBtn, bot.send).

      Parameters

      • screen: string

        Имя экрана

      Returns Record<string, unknown>

      { action, s: screen }

    • Показывает экран: текст, кнопки, «Назад», затем onShow.

      Parameters

      • ctx: TBotController

        Контроллер запроса

      • Optionalscreen: string

        Имя экрана; без него или для неизвестного — экран по умолчанию

      Returns void | Promise<void>

      Промис, только если onShow экрана асинхронный

    name: string

    Имя меню