umbot
Version:
Мультиплатформенный фреймворк для создания голосовых навыков и чат-ботов с единой бизнес-логикой. Встроенная поддержка ВКонтакте, Telegram, Viber, MAX, Яндекс Алисы, Маруси и Сбера SmartApp. Архитектура на адаптерах позволяет подключать любые другие платф
56 lines (55 loc) • 3.39 kB
TypeScript
import { AppContext, BotController } from '../../../index';
import { BasePlatform } from '../Base/Base';
import { ITelegramContent } from './interfaces/ITelegramPlatform';
/**
* Адаптер, обеспечивающий поддержку платформы Telegram. Позволяет разрабатывать чат-ботов для Телеграм на TypeScript с использованием кросс-платформенного функционала: обработка текстовых запросов, работа с карточками и кнопками.
*
* Подключение адаптера не требует изменения существующей бизнес-логики: после интеграции
* все команды и обработчики, написанные для umbot, автоматически становятся доступны для Telegram.
* Единый интерфейс позволяет одновременно использовать одну бизнес-логику для нескольких
* платформ (Telegram, VK, Алиса и др.) без дублирования кода.
*
* Этот адаптер автоматически обрабатывает входящие webhook`и от мессенджера Telegram,
* преобразует их в унифицированный формат фреймворка и формирует ответ,
* совместимый с требованиями платформы. Подключается одной строкой и
* не мешает работе других адаптеров (например, для Алисы или Маруси).
*
* Поддерживает:
* - голосовые и текстовые запросы;
* - карточки, кнопки;
*
* Подключается как любой другой адаптер: `bot.use(new TelegramAdapter(token))`.
* Несколько адаптеров могут работать одновременно — система сама выберет подходящий
* на основе заголовков и структуры входящего запроса.
* @example
* ```ts
* // Простейший бот для Telegram, который отвечает на приветствие
* import { Bot } from 'umbot';
* import { TelegramAdapter } from 'umbot/plugins';
*
* const bot = new Bot()
* .use(new TelegramAdapter('YOUR_BOT_TOKEN'))
* .addCommand('start', ['привет'], (_text, ctx) => {
* ctx.text = 'Привет! Я твой первый бот для Telegram';
* });
*
* bot.start('localhost', 3000);
* ```
*
* @see Bot
* @see BotController
* @see BasePlatform
*/
export declare class TelegramAdapter extends BasePlatform<string | ITelegramContent> {
#private;
platformName: string;
isVoice: boolean;
limit: number;
signatureName: string;
init(appContext: AppContext): void;
isPlatformOnQuery(query: ITelegramContent, headers?: Record<string, unknown>): boolean;
setQueryData(query: ITelegramContent, controller: BotController): Promise<boolean>;
getContent(controller: BotController): Promise<string>;
static isVoice(): boolean;
getQueryExample(query: string, userId: string, count: number): Record<string, unknown>;
}