Events Reference
Here you will find a quick summary of all the methods and properties that you can access when working with events.
You can access the client that creates this event by doing
event.client
, and you should view the description of the
events to find out what arguments it allows on creation and
its attributes (the properties will be shown here).
Important
Remember that all events base ChatGetter
! Please see FAQ
if you don’t know what this means or the implications of it.
NewMessage
Occurs whenever a new text message or a message with media arrives.
Note
The new message event should be treated as a
normal Message
, with
the following exceptions:
pattern_match
is the match object returned bypattern=
.message
is not the message string. It’s theMessage
object.
Remember, this event is just a proxy over the message, so while you won’t see its attributes and properties, you can still access them. Please see the full documentation for examples.
Full documentation for the NewMessage
.
MessageEdited
Occurs whenever a message is edited. Just like NewMessage
, you should treat
this event as a Message
.
Full documentation for the MessageEdited
.
MessageDeleted
Occurs whenever a message is deleted. Note that this event isn’t 100% reliable, since Telegram doesn’t always notify the clients that a message was deleted.
It only has the deleted_id
and deleted_ids
attributes
(in addition to the chat if the deletion happened in a channel).
Full documentation for the MessageDeleted
.
MessageRead
Occurs whenever one or more messages are read in a chat.
Full documentation for the MessageRead
.
ChatAction
Occurs on certain chat actions, such as chat title changes, user join or leaves, pinned messages, photo changes, etc.
Full documentation for the ChatAction
.
UserUpdate
Occurs whenever a user goes online, starts typing, etc.
Full documentation for the UserUpdate
.
The typing module: Support for gradual typing as defined by PEP 484 and subsequent PEPs. |
CallbackQuery
Occurs whenever you sign in as a bot and a user clicks one of the inline buttons on your messages.
Full documentation for the CallbackQuery
.
InlineQuery
Occurs whenever you sign in as a bot and a user
sends an inline query such as @bot query
.
Full documentation for the InlineQuery
.
Album
Occurs whenever you receive an entire album.
Full documentation for the Album
.
Raw
Raw events are not actual events. Instead, they are the raw Update object that Telegram sends. You normally shouldn’t need these.