peyk.platforms.telegram.types.document

Classes

Document(file_id, file_unique_id[, ...])

This object represents a general file (as opposed to photos, voice messages and audio files).
class peyk.platforms.telegram.types.document.Document(file_id: str, file_unique_id: str, thumbnail: PhotoSize | None = None, file_name: str | None = None, mime_type: str | None = None, file_size: int | None = None)[source]

Bases: object

This object represents a general file (as opposed to photos, voice messages and audio files).

Variables:

  • 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.

  • thumbnail (peyk.platforms.telegram.types.photo_size.PhotoSize | None) – Document thumbnail as defined by the sender

  • file_name (str | None) – Original filename as defined by the sender

  • mime_type (str | None) – MIME type of the file as defined by the sender

  • file_size (int | None) – File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

file_id: str
file_unique_id: str
thumbnail: PhotoSize | None = None
file_name: str | None = None
mime_type: str | None = None
file_size: int | None = None
classmethod from_dict(data: dict | None) → Document | None[source]

Parse a Telegram API mapping into this type.

Parameters:

data – Raw Telegram API mapping, or None.

Returns:

Parsed type instance, or None when data is None.