#!/usr/bin/env python

# pylint: disable=redefined-builtin

#

# A library that provides a Python interface to the Telegram Bot API

# Copyright (C) 2015-2024

# Leandro Toledo de Souza <devs@python-telegram-bot.org>

#

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU Lesser Public License for more details.

#

# You should have received a copy of the GNU Lesser Public License

# along with this program. If not, see [http://www.gnu.org/licenses/].

"""This module contains an object that represents a Telegram Chat."""

from datetime import datetime

from html import escape

from typing import TYPE_CHECKING, Any, Final, Optional, Sequence, Tuple, Union

from telegram import constants

from telegram._birthdate import Birthdate

from telegram._chatlocation import ChatLocation

from telegram._chatpermissions import ChatPermissions

from telegram._files.chatphoto import ChatPhoto

from telegram._forumtopic import ForumTopic

from telegram._menubutton import MenuButton

from telegram._reaction import ReactionType

from telegram._telegramobject import TelegramObject

from telegram._utils import enum

from telegram._utils.argumentparsing import parse_sequence_arg

from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp

from telegram._utils.defaultvalue import DEFAULT_NONE

from telegram._utils.types import CorrectOptionID, FileInput, JSONDict, ODVInput, ReplyMarkup

from telegram._utils.warnings import warn

from telegram.helpers import escape_markdown

from telegram.helpers import mention_html as helpers_mention_html

from telegram.helpers import mention_markdown as helpers_mention_markdown

from telegram.warnings import PTBDeprecationWarning

if TYPE_CHECKING:

from telegram import (

Animation,

Audio,

Bot,

BusinessIntro,

BusinessLocation,

BusinessOpeningHours,

ChatInviteLink,

ChatMember,

Contact,

Document,

InlineKeyboardMarkup,

InputMediaAudio,

InputMediaDocument,

InputMediaPhoto,

InputMediaVideo,

InputPollOption,

LabeledPrice,

LinkPreviewOptions,

Location,

Message,

MessageEntity,

MessageId,

PhotoSize,

ReplyParameters,

Sticker,

UserChatBoosts,

Venue,

Video,

VideoNote,

Voice,

)

_deprecated_attrs = (

"accent_color_id",

"active_usernames",

"available_reactions",

"background_custom_emoji_id",

"bio",

"birthdate",

"business_intro",

"business_location",

"business_opening_hours",

"can_set_sticker_set",

"custom_emoji_sticker_set_name",

"description",

"emoji_status_custom_emoji_id",

"emoji_status_expiration_date",

"has_aggressive_anti_spam_enabled",

"has_hidden_members",

"has_private_forwards",

"has_protected_content",

"has_restricted_voice_and_video_messages",

"has_visible_history",

"invite_link",

"join_by_request",

"join_to_send_messages",

"linked_chat_id",

"location",

"message_auto_delete_time",

"permissions",

"personal_chat",

"photo",

"pinned_message",

"profile_accent_color_id",

"profile_background_custom_emoji_id",

"slow_mode_delay",

"sticker_set_name",

"unrestrict_boost_count",

)

class Chat(TelegramObject):

