Skip to main content
Module

x/grammy_types/update.ts>Update

Type declarations of the Telegram Bot API.
Very Popular
Go to Latest
namespace Update
import { Update } from "https://deno.land/x/grammy_types@v3.5.2/update.ts";

Internal namespace used to make some message types more accurate

Interfaces

Internal type holding properties that message updates in channels share.

Internal type holding properties that updates about edited messages share.

Internal type holding properties that message updates outside of channels share.

interface Update
import { type Update } from "https://deno.land/x/grammy_types@v3.5.2/update.ts";

This object represents an incoming update. At most one of the optional parameters can be present in any given update.

Properties

update_id: number

The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

optional
message: Message & Update.NonChannel

New incoming message of any kind - text, photo, sticker, etc.

optional
edited_message: Message & Update.Edited & Update.NonChannel

New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.

optional
channel_post: Message & Update.Channel

New incoming channel post of any kind - text, photo, sticker, etc.

optional
edited_channel_post: Message & Update.Edited & Update.Channel

New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.

optional
message_reaction: MessageReactionUpdated

A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.

optional
message_reaction_count: MessageReactionCountUpdated

Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.

optional
inline_query: InlineQuery

New incoming inline query

optional
chosen_inline_result: ChosenInlineResult

The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.

optional
callback_query: CallbackQuery

New incoming callback query

optional
shipping_query: ShippingQuery

New incoming shipping query. Only for invoices with flexible price

optional
pre_checkout_query: PreCheckoutQuery

New incoming pre-checkout query. Contains full information about checkout

optional
poll: Poll

New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot

optional
poll_answer: PollAnswer

A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.

optional
my_chat_member: ChatMemberUpdated

The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.

optional
chat_member: ChatMemberUpdated

A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.

optional
chat_join_request: ChatJoinRequest

A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.

optional
chat_boost: ChatBoostUpdated

A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.

optional
removed_chat_boost: ChatBoostRemoved

A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.