PassportFile¶
- class telegram.PassportFile(file_id, file_unique_id, file_date, file_size, credentials=None, *, api_kwargs=None)[source]¶
Bases:
telegram.TelegramObject
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don’t exceed 10MB.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
file_unique_id
is equal.Available In
- Parameters:
file_id (
str
) – Identifier for this file, which can be used to download or reuse the file.file_unique_id (
str
) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.Unix time when the file was uploaded.
Deprecated since version 20.6: This argument will only accept a datetime instead of an integer in future major versions.
- file_unique_id[source]¶
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.
- Type:
- classmethod de_json_decrypted(data, bot, credentials)[source]¶
Variant of
telegram.TelegramObject.de_json()
that also takes into account passport credentials.- Parameters:
bot (
telegram.Bot
|None
) –The bot associated with these object. May be
None
, in which case shortcut methods will not be available.Deprecated since version 21.4: This argument will be converted to an optional argument in future versions.
credentials (
telegram.FileCredentials
) – The credentials
- Return type:
- classmethod de_list_decrypted(data, bot, credentials)[source]¶
Variant of
telegram.TelegramObject.de_list()
that also takes into account passport credentials.Changed in version 20.0:
Returns a tuple instead of a list.
Filters out any
None
values
- Parameters:
bot (
telegram.Bot
|None
) –The bot associated with these object. May be
None
, in which case shortcut methods will not be available.Deprecated since version 21.4: This argument will be converted to an optional argument in future versions.
credentials (
telegram.FileCredentials
) – The credentials
- Return type:
tuple[
telegram.PassportFile
]
- property file_date[source]¶
Unix time when the file was uploaded.
Deprecated since version 20.6: This attribute will return a datetime instead of a integer in future major versions.
- Type:
- async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Wrapper over
telegram.Bot.get_file()
. Will automatically assign the correct credentials to the returnedtelegram.File
if originating fromtelegram.PassportData.decrypted_data
.For the documentation of the arguments, please see
telegram.Bot.get_file()
.- Returns:
- Raises:
- to_dict(recursive=True)[source]¶
See
telegram.TelegramObject.to_dict()
for details.