"""This object represents a chat.

Objects of this class are comparable in terms of equality. Two objects of this class are

considered equal, if their :attr:`id` is equal.

.. versionchanged:: 20.0

* Removed the deprecated methods ``kick_member`` and ``get_members_count``.

* The following are now keyword-only arguments in Bot methods:

``location``, ``filename``, ``contact``, ``{read, write, connect, pool}_timeout``,

``api_kwargs``. Use a named argument for those,

and notice that some positional arguments changed position as a result.

.. versionchanged:: 20.0

Removed the attribute ``all_members_are_administrators``. As long as Telegram provides

this field for backwards compatibility, it is available through

:attr:`~telegram.TelegramObject.api_kwargs`.

Args:

id (:obj:`int`): Unique identifier for this chat. This number may be greater than 32 bits

and some programming languages may have difficulty/silent defects in interpreting it.

But it is smaller than 52 bits, so a signed 64-bit integer or double-precision float

type are safe for storing this identifier.

type (:obj:`str`): Type of chat, can be either :attr:`PRIVATE`, :attr:`GROUP`,

:attr:`SUPERGROUP` or :attr:`CHANNEL`.

title (:obj:`str`, optional): Title, for supergroups, channels and group chats.

username (:obj:`str`, optional): Username, for private chats, supergroups and channels if

available.

first_name (:obj:`str`, optional): First name of the other party in a private chat.

last_name (:obj:`str`, optional): Last name of the other party in a private chat.

photo (:class:`telegram.ChatPhoto`, optional): Chat photo.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

bio (:obj:`str`, optional): Bio of the other party in a private chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_private_forwards (:obj:`bool`, optional): :obj:`True`, if privacy settings of the other

party in the private chat allows to use ``tg://user?id=<user_id>`` links only in chats

with the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.9

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

description (:obj:`str`, optional): Description, for groups, supergroups and channel chats.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

invite_link (:obj:`str`, optional): Primary invite link, for groups, supergroups and

channel. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

pinned_message (:class:`telegram.Message`, optional): The most recent pinned message

(by sending date). Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

permissions (:class:`telegram.ChatPermissions`): Optional. Default chat member permissions,

for groups and supergroups. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

slow_mode_delay (:obj:`int`, optional): For supergroups, the minimum allowed delay between

consecutive messages sent by each unprivileged user.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

message_auto_delete_time (:obj:`int`, optional): The time after which all messages sent to

the chat will be automatically deleted; in seconds. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.4

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_protected_content (:obj:`bool`, optional): :obj:`True`, if messages from the chat can't

be forwarded to other chats. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.9

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_visible_history (:obj:`bool`, optional): :obj:`True`, if new chat members will have

access to old messages; available only to chat administrators. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

sticker_set_name (:obj:`str`, optional): For supergroups, name of group sticker set.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

can_set_sticker_set (:obj:`bool`, optional): :obj:`True`, if the bot can change group the

sticker set. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

linked_chat_id (:obj:`int`, optional): Unique identifier for the linked chat, i.e. the

discussion group identifier for a channel and vice versa; for supergroups and channel

chats. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

location (:class:`telegram.ChatLocation`, optional): For supergroups, the location to which

the supergroup is connected. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

join_to_send_messages (:obj:`bool`, optional): :obj:`True`, if users need to join the

supergroup before they can send messages. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

join_by_request (:obj:`bool`, optional): :obj:`True`, if all users directly joining the

supergroup without using an invite link need to be approved by supergroup

administrators. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_restricted_voice_and_video_messages (:obj:`bool`, optional): :obj:`True`, if the

privacy settings of the other party restrict sending voice and video note messages

in the private chat. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

is_forum (:obj:`bool`, optional): :obj:`True`, if the supergroup chat is a forum

(has topics_ enabled).

.. versionadded:: 20.0

active_usernames (Sequence[:obj:`str`], optional): If set, the list of all `active chat

usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames\

#collectible-usernames>`_; for private chats, supergroups and channels. Returned

only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_intro (:class:`telegram.BusinessIntro`, optional): For private chats with

business accounts, the intro of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_location (:class:`telegram.BusinessLocation`, optional): For private chats with

business accounts, the location of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_opening_hours (:class:`telegram.BusinessOpeningHours`, optional): For private

chats with business accounts, the opening hours of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

available_reactions (Sequence[:class:`telegram.ReactionType`], optional): List of available

reactions allowed in the chat. If omitted, then all of

:const:`telegram.constants.ReactionEmoji` are allowed. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

accent_color_id (:obj:`int`, optional): Identifier of the

:class:`accent color <telegram.constants.AccentColor>` for the chat name and

backgrounds of the chat photo, reply header, and link preview. See `accent colors`_

for more details. Returned only in :meth:`telegram.Bot.get_chat`. Always returned in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

background_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of emoji chosen

by the chat for the reply header and link preview background. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

profile_accent_color_id (:obj:`int`, optional): Identifier of the

:class:`accent color <telegram.constants.ProfileAccentColor>` for the chat's profile

background. See profile `accent colors`_ for more details. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

profile_background_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of

the emoji chosen by the chat for its profile background. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

emoji_status_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of emoji

status of the chat or the other party in a private chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

emoji_status_expiration_date (:class:`datetime.datetime`, optional): Expiration date of

emoji status of the chat or the other party in a private chat, in seconds. Returned

only in :meth:`telegram.Bot.get_chat`.

|datetime_localization|

.. versionadded:: 20.5

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_aggressive_anti_spam_enabled (:obj:`bool`, optional): :obj:`True`, if aggressive

anti-spam checks are enabled in the supergroup. The field is only available to chat

administrators. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_hidden_members (:obj:`bool`, optional): :obj:`True`, if non-administrators can only

get the list of bots and administrators in the chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

unrestrict_boost_count (:obj:`int`, optional): For supergroups, the minimum number of

boosts that a non-administrator user needs to add in order to ignore slow mode and chat

permissions. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

custom_emoji_sticker_set_name (:obj:`str`, optional): For supergroups, the name of the

group's custom emoji sticker set. Custom emoji from this set can be used by all users

and bots in the group. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

birthdate (:obj:`telegram.Birthdate`, optional): For private chats,

the date of birth of the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

personal_chat (:obj:`telegram.Chat`, optional): For private chats, the personal channel of

the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

Attributes:

id (:obj:`int`): Unique identifier for this chat. This number may be greater than 32 bits

and some programming languages may have difficulty/silent defects in interpreting it.

But it is smaller than 52 bits, so a signed 64-bit integer or double-precision float

type are safe for storing this identifier.

type (:obj:`str`): Type of chat, can be either :attr:`PRIVATE`, :attr:`GROUP`,

:attr:`SUPERGROUP` or :attr:`CHANNEL`.

title (:obj:`str`): Optional. Title, for supergroups, channels and group chats.

username (:obj:`str`): Optional. Username, for private chats, supergroups and channels if

available.

first_name (:obj:`str`): Optional. First name of the other party in a private chat.

last_name (:obj:`str`): Optional. Last name of the other party in a private chat.

photo (:class:`telegram.ChatPhoto`): Optional. Chat photo.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

bio (:obj:`str`): Optional. Bio of the other party in a private chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_private_forwards (:obj:`bool`): Optional. :obj:`True`, if privacy settings of the other

party in the private chat allows to use ``tg://user?id=<user_id>`` links only in chats

with the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.9

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

description (:obj:`str`): Optional. Description, for groups, supergroups and channel chats.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

invite_link (:obj:`str`): Optional. Primary invite link, for groups, supergroups and

channel. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

pinned_message (:class:`telegram.Message`): Optional. The most recent pinned message

(by sending date). Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

permissions (:class:`telegram.ChatPermissions`): Optional. Default chat member permissions,

for groups and supergroups. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

slow_mode_delay (:obj:`int`): Optional. For supergroups, the minimum allowed delay between

consecutive messages sent by each unprivileged user. Returned only in

:meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

message_auto_delete_time (:obj:`int`): Optional. The time after which all messages sent to

the chat will be automatically deleted; in seconds. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.4

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_protected_content (:obj:`bool`): Optional. :obj:`True`, if messages from the chat can't

be forwarded to other chats. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 13.9

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_visible_history (:obj:`bool`): Optional. :obj:`True`, if new chat members will have

access to old messages; available only to chat administrators. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

sticker_set_name (:obj:`str`): Optional. For supergroups, name of Group sticker set.

Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

can_set_sticker_set (:obj:`bool`): Optional. :obj:`True`, if the bot can change group the

sticker set. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

linked_chat_id (:obj:`int`): Optional. Unique identifier for the linked chat, i.e. the

discussion group identifier for a channel and vice versa; for supergroups and channel

chats. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

location (:class:`telegram.ChatLocation`): Optional. For supergroups, the location to which

the supergroup is connected. Returned only in :meth:`telegram.Bot.get_chat`.

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

join_to_send_messages (:obj:`bool`): Optional. :obj:`True`, if users need to join

the supergroup before they can send messages. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

join_by_request (:obj:`bool`): Optional. :obj:`True`, if all users directly joining the

supergroup without using an invite link need to be approved by supergroup

administrators. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_restricted_voice_and_video_messages (:obj:`bool`): Optional. :obj:`True`, if the

privacy settings of the other party restrict sending voice and video note messages

in the private chat. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

is_forum (:obj:`bool`): Optional. :obj:`True`, if the supergroup chat is a forum

(has topics_ enabled).

.. versionadded:: 20.0

active_usernames (Tuple[:obj:`str`]): Optional. If set, the list of all `active chat

usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames\

#collectible-usernames>`_; for private chats, supergroups and channels. Returned

only in :meth:`telegram.Bot.get_chat`.

This list is empty if the chat has no active usernames or this chat instance was not

obtained via :meth:`~telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_intro (:class:`telegram.BusinessIntro`): Optional. For private chats with

business accounts, the intro of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_location (:class:`telegram.BusinessLocation`): Optional. For private chats with

business accounts, the location of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

business_opening_hours (:class:`telegram.BusinessOpeningHours`): Optional. For private

chats with business accounts, the opening hours of the business. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

available_reactions (Tuple[:class:`telegram.ReactionType`]): Optional. List of available

reactions allowed in the chat. If omitted, then all of

:const:`telegram.constants.ReactionEmoji` are allowed. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

accent_color_id (:obj:`int`): Optional. Identifier of the

:class:`accent color <telegram.constants.AccentColor>` for the chat name and

backgrounds of the chat photo, reply header, and link preview. See `accent colors`_

for more details. Returned only in :meth:`telegram.Bot.get_chat`. Always returned in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

background_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of emoji chosen

by the chat for the reply header and link preview background. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

profile_accent_color_id (:obj:`int`): Optional. Identifier of the

:class:`accent color <telegram.constants.ProfileAccentColor>` for the chat's profile

background. See profile `accent colors`_ for more details. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

profile_background_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of

the emoji chosen by the chat for its profile background. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.8

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

emoji_status_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of emoji

status of the chat or the other party in a private chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

emoji_status_expiration_date (:class:`datetime.datetime`): Optional. Expiration date of

emoji status of the chat or the other party in a private chat, in seconds. Returned

only in :meth:`telegram.Bot.get_chat`.

|datetime_localization|

.. versionadded:: 20.5

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_aggressive_anti_spam_enabled (:obj:`bool`): Optional. :obj:`True`, if aggressive

anti-spam checks are enabled in the supergroup. The field is only available to chat

administrators. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

has_hidden_members (:obj:`bool`): Optional. :obj:`True`, if non-administrators can only

get the list of bots and administrators in the chat. Returned only in

:meth:`telegram.Bot.get_chat`.

.. versionadded:: 20.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

unrestrict_boost_count (:obj:`int`): Optional. For supergroups, the minimum number of

boosts that a non-administrator user needs to add in order to ignore slow mode and chat

permissions. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

custom_emoji_sticker_set_name (:obj:`str`): Optional. For supergroups, the name of the

group's custom emoji sticker set. Custom emoji from this set can be used by all users

and bots in the group. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.0

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

birthdate (:obj:`telegram.Birthdate`): Optional. For private chats,

the date of birth of the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

personal_chat (:obj:`telegram.Chat`): Optional. For private chats, the personal channel of

the user. Returned only in :meth:`telegram.Bot.get_chat`.

.. versionadded:: 21.1

.. deprecated:: 21.2

In accordance to Bot API 7.3, this attribute will be moved to

:class:`telegram.ChatFullInfo`.

.. _topics: https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups

.. _accent colors: https://core.telegram.org/bots/api#accent-colors

"""

