Skip to content

Commit 4601eed

Browse files
authored
Show status_updates in docs (python-telegram-bot#798)
* Show status_updates in docs * Show status_updates in docs
1 parent 6cd0c14 commit 4601eed

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

telegram/ext/filters.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,33 @@ def filter(self, message):
353353
self.migrate(message) or self.pinned_message(message))
354354

355355
status_update = _StatusUpdate()
356+
"""Subset for messages containing a status update.
357+
358+
Examples:
359+
Use these filters like: ``Filters.status_update.new_chat_member`` etc. Or use just
360+
``Filters.status_update`` for all status update messages.
361+
362+
Attributes:
363+
chat_created (:obj:`Filter`): Messages that contain
364+
:attr:`telegram.Message.group_chat_created`,
365+
:attr:`telegram.Message.supergroup_chat_created` or
366+
:attr:`telegram.Message.channel_chat_created`.
367+
delete_chat_photo (:obj:`Filter`): Messages that contain
368+
:attr:`telegram.Message.delete_chat_photo`.
369+
left_chat_member (:obj:`Filter`): Messages that contain
370+
:attr:`telegram.Message.left_chat_member`.
371+
migrate (:obj:`Filter`): Messages that contain
372+
:attr:`telegram.Message.migrate_from_chat_id` or
373+
:attr: `telegram.Message.migrate_from_chat_id`.
374+
new_chat_members (:obj:`Filter`): Messages that contain
375+
:attr:`telegram.Message.new_chat_member`.
376+
new_chat_photo (:obj:`Filter`): Messages that contain
377+
:attr:`telegram.Message.new_chat_photo`.
378+
new_chat_title (:obj:`Filter`): Messages that contain
379+
:attr:`telegram.Message.new_chat_title`.
380+
pinned_message (:obj:`Filter`): Messages that contain
381+
:attr:`telegram.Message.pinned_message`.
382+
"""
356383

357384
class _Forwarded(BaseFilter):
358385
name = 'Filters.forwarded'

0 commit comments

Comments
 (0)