umbot
    Preparing search index...

    Interface IControllerApi

    Универсальный API-фасад активной платформы (controller.api).

    Даёт бизнес-логике доступ к возможностям платформы — отправить медиа, ответить на callback-кнопку — без ручного конструирования платформенных Request-классов. Реализация подбирается адаптером по controller.appType; интерфейс объявлен здесь, чтобы контроллер не зависел от модулей платформ.

    interface IControllerApi {
        answerCallback(
            text: string,
            showAlert?: boolean,
        ): Promise<Record<string, unknown> | null>;
        can(method: TApiMethod): boolean;
        sendAudio(
            file: string,
            params?: IApiMediaParams,
        ): Promise<Record<string, unknown> | null>;
        sendDocument(
            file: string,
            params?: IApiMediaParams,
        ): Promise<Record<string, unknown> | null>;
        sendPhoto(
            image: string,
            params?: IApiMediaParams,
        ): Promise<Record<string, unknown> | null>;
        sendVideo(
            file: string,
            params?: IApiMediaParams,
        ): Promise<Record<string, unknown> | null>;
    }
    Index

    Methods

    answerCallback can sendAudio sendDocument sendPhoto sendVideo

    Methods

    • Отвечает на нажатие callback-кнопки: показывает уведомление/snackbar (Telegram answerCallbackQuery, VK show_snackbar, MAX /answers). Вне callback-запроса — предупреждение в лог и null.

      Parameters

      • text: string

        Текст уведомления

      • OptionalshowAlert: boolean

        Показать как модальное окно вместо всплывающего уведомления. Поддерживает только Telegram; VK (snackbar) и MAX игнорируют параметр.

      Returns Promise<Record<string, unknown> | null>

    • Проверяет, поддерживает ли активная платформа указанный метод фасада (например, Viber возвращает false для всех — его Bot API требует URL + size, которые фасад не собирает).

      Parameters

      Returns boolean

    • Отправляет аудио пользователю текущего запроса.

      Parameters

      Returns Promise<Record<string, unknown> | null>

    • Отправляет документ/файл пользователю текущего запроса.

      Parameters

      Returns Promise<Record<string, unknown> | null>

    • Отправляет фотографию пользователю текущего запроса.

      Parameters

      Returns Promise<Record<string, unknown> | null>

    • Отправляет видео пользователю текущего запроса.

      Parameters

      Returns Promise<Record<string, unknown> | null>

    Settings

    Member Visibility

    On This Page

    Methods