Class Context

Hierarchy (View Summary)

ReplyContext
- Context
  - SceneContext

Constructors

constructor

new Context(update: Update, api: TelegramBotApi): Context
Parameters
- update: Update
- api: TelegramBotApi
Returns Context
Overrides ReplyContext.constructor
- Defined in core/context.ts:5

Properties

`Readonly`api

api: TelegramBotApi

`Optional` `Readonly`callbackQuery

callbackQuery?: CallbackQuery

`Readonly`update

update: Update

Accessors

chatId

get chatId(): number | undefined
Returns number | undefined
Inherited from ReplyContext.chatId
- Defined in core/context/base-context.ts:23

from

get from(): User | undefined
Returns User | undefined
Inherited from ReplyContext.from
- Defined in core/context/base-context.ts:36

isMessageAccessible

get isMessageAccessible(): boolean
Returns boolean
Inherited from ReplyContext.isMessageAccessible
- Defined in core/context/base-context.ts:32

payload

get payload(): string
Returns command arguments (everything that follows the command name). Example: for the message "/start ref_123", it will return "ref_123". If it is just "/start", it will return an empty string.

Returns string
string
Inherited from ReplyContext.payload
- Defined in core/context/reply-context.ts:297

senderId

get senderId(): number | undefined
ID of the user who initiated the event

Returns number | undefined
number | undefined
Inherited from ReplyContext.senderId
- Defined in core/context/reply-context.ts:311

text

get text(): string | undefined
Returns string | undefined
Inherited from ReplyContext.text
- Defined in core/context/base-context.ts:42

Methods

answerCbQuery

answerCbQuery(
params?: string | Omit<AnswerCallbackQueryParams, "callback_query_id">,
): Promise<boolean>
Remove loading indicator from an inline button
Parameters
- Optionalparams: string | Omit<AnswerCallbackQueryParams, "callback_query_id">
  Parameters object or just the notification text
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.answerCbQuery
- Defined in core/context/reply-context.ts:173

answerGuest

answerGuest(
result: InlineQueryResult,
options?: Omit<AnswerGuestQueryParams, "guest_query_id" | "result">,
): Promise<SentGuestMessage>
Answer a guest query (Guest Mode)
Parameters
- result: InlineQueryResult
  query result
- Optionaloptions: Omit<AnswerGuestQueryParams, "guest_query_id" | "result">
  parameters object
Returns Promise<SentGuestMessage>
Promise<SentGuestMessage>
Inherited from ReplyContext.answerGuest
- Defined in core/context/reply-context.ts:508

answerPreCheckoutQuery

answerPreCheckoutQuery(ok: boolean, errorMessage?: string): Promise<boolean>
Answer a pre-checkout query (Pre-checkout Query)
Parameters
- ok: boolean
  Is everything okay
- OptionalerrorMessage: string
  Error message
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.answerPreCheckoutQuery
- Defined in core/context/reply-context.ts:422

answerShippingQuery

answerShippingQuery(
ok: boolean,
options?: Omit<AnswerShippingQueryParams, "shipping_query_id" | "ok">,
): Promise<boolean>
Answer a shipping query (Shipping Query)
Parameters
- ok: boolean
  Is everything okay
- Optionaloptions: Omit<AnswerShippingQueryParams, "shipping_query_id" | "ok">
  Additional parameters
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.answerShippingQuery
- Defined in core/context/reply-context.ts:402

copyTo

copyTo(toChatId: string | number): Promise<MessageId>
Copy the current message to another chat
Parameters
- toChatId: string | number
  ID of the chat where the message is copied
Returns Promise<MessageId>
Promise<MessageId>
Inherited from ReplyContext.copyTo
- Defined in core/context/reply-context.ts:281

deleteAllReactions