__slots__ = (

"accent_color_id",

"active_usernames",

"available_reactions",

"background_custom_emoji_id",

"bio",

"birthdate",

"business_intro",

"business_location",

"business_opening_hours",

"can_set_sticker_set",

"custom_emoji_sticker_set_name",

"description",

"emoji_status_custom_emoji_id",

"emoji_status_expiration_date",

"first_name",

"has_aggressive_anti_spam_enabled",

"has_hidden_members",

"has_private_forwards",

"has_protected_content",

"has_restricted_voice_and_video_messages",

"has_visible_history",

"id",

"invite_link",

"is_forum",

"join_by_request",

"join_to_send_messages",

"last_name",

"linked_chat_id",

"location",

"message_auto_delete_time",

"permissions",

"personal_chat",

"photo",

"pinned_message",

"profile_accent_color_id",

"profile_background_custom_emoji_id",

"slow_mode_delay",

"sticker_set_name",

"title",

"type",

"unrestrict_boost_count",

"username",

)

SENDER: Final[str] = constants.ChatType.SENDER

""":const:`telegram.constants.ChatType.SENDER`

.. versionadded:: 13.5

"""

PRIVATE: Final[str] = constants.ChatType.PRIVATE

""":const:`telegram.constants.ChatType.PRIVATE`"""

