Optionaloptions:Partial<Options<C>>OptionalOverridesComposer.constructor
OptionalbotSet manually to avoid implicitgetMe call inlaunch orwebhookCallback
PrivateOptionalbotReadonlycontextPrivateReadonlyoptionsPrivateOptionalpollingAssign to this to customise the webhook filter middleware.{ path, secretToken } will be bound to this rather than the Telegraf instance.Remember to assign a regular function and not an arrow function so it's bindable.
Use path instead
OptionalsecretPrivateOptionalwebhookStaticmountGenerates middleware for handling provided update types.
Rest...fns:NonemptyReadonlyArray<Middleware<FilteredContext<Ctx,Filter>>>RestuseComposer.on instead
Generates middleware for handling provided update types.
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<Ctx,MountMap[Filter]>,MountMap[Filter]>>RestuseComposer.on instead
Privatetokenusectx.telegram.webhookReply
usectx.telegram.webhookReply
Registers middleware for handling matching callback queries.
Rest...fns:MatchedMiddleware<C,"callback_query">RestRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.cashtag
Override error handling
Registers middleware for handling specified commands.
Rest...fns:NonemptyReadonlyArray<Middleware<Context<{RestInherited fromComposer.command
Specify a url to receive incoming updates via webhook.Returns an Express-style middleware you can pass to app.use()
Registers middleware for dropping matching updates.
Rest...fns:MatchedMiddleware<C,"channel_post" |"message">RestuseComposer::drop
Registers middleware for handling game queries
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<C,CallbackQueryUpdate<GameQuery>>>>RestInherited fromComposer.gameQuery
PrivategetOptionalpath?:stringRegisters middleware for handling updatesmatching given type guard function.
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<C,U>,U>>RestuseComposer::on
PrivatehandleOptionalwebhookResponse:ServerResponse<IncomingMessage>OptionalRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.hashtag
Registers middleware for handling matching text messages.
Rest...fns:MatchedMiddleware<C,"text">RestRegisters a middleware for handling /help
Rest...fns:NonemptyReadonlyArray<Middleware<Context<{RestRegisters middleware for handling matching inline queries.
Rest...fns:MatchedMiddleware<C,"inline_query">RestInherited fromComposer.inlineQuery
OptionalonLaunch:(() =>void)OptionalOptionalonLaunch:(() =>void)OptionalRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.mention
Registers middleware for handling updates narrowed by update types or filter queries.
Rest...fns:NonemptyReadonlyArray<Middleware<FilteredContext<C,Filter>>>RestRegisters middleware for handling updates narrowed by update types or message subtypes.
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<C,MountMap[Filter]>,MountMap[Filter]>>RestUse filter utils instead. Support for Message subtype inComposer::on will be removed in Telegraf v5.
Rest...fns:MatchedMiddleware<C,"channel_post" |"message">RestRest...fns:NonemptyReadonlyArray<Middleware<Context<MessageReactionUpdate> &Omit<C,keyofContext<Update>> &{RestInherited fromComposer.reaction
Registers a middleware for handling /settings
Rest...fns:NonemptyReadonlyArray<Middleware<Context<{RestInherited fromComposer.settings
Rest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.spoiler
Registers a middleware for handling /start
Rest...fns:NonemptyReadonlyArray<Middleware<Context<{RestPrivatestartPrivatestartOptionaltlsOptions:TlsOptionsOptionalOptionalport:numberOptionalOptionalhost:stringOptionalOptionalcb:RequestListener<typeofIncomingMessage,typeofServerResponse>OptionalOptionalsecretToken:stringOptionalRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.textLink
Rest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.textMention
Rest...fns:MatchedMiddleware<C,"channel_post" |"message">RestRegisters a middleware.
Rest...fns:readonlyMiddleware<C>[]RestYou must callbot.telegram.setWebhook for this to work.You should probably useTelegraf.createWebhook instead.
OptionalsecretStaticaclGenerates middleware responding only to specified users.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestStaticactionGenerates middleware for handling matching callback queries.
Rest...fns:MatchedMiddleware<C,"callback_query">RestStaticadminGenerates middleware responding only to chat admins and chat creator.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestStaticbranchmiddleware to run if the predicate returns true
middleware to run if the predicate returns false
StaticcashtagRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.cashtag
StaticcatchRest...fns:readonlyMiddleware<C>[]RestStaticchatGenerates middleware running only in specified chat types.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestInherited fromComposer.chatType
StaticcommandGenerates middleware for handling specified commands.
Rest...fns:NonemptyReadonlyArray<Middleware<Context<{RestInherited fromComposer.command
StaticcomposeInherited fromComposer.compose
StaticcreatorGenerates middleware responding only to chat creator.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestInherited fromComposer.creator
StaticdispatchInherited fromComposer.dispatch
StaticdropGenerates middleware for dropping matching updates.
StaticemailRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestStaticentityRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.entityText
StaticfilteruseComposer.drop
StaticforkGenerates middleware that runs in the background.
StaticgameGenerates middleware for handling game queries.
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<C,CallbackQueryUpdate<GameQuery>>>>RestInherited fromComposer.gameQuery
StaticgroupGenerates middleware running only in groups and supergroups.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestInherited fromComposer.groupChat
StaticguardGenerates optional middleware based on a predicate that only operates onctx.update.
Example:
import {Composer,Update }from'telegraf'
constpredicate = (u):uisUpdate.MessageUpdate=>'message'inu
constmiddleware =Composer.guard(predicate, (ctx)=> {
constmessage =ctx.update.message
})Note thatComposer.on('message') is preferred over this.
predicate to decide whether to run the middleware based on thectx.update object
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<C,U>,U>>middleware to run if the predicate returns true
RestComposer.optional for a more generic version of this method that allows the predicate to operate onctx itself
useComposer.on
StatichashtagRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.hashtag
StatichearsGenerates middleware for handling matching text messages.
Rest...fns:MatchedMiddleware<C,"text">RestStaticinlineGenerates middleware for handling matching inline queries.
Rest...fns:MatchedMiddleware<C,"inline_query">RestInherited fromComposer.inlineQuery
StaticlazyStaticlogStaticmentionRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.mention
StaticonGenerates middleware for handling updates narrowed by update types or filter queries.
Rest...fns:NonemptyReadonlyArray<Middleware<FilteredContext<Ctx,Filter>>>RestGenerates middleware for handling updates narrowed by update types or message subtype.
Rest...fns:NonemptyReadonlyArray<Middleware<NarrowedContext<Ctx,MountMap[Filter]>,MountMap[Filter]>>RestUse filter utils instead. Support for Message subtype inComposer.on will be removed in Telegraf v5.
StaticoptionalGenerates optional middleware.
predicate to decide on a context object whether to run the middleware
Rest...fns:NonemptyReadonlyArray<Middleware<C>>middleware to run if the predicate returns true
RestInherited fromComposer.optional
StaticpassGenerates middleware that gives up control to the next middleware.
Inherited fromComposer.passThru
StaticphoneRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestStaticprivateGenerates middleware running only in private chats.
Rest...fns:NonemptyReadonlyArray<Middleware<C>>RestInherited fromComposer.privateChat
StaticreactionRest...fns:NonemptyReadonlyArray<Middleware<Context<MessageReactionUpdate> &Omit<C,keyofContext<Update>> &{RestInherited fromComposer.reaction
StaticreplyRest...args:[text:string |FmtString<string>,extra?:Omit<{},"text" |"chat_id">]RestStaticspoilerRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.spoiler
StatictapStatictextRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.textLink
StatictextRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestInherited fromComposer.textMention
StaticunwrapStaticurlRest...fns:MatchedMiddleware<C,"channel_post" |"message">RestGenerated usingTypeDoc