telegram.ext.ChatMemberHandler#

class telegram.ext.ChatMemberHandler(callback, chat_member_types=- 1, block=True)[source]#

Handler class to handle Telegram updates that contain a chat member update.

New in version 13.4.

Warning

When setting block to False, you cannot rely on adding custom attributes to telegram.ext.CallbackContext. See its docs for more info.

Parameters

callback (coroutine function) –
The callback function for this handler. Will be called when check_update() has determined that an update should be processed by this handler. Callback signature:
```
async def callback(update: Update, context: CallbackContext)
```
The return value of the callback is usually ignored except for the special case of telegram.ext.ConversationHandler.
chat_member_types (int, optional) – Pass one of MY_CHAT_MEMBER, CHAT_MEMBER or ANY_CHAT_MEMBER to specify if this handler should handle only updates with telegram.Update.my_chat_member, telegram.Update.chat_member or both. Defaults to MY_CHAT_MEMBER.
block (bool, optional) – Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update(). Defaults to True.

The callback function for this handler.

chat_member_types[source]#

Specifies if this handler should handle only updates with telegram.Update.my_chat_member, telegram.Update.chat_member or both.

Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update().

ANY_CHAT_MEMBER = 1[source]#

CHAT_MEMBER = 0[source]#

Used as a constant to handle only telegram.Update.chat_member.

MY_CHAT_MEMBER = -1[source]#

Used as a constant to handle only telegram.Update.my_chat_member.

check_update(update)[source]#

Determines whether an update should be passed to this handler’s callback.