Class TelegramBot

Hierarchy

TelegramBot

Implements

SociablyBot<TelegramChat, TelegramJob, TelegramResult>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TelegramBot(__namedParameters: TelegramBotOptions): TelegramBot

- Defined in packages/telegram/src/Bot.ts:62
Parameters
- __namedParameters: TelegramBotOptions
Returns TelegramBot

Properties

engine

engine: default<TelegramChat, TelegramSegmentValue, TelegramComponent<unknown, UnitSegment<TelegramSegmentValue>>, TelegramJob, TelegramResult>

id

id: number

platform

platform: "telegram" = TELEGRAM

token

token: string

Methods

fetchFile

fetchFile(fileId: string): Promise<null | { content: ReadableStream; contentLength?: number; contentType?: string }>

- Defined in packages/telegram/src/Bot.ts:121
Parameters
- fileId: string
Returns Promise<null | { content: ReadableStream; contentLength?: number; contentType?: string }>

makeApiCall

makeApiCall<Result>(method: string, parameters?: Record<string, unknown>, uploadingFiles?: UploadingFile[]): Promise<Result>

- Defined in packages/telegram/src/Bot.ts:154
Type parameters
- Result: BotApiResult
Parameters
- method: string
- parameters: Record<string, unknown> = {}
- Optional uploadingFiles: UploadingFile[]
Returns Promise<Result>

render

render(target: null | string | number | TelegramChat, message: SociablyNode): Promise<null | TelegramDispatchResponse>

Implementation of SociablyBot.render
- Defined in packages/telegram/src/Bot.ts:105
Render UI on a Telegram chat. If chat target is null, only allow AnswerCallbackQuery, AnswerInlineQuery, AnswerShippingQuery, AnswerPreCheckoutQuery and editing inline mode messages (using EditText, EditCaption and EditMedia with inlineMessageId prop).

Parameters
- target: null | string | number | TelegramChat
- message: SociablyNode
Returns Promise<null | TelegramDispatchResponse>

start

start(): Promise<void>

- Defined in packages/telegram/src/Bot.ts:90
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in packages/telegram/src/Bot.ts:94
Returns Promise<void>

Generated using TypeDoc