deleteAllReactions(
options?: Omit<DeleteAllMessageReactionsParams, "chat_id">,
): Promise<boolean>
Delete all reactions of a specific user in the current chat (up to 10,000). By default, deletes the reactions of the user who initiated the event.
Parameters
- Optionaloptions: Omit<DeleteAllMessageReactionsParams, "chat_id">
  parameters object
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.deleteAllReactions
- Defined in core/context/reply-context.ts:555

deleteMessage

deleteMessage(): Promise<boolean>
Delete the current message

Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.deleteMessage
- Defined in core/context/reply-context.ts:233

deleteReaction

deleteReaction(
options?: Omit<DeleteMessageReactionParams, "chat_id" | "message_id">,
): Promise<boolean>
Delete reaction on the current message. By default, deletes the reaction of the user who initiated the event.
Parameters
- Optionaloptions: Omit<DeleteMessageReactionParams, "chat_id" | "message_id">
  parameters object
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.deleteReaction
- Defined in core/context/reply-context.ts:530

editCaption

editCaption(
    caption: string,
    options?: Omit<
        EditMessageCaptionParams,
        "caption"
        | "chat_id"
        | "message_id",
    >,
): Promise<boolean | Message>
Change the caption of the current media file (photo/video)
Parameters
- caption: string
  caption
- Optionaloptions: Omit<EditMessageCaptionParams, "caption" | "chat_id" | "message_id">
  parameters object
Returns Promise<boolean | Message>
Promise<Message | boolean>
Inherited from ReplyContext.editCaption
- Defined in core/context/reply-context.ts:338

editMessage

editMessage(
text: string,
options?: Omit<EditMessageTextParams, "text" | "chat_id" | "message_id">,
): Promise<boolean | Message>
Edit the text of the current message
Parameters
- text: string
  Message text
- Optionaloptions: Omit<EditMessageTextParams, "text" | "chat_id" | "message_id">
  Additional parameters
Returns Promise<boolean | Message>
Promise<Message | boolean>
Inherited from ReplyContext.editMessage
- Defined in core/context/reply-context.ts:248

editReplyMarkup

editReplyMarkup(replyMarkup?: InlineKeyboardMarkup): Promise<boolean | Message>
Change only the inline keyboard of the current message
Parameters
- OptionalreplyMarkup: InlineKeyboardMarkup
  keyboard
Returns Promise<boolean | Message>
Promise<Message | boolean>
Inherited from ReplyContext.editReplyMarkup
- Defined in core/context/reply-context.ts:320

forwardTo

forwardTo(toChatId: string | number): Promise<Message>
Forward the current message to another chat
Parameters
- toChatId: string | number
  ID of the chat where the message is forwarded
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.forwardTo
- Defined in core/context/reply-context.ts:266

getAdministrators

getAdministrators(): Promise<ChatMember[]>
Get the list of administrators of the current chat

Returns Promise<ChatMember[]>
Promise<ChatMember[]>
Inherited from ReplyContext.getAdministrators
- Defined in core/context/reply-context.ts:355

getGameHighScores

getGameHighScores(): Promise<GameHighScore[]>
Get high scores table for the game

Returns Promise<GameHighScore[]>
Promise<GameHighScore[]>
Inherited from ReplyContext.getGameHighScores
- Defined in core/context/reply-context.ts:487

getMember

getMember(userId: number): Promise<ChatMember>
Get information about a specific member in the current chat
Parameters
- userId: number
  User ID
Returns Promise<ChatMember>
Promise<ChatMember>
Inherited from ReplyContext.getMember
- Defined in core/context/reply-context.ts:365

`Protected`getRequiredIds

getRequiredIds(operation: string): { chatId: number; messageId: number }
Parameters
- operation: string
Returns { chatId: number; messageId: number }
Inherited from ReplyContext.getRequiredIds
- Defined in core/context/base-context.ts:51
getRequiredIds(
operation: string,
force: true,
): { chatId: number; messageId: number }
Parameters
- operation: string
- force: true
Returns { chatId: number; messageId: number }
Inherited from ReplyContext.getRequiredIds
- Defined in core/context/base-context.ts:52
getRequiredIds(
operation: string,
force: false,
): { chatId: number; messageId: number | undefined }
Parameters
- operation: string
- force: false
Returns { chatId: number; messageId: number | undefined }
Inherited from ReplyContext.getRequiredIds
- Defined in core/context/base-context.ts:53

