Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

Index

Properties

Accessors

Methods

Properties

botInfo: UserFromGetMe
session: SceneSession<D>
state: Record<string | symbol, any> = {}
telegram: Telegram
update: Update

Accessors

  • get callbackQuery(): PropOr<U, "callback_query", undefined>
  • Returns PropOr<U, "callback_query", undefined>

  • get channelPost(): PropOr<U, "channel_post", undefined>
  • Returns PropOr<U, "channel_post", undefined>

  • get chat(): PropOr<GetUpdateContent<U>, "chat", undefined>
  • Returns PropOr<GetUpdateContent<U>, "chat", undefined>

  • get chatJoinRequest(): undefined | ChatJoinRequest
  • Returns undefined | ChatJoinRequest

  • get chatMember(): PropOr<U, "chat_member", undefined>
  • Returns PropOr<U, "chat_member", undefined>

  • get chosenInlineResult(): PropOr<U, "chosen_inline_result", undefined>
  • Returns PropOr<U, "chosen_inline_result", undefined>

  • get editedChannelPost(): PropOr<U, "edited_channel_post", undefined>
  • Returns PropOr<U, "edited_channel_post", undefined>

  • get editedMessage(): PropOr<U, "edited_message", undefined>
  • Returns PropOr<U, "edited_message", undefined>

  • get from(): PropOr<GetUpdateContent<U>, "from", undefined>
  • Returns PropOr<GetUpdateContent<U>, "from", undefined>

  • get inlineMessageId(): undefined | string
  • Returns undefined | string

  • get inlineQuery(): PropOr<U, "inline_query", undefined>
  • Returns PropOr<U, "inline_query", undefined>

  • get kickChatMember(): (...args: [userId: number, untilDate?: number, extra?: ExtraBanChatMember]) => Promise<true>
  • get me(): string
  • get message(): PropOr<U, "message", undefined>
  • Returns PropOr<U, "message", undefined>

  • get myChatMember(): PropOr<U, "my_chat_member", undefined>
  • Returns PropOr<U, "my_chat_member", undefined>

  • get passportData(): undefined | PassportData
  • Returns undefined | PassportData

  • get poll(): PropOr<U, "poll", undefined>
  • Returns PropOr<U, "poll", undefined>

  • get pollAnswer(): PropOr<U, "poll_answer", undefined>
  • Returns PropOr<U, "poll_answer", undefined>

  • get preCheckoutQuery(): PropOr<U, "pre_checkout_query", undefined>
  • Returns PropOr<U, "pre_checkout_query", undefined>

  • get senderChat(): PropOr<GetUpdateContent<U>, "sender_chat", undefined>
  • Returns PropOr<GetUpdateContent<U>, "sender_chat", undefined>

  • get shippingQuery(): PropOr<U, "shipping_query", undefined>
  • Returns PropOr<U, "shipping_query", undefined>

  • get updateType(): Extract<UnionKeys<U>, UpdateType>
  • get webAppData(): undefined | { button_text: string; data: { json: any; text: any } }
  • Returns undefined | { button_text: string; data: { json: any; text: any } }

  • get webhookReply(): boolean
  • set webhookReply(enable: boolean): void

