telegram.ChatPermissions¶
- class telegram.ChatPermissions(*args, **kwargs)[source]¶
Bases:
telegram.TelegramObject
Describes actions that a non-administrator user is allowed to take in a chat.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
can_send_messages
,can_send_media_messages
,can_send_polls
,can_send_other_messages
,can_add_web_page_previews
,can_change_info
,can_invite_users
andcan_pin_messages
are equal.Note
Though not stated explicitly in the official docs, Telegram changes not only the permissions that are set, but also sets all the others to
False
. However, since not documented, this behaviour may change unbeknown to PTB.- Parameters
can_send_messages (
bool
, optional) –True
, if the user is allowed to send text messages, contacts, locations and venues.can_send_media_messages (
bool
, optional) –True
, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, impliescan_send_messages
.can_send_polls (
bool
, optional) –True
, if the user is allowed to send polls, impliescan_send_messages
.can_send_other_messages (
bool
, optional) –True
, if the user is allowed to send animations, games, stickers and use inline bots, impliescan_send_media_messages
.can_add_web_page_previews (
bool
, optional) –True
, if the user is allowed to add web page previews to their messages, impliescan_send_media_messages
.can_change_info (
bool
, optional) –True
, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.can_invite_users (
bool
, optional) –True
, if the user is allowed to invite new users to the chat.can_pin_messages (
bool
, optional) –True
, if the user is allowed to pin messages. Ignored in public supergroups.
- can_send_messages[source]¶
Optional.
True
, if the user is allowed to send text messages, contacts, locations and venues.- Type
- can_send_media_messages[source]¶
Optional.
True
, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, impliescan_send_messages
.- Type
- can_send_polls[source]¶
Optional.
True
, if the user is allowed to send polls, impliescan_send_messages
.- Type
- can_send_other_messages[source]¶
Optional.
True
, if the user is allowed to send animations, games, stickers and use inline bots, impliescan_send_media_messages
.- Type
- can_add_web_page_previews[source]¶
Optional.
True
, if the user is allowed to add web page previews to their messages, impliescan_send_media_messages
.- Type
- can_change_info[source]¶
Optional.
True
, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.- Type
- can_invite_users[source]¶
Optional.
True
, if the user is allowed to invite new users to the chat.- Type
- can_pin_messages[source]¶
Optional.
True
, if the user is allowed to pin messages. Ignored in public supergroups.- Type
- classmethod all_permissions()[source]¶
This method returns an
ChatPermissions
instance with all attributes set toTrue
. This is e.g. useful when unrestricting a chat member withtelegram.Bot.restrict_chat_member()
.New in version 20.0.
- classmethod no_permissions()[source]¶
This method returns an
ChatPermissions
instance with all attributes set toFalse
.New in version 20.0.