leaveChat

leaveChat(): Promise<boolean>
Leave the current chat (group/channel)

Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.leaveChat
- Defined in core/context/reply-context.ts:374

react

react(reactions: ReactionType[]): Promise<boolean>
React to the current message
Parameters
- reactions: ReactionType[]
  Array of reactions (e.g.: [{ type: "emoji", emoji: "👍" }])
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.react
- Defined in core/context/reply-context.ts:203

reply

reply(
text: string,
options?: Omit<SendMessageParams, "text" | "chat_id">,
): Promise<Message>
Parameters
- text: string
- Optionaloptions: Omit<SendMessageParams, "text" | "chat_id">
Returns Promise<Message>
Inherited from ReplyContext.reply
- Defined in core/context/reply-context.ts:8

replyWithChatAction

replyWithChatAction(
    action:
        | "typing"
        | "upload_photo"
        | "record_video"
        | "upload_video"
        | "record_voice"
        | "upload_voice"
        | "upload_document"
        | "choose_sticker"
        | "find_location"
        | "record_video_note"
        | "upload_video_note",
): Promise<boolean>
Send chat action status to the current chat (e.g., "typing", "upload_photo")
Parameters
- action:
      | "typing"
      | "upload_photo"
      | "record_video"
      | "upload_video"
      | "record_voice"
      | "upload_voice"
      | "upload_document"
      | "choose_sticker"
      | "find_location"
      | "record_video_note"
      | "upload_video_note"
  Action status (e.g., "typing", "upload_photo")
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.replyWithChatAction
- Defined in core/context/reply-context.ts:218

replyWithDocument

replyWithDocument(
document: string | InputFile,
options?: Omit<SendDocumentParams, "chat_id" | "document">,
): Promise<Message>
Reply to the current message with a document (file)
Parameters
- document: string | InputFile
  URL of the file or file_id
- Optionaloptions: Omit<SendDocumentParams, "chat_id" | "document">
  Parameters object or just the notification text
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithDocument
- Defined in core/context/reply-context.ts:111

replyWithDraft

replyWithDraft(
draftId: number,
options?: Omit<SendMessageDraftParams, "draft_id">,
): Promise<boolean>
Streaming a temporary message (Draft) for generating responses (e.g., AI). This ephemeral message lives for 30 seconds. After completion, it is mandatory to call a regular reply().
Parameters
- draftId: number
  unique stream identifier (must be > 0). Identical IDs animate changes.
- Optionaloptions: Omit<SendMessageDraftParams, "draft_id">
  parameters object
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.replyWithDraft
- Defined in core/context/reply-context.ts:606

replyWithGame

replyWithGame(
gameShortName: string,
options?: Omit<SendGameParams, "chat_id" | "game_short_name">,
): Promise<Message>
Send a game to the current chat
Parameters
- gameShortName: string
  short name of the game
- Optionaloptions: Omit<SendGameParams, "chat_id" | "game_short_name">
  parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithGame
- Defined in core/context/reply-context.ts:444

replyWithInlineKeyboard

replyWithInlineKeyboard(
    text: string,
    buttons: InlineKeyboardButton[][] | InlineKeyboard,
    options?: Omit<SendMessageParams, "text" | "chat_id" | "reply_markup">,
): Promise<Message>
Quick reply with an Inline keyboard
Parameters
- text: string
  message text
- buttons: InlineKeyboardButton[][] | InlineKeyboard
  keyboard
- Optionaloptions: Omit<SendMessageParams, "text" | "chat_id" | "reply_markup">
  parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithInlineKeyboard
- Defined in core/context/reply-context.ts:51

replyWithInvoice

replyWithInvoice(params: Omit<SendInvoiceParams, "chat_id">): Promise<Message>
Send an invoice to the current chat
Parameters
- params: Omit<SendInvoiceParams, "chat_id">
  Parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithInvoice
- Defined in core/context/reply-context.ts:386

replyWithKeyboard

replyWithKeyboard(
    text: string,
    keyboard:
        | InlineKeyboardMarkup
        | ReplyKeyboardMarkup
        | ReplyKeyboardRemove
        | ForceReply
        | InlineKeyboard
        | ReplyKeyboard,
    options?: Omit<SendMessageParams, "text" | "chat_id" | "reply_markup">,
): Promise<Message>
Reply to the current message with a keyboard (Inline or Reply)
Parameters
- text: string
  message text
- keyboard:
      | InlineKeyboardMarkup
      | ReplyKeyboardMarkup
      | ReplyKeyboardRemove
      | ForceReply
      | InlineKeyboard
      | ReplyKeyboard
  keyboard
- Optionaloptions: Omit<SendMessageParams, "text" | "chat_id" | "reply_markup">
  parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithKeyboard
- Defined in core/context/reply-context.ts:29

replyWithLivePhoto

replyWithLivePhoto(
    photo: string | InputFile,
    livePhoto: string | InputFile,
    options?: Omit<SendLivePhotoParams, "chat_id" | "photo" | "live_photo">,
): Promise<Message>
Reply to the current message with a "live photo" (Live Photo)
Parameters
- photo: string | InputFile
  URL of the photo or file_id
- livePhoto: string | InputFile
  URL of the "live photo" or file_id
- Optionaloptions: Omit<SendLivePhotoParams, "chat_id" | "photo" | "live_photo">
  Parameters object or just the notification text
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithLivePhoto
- Defined in core/context/reply-context.ts:132

replyWithMediaGroup

replyWithMediaGroup(
    media:
        | InputMediaAudio[]
        | InputMediaDocument[]
        | (InputMediaLivePhoto | InputMediaPhoto | InputMediaVideo)[],
    options?: Omit<SendMediaGroupParams, "chat_id" | "media">,
): Promise<Message[]>
Send a group of media files (album). Supports photos, videos, audio, documents, and new Live Photos (API 10.0).
Parameters
- media:
      | InputMediaAudio[]
      | InputMediaDocument[]
      | (InputMediaLivePhoto | InputMediaPhoto | InputMediaVideo)[]
  array of media files
- Optionaloptions: Omit<SendMediaGroupParams, "chat_id" | "media">
  parameters object
Returns Promise<Message[]>
Promise<Message[]>
Inherited from ReplyContext.replyWithMediaGroup
- Defined in core/context/reply-context.ts:626

replyWithPaidMedia

replyWithPaidMedia(
    starCount: number,
    media: (
        InputPaidMediaLivePhoto
        | InputPaidMediaPhoto
        | InputPaidMediaVideo
    )[],
    options?: Omit<SendPaidMediaParams, "chat_id" | "media" | "star_count">,
): Promise<Message>
Send paid media, for viewing which the user must pay with Telegram Stars.
Parameters
- starCount: number
  number of stars the user must pay
- media: (InputPaidMediaLivePhoto | InputPaidMediaPhoto | InputPaidMediaVideo)[]
  array of media files
- Optionaloptions: Omit<SendPaidMediaParams, "chat_id" | "media" | "star_count">
  parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithPaidMedia
- Defined in core/context/reply-context.ts:647

replyWithPhoto

replyWithPhoto(
photo: string | InputFile,
options?: Omit<SendPhotoParams, "chat_id" | "photo">,
): Promise<Message>
Reply to the current message with a photo
Parameters
- photo: string | InputFile
  URL of the image or file_id
