Class Context

Type Parameters

U extends Deunionize<tg.Update> = tg.Update

Hierarchy

Context
- SceneContext
- WizardContext

Index

Constructors

constructor

new Context(update, telegram, botInfo): Context
Type Parameters
- U extends Deunionize<Update> = Update
Parameters
- update: U
- telegram: Telegram
- botInfo: UserFromGetMe
Returns Context
- Defined in src/context.ts:41

Properties

`Readonly` botInfo

botInfo: UserFromGetMe

`Readonly` state

state: Record<string | symbol, any> = {}

`Readonly` telegram

telegram: Telegram

`Readonly` update

update: U

Accessors

callbackQuery

get callbackQuery(): PropOr<U, "callback_query">
Returns PropOr<U, "callback_query">
- Defined in src/context.ts:100

channelPost

get channelPost(): PropOr<U, "channel_post">
Returns PropOr<U, "channel_post">
- Defined in src/context.ts:92

chat

get chat(): PropOr<GetUpdateContent, "chat", undefined>
Returns PropOr<GetUpdateContent, "chat", undefined>
- Defined in src/context.ts:124

chatJoinRequest

get chatJoinRequest(): PropOr<U, "chat_join_request">
Returns PropOr<U, "chat_join_request">
- Defined in src/context.ts:120

chatMember

get chatMember(): PropOr<U, "chat_member">
Returns PropOr<U, "chat_member">
- Defined in src/context.ts:116

chosenInlineResult

get chosenInlineResult(): PropOr<U, "chosen_inline_result">
Returns PropOr<U, "chosen_inline_result">
- Defined in src/context.ts:88

editedChannelPost

get editedChannelPost(): PropOr<U, "edited_channel_post">
Returns PropOr<U, "edited_channel_post">
- Defined in src/context.ts:96

editedMessage

get editedMessage(): PropOr<U, "edited_message">
Returns PropOr<U, "edited_message">
- Defined in src/context.ts:72

from

get from(): PropOr<GetUpdateContent, "from", undefined>
Returns PropOr<GetUpdateContent, "from", undefined>
- Defined in src/context.ts:140

inlineMessageId

get inlineMessageId(): undefined | string
Returns undefined | string
- Defined in src/context.ts:154

inlineQuery

get inlineQuery(): PropOr<U, "inline_query">
Returns PropOr<U, "inline_query">
- Defined in src/context.ts:76

kickChatMember

get kickChatMember(): ((...args) => Promise<true>)
Returns ((...args) => Promise<true>)
- - (...args): Promise<true>
 - Parameters
 - Rest ...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]
 Rest
 Returns Promise<true>
 
 See
 https://core.telegram.org/bots/api#banchatmember
See
https://core.telegram.org/bots/api#banchatmember

Deprecated
since API 5.3. Use Context.banChatMember
- Defined in src/context.ts:451

me

get me(): string
Returns string
- Defined in src/context.ts:57

message

get message(): PropOr<U, "message">
Returns PropOr<U, "message">
- Defined in src/context.ts:68

myChatMember

get myChatMember(): PropOr<U, "my_chat_member">
Returns PropOr<U, "my_chat_member">
- Defined in src/context.ts:112

passportData

get passportData(): undefined | PassportData
Returns undefined | PassportData
- Defined in src/context.ts:158

poll

get poll(): PropOr<U, "poll">
Returns PropOr<U, "poll">
- Defined in src/context.ts:104

pollAnswer

get pollAnswer(): PropOr<U, "poll_answer">
Returns PropOr<U, "poll_answer">
- Defined in src/context.ts:108

preCheckoutQuery

get preCheckoutQuery(): PropOr<U, "pre_checkout_query">
Returns PropOr<U, "pre_checkout_query">
- Defined in src/context.ts:84

senderChat

get senderChat(): PropOr<GetUpdateContent, "sender_chat", undefined>
Returns PropOr<GetUpdateContent, "sender_chat", undefined>
- Defined in src/context.ts:133

shippingQuery

get shippingQuery(): PropOr<U, "shipping_query">
Returns PropOr<U, "shipping_query">
- Defined in src/context.ts:80

tg

get tg(): Telegram
Returns Telegram

Deprecated
Use ctx.telegram instead
- Defined in src/context.ts:64

updateType

get updateType(): Extract<UnionKeys, UpdateType>
Returns Extract<UnionKeys, UpdateType>
- Defined in src/context.ts:47

webAppData

get webAppData(): undefined | {
 button_text: string;
 data: {
 json<T>() => T;
 text() => string;
 };
}
Returns undefined | {
 button_text: string;
 data: {
 json<T>() => T;
 text() => string;
 };
}
- Defined in src/context.ts:164

webhookReply

get webhookReply(): boolean
Returns boolean

Deprecated
use Telegram.webhookReply
- Defined in src/context.ts:192
set webhookReply(enable): void
Parameters
- enable: boolean
Returns void
- Defined in src/context.ts:196

Methods

addStickerToSet