GROUP: Final[str] = constants.ChatType.GROUP

""":const:`telegram.constants.ChatType.GROUP`"""

SUPERGROUP: Final[str] = constants.ChatType.SUPERGROUP

""":const:`telegram.constants.ChatType.SUPERGROUP`"""

CHANNEL: Final[str] = constants.ChatType.CHANNEL

""":const:`telegram.constants.ChatType.CHANNEL`"""

def __init__(

self,

id: int,

type: str,

title: Optional[str] = None,

username: Optional[str] = None,

first_name: Optional[str] = None,

last_name: Optional[str] = None,

photo: Optional[ChatPhoto] = None,

description: Optional[str] = None,

invite_link: Optional[str] = None,

pinned_message: Optional["Message"] = None,

permissions: Optional[ChatPermissions] = None,

sticker_set_name: Optional[str] = None,

can_set_sticker_set: Optional[bool] = None,

slow_mode_delay: Optional[int] = None,

bio: Optional[str] = None,

linked_chat_id: Optional[int] = None,

location: Optional[ChatLocation] = None,

message_auto_delete_time: Optional[int] = None,

has_private_forwards: Optional[bool] = None,

has_protected_content: Optional[bool] = None,

join_to_send_messages: Optional[bool] = None,

join_by_request: Optional[bool] = None,

has_restricted_voice_and_video_messages: Optional[bool] = None,

is_forum: Optional[bool] = None,

active_usernames: Optional[Sequence[str]] = None,

emoji_status_custom_emoji_id: Optional[str] = None,

emoji_status_expiration_date: Optional[datetime] = None,

has_aggressive_anti_spam_enabled: Optional[bool] = None,

has_hidden_members: Optional[bool] = None,

available_reactions: Optional[Sequence[ReactionType]] = None,

accent_color_id: Optional[int] = None, # required in API 7.3 - Optional for back compat

background_custom_emoji_id: Optional[str] = None,

profile_accent_color_id: Optional[int] = None,

profile_background_custom_emoji_id: Optional[str] = None,

has_visible_history: Optional[bool] = None,

unrestrict_boost_count: Optional[int] = None,

custom_emoji_sticker_set_name: Optional[str] = None,

birthdate: Optional[Birthdate] = None,

personal_chat: Optional["Chat"] = None,

business_intro: Optional["BusinessIntro"] = None,

business_location: Optional["BusinessLocation"] = None,

business_opening_hours: Optional["BusinessOpeningHours"] = None,

*,

api_kwargs: Optional[JSONDict] = None,

):