- Optionaloptions: Omit<SendPhotoParams, "chat_id" | "photo">
  Parameters object or just the notification text
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithPhoto
- Defined in core/context/reply-context.ts:72

replyWithPoll

replyWithPoll(
    question: string,
    pollOptions: (string | InputPollOption)[],
    options?: Omit<SendPollParams, "chat_id" | "question" | "options">,
): Promise<Message>
Send a poll or quiz (Poll / Quiz) to the current chat. Supports new API 10.0 features: media, explanation_media, 1 answer option.
Parameters
- question: string
  poll text
- pollOptions: (string | InputPollOption)[]
  answer options
- Optionaloptions: Omit<SendPollParams, "chat_id" | "question" | "options">
  parameters object
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithPoll
- Defined in core/context/reply-context.ts:579

replyWithVideo

replyWithVideo(
video: string | InputFile,
options?: Omit<SendVideoParams, "chat_id" | "video">,
): Promise<Message>
Reply to the current message with a video file
Parameters
- video: string | InputFile
  URL of the video or file_id
- Optionaloptions: Omit<SendVideoParams, "chat_id" | "video">
  Parameters object or just the notification text
Returns Promise<Message>
Promise<Message>
Inherited from ReplyContext.replyWithVideo
- Defined in core/context/reply-context.ts:92

sendGift

sendGift(
giftId: string,
options?: Omit<SendGiftParams, "chat_id" | "user_id" | "gift_id">,
): Promise<boolean>
Send a gift (Star Gift) to the current user
Parameters
- giftId: string
  Gift ID
- Optionaloptions: Omit<SendGiftParams, "chat_id" | "user_id" | "gift_id">
  Parameters object
Returns Promise<boolean>
Promise<boolean>
Inherited from ReplyContext.sendGift
- Defined in core/context/reply-context.ts:154

setGameScore

setGameScore(
score: number,
options?: Omit<SetGameScoreParams, "user_id" | "score">,
): Promise<boolean | Message>
Set a high score for a player in the game
Parameters
- score: number
  game score
- Optionaloptions: Omit<SetGameScoreParams, "user_id" | "score">
  parameters object
Returns Promise<boolean | Message>
Promise<Message | boolean>
Inherited from ReplyContext.setGameScore
- Defined in core/context/reply-context.ts:462

Class Context

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Context

Properties

Readonlyapi

Optional ReadonlycallbackQuery

Optionalmenu

Optional Readonlymessage

Optionalsession

Readonlyupdate

Accessors

chatId

Returns number | undefined

from

Returns User | undefined

isMessageAccessible

Returns boolean

payload

Returns string

senderId

Returns number | undefined

text

Returns string | undefined

Methods

answerCbQuery

Parameters

Returns Promise<boolean>

answerGuest

Parameters

Returns Promise<SentGuestMessage>

answerPreCheckoutQuery

Parameters

Returns Promise<boolean>

answerShippingQuery

Parameters

Returns Promise<boolean>

copyTo

Parameters

Returns Promise<MessageId>

deleteAllReactions

Parameters

Returns Promise<boolean>

deleteMessage

Returns Promise<boolean>

deleteReaction

Parameters

Returns Promise<boolean>

editCaption

Parameters

Returns Promise<boolean | Message>

editMessage

Parameters

Returns Promise<boolean | Message>

editReplyMarkup

Parameters

Returns Promise<boolean | Message>

forwardTo

Parameters

Returns Promise<Message>

getAdministrators

Returns Promise<ChatMember[]>

getGameHighScores

Returns Promise<GameHighScore[]>

getMember

Parameters

Returns Promise<ChatMember>

ProtectedgetRequiredIds

Parameters

Returns { chatId: number; messageId: number }

Parameters

Returns { chatId: number; messageId: number }

Parameters

`Readonly`api

`Optional` `Readonly`callbackQuery

`Optional`menu

`Optional` `Readonly`message

`Optional`session

`Readonly`update

`Protected`getRequiredIds