Class default

Client for the subset of Telegram Bot API endpoints used by this app.

Index

Accessors

Constructors

Methods

sendHtmlMessage setMyCommands getUpdates getLatestOffset confirmOffset getFilePath downloadFile

Accessors

chatId

get chatId(): string
Chat id this client targets.

Returns string
The chat id passed at construction time.
- Defined in Services/Notifications/TelegramApiClient.ts:52

Constructors

constructor

new default(botToken: string, chatId: string): default
Constructs a new client bound to a single bot+chat combination.
Parameters
- botToken: string
  Bot token from @BotFather.
- chatId: string
  Default chat id used by sendHtmlMessage when not overridden.
Returns default
- Defined in Services/Notifications/TelegramApiClient.ts:42

Methods

sendHtmlMessage

sendHtmlMessage(text: string, replyMarkup?: InlineKeyboard): Promise<void>
Sends an HTML-parsed message, optionally with an inline keyboard.
Parameters
- text: string
  HTML message text (caller must pre-truncate/pre-escape).
- OptionalreplyMarkup: InlineKeyboard
  Optional inline keyboard rows.
Returns Promise<void>
Resolves when the message has been accepted by the Telegram API.

Throws
NetworkError when the Telegram API rejects the request.
- Defined in Services/Notifications/TelegramApiClient.ts:62

setMyCommands

setMyCommands(
commands: { command: string; description: string }[],
): Promise<void>
Registers the bot command list with Telegram.
Parameters
- commands: { command: string; description: string }[]
  Command list to register.
Returns Promise<void>
Resolves when the command list has been registered with Telegram.

Throws
NetworkError when setMyCommands rejects the request.
- Defined in Services/Notifications/TelegramApiClient.ts:77

getUpdates

getUpdates(offset: number, timeoutSec: number): Promise<Procedure<IPollResult>>
Fetches pending updates from Telegram starting at the given offset.
Parameters
- offset: number
  The update_id offset to pass to getUpdates.
- timeoutSec: number
  Long-poll timeout in seconds (Telegram-side).
Returns Promise<Procedure<IPollResult>>
Procedure with updates and the next offset, or failure on HTTP error.
- Defined in Services/Notifications/TelegramApiClient.ts:90

getLatestOffset

getLatestOffset(): Promise<number>
Fetches the latest update_id to use as a starting offset.

Returns Promise<number>
The next offset (latest update_id + 1), or 0 on failure.
- Defined in Services/Notifications/TelegramApiClient.ts:107

confirmOffset

confirmOffset(offset: number): Promise<void>
Confirms updates up to the given offset (best-effort, never throws).
Parameters
- offset: number
  The offset to confirm.
Returns Promise<void>
Resolves when the best-effort acknowledgement completes.
- Defined in Services/Notifications/TelegramApiClient.ts:122

getFilePath

getFilePath(fileId: string): Promise<string | false>
Looks up the file_path for a given file_id via getFile.
Parameters
- fileId: string
  The Telegram file_id.
Returns Promise<string | false>
The file_path string, or false when unavailable.
- Defined in Services/Notifications/TelegramApiClient.ts:137

downloadFile

downloadFile(filePath: string): Promise<Procedure<Buffer<ArrayBufferLike>>>
Downloads file content from the Telegram file storage.
Parameters
- filePath: string
  The Telegram file_path returned by getFilePath.
Returns Promise<Procedure<Buffer<ArrayBufferLike>>>
Procedure with the binary Buffer, or failure on HTTP error.
- Defined in Services/Notifications/TelegramApiClient.ts:153