super().__init__(api_kwargs=api_kwargs)

# Required

self.id: int = id

self.type: str = enum.get_member(constants.ChatType, type, type)

# Optionals

self.title: Optional[str] = title

self.username: Optional[str] = username

self.first_name: Optional[str] = first_name

self.last_name: Optional[str] = last_name

self.photo: Optional[ChatPhoto] = photo

self.bio: Optional[str] = bio

self.has_private_forwards: Optional[bool] = has_private_forwards

self.description: Optional[str] = description

self.invite_link: Optional[str] = invite_link

self.pinned_message: Optional[Message] = pinned_message

self.permissions: Optional[ChatPermissions] = permissions

self.slow_mode_delay: Optional[int] = slow_mode_delay

self.message_auto_delete_time: Optional[int] = (

int(message_auto_delete_time) if message_auto_delete_time is not None else None

)

self.has_protected_content: Optional[bool] = has_protected_content

self.has_visible_history: Optional[bool] = has_visible_history

self.sticker_set_name: Optional[str] = sticker_set_name

self.can_set_sticker_set: Optional[bool] = can_set_sticker_set

self.linked_chat_id: Optional[int] = linked_chat_id

self.location: Optional[ChatLocation] = location

self.join_to_send_messages: Optional[bool] = join_to_send_messages

