2016-04-12 06:12:35 +02: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
|
2016-04-12 06:12:35 +02: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/].
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This module contains the classes that represent Telegram InlineQueryResultContact."""
|
2016-04-14 01:01:36 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
from typing import TYPE_CHECKING
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup
|
|
|
|
from telegram._inline.inlinequeryresult import InlineQueryResult
|
2022-10-07 11:51:53 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2021-10-19 18:28:19 +02:00
|
|
|
from telegram.constants import InlineQueryResultType
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
2022-01-19 18:00:21 +01:00
|
|
|
from telegram import InputMessageContent
|
2016-04-13 14:59:48 +02:00
|
|
|
|
|
|
|
|
|
|
|
class InlineQueryResultContact(InlineQueryResult):
|
2017-07-23 22:33:08 +02:00
|
|
|
"""
|
|
|
|
Represents a contact with a phone number. By default, this contact will be sent by the user.
|
|
|
|
Alternatively, you can use :attr:`input_message_content` to send a message with the specified
|
|
|
|
content instead of the contact.
|
2016-10-17 22:44:40 +02:00
|
|
|
|
|
|
|
Args:
|
2022-11-22 11:07:42 +01:00
|
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
2017-07-23 22:33:08 +02:00
|
|
|
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.
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
vcard (:obj:`str`, optional): Additional data about the contact in the form of a vCard,
|
2022-11-22 11:07:42 +01:00
|
|
|
0-:tg-const:`telegram.constants.ContactLimit.VCARD` bytes.
|
2017-07-23 22:33:08 +02:00
|
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached
|
|
|
|
to the message.
|
|
|
|
input_message_content (:class:`telegram.InputMessageContent`, optional): Content of the
|
|
|
|
message to be sent instead of the contact.
|
|
|
|
thumb_url (:obj:`str`, optional): Url of the thumbnail for the result.
|
|
|
|
thumb_width (:obj:`int`, optional): Thumbnail width.
|
|
|
|
thumb_height (:obj:`int`, optional): Thumbnail height.
|
2016-10-17 22:44:40 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
2021-10-19 18:28:19 +02:00
|
|
|
type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.CONTACT`.
|
2022-11-22 11:07:42 +01:00
|
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
2020-12-30 15:59:50 +01:00
|
|
|
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.
|
|
|
|
vcard (:obj:`str`): Optional. Additional data about the contact in the form of a vCard,
|
2022-11-22 11:07:42 +01:00
|
|
|
0-:tg-const:`telegram.constants.ContactLimit.VCARD` bytes.
|
2020-12-30 15:59:50 +01:00
|
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached
|
|
|
|
to the message.
|
|
|
|
input_message_content (:class:`telegram.InputMessageContent`): Optional. Content of the
|
|
|
|
message to be sent instead of the contact.
|
|
|
|
thumb_url (:obj:`str`): Optional. Url of the thumbnail for the result.
|
|
|
|
thumb_width (:obj:`int`): Optional. Thumbnail width.
|
|
|
|
thumb_height (:obj:`int`): Optional. Thumbnail height.
|
|
|
|
|
2016-10-17 22:44:40 +02:00
|
|
|
"""
|
2016-05-15 03:46:40 +02:00
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
__slots__ = (
|
|
|
|
"reply_markup",
|
|
|
|
"thumb_width",
|
|
|
|
"thumb_height",
|
|
|
|
"vcard",
|
|
|
|
"first_name",
|
|
|
|
"last_name",
|
|
|
|
"phone_number",
|
|
|
|
"input_message_content",
|
|
|
|
"thumb_url",
|
|
|
|
)
|
|
|
|
|
2016-04-16 17:35:23 +02:00
|
|
|
def __init__(
|
|
|
|
self,
|
2021-10-08 08:17:00 +02:00
|
|
|
id: str, # pylint: disable=redefined-builtin
|
2020-10-06 19:28:40 +02:00
|
|
|
phone_number: str,
|
|
|
|
first_name: str,
|
|
|
|
last_name: str = None,
|
2022-01-19 18:00:21 +01:00
|
|
|
reply_markup: InlineKeyboardMarkup = None,
|
2020-10-06 19:28:40 +02:00
|
|
|
input_message_content: "InputMessageContent" = None,
|
|
|
|
thumb_url: str = None,
|
|
|
|
thumb_width: int = None,
|
|
|
|
thumb_height: int = None,
|
|
|
|
vcard: str = None,
|
2022-10-07 11:51:53 +02:00
|
|
|
*,
|
|
|
|
api_kwargs: JSONDict = None,
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2016-04-16 17:35:23 +02:00
|
|
|
# Required
|
2022-10-07 11:51:53 +02:00
|
|
|
super().__init__(InlineQueryResultType.CONTACT, id, api_kwargs=api_kwargs)
|
2022-12-15 15:00:36 +01:00
|
|
|
with self._unfrozen():
|
|
|
|
self.phone_number = phone_number
|
|
|
|
self.first_name = first_name
|
2016-04-16 17:35:23 +02:00
|
|
|
|
2022-12-15 15:00:36 +01:00
|
|
|
# Optionals
|
|
|
|
self.last_name = last_name
|
|
|
|
self.vcard = vcard
|
|
|
|
self.reply_markup = reply_markup
|
|
|
|
self.input_message_content = input_message_content
|
|
|
|
self.thumb_url = thumb_url
|
|
|
|
self.thumb_width = thumb_width
|
|
|
|
self.thumb_height = thumb_height
|