Class TelegramExecutionContext

constructor

• new TelegramExecutionContext(
      bot: TelegramBot,
      update: TelegramUpdate,
  ): TelegramExecutionContext

  Create a telegram execution context

  Parameters

  • bot: TelegramBot

    the telegram bot

  • update: TelegramUpdate

    the telegram update

  Returns TelegramExecutionContext

api

args

bot

update

update_type

chatId

• get chatId(): string

  Get the chat ID as a string

  Returns string

  The chat ID

text

• get text(): string

  Get the message text from the current update

  Returns string

  The message text as a string or empty string if not available

userId

• get userId(): number | undefined

  Get the user ID from the current update

  Returns number | undefined

  The user ID or undefined if not available

answerGuestQuery

• answerGuestQuery(message: string, parse_mode?: string): Promise<Response>

  Answer a guest query

  Parameters

  • message: string

    text to reply with

  • parse_mode: string = ''

    one of HTML, MarkdownV2, Markdown, or an empty string for ascii

  Returns Promise<Response>

  Promise with the API response

answerPreCheckoutQuery

• answerPreCheckoutQuery(ok: boolean, error_message?: string): Promise<Response>

  Answer a pre-checkout query

  Parameters

  • ok: boolean

    whether the payment can proceed

  • Optionalerror_message: string

    error message if not ok

  Returns Promise<Response>

  Promise with the API response

getFile

• getFile(file_id: string): Promise<Response>

  Get File from telegram file_id

  Parameters

  • file_id: string

    telegram file_id

  Returns Promise<Response>

  Promise with the file response

reply

• reply(
      message: string,
      parse_mode?: string,
      reply?: boolean,
      options?: Record<string, number | string | boolean>,
  ): Promise<Response | null>

  Reply to the last message with text

  Parameters

  • message: string

    text to reply with

  • parse_mode: string = ''

    one of HTML, MarkdownV2, Markdown, or an empty string for ascii

  • reply: boolean = true
  • options: Record<string, number | string | boolean> = {}

    any additional options to pass to sendMessage

  Returns Promise<Response | null>

  Promise with the API response

replyInline

• replyInline(
      title: string,
      message: string,
      parse_mode?: string,
  ): Promise<Response | null>

  Reply to an inline message with a title and content

  Parameters

  • title: string

    title to reply with

  • message: string

    message contents to reply with

  • parse_mode: string = ''

    parse mode to use

  Returns Promise<Response | null>

  Promise with the API response

replyPhoto

• replyPhoto(
      photo: string,
      caption?: string,
      options?: Record<string, number | string | boolean>,
  ): Promise<Response | null>

  Reply to the last message with a photo

  Parameters

  • photo: string

    url or file_id to photo

  • caption: string = ''

    photo caption

  • options: Record<string, number | string | boolean> = {}

    any additional options to pass to sendPhoto

  Returns Promise<Response | null>

  Promise with the API response

replyVideo

• replyVideo(
      video: string,
      options?: Record<string, number | string | boolean>,
  ): Promise<Response | null>

  Reply to the last message with a video

  Parameters

  • video: string

    string to a video on the internet or a file_id on telegram

  • options: Record<string, number | string | boolean> = {}

    any additional options to pass to sendVideo

  Returns Promise<Response | null>

  Promise with the API response

sendStarsInvoice

• sendStarsInvoice(
      title: string,
      description: string,
      payload: string,
      amount: number,
  ): Promise<Response>

  Send an invoice for Telegram Stars

  Parameters

  • title: string

    product name

  • description: string

    product description

  • payload: string

    bot-defined invoice payload

  • amount: number

    amount of stars

  Returns Promise<Response>

  Promise with the API response

sendTyping

• sendTyping(): Promise<Response | null>

  Send typing in a chat

  Returns Promise<Response | null>

  Promise with the API response

streamReply

• streamReply(
      message: string,
      draft_id: number,
      parse_mode?: string,
      options?: Record<string, number | string | boolean>,
  ): Promise<Response>

  Reply to the last message with a stream of text

  Parameters

  • message: string

    text to reply with

  • draft_id: number
  • parse_mode: string = ''

    one of HTML, MarkdownV2, Markdown, or an empty string for ascii

  • options: Record<string, number | string | boolean> = {}

    any additional options to pass to sendMessage

  Returns Promise<Response>

  Promise with the API response