deno.land / x / grammy@v1.22.4 / context.ts
نووسراو ببینە
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963// deno-lint-ignore-file camelcaseimport { type Api, type Other as OtherApi } from "./core/api.ts";import { type Methods, type RawApi } from "./core/client.ts";import { type Filter, type FilterCore, type FilterQuery, matchFilter,} from "./filter.ts";import { type Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type ReactionType, type ReactionTypeEmoji, type Update, type User, type UserFromGetMe,} from "./types.ts";
// === Util typesexport type MaybeArray<T> = T | T[];export type StringWithSuggestions<S extends string> = | (string & Record<never, never>) | S; // permits `string` but gives hintstype Other<M extends Methods<RawApi>, X extends string = never> = OtherApi< RawApi, M, X>;type SnakeToCamelCase<S extends string> = S extends `${infer L}_${infer R}` ? `${L}${Capitalize<SnakeToCamelCase<R>>}` : S;type AliasProps<U> = { [K in string & keyof U as SnakeToCamelCase<K>]: U[K];};type RenamedUpdate = AliasProps<Omit<Update, "update_id">>;
// === Context probing logicinterface StaticHas { /** * Generates a predicate function that can test context objects for matching * the given filter query. This uses the same logic as `bot.on`. * * @param filter The filter query to check */ filterQuery<Q extends FilterQuery>( filter: Q | Q[], ): <C extends Context>(ctx: C) => ctx is Filter<C, Q>; /** * Generates a predicate function that can test context objects for * containing the given text, or for the text to match the given regular * expression. This uses the same logic as `bot.hears`. * * @param trigger The string or regex to match */ text( trigger: MaybeArray<string | RegExp>, ): <C extends Context>(ctx: C) => ctx is HearsContext<C>; /** * Generates a predicate function that can test context objects for * containing a command. This uses the same logic as `bot.command`. * * @param command The command to match */ command<S extends string>( command: MaybeArray< StringWithSuggestions<S | "start" | "help" | "settings"> >, ): <C extends Context>(ctx: C) => ctx is CommandContext<C>; /** * Generates a predicate function that can test context * objects for containing a message reaction update. This uses the same * logic as `bot.reaction`. * * @param reaction The reaction to test against */ reaction( reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>, ): <C extends Context>(ctx: C) => ctx is ReactionContext<C>; /** * Generates a predicate function that can test context objects for * belonging to a chat with the given chat type. This uses the same logic as * `bot.chatType`. * * @param chatType The chat type to match */ chatType<T extends Chat["type"]>( chatType: MaybeArray<T>, ): <C extends Context>(ctx: C) => ctx is ChatTypeContext<C, T>; /** * Generates a predicate function that can test context objects for * containing the given callback query, or for the callback query data to * match the given regular expression. This uses the same logic as * `bot.callbackQuery`. * * @param trigger The string or regex to match */ callbackQuery( trigger: MaybeArray<string | RegExp>, ): <C extends Context>(ctx: C) => ctx is CallbackQueryContext<C>; /** * Generates a predicate function that can test context objects for * containing the given game query, or for the game name to match the given * regular expression. This uses the same logic as `bot.gameQuery`. * * @param trigger The string or regex to match */ gameQuery( trigger: MaybeArray<string | RegExp>, ): <C extends Context>(ctx: C) => ctx is GameQueryContext<C>; /** * Generates a predicate function that can test context objects for * containing the given inline query, or for the inline query to match the * given regular expression. This uses the same logic as `bot.inlineQuery`. * * @param trigger The string or regex to match */ inlineQuery( trigger: MaybeArray<string | RegExp>, ): <C extends Context>(ctx: C) => ctx is InlineQueryContext<C>; /** * Generates a predicate function that can test context objects for * containing the chosen inline result, or for the chosen inline result to * match the given regular expression. * * @param trigger The string or regex to match */ chosenInlineResult( trigger: MaybeArray<string | RegExp>, ): <C extends Context>(ctx: C) => ctx is ChosenInlineResultContext<C>;}const checker: StaticHas = { filterQuery<Q extends FilterQuery>(filter: Q | Q[]) { const pred = matchFilter(filter); return <C extends Context>(ctx: C): ctx is Filter<C, Q> => pred(ctx); }, text(trigger) { const hasText = checker.filterQuery([":text", ":caption"]); const trg = triggerFn(trigger); return <C extends Context>(ctx: C): ctx is HearsContext<C> => { if (!hasText(ctx)) return false; const msg = ctx.message ?? ctx.channelPost; const txt = msg.text ?? msg.caption; return match(ctx, txt, trg); }; }, command(command) { const hasEntities = checker.filterQuery(":entities:bot_command"); const atCommands = new Set<string>(); const noAtCommands = new Set<string>(); toArray(command).forEach((cmd) => { if (cmd.startsWith("/")) { throw new Error( `Do not include '/' when registering command handlers (use '${ cmd.substring(1) }' not '${cmd}')`, ); } const set = cmd.includes("@") ? atCommands : noAtCommands; set.add(cmd); }); return <C extends Context>(ctx: C): ctx is CommandContext<C> => { if (!hasEntities(ctx)) return false; const msg = ctx.message ?? ctx.channelPost; const txt = msg.text ?? msg.caption; return msg.entities.some((e) => { if (e.type !== "bot_command") return false; if (e.offset !== 0) return false; const cmd = txt.substring(1, e.length); if (noAtCommands.has(cmd) || atCommands.has(cmd)) { ctx.match = txt.substring(cmd.length + 1).trimStart(); return true; } const index = cmd.indexOf("@"); if (index === -1) return false; const atTarget = cmd.substring(index + 1).toLowerCase(); const username = ctx.me.username.toLowerCase(); if (atTarget !== username) return false; const atCommand = cmd.substring(0, index); if (noAtCommands.has(atCommand)) { ctx.match = txt.substring(cmd.length + 1).trimStart(); return true; } return false; }); }; }, reaction(reaction) { const hasMessageReaction = checker.filterQuery("message_reaction"); const normalized: ReactionType[] = typeof reaction === "string" ? [{ type: "emoji", emoji: reaction }] : (Array.isArray(reaction) ? reaction : [reaction]).map((emoji) => typeof emoji === "string" ? { type: "emoji", emoji } : emoji ); return <C extends Context>(ctx: C): ctx is ReactionContext<C> => { if (!hasMessageReaction(ctx)) return false; const { old_reaction, new_reaction } = ctx.messageReaction; for (const reaction of new_reaction) { let isOld = false; if (reaction.type === "emoji") { for (const old of old_reaction) { if (old.type !== "emoji") continue; if (old.emoji === reaction.emoji) { isOld = true; break; } } } else if (reaction.type === "custom_emoji") { for (const old of old_reaction) { if (old.type !== "custom_emoji") continue; if (old.custom_emoji_id === reaction.custom_emoji_id) { isOld = true; break; } } } else { // always regard unsupported emoji types as new } if (!isOld) { if (reaction.type === "emoji") { for (const wanted of normalized) { if (wanted.type !== "emoji") continue; if (wanted.emoji === reaction.emoji) { return true; } } } else if (reaction.type === "custom_emoji") { for (const wanted of normalized) { if (wanted.type !== "custom_emoji") continue; if ( wanted.custom_emoji_id === reaction.custom_emoji_id ) { return true; } } } else { // always regard unsupported emoji types as new return true; } } } return false; }; }, chatType<T extends Chat["type"]>(chatType: MaybeArray<T>) { const set = new Set<Chat["type"]>(toArray(chatType)); return <C extends Context>(ctx: C): ctx is ChatTypeContext<C, T> => ctx.chat?.type !== undefined && set.has(ctx.chat.type); }, callbackQuery(trigger) { const hasCallbackQuery = checker.filterQuery("callback_query:data"); const trg = triggerFn(trigger); return <C extends Context>(ctx: C): ctx is CallbackQueryContext<C> => hasCallbackQuery(ctx) && match(ctx, ctx.callbackQuery.data, trg); }, gameQuery(trigger) { const hasGameQuery = checker.filterQuery( "callback_query:game_short_name", ); const trg = triggerFn(trigger); return <C extends Context>(ctx: C): ctx is GameQueryContext<C> => hasGameQuery(ctx) && match(ctx, ctx.callbackQuery.game_short_name, trg); }, inlineQuery(trigger) { const hasInlineQuery = checker.filterQuery("inline_query"); const trg = triggerFn(trigger); return <C extends Context>(ctx: C): ctx is InlineQueryContext<C> => hasInlineQuery(ctx) && match(ctx, ctx.inlineQuery.query, trg); }, chosenInlineResult(trigger) { const hasChosenInlineResult = checker.filterQuery( "chosen_inline_result", ); const trg = triggerFn(trigger); return <C extends Context>( ctx: C, ): ctx is ChosenInlineResultContext<C> => hasChosenInlineResult(ctx) && match(ctx, ctx.chosenInlineResult.result_id, trg); },};
// === Context class/** * When your bot receives a message, Telegram sends an update object to your * bot. The update contains information about the chat, the user, and of course * the message itself. There are numerous other updates, too: * https://core.telegram.org/bots/api#update * * When grammY receives an update, it wraps this update into a context object * for you. Context objects are commonly named `ctx`. A context object does two * things: * 1. **`ctx.update`** holds the update object that you can use to process the * message. This includes providing useful shortcuts for the update, for * instance, `ctx.msg` is a shortcut that gives you the message object from * the update—no matter whether it is contained in `ctx.update.message`, or * `ctx.update.edited_message`, or `ctx.update.channel_post`, or * `ctx.update.edited_channel_post`. * 2. **`ctx.api`** gives you access to the full Telegram Bot API so that you * can directly call any method, such as responding via * `ctx.api.sendMessage`. Also here, the context objects has some useful * shortcuts for you. For instance, if you want to send a message to the same * chat that a message comes from (i.e. just respond to a user) you can call * `ctx.reply`. This is nothing but a wrapper for `ctx.api.sendMessage` with * the right `chat_id` pre-filled for you. Almost all methods of the Telegram * Bot API have their own shortcut directly on the context object, so you * probably never really have to use `ctx.api` at all. * * This context object is then passed to all of the listeners (called * middleware) that you register on your bot. Because this is so useful, the * context object is often used to hold more information. One example are * sessions (a chat-specific data storage that is stored in a database), and * another example is `ctx.match` that is used by `bot.command` and other * methods to keep information about how a regular expression was matched. * * Read up about middleware on the * [website](https://grammy.dev/guide/context.html) if you want to know more * about the powerful opportunities that lie in context objects, and about how * grammY implements them. */export class Context implements RenamedUpdate { /** * Used by some middleware to store information about how a certain string * or regular expression was matched. */ public match: string | RegExpMatchArray | undefined; constructor( /** * The update object that is contained in the context. */ public readonly update: Update, /** * An API instance that allows you to call any method of the Telegram * Bot API. */ public readonly api: Api, /** * Information about the bot itself. */ public readonly me: UserFromGetMe, ) {} // UPDATE SHORTCUTS /** Alias for `ctx.update.message` */ get message() { return this.update.message; } /** Alias for `ctx.update.edited_message` */ get editedMessage() { return this.update.edited_message; } /** Alias for `ctx.update.channel_post` */ get channelPost() { return this.update.channel_post; } /** Alias for `ctx.update.edited_channel_post` */ get editedChannelPost() { return this.update.edited_channel_post; } /** Alias for `ctx.update.business_connection` */ get businessConnection() { return this.update.business_connection; } /** Alias for `ctx.update.business_message` */ get businessMessage() { return this.update.business_message; } /** Alias for `ctx.update.edited_business_message` */ get editedBusinessMessage() { return this.update.edited_business_message; } /** Alias for `ctx.update.deleted_business_messages` */ get deletedBusinessMessages() { return this.update.deleted_business_messages; } /** Alias for `ctx.update.message_reaction` */ get messageReaction() { return this.update.message_reaction; } /** Alias for `ctx.update.message_reaction_count` */ get messageReactionCount() { return this.update.message_reaction_count; } /** Alias for `ctx.update.inline_query` */ get inlineQuery() { return this.update.inline_query; } /** Alias for `ctx.update.chosen_inline_result` */ get chosenInlineResult() { return this.update.chosen_inline_result; } /** Alias for `ctx.update.callback_query` */ get callbackQuery() { return this.update.callback_query; } /** Alias for `ctx.update.shipping_query` */ get shippingQuery() { return this.update.shipping_query; } /** Alias for `ctx.update.pre_checkout_query` */ get preCheckoutQuery() { return this.update.pre_checkout_query; } /** Alias for `ctx.update.poll` */ get poll() { return this.update.poll; } /** Alias for `ctx.update.poll_answer` */ get pollAnswer() { return this.update.poll_answer; } /** Alias for `ctx.update.my_chat_member` */ get myChatMember() { return this.update.my_chat_member; } /** Alias for `ctx.update.chat_member` */ get chatMember() { return this.update.chat_member; } /** Alias for `ctx.update.chat_join_request` */ get chatJoinRequest() { return this.update.chat_join_request; } /** Alias for `ctx.update.chat_boost` */ get chatBoost() { return this.update.chat_boost; } /** Alias for `ctx.update.removed_chat_boost` */ get removedChatBoost() { return this.update.removed_chat_boost; } // AGGREGATION SHORTCUTS /** * Get the message object from wherever possible. Alias for `this.message ?? * this.editedMessage ?? this.channelPost ?? this.editedChannelPost ?? * this.businessMessage ?? this.editedBusinessMessage ?? * this.callbackQuery?.message`. */ get msg(): Message | undefined { // Keep in sync with types in `filter.ts`. return ( this.message ?? this.editedMessage ?? this.channelPost ?? this.editedChannelPost ?? this.businessMessage ?? this.editedBusinessMessage ?? this.callbackQuery?.message ); } /** * Get the chat object from wherever possible. Alias for `(this.msg ?? * this.deletedBusinessMessages ?? this.messageReaction ?? * this.messageReactionCount ?? this.myChatMember ?? this.chatMember ?? * this.chatJoinRequest ?? this.chatBoost ?? this.removedChatBoost)?.chat`. */ get chat(): Chat | undefined { // Keep in sync with types in `filter.ts`. return ( this.msg ?? this.deletedBusinessMessages ?? this.messageReaction ?? this.messageReactionCount ?? this.myChatMember ?? this.chatMember ?? this.chatJoinRequest ?? this.chatBoost ?? this.removedChatBoost )?.chat; } /** * Get the sender chat object from wherever possible. Alias for * `ctx.msg?.sender_chat`. */ get senderChat(): Chat | undefined { // Keep in sync with types in `filter.ts`. return this.msg?.sender_chat; } /** * Get the user object from wherever possible. Alias for * `(this.businessConnection ?? this.messageReaction ?? * (this.chatBoost?.boost ?? this.removedChatBoost)?.source)?.user ?? * (this.callbackQuery ?? this.msg ?? this.inlineQuery ?? * this.chosenInlineResult ?? this.shippingQuery ?? this.preCheckoutQuery ?? * this.myChatMember ?? this.chatMember ?? this.chatJoinRequest)?.from`. */ get from(): User | undefined { // Keep in sync with types in `filter.ts`. return ( this.businessConnection ?? this.messageReaction ?? (this.chatBoost?.boost ?? this.removedChatBoost)?.source )?.user ?? ( this.callbackQuery ?? this.msg ?? this.inlineQuery ?? this.chosenInlineResult ?? this.shippingQuery ?? this.preCheckoutQuery ?? this.myChatMember ?? this.chatMember ?? this.chatJoinRequest )?.from; } /** * Get the message identifier from wherever possible. Alias for * `this.msg?.message_id ?? this.messageReaction?.message_id ?? * this.messageReactionCount?.message_id`. */ get msgId(): number | undefined { // Keep in sync with types in `filter.ts`. return this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id; } /** * Get the inline message identifier from wherever possible. Alias for * `(ctx.callbackQuery ?? ctx.chosenInlineResult)?.inline_message_id`. */ get inlineMessageId(): string | undefined { return ( this.callbackQuery?.inline_message_id ?? this.chosenInlineResult?.inline_message_id ); } /** * Get the business connection identifier from wherever possible. Alias for * `this.msg?.business_connection_id ?? this.businessConnection?.id ?? * this.deletedBusinessMessages?.business_connection_id`. */ get businessConnectionId(): string | undefined { return this.msg?.business_connection_id ?? this.businessConnection?.id ?? this.deletedBusinessMessages?.business_connection_id; } /** * Get entities and their text. Extracts the text from `ctx.msg.text` or `ctx.msg.caption`. * Returns an empty array if one of `ctx.msg`, `ctx.msg.text` * or `ctx.msg.entities` is undefined. * * You can filter specific entity types by passing the `types` parameter. Example: * * ```ts * ctx.entities() // Returns all entity types * ctx.entities('url') // Returns only url entities * ctx.enttities(['url', 'email']) // Returns url and email entities * ``` * * @param types Types of entities to return. Omit to get all entities. * @returns Array of entities and their texts, or empty array when there's no text */ entities(): Array< MessageEntity & { /** Slice of the message text that contains this entity */ text: string; } >; entities<T extends MessageEntity["type"]>( types: MaybeArray<T>, ): Array< MessageEntity & { type: T; /** Slice of the message text that contains this entity */ text: string; } >; entities(types?: MaybeArray<MessageEntity["type"]>) { const message = this.msg; if (message === undefined) return []; const text = message.text ?? message.caption; if (text === undefined) return []; let entities = message.entities ?? message.caption_entities; if (entities === undefined) return []; if (types !== undefined) { const filters = new Set(toArray(types)); entities = entities.filter((entity) => filters.has(entity.type)); } return entities.map((entity) => ({ ...entity, text: text.substring(entity.offset, entity.offset + entity.length), })); } /** * Find out which reactions were added and removed in a `message_reaction` * update. This method looks at `ctx.messageReaction` and computes the * difference between the old reaction and the new reaction. It also groups * the reactions by emoji reactions and custom emoji reactions. For example, * the resulting object could look like this: * ```ts * { * emoji: ['👍', '🎉'] * emojiAdded: ['🎉'], * emojiKept: ['👍'], * emojiRemoved: [], * customEmoji: [], * customEmojiAdded: [], * customEmojiKept: [], * customEmojiRemoved: ['id0123'], * } * ``` * In the above example, a tada reaction was added by the user, and a custom * emoji reaction with the custom emoji 'id0123' was removed in the same * update. The user had already reacted with a thumbs up reaction, which * they left unchanged. As a result, the current reaction by the user is * thumbs up and tada. Note that the current reaction (both emoji and custom * emoji in one list) can also be obtained from * `ctx.messageReaction.new_reaction`. * * Remember that reaction updates only include information about the * reaction of a specific user. The respective message may have many more * reactions by other people which will not be included in this update. * * @returns An object containing information about the reaction update */ reactions(): { /** Emoji currently present in this user's reaction */ emoji: ReactionTypeEmoji["emoji"][]; /** Emoji newly added to this user's reaction */ emojiAdded: ReactionTypeEmoji["emoji"][]; /** Emoji not changed by the update to this user's reaction */ emojiKept: ReactionTypeEmoji["emoji"][]; /** Emoji removed from this user's reaction */ emojiRemoved: ReactionTypeEmoji["emoji"][]; /** Custom emoji currently present in this user's reaction */ customEmoji: string[]; /** Custom emoji newly added to this user's reaction */ customEmojiAdded: string[]; /** Custom emoji not changed by the update to this user's reaction */ customEmojiKept: string[]; /** Custom emoji removed from this user's reaction */ customEmojiRemoved: string[]; } { const emoji: ReactionTypeEmoji["emoji"][] = []; const emojiAdded: ReactionTypeEmoji["emoji"][] = []; const emojiKept: ReactionTypeEmoji["emoji"][] = []; const emojiRemoved: ReactionTypeEmoji["emoji"][] = []; const customEmoji: string[] = []; const customEmojiAdded: string[] = []; const customEmojiKept: string[] = []; const customEmojiRemoved: string[] = []; const r = this.messageReaction; if (r !== undefined) { const { old_reaction, new_reaction } = r; // group all current emoji in `emoji` and `customEmoji` for (const reaction of new_reaction) { if (reaction.type === "emoji") { emoji.push(reaction.emoji); } else if (reaction.type === "custom_emoji") { customEmoji.push(reaction.custom_emoji_id); } } // temporarily move all old emoji to the *Removed arrays for (const reaction of old_reaction) { if (reaction.type === "emoji") { emojiRemoved.push(reaction.emoji); } else if (reaction.type === "custom_emoji") { customEmojiRemoved.push(reaction.custom_emoji_id); } } // temporarily move all new emoji to the *Added arrays emojiAdded.push(...emoji); customEmojiAdded.push(...customEmoji); // drop common emoji from both lists and add them to `emojiKept` for (let i = 0; i < emojiRemoved.length; i++) { const len = emojiAdded.length; if (len === 0) break; const rem = emojiRemoved[i]; for (let j = 0; j < len; j++) { if (rem === emojiAdded[j]) { emojiKept.push(rem); emojiRemoved.splice(i, 1); emojiAdded.splice(j, 1); i--; break; } } } // drop common custom emoji from both lists and add them to `customEmojiKept` for (let i = 0; i < customEmojiRemoved.length; i++) { const len = customEmojiAdded.length; if (len === 0) break; const rem = customEmojiRemoved[i]; for (let j = 0; j < len; j++) { if (rem === customEmojiAdded[j]) { customEmojiKept.push(rem); customEmojiRemoved.splice(i, 1); customEmojiAdded.splice(j, 1); i--; break; } } } } return { emoji, emojiAdded, emojiKept, emojiRemoved, customEmoji, customEmojiAdded, customEmojiKept, customEmojiRemoved, }; } // PROBING SHORTCUTS /** * `Context.has` is an object that contains a number of useful functions for * probing context objects. Each of these functions can generate a predicate * function, to which you can pass context objects in order to check if a * condition holds for the respective context object. * * For example, you can call `Context.has.filterQuery(":text")` to generate * a predicate function that tests context objects for containing text: * ```ts * const hasText = Context.has.filterQuery(":text"); * * if (hasText(ctx0)) {} // `ctx0` matches the filter query `:text` * if (hasText(ctx1)) {} // `ctx1` matches the filter query `:text` * if (hasText(ctx2)) {} // `ctx2` matches the filter query `:text` * ``` * These predicate functions are used internally by the has-methods that are * installed on every context object. This means that calling * `ctx.has(":text")` is equivalent to * `Context.has.filterQuery(":text")(ctx)`. */ static has = checker; /** * Returns `true` if this context object matches the given filter query, and * `false` otherwise. This uses the same logic as `bot.on`. * * @param filter The filter query to check */ has<Q extends FilterQuery>(filter: Q | Q[]): this is FilterCore<Q> { return Context.has.filterQuery(filter)(this); } /** * Returns `true` if this context object contains the given text, or if it * contains text that matches the given regular expression. It returns * `false` otherwise. This uses the same logic as `bot.hears`. * * @param trigger The string or regex to match */ hasText(trigger: MaybeArray<string | RegExp>): this is HearsContextCore { return Context.has.text(trigger)(this); } /** * Returns `true` if this context object contains the given command, and * `false` otherwise. This uses the same logic as `bot.command`. * * @param command The command to match */ hasCommand<S extends string>( command: MaybeArray< StringWithSuggestions<S | "start" | "help" | "settings"> >, ): this is CommandContextCore { return Context.has.command(command)(this); } hasReaction( reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>, ): this is ReactionContextCore { return Context.has.reaction(reaction)(this); } /** * Returns `true` if this context object belongs to a chat with the given * chat type, and `false` otherwise. This uses the same logic as * `bot.chatType`. * * @param chatType The chat type to match */ hasChatType<T extends Chat["type"]>( chatType: MaybeArray<T>, ): this is ChatTypeContextCore<T> { return Context.has.chatType(chatType)(this); } /** * Returns `true` if this context object contains the given callback query, * or if the contained callback query data matches the given regular * expression. It returns `false` otherwise. This uses the same logic as * `bot.callbackQuery`. * * @param trigger The string or regex to match */ hasCallbackQuery( trigger: MaybeArray<string | RegExp>, ): this is CallbackQueryContextCore { return Context.has.callbackQuery(trigger)(this); } /** * Returns `true` if this context object contains the given game query, or * if the contained game query matches the given regular expression. It * returns `false` otherwise. This uses the same logic as `bot.gameQuery`. * * @param trigger The string or regex to match */ hasGameQuery( trigger: MaybeArray<string | RegExp>, ): this is GameQueryContextCore { return Context.has.gameQuery(trigger)(this); } /** * Returns `true` if this context object contains the given inline query, or * if the contained inline query matches the given regular expression. It * returns `false` otherwise. This uses the same logic as `bot.inlineQuery`. * * @param trigger The string or regex to match */ hasInlineQuery( trigger: MaybeArray<string | RegExp>, ): this is InlineQueryContextCore { return Context.has.inlineQuery(trigger)(this); } /** * Returns `true` if this context object contains the chosen inline result, or * if the contained chosen inline result matches the given regular expression. It * returns `false` otherwise. This uses the same logic as `bot.chosenInlineResult`. * * @param trigger The string or regex to match */ hasChosenInlineResult( trigger: MaybeArray<string | RegExp>, ): this is ChosenInlineResultContextCore { return Context.has.chosenInlineResult(trigger)(this); } // API /** * Context-aware alias for `api.sendMessage`. Use this method to send text messages. On success, the sent Message is returned. * * @param text Text of the message to be sent, 1-4096 characters after entities parsing * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendmessage */ reply( text: string, other?: Other<"sendMessage", "chat_id" | "text">, signal?: AbortSignal, ) { return this.api.sendMessage( orThrow(this.chat, "sendMessage").id, text, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.forwardMessage`. Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned. * * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#forwardmessage */ forwardMessage( chat_id: number | string, other?: Other< "forwardMessage", "chat_id" | "from_chat_id" | "message_id" >, signal?: AbortSignal, ) { return this.api.forwardMessage( chat_id, orThrow(this.chat, "forwardMessage").id, orThrow(this.msgId, "forwardMessage"), other, signal, ); } /** * Context-aware alias for `api.forwardMessages`. Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned. * * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param message_ids A list of 1-100 identifiers of messages in the current chat to forward. The identifiers must be specified in a strictly increasing order. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#forwardmessages */ forwardMessages( chat_id: number | string, message_ids: number[], other?: Other< "forwardMessages", "chat_id" | "from_chat_id" | "message_ids" >, signal?: AbortSignal, ) { return this.api.forwardMessages( chat_id, orThrow(this.chat, "forwardMessages").id, message_ids, other, signal, ); } /** * Context-aware alias for `api.copyMessage`. Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. * * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#copymessage */ copyMessage( chat_id: number | string, other?: Other<"copyMessage", "chat_id" | "from_chat_id" | "message_id">, signal?: AbortSignal, ) { return this.api.copyMessage( chat_id, orThrow(this.chat, "copyMessage").id, orThrow(this.msgId, "copyMessage"), other, signal, ); } /** * Context-aware alias for `api.copyMessages`.Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. * * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param message_ids A list of 1-100 identifiers of messages in the current chat to copy. The identifiers must be specified in a strictly increasing order. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#copymessages */ copyMessages( chat_id: number | string, message_ids: number[], other?: Other< "copyMessages", "chat_id" | "from_chat_id" | "message_id" >, signal?: AbortSignal, ) { return this.api.copyMessages( chat_id, orThrow(this.chat, "copyMessages").id, message_ids, other, signal, ); } /** * Context-aware alias for `api.sendPhoto`. Use this method to send photos. On success, the sent Message is returned. * * @param photo Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendphoto */ replyWithPhoto( photo: InputFile | string, other?: Other<"sendPhoto", "chat_id" | "photo">, signal?: AbortSignal, ) { return this.api.sendPhoto( orThrow(this.chat, "sendPhoto").id, photo, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendAudio`. Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. * * For sending voice messages, use the sendVoice method instead. * * @param audio Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendaudio */ replyWithAudio( audio: InputFile | string, other?: Other<"sendAudio", "chat_id" | "audio">, signal?: AbortSignal, ) { return this.api.sendAudio( orThrow(this.chat, "sendAudio").id, audio, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendDocument`. Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. * * @param document File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#senddocument */ replyWithDocument( document: InputFile | string, other?: Other<"sendDocument", "chat_id" | "document">, signal?: AbortSignal, ) { return this.api.sendDocument( orThrow(this.chat, "sendDocument").id, document, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendVideo`. Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. * * @param video Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendvideo */ replyWithVideo( video: InputFile | string, other?: Other<"sendVideo", "chat_id" | "video">, signal?: AbortSignal, ) { return this.api.sendVideo( orThrow(this.chat, "sendVideo").id, video, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendAnimation`. Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. * * @param animation Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendanimation */ replyWithAnimation( animation: InputFile | string, other?: Other<"sendAnimation", "chat_id" | "animation">, signal?: AbortSignal, ) { return this.api.sendAnimation( orThrow(this.chat, "sendAnimation").id, animation, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendVoice`. Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. * * @param voice Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendvoice */ replyWithVoice( voice: InputFile | string, other?: Other<"sendVoice", "chat_id" | "voice">, signal?: AbortSignal, ) { return this.api.sendVoice( orThrow(this.chat, "sendVoice").id, voice, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendVideoNote`. Use this method to send video messages. On success, the sent Message is returned. * As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. * * @param video_note Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending video notes by a URL is currently unsupported * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendvideonote */ replyWithVideoNote( video_note: InputFile | string, other?: Other<"sendVideoNote", "chat_id" | "video_note">, signal?: AbortSignal, ) { return this.api.sendVideoNote( orThrow(this.chat, "sendVideoNote").id, video_note, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendMediaGroup`. Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned. * * @param media An array describing messages to be sent, must include 2-10 items * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendmediagroup */ replyWithMediaGroup( media: ReadonlyArray< | InputMediaAudio | InputMediaDocument | InputMediaPhoto | InputMediaVideo >, other?: Other<"sendMediaGroup", "chat_id" | "media">, signal?: AbortSignal, ) { return this.api.sendMediaGroup( orThrow(this.chat, "sendMediaGroup").id, media, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendLocation`. Use this method to send point on the map. On success, the sent Message is returned. * * @param latitude Latitude of the location * @param longitude Longitude of the location * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendlocation */ replyWithLocation( latitude: number, longitude: number, other?: Other<"sendLocation", "chat_id" | "latitude" | "longitude">, signal?: AbortSignal, ) { return this.api.sendLocation( orThrow(this.chat, "sendLocation").id, latitude, longitude, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.editMessageLiveLocation`. Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param latitude Latitude of new location * @param longitude Longitude of new location * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editmessagelivelocation */ editMessageLiveLocation( latitude: number, longitude: number, other?: Other< "editMessageLiveLocation", | "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.editMessageLiveLocationInline( inlineId, latitude, longitude, other, ) : this.api.editMessageLiveLocation( orThrow(this.chat, "editMessageLiveLocation").id, orThrow(this.msgId, "editMessageLiveLocation"), latitude, longitude, other, signal, ); } /** * Context-aware alias for `api.stopMessageLiveLocation`. Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#stopmessagelivelocation */ stopMessageLiveLocation( other?: Other< "stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.stopMessageLiveLocationInline(inlineId, other) : this.api.stopMessageLiveLocation( orThrow(this.chat, "stopMessageLiveLocation").id, orThrow(this.msgId, "stopMessageLiveLocation"), other, signal, ); } /** * Context-aware alias for `api.sendVenue`. Use this method to send information about a venue. On success, the sent Message is returned. * * @param latitude Latitude of the venue * @param longitude Longitude of the venue * @param title Name of the venue * @param address Address of the venue * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendvenue */ replyWithVenue( latitude: number, longitude: number, title: string, address: string, other?: Other< "sendVenue", "chat_id" | "latitude" | "longitude" | "title" | "address" >, signal?: AbortSignal, ) { return this.api.sendVenue( orThrow(this.chat, "sendVenue").id, latitude, longitude, title, address, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendContact`. Use this method to send phone contacts. On success, the sent Message is returned. * * @param phone_number Contact's phone number * @param first_name Contact's first name * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendcontact */ replyWithContact( phone_number: string, first_name: string, other?: Other<"sendContact", "chat_id" | "phone_number" | "first_name">, signal?: AbortSignal, ) { return this.api.sendContact( orThrow(this.chat, "sendContact").id, phone_number, first_name, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendPoll`. Use this method to send a native poll. On success, the sent Message is returned. * * @param question Poll question, 1-300 characters * @param options A list of answer options, 2-10 strings 1-100 characters each * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendpoll */ replyWithPoll( question: string, options: readonly string[], other?: Other<"sendPoll", "chat_id" | "question" | "options">, signal?: AbortSignal, ) { return this.api.sendPoll( orThrow(this.chat, "sendPoll").id, question, options, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendDice`. Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. * * @param emoji Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, or “🎰”. Dice can have values 1-6 for “🎲” and “🎯”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲” * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#senddice */ replyWithDice( emoji: string, other?: Other<"sendDice", "chat_id" | "emoji">, signal?: AbortSignal, ) { return this.api.sendDice( orThrow(this.chat, "sendDice").id, emoji, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.sendChatAction`. Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. * * Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. * * We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. * * @param action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendchataction */ 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", other?: Other<"sendChatAction", "chat_id" | "action">, signal?: AbortSignal, ) { return this.api.sendChatAction( orThrow(this.chat, "sendChatAction").id, action, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Context-aware alias for `api.setMessageReaction`. Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success. * * @param reaction A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setmessagereaction */ react( reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>, other?: Other< "setMessageReaction", "chat_id" | "message_id" | "reaction" >, signal?: AbortSignal, ) { return this.api.setMessageReaction( orThrow(this.chat, "setMessageReaction").id, orThrow(this.msgId, "setMessageReaction"), typeof reaction === "string" ? [{ type: "emoji", emoji: reaction }] : (Array.isArray(reaction) ? reaction : [reaction]) .map((emoji) => typeof emoji === "string" ? { type: "emoji", emoji } : emoji ), other, signal, ); } /** * Context-aware alias for `api.getUserProfilePhotos`. Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. * * @param user_id Unique identifier of the target user * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getuserprofilephotos */ getUserProfilePhotos( other?: Other<"getUserProfilePhotos", "user_id">, signal?: AbortSignal, ) { return this.api.getUserProfilePhotos( orThrow(this.from, "getUserProfilePhotos").id, other, signal, ); } /** * Context-aware alias for `api.getUserChatBoosts`. Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object. * * @param chat_id Unique identifier for the chat or username of the channel (in the format @channelusername) * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getuserchatboosts */ getUserChatBoosts(chat_id: number | string, signal?: AbortSignal) { return this.api.getUserChatBoosts( chat_id, orThrow(this.from, "getUserChatBoosts").id, signal, ); } /** * Context-aware alias for `api.getBusinessConnection`. Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success. * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getbusinessconnection */ getBusinessConnection(signal?: AbortSignal) { return this.api.getBusinessConnection( orThrow(this.businessConnectionId, "getBusinessConnection"), signal, ); } /** * Context-aware alias for `api.getFile`. Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. * * Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getfile */ getFile(signal?: AbortSignal) { const m = orThrow(this.msg, "getFile"); const file = m.photo !== undefined ? m.photo[m.photo.length - 1] : m.animation ?? m.audio ?? m.document ?? m.video ?? m.video_note ?? m.voice ?? m.sticker; return this.api.getFile(orThrow(file, "getFile").file_id, signal); } /** @deprecated Use `banAuthor` instead. */ kickAuthor(...args: Parameters<Context["banAuthor"]>) { return this.banAuthor(...args); } /** * Context-aware alias for `api.banChatMember`. Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#banchatmember */ banAuthor( other?: Other<"banChatMember", "chat_id" | "user_id">, signal?: AbortSignal, ) { return this.api.banChatMember( orThrow(this.chat, "banAuthor").id, orThrow(this.from, "banAuthor").id, other, signal, ); } /** @deprecated Use `banChatMember` instead. */ kickChatMember(...args: Parameters<Context["banChatMember"]>) { return this.banChatMember(...args); } /** * Context-aware alias for `api.banChatMember`. Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param user_id Unique identifier of the target user * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#banchatmember */ banChatMember( user_id: number, other?: Other<"banChatMember", "chat_id" | "user_id">, signal?: AbortSignal, ) { return this.api.banChatMember( orThrow(this.chat, "banChatMember").id, user_id, other, signal, ); } /** * Context-aware alias for `api.unbanChatMember`. Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success. * * @param user_id Unique identifier of the target user * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unbanchatmember */ unbanChatMember( user_id: number, other?: Other<"unbanChatMember", "chat_id" | "user_id">, signal?: AbortSignal, ) { return this.api.unbanChatMember( orThrow(this.chat, "unbanChatMember").id, user_id, other, signal, ); } /** * Context-aware alias for `api.restrictChatMember`. Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success. * * @param permissions An object for new user permissions * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#restrictchatmember */ restrictAuthor( permissions: ChatPermissions, other?: Other< "restrictChatMember", "chat_id" | "user_id" | "permissions" >, signal?: AbortSignal, ) { return this.api.restrictChatMember( orThrow(this.chat, "restrictAuthor").id, orThrow(this.from, "restrictAuthor").id, permissions, other, signal, ); } /** * Context-aware alias for `api.restrictChatMember`. Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success. * * @param user_id Unique identifier of the target user * @param permissions An object for new user permissions * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#restrictchatmember */ restrictChatMember( user_id: number, permissions: ChatPermissions, other?: Other< "restrictChatMember", "chat_id" | "user_id" | "permissions" >, signal?: AbortSignal, ) { return this.api.restrictChatMember( orThrow(this.chat, "restrictChatMember").id, user_id, permissions, other, signal, ); } /** * Context-aware alias for `api.promoteChatMember`. Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#promotechatmember */ promoteAuthor( other?: Other<"promoteChatMember", "chat_id" | "user_id">, signal?: AbortSignal, ) { return this.api.promoteChatMember( orThrow(this.chat, "promoteAuthor").id, orThrow(this.from, "promoteAuthor").id, other, signal, ); } /** * Context-aware alias for `api.promoteChatMember`. Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success. * * @param user_id Unique identifier of the target user * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#promotechatmember */ promoteChatMember( user_id: number, other?: Other<"promoteChatMember", "chat_id" | "user_id">, signal?: AbortSignal, ) { return this.api.promoteChatMember( orThrow(this.chat, "promoteChatMember").id, user_id, other, signal, ); } /** * Context-aware alias for `api.setChatAdministratorCustomTitle`. Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. * * @param custom_title New custom title for the administrator; 0-16 characters, emoji are not allowed * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatadministratorcustomtitle */ setChatAdministratorAuthorCustomTitle( custom_title: string, signal?: AbortSignal, ) { return this.api.setChatAdministratorCustomTitle( orThrow(this.chat, "setChatAdministratorAuthorCustomTitle").id, orThrow(this.from, "setChatAdministratorAuthorCustomTitle").id, custom_title, signal, ); } /** * Context-aware alias for `api.setChatAdministratorCustomTitle`. Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. * * @param user_id Unique identifier of the target user * @param custom_title New custom title for the administrator; 0-16 characters, emoji are not allowed * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatadministratorcustomtitle */ setChatAdministratorCustomTitle( user_id: number, custom_title: string, signal?: AbortSignal, ) { return this.api.setChatAdministratorCustomTitle( orThrow(this.chat, "setChatAdministratorCustomTitle").id, user_id, custom_title, signal, ); } /** * Context-aware alias for `api.banChatSenderChat`. Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success. * * @param sender_chat_id Unique identifier of the target sender chat * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#banchatsenderchat */ banChatSenderChat(sender_chat_id: number, signal?: AbortSignal) { return this.api.banChatSenderChat( orThrow(this.chat, "banChatSenderChat").id, sender_chat_id, signal, ); } /** * Context-aware alias for `api.unbanChatSenderChat`. Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success. * * @param sender_chat_id Unique identifier of the target sender chat * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unbanchatsenderchat */ unbanChatSenderChat( sender_chat_id: number, signal?: AbortSignal, ) { return this.api.unbanChatSenderChat( orThrow(this.chat, "unbanChatSenderChat").id, sender_chat_id, signal, ); } /** * Context-aware alias for `api.setChatPermissions`. Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success. * * @param permissions New default chat permissions * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatpermissions */ setChatPermissions(permissions: ChatPermissions, signal?: AbortSignal) { return this.api.setChatPermissions( orThrow(this.chat, "setChatPermissions").id, permissions, signal, ); } /** * Context-aware alias for `api.exportChatInviteLink`. Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success. * * Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#exportchatinvitelink */ exportChatInviteLink(signal?: AbortSignal) { return this.api.exportChatInviteLink( orThrow(this.chat, "exportChatInviteLink").id, signal, ); } /** * Context-aware alias for `api.createChatInviteLink`. Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#createchatinvitelink */ createChatInviteLink( other?: Other<"createChatInviteLink", "chat_id">, signal?: AbortSignal, ) { return this.api.createChatInviteLink( orThrow(this.chat, "createChatInviteLink").id, other, signal, ); } /** * Context-aware alias for `api.editChatInviteLink`. Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object. * * @param invite_link The invite link to edit * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editchatinvitelink */ editChatInviteLink( invite_link: string, other?: Other<"editChatInviteLink", "chat_id" | "invite_link">, signal?: AbortSignal, ) { return this.api.editChatInviteLink( orThrow(this.chat, "editChatInviteLink").id, invite_link, other, signal, ); } /** * Context-aware alias for `api.revokeChatInviteLink`. Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object. * * @param invite_link The invite link to revoke * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#revokechatinvitelink */ revokeChatInviteLink(invite_link: string, signal?: AbortSignal) { return this.api.revokeChatInviteLink( orThrow(this.chat, "editChatInviteLink").id, invite_link, signal, ); } /** * Context-aware alias for `api.approveChatJoinRequest`. Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success. * * @param user_id Unique identifier of the target user * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#approvechatjoinrequest */ approveChatJoinRequest( user_id: number, signal?: AbortSignal, ) { return this.api.approveChatJoinRequest( orThrow(this.chat, "approveChatJoinRequest").id, user_id, signal, ); } /** * Context-aware alias for `api.declineChatJoinRequest`. Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success. * * @param user_id Unique identifier of the target user * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#declinechatjoinrequest */ declineChatJoinRequest( user_id: number, signal?: AbortSignal, ) { return this.api.declineChatJoinRequest( orThrow(this.chat, "declineChatJoinRequest").id, user_id, signal, ); } /** * Context-aware alias for `api.setChatPhoto`. Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param photo New chat photo, uploaded using multipart/form-data * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatphoto */ setChatPhoto(photo: InputFile, signal?: AbortSignal) { return this.api.setChatPhoto( orThrow(this.chat, "setChatPhoto").id, photo, signal, ); } /** * Context-aware alias for `api.deleteChatPhoto`. Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#deletechatphoto */ deleteChatPhoto(signal?: AbortSignal) { return this.api.deleteChatPhoto( orThrow(this.chat, "deleteChatPhoto").id, signal, ); } /** * Context-aware alias for `api.setChatTitle`. Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param title New chat title, 1-255 characters * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchattitle */ setChatTitle(title: string, signal?: AbortSignal) { return this.api.setChatTitle( orThrow(this.chat, "setChatTitle").id, title, signal, ); } /** * Context-aware alias for `api.setChatDescription`. Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. * * @param description New chat description, 0-255 characters * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatdescription */ setChatDescription(description: string | undefined, signal?: AbortSignal) { return this.api.setChatDescription( orThrow(this.chat, "setChatDescription").id, description, signal, ); } /** * Context-aware alias for `api.pinChatMessage`. Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success. * * @param message_id Identifier of a message to pin * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#pinchatmessage */ pinChatMessage( message_id: number, other?: Other<"pinChatMessage", "chat_id" | "message_id">, signal?: AbortSignal, ) { return this.api.pinChatMessage( orThrow(this.chat, "pinChatMessage").id, message_id, other, signal, ); } /** * Context-aware alias for `api.unpinChatMessage`. Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success. * * @param message_id Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unpinchatmessage */ unpinChatMessage(message_id?: number, signal?: AbortSignal) { return this.api.unpinChatMessage( orThrow(this.chat, "unpinChatMessage").id, message_id, signal, ); } /** * Context-aware alias for `api.unpinAllChatMessages`. Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unpinallchatmessages */ unpinAllChatMessages(signal?: AbortSignal) { return this.api.unpinAllChatMessages( orThrow(this.chat, "unpinAllChatMessages").id, signal, ); } /** * Context-aware alias for `api.leaveChat`. Use this method for your bot to leave a group, supergroup or channel. Returns True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#leavechat */ leaveChat(signal?: AbortSignal) { return this.api.leaveChat(orThrow(this.chat, "leaveChat").id, signal); } /** * Context-aware alias for `api.getChat`. Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getchat */ getChat(signal?: AbortSignal) { return this.api.getChat(orThrow(this.chat, "getChat").id, signal); } /** * Context-aware alias for `api.getChatAdministrators`. Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getchatadministrators */ getChatAdministrators(signal?: AbortSignal) { return this.api.getChatAdministrators( orThrow(this.chat, "getChatAdministrators").id, signal, ); } /** @deprecated Use `getChatMembersCount` instead. */ getChatMembersCount(...args: Parameters<Context["getChatMemberCount"]>) { return this.getChatMemberCount(...args); } /** * Context-aware alias for `api.getChatMemberCount`. Use this method to get the number of members in a chat. Returns Int on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getchatmembercount */ getChatMemberCount(signal?: AbortSignal) { return this.api.getChatMemberCount( orThrow(this.chat, "getChatMemberCount").id, signal, ); } /** * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getchatmember */ getAuthor(signal?: AbortSignal) { return this.api.getChatMember( orThrow(this.chat, "getAuthor").id, orThrow(this.from, "getAuthor").id, signal, ); } /** * Context-aware alias for `api.getChatMember`. Use this method to get information about a member of a chat. The method is guaranteed to work only if the bot is an administrator in the chat. Returns a ChatMember object on success. * * @param user_id Unique identifier of the target user * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getchatmember */ getChatMember(user_id: number, signal?: AbortSignal) { return this.api.getChatMember( orThrow(this.chat, "getChatMember").id, user_id, signal, ); } /** * Context-aware alias for `api.setChatStickerSet`. Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success. * * @param sticker_set_name Name of the sticker set to be set as the group sticker set * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatstickerset */ setChatStickerSet(sticker_set_name: string, signal?: AbortSignal) { return this.api.setChatStickerSet( orThrow(this.chat, "setChatStickerSet").id, sticker_set_name, signal, ); } /** * Context-aware alias for `api.deleteChatStickerSet`. Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#deletechatstickerset */ deleteChatStickerSet(signal?: AbortSignal) { return this.api.deleteChatStickerSet( orThrow(this.chat, "deleteChatStickerSet").id, signal, ); } /** * Context-aware alias for `api.createForumTopic`. 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. * * @param name Topic name, 1-128 characters * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#createforumtopic */ createForumTopic( name: string, other?: Other<"createForumTopic", "chat_id" | "name">, signal?: AbortSignal, ) { return this.api.createForumTopic( orThrow(this.chat, "createForumTopic").id, name, other, signal, ); } /** * Context-aware alias for `api.editForumTopic`. 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. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editforumtopic */ editForumTopic( other?: Other<"editForumTopic", "chat_id" | "message_thread_id">, signal?: AbortSignal, ) { const message = orThrow(this.msg, "editForumTopic"); const thread = orThrow(message.message_thread_id, "editForumTopic"); return this.api.editForumTopic(message.chat.id, thread, other, signal); } /** * Context-aware alias for `api.closeForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#closeforumtopic */ closeForumTopic(signal?: AbortSignal) { const message = orThrow(this.msg, "closeForumTopic"); const thread = orThrow(message.message_thread_id, "closeForumTopic"); return this.api.closeForumTopic(message.chat.id, thread, signal); } /** * Context-aware alias for `api.reopenForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#reopenforumtopic */ reopenForumTopic(signal?: AbortSignal) { const message = orThrow(this.msg, "reopenForumTopic"); const thread = orThrow(message.message_thread_id, "reopenForumTopic"); return this.api.reopenForumTopic(message.chat.id, thread, signal); } /** * Context-aware alias for `api.deleteForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#deleteforumtopic */ deleteForumTopic(signal?: AbortSignal) { const message = orThrow(this.msg, "deleteForumTopic"); const thread = orThrow(message.message_thread_id, "deleteForumTopic"); return this.api.deleteForumTopic(message.chat.id, thread, signal); } /** * Context-aware alias for `api.unpinAllForumTopicMessages`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unpinallforumtopicmessages */ unpinAllForumTopicMessages(signal?: AbortSignal) { const message = orThrow(this.msg, "unpinAllForumTopicMessages"); const thread = orThrow( message.message_thread_id, "unpinAllForumTopicMessages", ); return this.api.unpinAllForumTopicMessages( message.chat.id, thread, signal, ); } /** * Context-aware alias for `api.editGeneralForumTopic`. 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. * * @param name New topic name, 1-128 characters * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editgeneralforumtopic */ editGeneralForumTopic(name: string, signal?: AbortSignal) { return this.api.editGeneralForumTopic( orThrow(this.chat, "editGeneralForumTopic").id, name, signal, ); } /** * Context-aware alias for `api.closeGeneralForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#closegeneralforumtopic */ closeGeneralForumTopic(signal?: AbortSignal) { return this.api.closeGeneralForumTopic( orThrow(this.chat, "closeGeneralForumTopic").id, signal, ); } /** * Context-aware alias for `api.reopenGeneralForumTopic`. 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. * * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#reopengeneralforumtopic */ reopenGeneralForumTopic(signal?: AbortSignal) { return this.api.reopenGeneralForumTopic( orThrow(this.chat, "reopenGeneralForumTopic").id, signal, ); } /** * Context-aware alias for `api.hideGeneralForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#hidegeneralforumtopic */ hideGeneralForumTopic(signal?: AbortSignal) { return this.api.hideGeneralForumTopic( orThrow(this.chat, "hideGeneralForumTopic").id, signal, ); } /** * Context-aware alias for `api.unhideGeneralForumTopic`. 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. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unhidegeneralforumtopic */ unhideGeneralForumTopic(signal?: AbortSignal) { return this.api.unhideGeneralForumTopic( orThrow(this.chat, "unhideGeneralForumTopic").id, signal, ); } /** * Context-aware alias for `api.unpinAllGeneralForumTopicMessages`. 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 True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages */ unpinAllGeneralForumTopicMessages(signal?: AbortSignal) { return this.api.unpinAllGeneralForumTopicMessages( orThrow(this.chat, "unpinAllGeneralForumTopicMessages").id, signal, ); } /** * Context-aware alias for `api.answerCallbackQuery`. Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. * * Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#answercallbackquery */ answerCallbackQuery( other?: string | Other<"answerCallbackQuery", "callback_query_id">, signal?: AbortSignal, ) { return this.api.answerCallbackQuery( orThrow(this.callbackQuery, "answerCallbackQuery").id, typeof other === "string" ? { text: other } : other, signal, ); } /** * Context-aware alias for `api.setChatMenuButton`. Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatmenubutton */ setChatMenuButton( other?: Other<"setChatMenuButton">, signal?: AbortSignal, ) { return this.api.setChatMenuButton(other, signal); } /** * Context-aware alias for `api.getChatMenuButton`. Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setchatmenubutton */ getChatMenuButton( other?: Other<"getChatMenuButton">, signal?: AbortSignal, ) { return this.api.getChatMenuButton(other, signal); } /** * Context-aware alias for `api.setMyDefaultAdministratorRights`. Use this method to the change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setmydefaultadministratorrights */ setMyDefaultAdministratorRights( other?: Other<"setMyDefaultAdministratorRights">, signal?: AbortSignal, ) { return this.api.setMyDefaultAdministratorRights(other, signal); } /** * Context-aware alias for `api.getMyDefaultAdministratorRights`. Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request */ getMyDefaultAdministratorRights( other?: Other<"getMyDefaultAdministratorRights">, signal?: AbortSignal, ) { return this.api.getMyDefaultAdministratorRights(other, signal); } /** * Context-aware alias for `api.editMessageText`. Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param text New text of the message, 1-4096 characters after entities parsing * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editmessagetext */ editMessageText( text: string, other?: Other< "editMessageText", "chat_id" | "message_id" | "inline_message_id" | "text" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.editMessageTextInline(inlineId, text, other) : this.api.editMessageText( orThrow(this.chat, "editMessageText").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "editMessageText", ), text, other, signal, ); } /** * Context-aware alias for `api.editMessageCaption`. Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editmessagecaption */ editMessageCaption( other?: Other< "editMessageCaption", "chat_id" | "message_id" | "inline_message_id" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.editMessageCaptionInline(inlineId, other) : this.api.editMessageCaption( orThrow(this.chat, "editMessageCaption").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "editMessageCaption", ), other, signal, ); } /** * Context-aware alias for `api.editMessageMedia`. Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param media An object for a new media content of the message * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editmessagemedia */ editMessageMedia( media: InputMedia, other?: Other< "editMessageMedia", "chat_id" | "message_id" | "inline_message_id" | "media" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.editMessageMediaInline(inlineId, media, other) : this.api.editMessageMedia( orThrow(this.chat, "editMessageMedia").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "editMessageMedia", ), media, other, signal, ); } /** * Context-aware alias for `api.editMessageReplyMarkup`. Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#editmessagereplymarkup */ editMessageReplyMarkup( other?: Other< "editMessageReplyMarkup", "chat_id" | "message_id" | "inline_message_id" >, signal?: AbortSignal, ) { const inlineId = this.inlineMessageId; return inlineId !== undefined ? this.api.editMessageReplyMarkupInline(inlineId, other) : this.api.editMessageReplyMarkup( orThrow(this.chat, "editMessageReplyMarkup").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "editMessageReplyMarkup", ), other, signal, ); } /** * Context-aware alias for `api.stopPoll`. Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned. * * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#stoppoll */ stopPoll( other?: Other<"stopPoll", "chat_id" | "message_id">, signal?: AbortSignal, ) { return this.api.stopPoll( orThrow(this.chat, "stopPoll").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "stopPoll", ), other, signal, ); } /** * Context-aware alias for `api.deleteMessage`. Use this method to delete a message, including service messages, with the following limitations: * - A message can only be deleted if it was sent less than 48 hours ago. * - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. * - Bots can delete outgoing messages in private chats, groups, and supergroups. * - Bots can delete incoming messages in private chats. * - Bots granted can_post_messages permissions can delete outgoing messages in channels. * - If the bot is an administrator of a group, it can delete any message there. * - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. * Returns True on success. * * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#deletemessage */ deleteMessage(signal?: AbortSignal) { return this.api.deleteMessage( orThrow(this.chat, "deleteMessage").id, orThrow( this.msg?.message_id ?? this.messageReaction?.message_id ?? this.messageReactionCount?.message_id, "deleteMessage", ), signal, ); } /** * Context-aware alias for `api.deleteMessages`. Use this method to delete multiple messages simultaneously. Returns True on success. * * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername) * @param message_ids A list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#deletemessages */ deleteMessages(message_ids: number[], signal?: AbortSignal) { return this.api.deleteMessages( orThrow(this.chat, "deleteMessages").id, message_ids, signal, ); } /** * Context-aware alias for `api.sendSticker`. Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. * * @param sticker Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. Video and animated stickers can't be sent via an HTTP URL. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendsticker */ replyWithSticker( sticker: InputFile | string, other?: Other<"sendSticker", "chat_id" | "sticker">, signal?: AbortSignal, ) { return this.api.sendSticker( orThrow(this.chat, "sendSticker").id, sticker, { business_connection_id: this.businessConnectionId, ...other }, signal, ); } /** * Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects. * * @param custom_emoji_ids A list of custom emoji identifiers * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#getcustomemojistickers */ getCustomEmojiStickers(signal?: AbortSignal) { type Emoji = MessageEntity.CustomEmojiMessageEntity; return this.api.getCustomEmojiStickers( (this.msg?.entities ?? []) .filter((e): e is Emoji => e.type === "custom_emoji") .map((e) => e.custom_emoji_id), signal, ); } /** * Context-aware alias for `api.answerInlineQuery`. Use this method to send answers to an inline query. On success, True is returned. * No more than 50 results per query are allowed. * * Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. * * @param results An array of results for the inline query * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#answerinlinequery */ answerInlineQuery( results: readonly InlineQueryResult[], other?: Other<"answerInlineQuery", "inline_query_id" | "results">, signal?: AbortSignal, ) { return this.api.answerInlineQuery( orThrow(this.inlineQuery, "answerInlineQuery").id, results, other, signal, ); } /** * Context-aware alias for `api.sendInvoice`. Use this method to send invoices. On success, the sent Message is returned. * * @param title Product name, 1-32 characters * @param description Product description, 1-255 characters * @param payload Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. * @param provider_token Payment provider token, obtained via @BotFather * @param currency Three-letter ISO 4217 currency code, see more on currencies * @param prices Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendinvoice */ replyWithInvoice( title: string, description: string, payload: string, provider_token: string, currency: string, prices: readonly LabeledPrice[], other?: Other< "sendInvoice", | "chat_id" | "title" | "description" | "payload" | "provider_token" | "currency" | "prices" >, signal?: AbortSignal, ) { return this.api.sendInvoice( orThrow(this.chat, "sendInvoice").id, title, description, payload, provider_token, currency, prices, other, signal, ); } /** * Context-aware alias for `api.answerShippingQuery`. If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned. * * @param shipping_query_id Unique identifier for the query to be answered * @param ok Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#answershippingquery */ answerShippingQuery( ok: boolean, other?: Other<"answerShippingQuery", "shipping_query_id" | "ok">, signal?: AbortSignal, ) { return this.api.answerShippingQuery( orThrow(this.shippingQuery, "answerShippingQuery").id, ok, other, signal, ); } /** * Context-aware alias for `api.answerPreCheckoutQuery`. Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. * * @param ok Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#answerprecheckoutquery */ answerPreCheckoutQuery( ok: boolean, other?: | string | Other<"answerPreCheckoutQuery", "pre_checkout_query_id" | "ok">, signal?: AbortSignal, ) { return this.api.answerPreCheckoutQuery( orThrow(this.preCheckoutQuery, "answerPreCheckoutQuery").id, ok, typeof other === "string" ? { error_message: other } : other, signal, ); } /** * Context-aware alias for `api.setPassportDataErrors`. Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. * * Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. * * @param errors An array describing the errors * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#setpassportdataerrors */ setPassportDataErrors( errors: readonly PassportElementError[], signal?: AbortSignal, ) { return this.api.setPassportDataErrors( orThrow(this.from, "setPassportDataErrors").id, errors, signal, ); } /** * Context-aware alias for `api.sendGame`. Use this method to send a game. On success, the sent Message is returned. * * @param game_short_name Short name of the game, serves as the unique identifier for the game. Set up your games via BotFather. * @param other Optional remaining parameters, confer the official reference below * @param signal Optional `AbortSignal` to cancel the request * * **Official reference:** https://core.telegram.org/bots/api#sendgame */ replyWithGame( game_short_name: string, other?: Other<"sendGame", "chat_id" | "game_short_name">, signal?: AbortSignal, ) { return this.api.sendGame( orThrow(this.chat, "sendGame").id, game_short_name, { business_connection_id: this.businessConnectionId, ...other }, signal, ); }}
// === Filtered context typestype HearsContextCore = & FilterCore<":text" | ":caption"> & NarrowMatchCore<string | RegExpMatchArray>;/** * Type of the context object that is available inside the handlers for * `bot.hears`. * * This helper type can be used to narrow down context objects the same way how * `bot.hears` does it. This allows you to annotate context objects in * middleware that is not directly passed to `bot.hears`, hence not inferring * the correct type automatically. That way, handlers can be defined in separate * files and still have the correct types. */export type HearsContext<C extends Context> = Filter< NarrowMatch<C, string | RegExpMatchArray>, ":text" | ":caption">;type CommandContextCore = & FilterCore<":entities:bot_command"> & NarrowMatchCore<string>;/** * Type of the context object that is available inside the handlers for * `bot.command`. * * This helper type can be used to narrow down context objects the same way how * `bot.command` does it. This allows you to annotate context objects in * middleware that is not directly passed to `bot.command`, hence not inferring * the correct type automatically. That way, handlers can be defined in separate * files and still have the correct types. */export type CommandContext<C extends Context> = Filter< NarrowMatch<C, string>, ":entities:bot_command">;type NarrowMatchCore<T extends Context["match"]> = { match: T };type NarrowMatch<C extends Context, T extends C["match"]> = { [K in keyof C]: K extends "match" ? (T extends C[K] ? T : never) : C[K];};
type CallbackQueryContextCore = FilterCore<"callback_query:data">;/** * Type of the context object that is available inside the handlers for * `bot.callbackQuery`. * * This helper type can be used to annotate narrow down context objects the same * way `bot.callbackQuery` does it. This allows you to how context objects in * middleware that is not directly passed to `bot.callbackQuery`, hence not * inferring the correct type automatically. That way, handlers can be defined * in separate files and still have the correct types. */export type CallbackQueryContext<C extends Context> = Filter< NarrowMatch<C, string | RegExpMatchArray>, "callback_query:data">;type GameQueryContextCore = FilterCore<"callback_query:game_short_name">;/** * Type of the context object that is available inside the handlers for * `bot.gameQuery`. * * This helper type can be used to narrow down context objects the same way how * `bot.gameQuery` does it. This allows you to annotate context objects in * middleware that is not directly passed to `bot.gameQuery`, hence not * inferring the correct type automatically. That way, handlers can be defined * in separate files and still have the correct types. */export type GameQueryContext<C extends Context> = Filter< C, "callback_query:game_short_name">;type InlineQueryContextCore = FilterCore<"inline_query">;/** * Type of the context object that is available inside the handlers for * `bot.inlineQuery`. * * This helper type can be used to narrow down context objects the same way how * annotate `bot.inlineQuery` does it. This allows you to context objects in * middleware that is not directly passed to `bot.inlineQuery`, hence not * inferring the correct type automatically. That way, handlers can be defined * in separate files and still have the correct types. */export type InlineQueryContext<C extends Context> = Filter<C, "inline_query">;
type ReactionContextCore = FilterCore<"message_reaction">;/** * Type of the context object that is available inside the handlers for * `bot.reaction`. * * This helper type can be used to narrow down context objects the same way how * annotate `bot.reaction` does it. This allows you to context objects in * middleware that is not directly passed to `bot.reaction`, hence not inferring * the correct type automatically. That way, handlers can be defined in separate * files and still have the correct types. */export type ReactionContext<C extends Context> = Filter<C, "message_reaction">;
type ChosenInlineResultContextCore = FilterCore<"chosen_inline_result">;/** * Type of the context object that is available inside the handlers for * `bot.chosenInlineResult`. * * This helper type can be used to narrow down context objects the same way how * annotate `bot.chosenInlineResult` does it. This allows you to context objects in * middleware that is not directly passed to `bot.chosenInlineResult`, hence not * inferring the correct type automatically. That way, handlers can be defined * in separate files and still have the correct types. */export type ChosenInlineResultContext<C extends Context> = Filter< C, "chosen_inline_result">;type ChatTypeContextCore<T extends Chat["type"]> = & Record<"update", ChatTypeUpdate<T>> // ctx.update & ChatType<T> // ctx.chat & ChatFrom<T> // ctx.from & ChatTypeRecord<"msg", T> // ctx.msg & AliasProps<ChatTypeUpdate<T>>; // ctx.message etc/** * Type of the context object that is available inside the handlers for * `bot.chatType`. * * This helper type can be used to narrow down context objects the same way how * `bot.chatType` does it. This allows you to annotate context objects in * middleware that is not directly passed to `bot.chatType`, hence not inferring * the correct type automatically. That way, handlers can be defined in separate * files and still have the correct types. */export type ChatTypeContext<C extends Context, T extends Chat["type"]> = & C & ChatTypeContextCore<T>;type ChatTypeUpdate<T extends Chat["type"]> = & ChatTypeRecord< | "message" | "edited_message" | "channel_post" | "edited_channel_post" | "my_chat_member" | "chat_member" | "chat_join_request", T > & Partial<Record<"callback_query", ChatTypeRecord<"message", T>>> & ConstrainUpdatesByChatType<T>;type ConstrainUpdatesByChatType<T extends Chat["type"]> = Record< [T] extends ["channel"] ? "message" | "edited_message" : "channel_post" | "edited_channel_post", undefined>;type ChatTypeRecord<K extends string, T extends Chat["type"]> = Partial< Record<K, ChatType<T>>>;interface ChatType<T extends Chat["type"]> { chat: { type: T };}interface ChatFrom<T extends Chat["type"]> { // deno-lint-ignore ban-types from: [T] extends ["private"] ? {} : unknown;}
// === Util functionsfunction orThrow<T>(value: T | undefined, method: string): T { if (value === undefined) { throw new Error(`Missing information for API call to ${method}`); } return value;}
function triggerFn(trigger: MaybeArray<string | RegExp>) { return toArray(trigger).map((t) => typeof t === "string" ? (txt: string) => (txt === t ? t : null) : (txt: string) => txt.match(t) );}
function match<C extends Context>( ctx: C, content: string, triggers: Array<(content: string) => string | RegExpMatchArray | null>,): boolean { for (const t of triggers) { const res = t(content); if (res) { ctx.match = res; return true; } } return false;}function toArray<E>(e: MaybeArray<E>): E[] { return Array.isArray(e) ? e : [e];}
grammy
Version Info
a month ago
