peyk.platforms.telegram.types.input_media_document

Classes

InputMediaDocument(media[, thumbnail, ...])

Represents a general file to be sent.
class peyk.platforms.telegram.types.input_media_document.InputMediaDocument(media: object, thumbnail: object | None = None, caption: str | None = None, parse_mode: str | None = None, caption_entities: List[MessageEntity] | None = None, disable_content_type_detection: bool | None = None)[source]

Bases: object

Represents a general file to be sent.

Variables:

  • type – Type of the media, must be document

  • media (object) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass ‘attach://’ to upload a new one using multipart/form-data under name. More information on Sending Files

  • thumbnail (object | None) – Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass ‘attach://’ if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files

  • caption (str | None) – Caption of the document to be sent, 0-1024 characters after entities parsing

  • parse_mode (str | None) – Mode for parsing entities in the document caption. See formatting options for more details.

  • caption_entities (List[peyk.platforms.telegram.types.message_entity.MessageEntity] | None) – List of special entities that appear in the caption, which can be specified instead of parse_mode

  • disable_content_type_detection (bool | None) – Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.

media: object
thumbnail: object | None = None
caption: str | None = None
parse_mode: str | None = None
caption_entities: List[MessageEntity] | None = None
disable_content_type_detection: bool | None = None
to_dict(media: str, thumbnail: str | None = None) → Dict[str, object][source]

Provides the to dict operation for the Telegram integration.

Parameters:

  • media – Value used by this operation.

  • thumbnail – Value used by this operation.

Returns:

Result produced by the operation.