telegram.ext.ChatMemberHandler¶
-
class
telegram.ext.
ChatMemberHandler
(callback, chat_member_types=- 1, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False, run_async=False)¶ Bases:
telegram.ext.handler.Handler
[telegram.update.Update
,telegram.ext.utils.types.CCT
]Handler class to handle Telegram updates that contain a chat member update.
New in version 13.4.
Note
pass_user_data
andpass_chat_data
determine whether adict
you can use to keep any data in will be sent to thecallback
function. Related to either the user or the chat that the update was sent in. For each update from the same user or in the same chat, it will be the samedict
.Note that this is DEPRECATED, and you should use context based callbacks. See https://github.com/python-telegram-bot/python-telegram-bot/wiki /Transition-guide-to-Version-12.0 for more info.
Warning
When setting
run_async
toTrue
, you cannot rely on adding custom attributes totelegram.ext.CallbackContext
. See its docs for more info.- Parameters
callback (
callable
) –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 for context based API: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 ofMY_CHAT_MEMBER
,CHAT_MEMBER
orANY_CHAT_MEMBER
to specify if this handler should handle only updates withtelegram.Update.my_chat_member
,telegram.Update.chat_member
or both. Defaults toMY_CHAT_MEMBER
.pass_update_queue (
bool
, optional) – If set toTrue
, a keyword argument calledupdate_queue
will be passed to the callback function. It will be theQueue
instance used by thetelegram.ext.Updater
andtelegram.ext.Dispatcher
that contains new updates which can be used to insert updates. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_job_queue (
bool
, optional) – If set toTrue
, a keyword argument calledjob_queue
will be passed to the callback function. It will be atelegram.ext.JobQueue
instance created by thetelegram.ext.Updater
which can be used to schedule new jobs. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_user_data (
bool
, optional) – If set toTrue
, a keyword argument calleduser_data
will be passed to the callback function. Default isFalse
. DEPRECATED: Please switch to context based callbacks.pass_chat_data (
bool
, optional) – If set toTrue
, a keyword argument calledchat_data
will be passed to the callback function. Default isFalse
. DEPRECATED: Please switch to context based callbacks.run_async (
bool
) – Determines whether the callback will run asynchronously. Defaults toFalse
.
-
callback
¶ The callback function for this handler.
- Type
callable
-
chat_member_types
¶ Specifies if this handler should handle only updates with
telegram.Update.my_chat_member
,telegram.Update.chat_member
or both.- Type
int
, optional
-
pass_update_queue
¶ Determines whether
update_queue
will be passed to the callback function.- Type
bool
-
pass_job_queue
¶ Determines whether
job_queue
will be passed to the callback function.- Type
bool
-
pass_user_data
¶ Determines whether
user_data
will be passed to the callback function.- Type
bool
-
pass_chat_data
¶ Determines whether
chat_data
will be passed to the callback function.- Type
bool
-
run_async
¶ Determines whether the callback will run asynchronously.
- Type
bool
-
ANY_CHAT_MEMBER
: ClassVar[int] = 1¶ Used as a constant to handle bot
telegram.Update.my_chat_member
andtelegram.Update.chat_member
.- Type
int
-
CHAT_MEMBER
: ClassVar[int] = 0¶ Used as a constant to handle only
telegram.Update.chat_member
.- Type
int
-
MY_CHAT_MEMBER
: ClassVar[int] = -1¶ Used as a constant to handle only
telegram.Update.my_chat_member
.- Type
int
-
check_update
(update)¶ Determines whether an update should be passed to this handlers
callback
.- Parameters
update (
telegram.Update
|object
) – Incoming update.- Returns
bool