Methods

  • answerGameQuery(...args: [url: string]): Promise<true>
  • answerInlineQuery(...args: [results: readonly InlineQueryResult[], extra?: ExtraAnswerInlineQuery]): Promise<true>
  • answerPreCheckoutQuery(...args: [ok: boolean, errorMessage?: string]): Promise<true>
  • answerShippingQuery(...args: [ok: boolean, shippingOptions: readonly ShippingOption[], errorMessage: string]): Promise<true>
  • approveChatJoinRequest(userId: number): Promise<true>
  • banChatMember(...args: [userId: number, untilDate?: number, extra?: ExtraBanChatMember]): Promise<true>
  • banChatSenderChat(senderChatId: number): Promise<true>
  • copyMessage(chatId: string | number, extra?: ExtraCopyMessage): Promise<MessageId>
  • declineChatJoinRequest(userId: number): Promise<true>
  • deleteChatPhoto(...args: []): Promise<true>
  • deleteChatStickerSet(): Promise<true>
  • deleteMessage(messageId?: number): Promise<true>
  • deleteStickerFromSet(sticker: string): Promise<true>
  • editMessageCaption(caption: undefined | string, extra?: ExtraEditMessageCaption): Promise<true | (Edited & CaptionableMessage)>
  • editMessageLiveLocation(latitude: number, longitude: number, extra?: ExtraEditMessageLiveLocation): Promise<true | (Edited & LocationMessage)>
  • editMessageMedia(media: {} | {} | {} | {} | {}, extra?: ExtraEditMessageMedia): Promise<true | (Edited & AnimationMessage) | (Edited & AudioMessage) | (Edited & DocumentMessage) | (Edited & PhotoMessage) | (Edited & VideoMessage)>
  • editMessageReplyMarkup(markup: undefined | InlineKeyboardMarkup): Promise<true | ((Edited & LocationMessage) & (Edited & TextMessage) & (Edited & AnimationMessage) & (Edited & AudioMessage) & (Edited & DocumentMessage) & (Edited & PhotoMessage) & (Edited & VideoMessage) & (Edited & ChannelChatCreatedMessage) & (Edited & ConnectedWebsiteMessage) & (Edited & DeleteChatPhotoMessage) & (Edited & GroupChatCreatedMessage) & (Edited & InvoiceMessage) & (Edited & LeftChatMemberMessage) & (Edited & MessageAutoDeleteTimerChangedMessage) & (Edited & MigrateFromChatIdMessage) & (Edited & MigrateToChatIdMessage) & (Edited & NewChatMembersMessage) & (Edited & NewChatPhotoMessage) & (Edited & NewChatTitleMessage) & (Edited & PassportDataMessage) & (Edited & ProximityAlertTriggeredMessage) & (Edited & PinnedMessageMessage) & (Edited & SuccessfulPaymentMessage) & (Edited & SupergroupChatCreated) & (Edited & VideoChatScheduledMessage) & (Edited & VideoChatStartedMessage) & (Edited & VideoChatEndedMessage) & (Edited & VideoChatParticipantsInvitedMessage) & (Edited & WebAppDataMessage) & (Edited & ContactMessage) & (Edited & DiceMessage) & (Edited & GameMessage) & (Edited & PollMessage) & (Edited & StickerMessage) & (Edited & VenueMessage) & (Edited & VideoNoteMessage) & (Edited & VoiceMessage))>
  • Parameters

    • markup: undefined | InlineKeyboardMarkup

    Returns Promise<true | ((Edited & LocationMessage) & (Edited & TextMessage) & (Edited & AnimationMessage) & (Edited & AudioMessage) & (Edited & DocumentMessage) & (Edited & PhotoMessage) & (Edited & VideoMessage) & (Edited & ChannelChatCreatedMessage) & (Edited & ConnectedWebsiteMessage) & (Edited & DeleteChatPhotoMessage) & (Edited & GroupChatCreatedMessage) & (Edited & InvoiceMessage) & (Edited & LeftChatMemberMessage) & (Edited & MessageAutoDeleteTimerChangedMessage) & (Edited & MigrateFromChatIdMessage) & (Edited & MigrateToChatIdMessage) & (Edited & NewChatMembersMessage) & (Edited & NewChatPhotoMessage) & (Edited & NewChatTitleMessage) & (Edited & PassportDataMessage) & (Edited & ProximityAlertTriggeredMessage) & (Edited & PinnedMessageMessage) & (Edited & SuccessfulPaymentMessage) & (Edited & SupergroupChatCreated) & (Edited & VideoChatScheduledMessage) & (Edited & VideoChatStartedMessage) & (Edited & VideoChatEndedMessage) & (Edited & VideoChatParticipantsInvitedMessage) & (Edited & WebAppDataMessage) & (Edited & ContactMessage) & (Edited & DiceMessage) & (Edited & GameMessage) & (Edited & PollMessage) & (Edited & StickerMessage) & (Edited & VenueMessage) & (Edited & VideoNoteMessage) & (Edited & VoiceMessage))>

  • exportChatInviteLink(...args: []): Promise<string>
  • forwardMessage(chatId: string | number, extra?: { disable_notification?: boolean }): Promise<Message>
  • getChat(...args: []): Promise<ChatFromGetChat>
  • getChatAdministrators(...args: []): Promise<ChatMember[]>
  • getChatMember(...args: [userId: number]): Promise<ChatMember>
  • getChatMembersCount(...args: []): Promise<number>
  • getChatMenuButton(): Promise<MenuButton>
  • getMyCommands(): Promise<BotCommand[]>
  • getMyDefaultAdministratorRights(extra?: { forChannels?: boolean }): Promise<ChatAdministratorRights>
  • getStickerSet(setName: string): Promise<StickerSet>
  • leaveChat(...args: []): Promise<true>
  • pinChatMessage(...args: [messageId: number, extra?: { disable_notification?: boolean }]): Promise<true>
  • replyWithAnimation(...args: [animation: string | InputFile, extra?: ExtraAnimation]): Promise<AnimationMessage>
  • replyWithAudio(...args: [audio: string | InputFile, extra?: ExtraAudio]): Promise<AudioMessage>
  • replyWithChatAction(...args: [action: "typing" | "upload_photo" | "record_video" | "upload_video" | "record_voice" | "upload_voice" | "upload_document" | "choose_sticker" | "find_location" | "record_video_note" | "upload_video_note"]): Promise<true>
  • replyWithContact(...args: [phoneNumber: string, firstName: string, extra?: ExtraContact]): Promise<ContactMessage>
  • replyWithDice(...args: [extra?: ExtraDice]): Promise<DiceMessage>
  • replyWithDocument(...args: [document: string | InputFile, extra?: ExtraDocument]): Promise<DocumentMessage>
  • replyWithGame(...args: [gameName: string, extra?: ExtraGame]): Promise<GameMessage>
  • replyWithLocation(...args: [latitude: number, longitude: number, extra?: ExtraLocation]): Promise<LocationMessage>
  • replyWithMarkdownV2(markdown: string, extra?: ExtraReplyMessage): Promise<TextMessage>
  • replyWithMediaGroup(...args: [media: readonly ({} | {})[] | readonly {}[] | readonly {}[], extra?: ExtraMediaGroup]): Promise<(DocumentMessage | AudioMessage | PhotoMessage | VideoMessage)[]>
  • replyWithPhoto(...args: [photo: string | InputFile, extra?: ExtraPhoto]): Promise<PhotoMessage>
  • replyWithPoll(...args: [question: string, options: readonly string[], extra?: ExtraPoll]): Promise<PollMessage>
  • replyWithQuiz(...args: [question: string, options: readonly string[], extra: ExtraPoll]): Promise<PollMessage>
  • replyWithSticker(...args: [sticker: string | InputFile, extra?: ExtraSticker]): Promise<StickerMessage>
  • replyWithVenue(...args: [latitude: number, longitude: number, title: string, address: string, extra?: ExtraVenue]): Promise<VenueMessage>
  • replyWithVideo(...args: [video: string | InputFile, extra?: ExtraVideo]): Promise<VideoMessage>
  • replyWithVideoNote(...args: [videoNote: string | InputFileVideoNote, extra?: ExtraVideoNote]): Promise<VideoNoteMessage>
  • replyWithVoice(...args: [voice: string | InputFile, extra?: ExtraVoice]): Promise<VoiceMessage>
  • revokeChatInviteLink(...args: [inviteLink: string]): Promise<ChatInviteLink>
  • setChatAdministratorCustomTitle(...args: [userId: number, title: string]): Promise<true>
  • setChatDescription(...args: [description?: string]): Promise<true>
  • setChatMenuButton(menuButton?: MenuButton): Promise<true>
  • setChatPermissions(...args: [permissions: ChatPermissions]): Promise<true>
  • setChatPhoto(...args: [photo: InputFile]): Promise<true>
  • setChatStickerSet(setName: string): Promise<true>
  • setChatTitle(...args: [title: string]): Promise<true>
  • setMyCommands(commands: readonly BotCommand[]): Promise<true>
  • setMyDefaultAdministratorRights(extra?: { forChannels?: boolean; rights?: ChatAdministratorRights }): Promise<true>
  • setPassportDataErrors(errors: readonly PassportElementError[]): Promise<true>
  • setStickerPositionInSet(sticker: string, position: number): Promise<true>
  • setStickerSetThumb(...args: [name: string, userId: number, thumb?: string | InputFile]): Promise<true>
  • stopMessageLiveLocation(markup?: InlineKeyboardMarkup): Promise<true | (Edited & LocationMessage)>
  • stopPoll(...args: [messageId: number, extra?: ExtraStopPoll]): Promise<Poll>
  • unbanChatMember(...args: [userId: number, extra?: { only_if_banned?: boolean }]): Promise<true>
  • unbanChatSenderChat(senderChatId: number): Promise<true>
  • unpinAllChatMessages(...args: []): Promise<true>
  • unpinChatMessage(...args: [messageId?: number]): Promise<true>
  • uploadStickerFile(...args: [stickerFile: InputFile]): Promise<File>

Generated using TypeDoc