mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-24 08:06:26 +01:00
71 lines
2.7 KiB
Python
71 lines
2.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# 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 Contact."""
|
|
from typing import Optional
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class Contact(TelegramObject):
|
|
"""This object represents a phone contact.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`phone_number` is equal.
|
|
|
|
Args:
|
|
phone_number (:obj:`str`): Contact's phone number.
|
|
first_name (:obj:`str`): Contact's first name.
|
|
last_name (:obj:`str`, optional): Contact's last name.
|
|
user_id (:obj:`int`, optional): Contact's user identifier in Telegram.
|
|
vcard (:obj:`str`, optional): Additional data about the contact in the form of a vCard.
|
|
|
|
Attributes:
|
|
phone_number (:obj:`str`): Contact's phone number.
|
|
first_name (:obj:`str`): Contact's first name.
|
|
last_name (:obj:`str`): Optional. Contact's last name.
|
|
user_id (:obj:`int`): Optional. Contact's user identifier in Telegram.
|
|
vcard (:obj:`str`): Optional. Additional data about the contact in the form of a vCard.
|
|
|
|
"""
|
|
|
|
__slots__ = ("first_name", "last_name", "phone_number", "user_id", "vcard")
|
|
|
|
def __init__(
|
|
self,
|
|
phone_number: str,
|
|
first_name: str,
|
|
last_name: Optional[str] = None,
|
|
user_id: Optional[int] = None,
|
|
vcard: Optional[str] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
# Required
|
|
self.phone_number: str = str(phone_number)
|
|
self.first_name: str = first_name
|
|
# Optionals
|
|
self.last_name: Optional[str] = last_name
|
|
self.user_id: Optional[int] = user_id
|
|
self.vcard: Optional[str] = vcard
|
|
|
|
self._id_attrs = (self.phone_number,)
|
|
|
|
self._freeze()
|