self.join_by_request: Optional[bool] = join_by_request

self.has_restricted_voice_and_video_messages: Optional[bool] = (

has_restricted_voice_and_video_messages

)

self.is_forum: Optional[bool] = is_forum

self.active_usernames: Tuple[str, ...] = parse_sequence_arg(active_usernames)

self.emoji_status_custom_emoji_id: Optional[str] = emoji_status_custom_emoji_id

self.emoji_status_expiration_date: Optional[datetime] = emoji_status_expiration_date

self.has_aggressive_anti_spam_enabled: Optional[bool] = has_aggressive_anti_spam_enabled

self.has_hidden_members: Optional[bool] = has_hidden_members

self.available_reactions: Optional[Tuple[ReactionType, ...]] = parse_sequence_arg(

available_reactions

)

self.accent_color_id: Optional[int] = accent_color_id

self.background_custom_emoji_id: Optional[str] = background_custom_emoji_id

self.profile_accent_color_id: Optional[int] = profile_accent_color_id

self.profile_background_custom_emoji_id: Optional[str] = profile_background_custom_emoji_id

self.unrestrict_boost_count: Optional[int] = unrestrict_boost_count

self.custom_emoji_sticker_set_name: Optional[str] = custom_emoji_sticker_set_name

self.birthdate: Optional[Birthdate] = birthdate

self.personal_chat: Optional["Chat"] = personal_chat

self.business_intro: Optional["BusinessIntro"] = business_intro

self.business_location: Optional["BusinessLocation"] = business_location

self.business_opening_hours: Optional["BusinessOpeningHours"] = business_opening_hours

if self.__class__ is Chat:

for arg in _deprecated_attrs:

if (val := object.__getattribute__(self, arg)) is not None and val != ():

warn(

PTBDeprecationWarning(

"21.2",

f"The argument `{arg}` is deprecated and will only be available via "

"`ChatFullInfo` in the future.",

),

stacklevel=2,

)

self._id_attrs = (self.id,)

self._freeze()

def __getattribute__(self, name: str) -> Any:

if name in _deprecated_attrs and self.__class__ is Chat:

warn(

PTBDeprecationWarning(

"21.2",

f"The attribute `{name}` is deprecated and will only be accessible via "

"`ChatFullInfo` in the future.",

),

stacklevel=2,

)

return super().__getattribute__(name)

@property

def effective_name(self) -> Optional[str]:

"""

:obj:`str`: Convenience property. Gives :attr:`title` if not :obj:`None`,

else :attr:`full_name` if not :obj:`None`.

.. versionadded:: 20.1

"""

if self.title is not None:

return self.title

if self.full_name is not None:

return self.full_name

return None

@property

def full_name(self) -> Optional[str]:

"""

:obj:`str`: Convenience property. If :attr:`first_name` is not :obj:`None`, gives

:attr:`first_name` followed by (if available) :attr:`last_name`.

Note:

:attr:`full_name` will always be :obj:`None`, if the chat is a (super)group or

channel.

.. versionadded:: 13.2

"""

if not self.first_name:

return None

if self.last_name:

return f"{self.first_name} {self.last_name}"

return self.first_name

@property

def link(self) -> Optional[str]:

""":obj:`str`: Convenience property. If the chat has a :attr:`username`, returns a t.me

link of the chat.

"""

if self.username:

return f"https://t.me/{self.username}"

return None

@classmethod

def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["Chat"]:

"""See :meth:`telegram.TelegramObject.de_json`."""

data = cls._parse_data(data)

if not data:

return None

# Get the local timezone from the bot if it has defaults

loc_tzinfo = extract_tzinfo_from_defaults(bot)

data["emoji_status_expiration_date"] = from_timestamp(

data.get("emoji_status_expiration_date"), tzinfo=loc_tzinfo

)

data["photo"] = ChatPhoto.de_json(data.get("photo"), bot)

from telegram import ( # pylint: disable=import-outside-toplevel

BusinessIntro,

BusinessLocation,

BusinessOpeningHours,

Message,

)