addStickerToSet(...args): Promise<true>
Parameters
- Rest ...args: [name: string, stickerData: Omit<{}, "chat_id" | "name" | "user_id">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#addstickertoset
- Defined in src/context.ts:1248

answerCbQuery

answerCbQuery(...args): Promise<true>
Parameters
- Rest ...args: [text?: string, extra?: Omit<{}, "text" | "chat_id" | "callback_query_id">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#answercallbackquery
- Defined in src/context.ts:244

answerGameQuery

answerGameQuery(...args): Promise<true>
Parameters
- Rest ...args: [url: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#answercallbackquery
- Defined in src/context.ts:252

answerInlineQuery

answerInlineQuery(...args): Promise<true>
Parameters
- Rest ...args: [results: readonly InlineQueryResult[], extra?: Omit<{}, "chat_id" | "inline_query_id" | "results">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#answerinlinequery
- Defined in src/context.ts:236

answerPreCheckoutQuery

answerPreCheckoutQuery(...args): Promise<true>
Parameters
- Rest ...args: [ok: boolean, errorMessage?: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#answerprecheckoutquery
- Defined in src/context.ts:268

answerShippingQuery

answerShippingQuery(...args): Promise<true>
Parameters
- Rest ...args: [ok: boolean, shippingOptions: readonly ShippingOption[], errorMessage: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#answershippingquery
- Defined in src/context.ts:260

approveChatJoinRequest

approveChatJoinRequest(userId): Promise<true>
Parameters
- userId: number
Returns Promise<true>

See
https://core.telegram.org/bots/api#approvechatjoinrequest
- Defined in src/context.ts:1338

banChatMember

banChatMember(...args): Promise<true>
Parameters
- Rest ...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#banchatmember
- Defined in src/context.ts:442

banChatSenderChat

banChatSenderChat(senderChatId): Promise<true>
Parameters
- senderChatId: number
Returns Promise<true>

See
https://core.telegram.org/bots/api#banchatsenderchat
- Defined in src/context.ts:1354

closeForumTopic

closeForumTopic(): Promise<true>
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#closeforumtopic
- Defined in src/context.ts:1040

closeGeneralForumTopic

closeGeneralForumTopic(): Promise<true>
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#closegeneralforumtopic
- Defined in src/context.ts:1117

copyMessage

copyMessage(chatId, extra?): Promise<MessageId>
Parameters
- chatId: string | number
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<MessageId>

See
https://core.telegram.org/bots/api#copymessage
- Defined in src/context.ts:1324

createChatInviteLink

createChatInviteLink(...args): Promise<ChatInviteLink>
Parameters
- Rest ...args: [extra?: Omit<{}, "chat_id">]
 Rest
Returns Promise<ChatInviteLink>

See
https://core.telegram.org/bots/api#createchatinvitelink
- Defined in src/context.ts:418

createForumTopic

createForumTopic(...args): Promise<ForumTopic>
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
Parameters
- Rest ...args: [name: string, extra?: Omit<{}, "chat_id" | "name">]
 Rest
Returns Promise<ForumTopic>

See
https://core.telegram.org/bots/api#createforumtopic
- Defined in src/context.ts:1011

createNewStickerSet

createNewStickerSet(...args): Promise<true>
Parameters
- Rest ...args: [name: string, title: string, stickerData: Omit<{}, "chat_id" | "name" | "user_id" | "title">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#createnewstickerset
- Defined in src/context.ts:1240

declineChatJoinRequest

declineChatJoinRequest(userId): Promise<true>
Parameters
- userId: number
Returns Promise<true>

See
https://core.telegram.org/bots/api#declinechatjoinrequest
- Defined in src/context.ts:1346

deleteChatPhoto

deleteChatPhoto(...args): Promise<true>
Parameters
- Rest ...args: []
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#deletechatphoto
- Defined in src/context.ts:500

deleteChatStickerSet

deleteChatStickerSet(): Promise<true>
Returns Promise<true>

See
https://core.telegram.org/bots/api#deletechatstickerset
- Defined in src/context.ts:999

deleteForumTopic

deleteForumTopic(): Promise<true>
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#deleteforumtopic
- Defined in src/context.ts:1074

deleteMessage

deleteMessage(messageId?): Promise<true>
Parameters
- Optional messageId: number
 Optional
Returns Promise<true>

See
https://core.telegram.org/bots/api#deletemessage
- Defined in src/context.ts:1294

deleteStickerFromSet

deleteStickerFromSet(sticker): Promise<true>
Parameters
- sticker: string
Returns Promise<true>

Deprecated
use Telegram.deleteStickerFromSet

See
https://core.telegram.org/bots/api#deletestickerfromset
- Defined in src/context.ts:1225

deleteStickerSet

deleteStickerSet(...args): Promise<true>
Parameters
- Rest ...args: [name: string]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1207

editChatInviteLink

editChatInviteLink(...args): Promise<ChatInviteLink>
Parameters
- Rest ...args: [inviteLink: string, extra?: Omit<{}, "chat_id" | "invite_link">]
 Rest
Returns Promise<ChatInviteLink>

See
https://core.telegram.org/bots/api#editchatinvitelink
- Defined in src/context.ts:426

editForumTopic

editForumTopic(extra): Promise<true>
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Parameters
- extra: Omit<{}, "chat_id" | "message_thread_id">
Returns Promise<true>

See
https://core.telegram.org/bots/api#editforumtopic
- Defined in src/context.ts:1023

editGeneralForumTopic

editGeneralForumTopic(name): Promise<true>
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
Parameters
- name: string
Returns Promise<true>

See
https://core.telegram.org/bots/api#editgeneralforumtopic
- Defined in src/context.ts:1106

editMessageCaption

editMessageCaption(caption, extra?): Promise<true | Edited & CaptionableMessage>
Parameters
- caption: undefined | string | FmtString
- Optional extra: Omit<{}, "caption" | "chat_id" | "message_id" | "inline_message_id">
 Optional
Returns Promise<true | Edited & CaptionableMessage>

See
https://core.telegram.org/bots/api#editmessagecaption
- Defined in src/context.ts:293

editMessageLiveLocation

editMessageLiveLocation(latitude, longitude, extra?): Promise<true | Edited & LocationMessage>
Parameters
- latitude: number
- longitude: number
- Optional extra: Omit<{}, "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude">
 Optional
Returns Promise<true | Edited & LocationMessage>

See
https://core.telegram.org/bots/api#editmessagelivelocation
- Defined in src/context.ts:346

editMessageMedia

editMessageMedia(media, extra?): Promise<true | Object>
Parameters
- media: {
 caption?: string | FmtString;
 } | {
 caption?: string | FmtString;
 } | {
 caption?: string | FmtString;
 } | {
 caption?: string | FmtString;
 } | {
 caption?: string | FmtString;
 }
- Optional extra: Omit<{}, "chat_id" | "message_id" | "inline_message_id" | "media">
 Optional
Returns Promise<true | Object>

See
https://core.telegram.org/bots/api#editmessagemedia
- Defined in src/context.ts:313

editMessageReplyMarkup

editMessageReplyMarkup(markup): Promise<true | Object>
Parameters
- markup: undefined | InlineKeyboardMarkup
Returns Promise<true | Object>

See
https://core.telegram.org/bots/api#editmessagereplymarkup
- Defined in src/context.ts:330

editMessageText

editMessageText(text, extra?): Promise<true | Edited & TextMessage>
Parameters
- text: string | FmtString
- Optional extra: Omit<{}, "text" | "chat_id" | "message_id" | "inline_message_id">
 Optional
Returns Promise<true | Edited & TextMessage>

See
https://core.telegram.org/bots/api#editmessagetext
- Defined in src/context.ts:279

exportChatInviteLink

exportChatInviteLink(...args): Promise<string>
Parameters
- Rest ...args: []
 Rest
Returns Promise<string>

See
https://core.telegram.org/bots/api#exportchatinvitelink
- Defined in src/context.ts:410

forwardMessage

forwardMessage(chatId, extra?): Promise<Message>
Parameters
- chatId: string | number
- Optional extra: Omit<{}, "chat_id" | "from_chat_id" | "message_id">
 Optional
Returns Promise<Message>

See
https://core.telegram.org/bots/api#forwardmessage
- Defined in src/context.ts:1307

getChat

getChat(...args): Promise<ChatFromGetChat>
Parameters
- Rest ...args: []
 Rest
Returns Promise<ChatFromGetChat>

See
https://core.telegram.org/bots/api#getchat
- Defined in src/context.ts:402

getChatAdministrators

getChatAdministrators(...args): Promise<(ChatMemberOwner | ChatMemberAdministrator)[]>
Parameters
- Rest ...args: []
 Rest
Returns Promise<(ChatMemberOwner | ChatMemberAdministrator)[]>

See
https://core.telegram.org/bots/api#getchatadministrators
- Defined in src/context.ts:564

getChatMember

getChatMember(...args): Promise<ChatMember>
Parameters
- Rest ...args: [userId: number]
 Rest
Returns Promise<ChatMember>

See
https://core.telegram.org/bots/api#getchatmember
- Defined in src/context.ts:572

getChatMembersCount

getChatMembersCount(...args): Promise<number>
Parameters
- Rest ...args: []
 Rest
Returns Promise<number>

See
https://core.telegram.org/bots/api#getchatmembercount
- Defined in src/context.ts:580

getChatMenuButton

getChatMenuButton(): Promise<MenuButton>
Use this method to get the current value of the bot's menu button in the current private chat. Returns MenuButton on success.

Returns Promise<MenuButton>

See
https://core.telegram.org/bots/api#getchatmenubutton
- Defined in src/context.ts:1380

getMyCommands

getMyCommands(): Promise<BotCommand[]>
Returns Promise<BotCommand[]>

Deprecated
use Telegram.getMyCommands

See
https://core.telegram.org/bots/api#getmycommands
- Defined in src/context.ts:1257

getMyDefaultAdministratorRights

getMyDefaultAdministratorRights(extra?): Promise<ChatAdministratorRights>
Parameters
- Optional extra: {
 forChannels?: boolean;
 }
 Optional
 - Optional forChannels?: boolean
Returns Promise<ChatAdministratorRights>

See
https://core.telegram.org/bots/api#getmydefaultadministratorrights
- Defined in src/context.ts:1397

getStickerSet

getStickerSet(setName): Promise<StickerSet>
Parameters
- setName: string
Returns Promise<StickerSet>

Deprecated
use Telegram.getStickerSet

See
https://core.telegram.org/bots/api#getstickerset
- Defined in src/context.ts:984

has

has<Filter>(filters): this is FilteredContext<Context<Update>, Filter>
Type Parameters
- Filter extends UpdateType | Guard<Update>
Parameters
- filters: MaybeArray<Filter>
Returns this is FilteredContext<Context<Update>, Filter>
- Defined in src/context.ts:214

hideGeneralForumTopic

hideGeneralForumTopic(): Promise<true>
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#hidegeneralforumtopic
- Defined in src/context.ts:1141

leaveChat

leaveChat(...args): Promise<true>
Parameters
- Rest ...args: []
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#leavechat
- Defined in src/context.ts:548

persistentChatAction

persistentChatAction(action, callback, extra?): Promise<void>
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"
 
 chat action type.
- callback: (() => Promise<void>)
 
 a function to run along with the chat action.
 - - (): Promise<void>
 - Returns Promise<void>
- extra: Omit<{}, "action" | "chat_id"> & {
 intervalDuration?: number;
 } = {}
 
 extra parameters for sendChatAction.
Returns Promise<void>

See
https://core.telegram.org/bots/api#sendchataction

Sends the sendChatAction request repeatedly, with a delay between requests, as long as the provided callback function is being processed.

The sendChatAction errors should be ignored, because the goal is the actual long process completing and performing an action.
- Defined in src/context.ts:883

pinChatMessage

pinChatMessage(...args): Promise<true>
Parameters
- Rest ...args: [messageId: number, extra?: {
 disable_notification?: boolean;
 }]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#pinchatmessage
- Defined in src/context.ts:524

promoteChatMember

promoteChatMember(...args): Promise<true>
Parameters
- Rest ...args: [userId: number, extra: Omit<{}, "chat_id" | "user_id">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#promotechatmember
- Defined in src/context.ts:474

reopenForumTopic

reopenForumTopic(): Promise<true>
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#reopenforumtopic
- Defined in src/context.ts:1057

reopenGeneralForumTopic

reopenGeneralForumTopic(): Promise<true>
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#reopengeneralforumtopic
- Defined in src/context.ts:1129

reply

reply(...args): Promise<TextMessage>
Parameters
- Rest ...args: [text: string | FmtString, extra?: Omit<{}, "text" | "chat_id">]
 Rest
Returns Promise<TextMessage>

See
https://core.telegram.org/bots/api#sendmessage
- Defined in src/context.ts:395

replyWithAnimation

replyWithAnimation(...args): Promise<AnimationMessage>
Parameters
- Rest ...args: [animation: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<AnimationMessage>

See
https://core.telegram.org/bots/api#sendanimation
- Defined in src/context.ts:733

replyWithAudio

replyWithAudio(...args): Promise<AudioMessage>
Parameters
- Rest ...args: [audio: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<AudioMessage>

See
https://core.telegram.org/bots/api#sendaudio
- Defined in src/context.ts:643

replyWithChatAction

replyWithChatAction(...args): Promise<true>
Parameters
- Rest ...args: [action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note", extra?: Omit<{}, "action" | "chat_id">]
 Rest
Returns Promise<true>

Deprecated
use Context.sendChatAction instead

See
https://core.telegram.org/bots/api#sendchataction
- Defined in src/context.ts:912

replyWithContact

replyWithContact(...args): Promise<ContactMessage>
Parameters
- Rest ...args: [phoneNumber: string, firstName: string, extra?: Omit<{}, "phone_number" | "chat_id" | "first_name">]
 Rest
Returns Promise<ContactMessage>

See
https://core.telegram.org/bots/api#sendcontact
- Defined in src/context.ts:976

replyWithDice

replyWithDice(...args): Promise<DiceMessage>
Parameters
- Rest ...args: [extra?: Omit<{}, "chat_id">]
 Rest
Returns Promise<DiceMessage>

See
https://core.telegram.org/bots/api#senddice
- Defined in src/context.ts:661

replyWithDocument

replyWithDocument(...args): Promise<DocumentMessage>
Parameters
- Rest ...args: [document: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<DocumentMessage>

See
https://core.telegram.org/bots/api#senddocument
- Defined in src/context.ts:679

replyWithGame

replyWithGame(...args): Promise<GameMessage>
Parameters
- Rest ...args: [gameName: string, extra?: Omit<{}, "chat_id" | "game_short_name">]
 Rest
Returns Promise<GameMessage>

See
https://core.telegram.org/bots/api#sendgame
- Defined in src/context.ts:790

replyWithHTML

replyWithHTML(html, extra?): Promise<TextMessage>
Parameters
- html: string
- Optional extra: Omit<{}, "text" | "chat_id">
 Optional
Returns Promise<TextMessage>

See
https://core.telegram.org/bots/api#sendmessage
- Defined in src/context.ts:1287

replyWithInvoice

replyWithInvoice(...args): Promise<InvoiceMessage>
Parameters
- Rest ...args: [invoice: Omit<{}, "chat_id" | "message_thread_id" | "disable_notification" | "reply_to_message_id" | "allow_sending_without_reply" | "reply_markup">, extra?: Omit<{}, "chat_id" | "protect_content" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter">]
 Rest
Returns Promise<InvoiceMessage>

See
https://core.telegram.org/bots/api#sendinvoice
- Defined in src/context.ts:772

replyWithLocation

replyWithLocation(...args): Promise<LocationMessage>
Parameters
- Rest ...args: [latitude: number, longitude: number, extra?: Omit<{}, "chat_id" | "latitude" | "longitude">]
 Rest
Returns Promise<LocationMessage>

See
https://core.telegram.org/bots/api#sendlocation
- Defined in src/context.ts:930

replyWithMarkdown

replyWithMarkdown(markdown, extra?): Promise<TextMessage>
Parameters
- markdown: string
- Optional extra: Omit<{}, "text" | "chat_id">
 Optional
Returns Promise<TextMessage>

Deprecated
use Context.replyWithMarkdownV2

See
https://core.telegram.org/bots/api#sendmessage
- Defined in src/context.ts:1273

replyWithMarkdownV2

replyWithMarkdownV2(markdown, extra?): Promise<TextMessage>
Parameters
- markdown: string
- Optional extra: Omit<{}, "text" | "chat_id">
 Optional
Returns Promise<TextMessage>

See
https://core.telegram.org/bots/api#sendmessage
- Defined in src/context.ts:1280

replyWithMediaGroup

replyWithMediaGroup(...args): Promise<(DocumentMessage | AudioMessage | PhotoMessage | VideoMessage)[]>
Parameters
- Rest ...args: [media: MediaGroup, extra?: Omit<{}, "chat_id" | "media">]
 Rest
Returns Promise<(DocumentMessage | AudioMessage | PhotoMessage | VideoMessage)[]>

See
https://core.telegram.org/bots/api#sendmediagroup
- Defined in src/context.ts:625

replyWithPhoto

replyWithPhoto(...args): Promise<PhotoMessage>
Parameters
- Rest ...args: [photo: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<PhotoMessage>

See
https://core.telegram.org/bots/api#sendphoto
- Defined in src/context.ts:607

replyWithPoll

replyWithPoll(...args): Promise<PollMessage>
Parameters
- Rest ...args: [question: string, options: readonly string[], extra?: Omit<{}, "chat_id" | "question" | "options" | "type">]
 Rest
Returns Promise<PollMessage>

See
https://core.telegram.org/bots/api#sendpoll
- Defined in src/context.ts:826

replyWithQuiz

replyWithQuiz(...args): Promise<PollMessage>
Parameters
- Rest ...args: [question: string, options: readonly string[], extra: Omit<{}, "chat_id" | "question" | "options" | "type">]
 Rest
Returns Promise<PollMessage>

See
https://core.telegram.org/bots/api#sendpoll
- Defined in src/context.ts:844

replyWithSticker

replyWithSticker(...args): Promise<StickerMessage>
Parameters
- Rest ...args: [sticker: string | InputFile, extra?: Omit<{}, "chat_id" | "sticker">]
 Rest
Returns Promise<StickerMessage>

See
https://core.telegram.org/bots/api#sendsticker
- Defined in src/context.ts:697

replyWithVenue

replyWithVenue(...args): Promise<VenueMessage>
Parameters
- Rest ...args: [latitude: number, longitude: number, title: string, address: string, extra?: Omit<{}, "chat_id" | "title" | "latitude" | "longitude" | "address">]
 Rest
Returns Promise<VenueMessage>

See
https://core.telegram.org/bots/api#sendvenue
- Defined in src/context.ts:958

replyWithVideo

replyWithVideo(...args): Promise<VideoMessage>
Parameters
- Rest ...args: [video: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<VideoMessage>

See
https://core.telegram.org/bots/api#sendvideo
- Defined in src/context.ts:715

replyWithVideoNote

replyWithVideoNote(...args): Promise<VideoNoteMessage>
Parameters
- Rest ...args: [videoNote: string | InputFileVideoNote, extra?: Omit<{}, "chat_id" | "video_note">]
 Rest
Returns Promise<VideoNoteMessage>

See
https://core.telegram.org/bots/api#sendvideonote
- Defined in src/context.ts:754

replyWithVoice

replyWithVoice(...args): Promise<VoiceMessage>
Parameters
- Rest ...args: [voice: string | InputFile, extra?: {
 caption?: string | FmtString;
 }]
 Rest
Returns Promise<VoiceMessage>

See
https://core.telegram.org/bots/api#sendvoice
- Defined in src/context.ts:808

restrictChatMember

restrictChatMember(...args): Promise<true>
Parameters
- Rest ...args: [userId: number, extra: Omit<{}, "chat_id" | "user_id">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#restrictchatmember
- Defined in src/context.ts:466

revokeChatInviteLink

revokeChatInviteLink(...args): Promise<ChatInviteLink>
Parameters
- Rest ...args: [inviteLink: string]
 Rest
Returns Promise<ChatInviteLink>

See
https://core.telegram.org/bots/api#revokechatinvitelink
- Defined in src/context.ts:434

sendAnimation

sendAnimation(animation, extra?): Promise<AnimationMessage>
Parameters
- animation: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<AnimationMessage>

See
https://core.telegram.org/bots/api#sendanimation
- Defined in src/context.ts:722

sendAudio

sendAudio(audio, extra?): Promise<AudioMessage>
Parameters
- audio: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<AudioMessage>

See
https://core.telegram.org/bots/api#sendaudio
- Defined in src/context.ts:632

sendChatAction

sendChatAction(action, extra?): Promise<true>
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"
- Optional extra: Omit<{}, "action" | "chat_id">
 Optional
Returns Promise<true>

See
https://core.telegram.org/bots/api#sendchataction
- Defined in src/context.ts:859

sendContact

sendContact(phoneNumber, firstName, extra?): Promise<ContactMessage>
Parameters
- phoneNumber: string
- firstName: string
- Optional extra: Omit<{}, "phone_number" | "chat_id" | "first_name">
 Optional
Returns Promise<ContactMessage>

See
https://core.telegram.org/bots/api#sendcontact
- Defined in src/context.ts:965

sendDice

sendDice(extra?): Promise<DiceMessage>
Parameters
- Optional extra: Omit<{}, "chat_id">
 Optional
Returns Promise<DiceMessage>

See
https://core.telegram.org/bots/api#senddice
- Defined in src/context.ts:650

sendDocument

sendDocument(document, extra?): Promise<DocumentMessage>
Parameters
- document: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<DocumentMessage>

See
https://core.telegram.org/bots/api#senddocument
- Defined in src/context.ts:668

sendGame

sendGame(game, extra?): Promise<GameMessage>
Parameters
- game: string
- Optional extra: Omit<{}, "chat_id" | "game_short_name">
 Optional
Returns Promise<GameMessage>

See
https://core.telegram.org/bots/api#sendgame
- Defined in src/context.ts:779

sendInvoice

sendInvoice(invoice, extra?): Promise<InvoiceMessage>
Parameters
- invoice: Omit<{}, "chat_id" | "message_thread_id" | "disable_notification" | "reply_to_message_id" | "allow_sending_without_reply" | "reply_markup">
- Optional extra: Omit<{}, "chat_id" | "protect_content" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" | "max_tip_amount" | "suggested_tip_amounts" | "provider_data" | "photo_url" | "photo_size" | "photo_width" | "photo_height" | "need_name" | "need_phone_number" | "need_email" | "need_shipping_address" | "send_phone_number_to_provider" | "send_email_to_provider" | "is_flexible" | "start_parameter">
 Optional
Returns Promise<InvoiceMessage>

See
https://core.telegram.org/bots/api#sendinvoice
- Defined in src/context.ts:761

sendLocation

sendLocation(latitude, longitude, extra?): Promise<LocationMessage>
Parameters
- latitude: number
- longitude: number
- Optional extra: Omit<{}, "chat_id" | "latitude" | "longitude">
 Optional
Returns Promise<LocationMessage>

See
https://core.telegram.org/bots/api#sendlocation
- Defined in src/context.ts:919

sendMediaGroup

sendMediaGroup(media, extra?): Promise<(DocumentMessage | AudioMessage | PhotoMessage | VideoMessage)[]>
Parameters
- media: MediaGroup
- Optional extra: Omit<{}, "chat_id" | "media">
 Optional
Returns Promise<(DocumentMessage | AudioMessage | PhotoMessage | VideoMessage)[]>

See
https://core.telegram.org/bots/api#sendmediagroup
- Defined in src/context.ts:614

sendMessage

sendMessage(text, extra?): Promise<TextMessage>
Parameters
- text: string | FmtString
- Optional extra: Omit<{}, "text" | "chat_id">
 Optional
Returns Promise<TextMessage>

See
https://core.telegram.org/bots/api#sendmessage
- Defined in src/context.ts:384

sendPhoto

sendPhoto(photo, extra?): Promise<PhotoMessage>
Parameters
- photo: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<PhotoMessage>

See
https://core.telegram.org/bots/api#sendphoto
- Defined in src/context.ts:596

sendPoll

sendPoll(poll, options, extra?): Promise<PollMessage>
Parameters
- poll: string
- options: readonly string[]
- Optional extra: Omit<{}, "chat_id" | "question" | "options" | "type">
 Optional
Returns Promise<PollMessage>

See
https://core.telegram.org/bots/api#sendpoll
- Defined in src/context.ts:815

sendQuiz

sendQuiz(quiz, options, extra?): Promise<PollMessage>
Parameters
- quiz: string
- options: readonly string[]
- Optional extra: Omit<{}, "chat_id" | "question" | "options" | "type">
 Optional
Returns Promise<PollMessage>

See
https://core.telegram.org/bots/api#sendpoll
- Defined in src/context.ts:833

sendSticker

sendSticker(sticker, extra?): Promise<StickerMessage>
Parameters
- sticker: string | InputFile
- Optional extra: Omit<{}, "chat_id" | "sticker">
 Optional
Returns Promise<StickerMessage>

See
https://core.telegram.org/bots/api#sendsticker
- Defined in src/context.ts:686

sendVenue

sendVenue(latitude, longitude, title, address, extra?): Promise<VenueMessage>
Parameters
- latitude: number
- longitude: number
- title: string
- address: string
- Optional extra: Omit<{}, "chat_id" | "title" | "latitude" | "longitude" | "address">
 Optional
Returns Promise<VenueMessage>

See
https://core.telegram.org/bots/api#sendvenue
- Defined in src/context.ts:937

sendVideo

sendVideo(video, extra?): Promise<VideoMessage>
Parameters
- video: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<VideoMessage>

See
https://core.telegram.org/bots/api#sendvideo
- Defined in src/context.ts:704

sendVideoNote

sendVideoNote(videoNote, extra?): Promise<VideoNoteMessage>
Parameters
- videoNote: string | InputFileVideoNote
- Optional extra: Omit<{}, "chat_id" | "video_note">
 Optional
Returns Promise<VideoNoteMessage>

See
https://core.telegram.org/bots/api#sendvideonote
- Defined in src/context.ts:740

sendVoice

sendVoice(voice, extra?): Promise<VoiceMessage>
Parameters
- voice: string | InputFile
- Optional extra: {
 caption?: string | FmtString;
 }
 Optional
 - Optional caption?: string | FmtString
Returns Promise<VoiceMessage>

See
https://core.telegram.org/bots/api#sendvoice
- Defined in src/context.ts:797

setChatAdministratorCustomTitle

setChatAdministratorCustomTitle(...args): Promise<true>
Parameters
- Rest ...args: [userId: number, title: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatadministratorcustomtitle
- Defined in src/context.ts:482

setChatDescription

setChatDescription(...args): Promise<true>
Parameters
- Rest ...args: [description?: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatdescription
- Defined in src/context.ts:516

setChatMenuButton

setChatMenuButton(menuButton?): Promise<true>
Use this method to change the bot's menu button in the current private chat. Returns true on success.
Parameters
- Optional menuButton: MenuButton
 Optional
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatmenubutton
- Defined in src/context.ts:1371

setChatPermissions

setChatPermissions(...args): Promise<true>
Parameters
- Rest ...args: [permissions: ChatPermissions, extra?: Omit<{}, "chat_id" | "permissions">]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatpermissions
- Defined in src/context.ts:556

setChatPhoto

setChatPhoto(...args): Promise<true>
Parameters
- Rest ...args: [photo: InputFile]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatphoto
- Defined in src/context.ts:492

setChatStickerSet

setChatStickerSet(setName): Promise<true>
Parameters
- setName: string
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchatstickerset
- Defined in src/context.ts:991

setChatTitle

setChatTitle(...args): Promise<true>
Parameters
- Rest ...args: [title: string]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#setchattitle
- Defined in src/context.ts:508

setCustomEmojiStickerSetThumbnail

setCustomEmojiStickerSetThumbnail(...args): Promise<true>
Parameters
- Rest ...args: [name: string, custom_emoji_id: string]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1215

setMyCommands

setMyCommands(commands): Promise<true>
Parameters
- commands: readonly BotCommand[]
Returns Promise<true>

Deprecated
use Telegram.setMyCommands

See
https://core.telegram.org/bots/api#setmycommands
- Defined in src/context.ts:1265

setMyDefaultAdministratorRights

setMyDefaultAdministratorRights(extra?): Promise<true>
Parameters
- Optional extra: {
 forChannels?: boolean;
 rights?: ChatAdministratorRights;
 }
 Optional
 - Optional forChannels?: boolean
 - Optional rights?: ChatAdministratorRights
Returns Promise<true>

See
https://core.telegram.org/bots/api#setmydefaultadministratorrights
- Defined in src/context.ts:1388

setPassportDataErrors

setPassportDataErrors(errors): Promise<true>
Parameters
- errors: readonly PassportElementError[]
Returns Promise<true>

See
https://core.telegram.org/bots/api#setpassportdataerrors
- Defined in src/context.ts:588

setStickerEmojiList

setStickerEmojiList(...args): Promise<true>
Parameters
- Rest ...args: [sticker: string, emoji_list: string[]]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1203

setStickerKeywords

setStickerKeywords(...args): Promise<true>
Parameters
- Rest ...args: [sticker: string, keywords?: string[]]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1199

setStickerMaskPosition

setStickerMaskPosition(...args): Promise<true>
Parameters
- Rest ...args: [sticker: string, mask_position?: MaskPosition]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1193

setStickerPositionInSet

setStickerPositionInSet(sticker, position): Promise<true>
Parameters
- sticker: string
- position: number
Returns Promise<true>

Deprecated
use Telegram.setStickerPositionInSet

See
https://core.telegram.org/bots/api#setstickerpositioninset
- Defined in src/context.ts:1175

setStickerSetThumb

setStickerSetThumb(...args): Promise<true>
Parameters
- Rest ...args: [name: string, userId: number, thumbnail?: string | InputFile]
 Rest
Returns Promise<true>

Deprecated
use Telegram.setStickerSetThumbnail

See
https://core.telegram.org/bots/api#setstickersetthumbnail
- Defined in src/context.ts:1183

setStickerSetThumbnail

setStickerSetThumbnail(...args): Promise<true>
Parameters
- Rest ...args: [name: string, userId: number, thumbnail?: string | InputFile]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1187

setStickerSetTitle

setStickerSetTitle(...args): Promise<true>
Parameters
- Rest ...args: [name: string, title: string]
 Rest
Returns Promise<true>
- Defined in src/context.ts:1211

stopMessageLiveLocation

stopMessageLiveLocation(markup?): Promise<true | Edited & LocationMessage>
Parameters
- Optional markup: InlineKeyboardMarkup
 Optional
Returns Promise<true | Edited & LocationMessage>

See
https://core.telegram.org/bots/api#stopmessagelivelocation
- Defined in src/context.ts:368

stopPoll

stopPoll(...args): Promise<Poll>
Parameters
- Rest ...args: [messageId: number, extra?: Omit<{}, "chat_id" | "message_id">]
 Rest
Returns Promise<Poll>

See
https://core.telegram.org/bots/api#stoppoll
- Defined in src/context.ts:851

unbanChatMember

unbanChatMember(...args): Promise<true>
Parameters
- Rest ...args: [userId: number, extra?: {
 only_if_banned?: boolean;
 }]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#unbanchatmember
- Defined in src/context.ts:458

unbanChatSenderChat

unbanChatSenderChat(senderChatId): Promise<true>
Parameters
- senderChatId: number
Returns Promise<true>

See
https://core.telegram.org/bots/api#unbanchatsenderchat
- Defined in src/context.ts:1362

unhideGeneralForumTopic

unhideGeneralForumTopic(): Promise<true>
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#unhidegeneralforumtopic
- Defined in src/context.ts:1152

unpinAllChatMessages

unpinAllChatMessages(...args): Promise<true>
Parameters
- Rest ...args: []
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#unpinallchatmessages
- Defined in src/context.ts:540

unpinAllForumTopicMessages

unpinAllForumTopicMessages(): Promise<true>
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Returns Promise<true>

See
https://core.telegram.org/bots/api#unpinallforumtopicmessages
- Defined in src/context.ts:1090

unpinAllGeneralForumTopicMessages

unpinAllGeneralForumTopicMessages(): Promise<true>
Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup.

Returns Promise<true>

See
https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
- Defined in src/context.ts:1166

unpinChatMessage

unpinChatMessage(...args): Promise<true>
Parameters
- Rest ...args: [messageId?: number]
 Rest
Returns Promise<true>

See
https://core.telegram.org/bots/api#unpinchatmessage
- Defined in src/context.ts:532

uploadStickerFile

uploadStickerFile(...args): Promise<File>
Parameters
- Rest ...args: [sticker: InputFile, sticker_format: "video" | "static" | "animated"]
 Rest
Returns Promise<File>

See
https://core.telegram.org/bots/api#uploadstickerfile
- Defined in src/context.ts:1232

Class Context<U>

Type Parameters

U extends Deunionize<tg.Update> = tg.Update

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

U extends Deunionize<Update> = Update

Parameters

update: U

telegram: Telegram

botInfo: UserFromGetMe

Returns Context<U>

Properties

Readonly botInfo

Readonly state

Readonly telegram

Readonly update

Accessors

callbackQuery

Returns PropOr<U, "callback_query">

channelPost

Returns PropOr<U, "channel_post">

chat

Returns PropOr<GetUpdateContent<U>, "chat", undefined>

chatJoinRequest

Returns PropOr<U, "chat_join_request">

chatMember

Returns PropOr<U, "chat_member">

chosenInlineResult

Returns PropOr<U, "chosen_inline_result">

editedChannelPost

Returns PropOr<U, "edited_channel_post">

editedMessage

Returns PropOr<U, "edited_message">

from

Returns PropOr<GetUpdateContent<U>, "from", undefined>

inlineMessageId

Returns undefined | string

inlineQuery

Returns PropOr<U, "inline_query">

kickChatMember

Returns ((...args) => Promise<true>)

Parameters

Rest ...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]

Returns Promise<true>

See

See

Deprecated

me

Returns string

message

Returns PropOr<U, "message">

myChatMember

Returns PropOr<U, "my_chat_member">

passportData

Returns undefined | PassportData

poll

Returns PropOr<U, "poll">

pollAnswer

Returns PropOr<U, "poll_answer">

preCheckoutQuery

Returns PropOr<U, "pre_checkout_query">

senderChat

Returns PropOr<GetUpdateContent<U>, "sender_chat", undefined>

shippingQuery

Returns PropOr<U, "shipping_query">

tg

Returns Telegram

Deprecated

updateType

Returns Extract<UnionKeys<U>, UpdateType>

webAppData

Returns undefined | { button_text: string; data: { json<T>() => T; text() => string; }; }

webhookReply

`Readonly` botInfo

`Readonly` state

`Readonly` telegram

`Readonly` update

`Rest` ...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]

Returns undefined | {
button_text: string;
data: {
json<T>() => T;
text() => string;
};
}

`Rest` ...args: [name: string, stickerData: Omit<{}, "chat_id" | "name" | "user_id">]

`Rest` ...args: [text?: string, extra?: Omit<{}, "text" | "chat_id" | "callback_query_id">]

`Rest` ...args: [url: string]

`Rest` ...args: [results: readonly InlineQueryResult[], extra?: Omit<{}, "chat_id" | "inline_query_id" | "results">]

`Rest` ...args: [ok: boolean, errorMessage?: string]

`Rest` ...args: [ok: boolean, shippingOptions: readonly ShippingOption[], errorMessage: string]

`Rest` ...args: [userId: number, untilDate?: number, extra?: Omit<{}, "chat_id" | "user_id" | "until_date">]

`Optional` extra: {
caption?: string | FmtString;
}

`Optional` caption?: string | FmtString

`Rest` ...args: [extra?: Omit<{}, "chat_id">]