2021-03-14 16:41:35 +01:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2021-03-14 16:41:35 +01:00
|
|
|
# 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/].
|
2022-05-03 18:21:50 +02:00
|
|
|
"""This module contains objects related to Telegram video chats."""
|
2021-03-14 16:41:35 +01:00
|
|
|
|
2021-04-30 10:09:21 +02:00
|
|
|
import datetime as dtm
|
2022-05-05 09:27:54 +02:00
|
|
|
from typing import TYPE_CHECKING, List, Optional
|
2021-03-14 16:41:35 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._telegramobject import TelegramObject
|
|
|
|
from telegram._user import User
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.datetime import from_timestamp, to_timestamp
|
|
|
|
from telegram._utils.types import JSONDict
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from telegram import Bot
|
|
|
|
|
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
class VideoChatStarted(TelegramObject):
|
2021-03-14 16:41:35 +01:00
|
|
|
"""
|
2022-05-03 18:21:50 +02:00
|
|
|
This object represents a service message about a video
|
2021-03-14 16:41:35 +01:00
|
|
|
chat started in the chat. Currently holds no information.
|
|
|
|
|
|
|
|
.. versionadded:: 13.4
|
2022-05-03 18:21:50 +02:00
|
|
|
.. versionchanged:: 20.0
|
|
|
|
This class was renamed from ``VoiceChatStarted`` in accordance to Bot API 6.0.
|
2021-03-14 16:41:35 +01:00
|
|
|
"""
|
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
__slots__ = ()
|
|
|
|
|
2021-08-29 18:17:06 +02:00
|
|
|
def __init__(self, **_kwargs: object): # skipcq: PTC-W0049
|
2021-03-14 16:41:35 +01:00
|
|
|
pass
|
|
|
|
|
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
class VideoChatEnded(TelegramObject):
|
2021-03-14 16:41:35 +01:00
|
|
|
"""
|
|
|
|
This object represents a service message about a
|
2022-05-03 18:21:50 +02:00
|
|
|
video chat ended in the chat.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Objects of this class are comparable in terms of equality.
|
|
|
|
Two objects of this class are considered equal, if their
|
|
|
|
:attr:`duration` are equal.
|
|
|
|
|
|
|
|
.. versionadded:: 13.4
|
2022-05-03 18:21:50 +02:00
|
|
|
.. versionchanged:: 20.0
|
|
|
|
This class was renamed from ``VoiceChatEnded`` in accordance to Bot API 6.0.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Args:
|
|
|
|
duration (:obj:`int`): Voice chat duration in seconds.
|
2021-04-30 10:09:21 +02:00
|
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Attributes:
|
|
|
|
duration (:obj:`int`): Voice chat duration in seconds.
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
__slots__ = ("duration",)
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2021-08-29 18:17:06 +02:00
|
|
|
def __init__(self, duration: int, **_kwargs: object) -> None:
|
2021-03-14 16:41:35 +01:00
|
|
|
self.duration = int(duration) if duration is not None else None
|
|
|
|
self._id_attrs = (self.duration,)
|
|
|
|
|
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
class VideoChatParticipantsInvited(TelegramObject):
|
2021-03-14 16:41:35 +01:00
|
|
|
"""
|
2022-05-03 18:21:50 +02:00
|
|
|
This object represents a service message about new members invited to a video chat.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Objects of this class are comparable in terms of equality.
|
2022-05-03 18:21:50 +02:00
|
|
|
Two objects of this class are considered equal, if their :attr:`users` are equal.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
.. versionadded:: 13.4
|
2022-05-03 18:21:50 +02:00
|
|
|
.. versionchanged:: 20.0
|
|
|
|
This class was renamed from ``VoiceChatParticipantsInvited`` in accordance to Bot API 6.0.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Args:
|
2022-05-03 18:21:50 +02:00
|
|
|
users (List[:class:`telegram.User`]): New members that were invited to the video chat.
|
2021-04-30 10:09:21 +02:00
|
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
Attributes:
|
2022-05-03 18:21:50 +02:00
|
|
|
users (List[:class:`telegram.User`]): New members that were invited to the video chat.
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
"""
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
__slots__ = ("users",)
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
def __init__(self, users: List[User], **_kwargs: object) -> None:
|
2021-03-14 16:41:35 +01:00
|
|
|
self.users = users
|
|
|
|
self._id_attrs = (self.users,)
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def de_json(
|
2022-05-05 17:40:22 +02:00
|
|
|
cls, data: Optional[JSONDict], bot: "Bot"
|
|
|
|
) -> Optional["VideoChatParticipantsInvited"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2021-03-14 16:41:35 +01:00
|
|
|
|
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
data["users"] = User.de_list(data.get("users", []), bot)
|
2021-03-14 16:41:35 +01:00
|
|
|
return cls(**data)
|
|
|
|
|
|
|
|
def to_dict(self) -> JSONDict:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.to_dict`."""
|
2021-03-14 16:41:35 +01:00
|
|
|
data = super().to_dict()
|
|
|
|
|
2021-08-29 18:17:06 +02:00
|
|
|
if self.users is not None:
|
|
|
|
data["users"] = [u.to_dict() for u in self.users]
|
2021-03-14 16:41:35 +01:00
|
|
|
return data
|
2021-04-30 10:09:21 +02:00
|
|
|
|
2021-08-29 18:17:06 +02:00
|
|
|
def __hash__(self) -> int:
|
|
|
|
return hash(None) if self.users is None else hash(tuple(self.users))
|
|
|
|
|
2021-04-30 10:09:21 +02:00
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
class VideoChatScheduled(TelegramObject):
|
|
|
|
"""This object represents a service message about a video chat scheduled in the chat.
|
2021-04-30 10:09:21 +02:00
|
|
|
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
|
|
considered equal, if their :attr:`start_date` are equal.
|
|
|
|
|
2022-05-03 18:21:50 +02:00
|
|
|
.. versionchanged:: 20.0
|
|
|
|
This class was renamed from ``VoiceChatScheduled`` in accordance to Bot API 6.0.
|
|
|
|
|
2021-04-30 10:09:21 +02:00
|
|
|
Args:
|
2022-05-03 18:21:50 +02:00
|
|
|
start_date (:obj:`datetime.datetime`): Point in time (Unix timestamp) when the video
|
2021-04-30 10:09:21 +02:00
|
|
|
chat is supposed to be started by a chat administrator
|
|
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
|
|
|
|
Attributes:
|
2022-05-03 18:21:50 +02:00
|
|
|
start_date (:obj:`datetime.datetime`): Point in time (Unix timestamp) when the video
|
2021-04-30 10:09:21 +02:00
|
|
|
chat is supposed to be started by a chat administrator
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
__slots__ = ("start_date",)
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2021-08-29 18:17:06 +02:00
|
|
|
def __init__(self, start_date: dtm.datetime, **_kwargs: object) -> None:
|
2021-04-30 10:09:21 +02:00
|
|
|
self.start_date = start_date
|
|
|
|
|
|
|
|
self._id_attrs = (self.start_date,)
|
|
|
|
|
|
|
|
@classmethod
|
2022-05-05 17:40:22 +02:00
|
|
|
def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["VideoChatScheduled"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2021-04-30 10:09:21 +02:00
|
|
|
|
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
data["start_date"] = from_timestamp(data["start_date"])
|
2021-04-30 10:09:21 +02:00
|
|
|
|
|
|
|
return cls(**data, bot=bot)
|
|
|
|
|
|
|
|
def to_dict(self) -> JSONDict:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.to_dict`."""
|
2021-04-30 10:09:21 +02:00
|
|
|
data = super().to_dict()
|
|
|
|
|
|
|
|
# Required
|
2022-05-05 17:40:22 +02:00
|
|
|
data["start_date"] = to_timestamp(self.start_date)
|
2021-04-30 10:09:21 +02:00
|
|
|
|
|
|
|
return data
|