ChatPermissions¶
- class telegram.ChatPermissions(can_send_messages=None, can_send_media_messages=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, can_manage_topics=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, *, api_kwargs=None)[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
,can_pin_messages
, andcan_manage_topics
are equal.Available In
Changed in version 20.0:
can_manage_topics
is considered as well when comparing objects of this type in terms of equality.Deprecated since version 20.1:
can_send_audios
,can_send_documents
,can_send_photos
,can_send_videos
,can_send_video_notes
andcan_send_voice_notes
will be considered as well when comparing objects of this type in terms of equality in V21.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 behavior 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
.Deprecated since version 20.1: Bot API 6.5 replaced this argument with granular media settings.
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_manage_topics (
bool
, optional) –True
, if the user is allowed to create forum topics. If omitted defaults to the value ofcan_pin_messages
.New in version 20.0.
can_send_audios (
bool
) –True
, if the user is allowed to send audios.New in version 20.1.
True
, if the user is allowed to send documents.New in version 20.1.
can_send_photos (
bool
) –True
, if the user is allowed to send photos.New in version 20.1.
can_send_videos (
bool
) –True
, if the user is allowed to send videos.New in version 20.1.
True
, if the user is allowed to send video notes.New in version 20.1.
True
, if the user is allowed to send voice notes.New in version 20.1.
- 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
.Deprecated since version 20.1: Bot API 6.5 replaced this attribute with granular media settings.
- 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:
- can_manage_topics[source]¶
Optional.
True
, if the user is allowed to create forum topics. If omitted defaults to the value ofcan_pin_messages
.New in version 20.0.
- Type:
- can_send_documents[source]¶
True
, if the user is allowed to send documents.New in version 20.1.
- Type:
- can_send_video_notes[source]¶
True
, if the user is allowed to send video notes.New in version 20.1.
- Type:
- can_send_voice_notes[source]¶
True
, if the user is allowed to send voice notes.New in version 20.1.
- 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.