Class default

Telegram notification channel — formats and sends import summaries via the Bot API.

Implements

INotifier

Index

Constructors

Methods

sendSummary sendMessage sendError sendScanMenu waitForReply registerCommands downloadPhoto sendInlineMenu

Constructors

constructor

new default(config: ITelegramConfig, maxTransactions?: number): default
Creates a TelegramNotifier from the given config.
Parameters
- config: ITelegramConfig
  Telegram bot token, chat ID, message format, and transaction display mode.
- OptionalmaxTransactions: number
  Override for the max transactions shown per account.
Returns default
- Defined in Services/Notifications/TelegramNotifier.ts:48

Methods

sendSummary

sendSummary(summary: IImportSummary): Promise<void>
Formats and sends an import summary message to the configured Telegram chat.
Parameters
- summary: IImportSummary
  The ImportSummary to format and send.
Returns Promise<void>
Implementation of INotifier.sendSummary
- Defined in Services/Notifications/TelegramNotifier.ts:61

sendMessage

sendMessage(text: string): Promise<void>
Sends a plain HTML text message to the configured Telegram chat.
Parameters
- text: string
  The HTML-formatted text to send.
Returns Promise<void>
Implementation of INotifier.sendMessage
- Defined in Services/Notifications/TelegramNotifier.ts:76

sendError

sendError(error: string): Promise<void>
Sends an error notification with a fixed header to the configured Telegram chat.
Parameters
- error: string
  The error message string to include.
Returns Promise<void>
Implementation of INotifier.sendError
- Defined in Services/Notifications/TelegramNotifier.ts:86

sendScanMenu

sendScanMenu(banks: string[]): Promise<Procedure<{ status: string }>>
Sends an inline keyboard menu with a button per bank and an "All banks" button.
Parameters
- banks: string[]
  List of bank names to display as inline keyboard buttons.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the menu was sent or describing the failure.
- Defined in Services/Notifications/TelegramNotifier.ts:99

waitForReply

waitForReply(prompt: string, timeoutMs: number): Promise<string>
Sends a prompt and polls for the next non-command reply from the chat.
Parameters
- prompt: string
  HTML-formatted message to send before waiting.
- timeoutMs: number
  Maximum milliseconds to wait before throwing a timeout error.
Returns Promise<string>
The text content of the first valid reply message.
- Defined in Services/Notifications/TelegramNotifier.ts:111

registerCommands

registerCommands(
extras?: { command: string; description: string }[],
): Promise<Procedure<{ status: string }>>
Registers the bot's command list with Telegram via setMyCommands.
Parameters
- extras: { command: string; description: string }[] = []
  Additional commands to include beyond the built-in set.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating commands were registered.
- Defined in Services/Notifications/TelegramNotifier.ts:121

downloadPhoto

downloadPhoto(fileId: string): Promise<Procedure<Buffer<ArrayBufferLike>>>
Downloads a photo from Telegram by its file_id.
Parameters
- fileId: string
  The Telegram file_id of the photo to download.
Returns Promise<Procedure<Buffer<ArrayBufferLike>>>
Procedure with the image Buffer, or failure.
- Defined in Services/Notifications/TelegramNotifier.ts:145

sendInlineMenu

sendInlineMenu(
text: string,
keyboard: InlineKeyboard,
): Promise<Procedure<{ status: string }>>
Sends an inline keyboard menu to the configured chat.
Parameters
- text: string
  HTML message text above the keyboard.
- keyboard: InlineKeyboard
  Array of button rows for the inline keyboard.
Returns Promise<Procedure<{ status: string }>>
Procedure indicating the menu was sent.
- Defined in Services/Notifications/TelegramNotifier.ts:162