-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathinput_media_document.py
More file actions
74 lines (60 loc) · 3.08 KB
/
input_media_document.py
File metadata and controls
74 lines (60 loc) · 3.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hydrogram 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 General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import TYPE_CHECKING, BinaryIO
from .input_media import InputMedia
if TYPE_CHECKING:
from hydrogram import enums
from hydrogram.types.messages_and_media import MessageEntity
class InputMediaDocument(InputMedia):
"""A generic file to be sent inside an album.
Parameters:
media (``str`` | ``BinaryIO``):
File to send.
Pass a file_id as string to send a file that exists on the Telegram servers or
pass a file path as string to upload a new file that exists on your local machine or
pass a binary file-like object with its attribute “.name” set for in-memory uploads or
pass an HTTP URL as a string for Telegram to get a file from the Internet.
thumb (``str | BinaryIO``, *optional*):
Thumbnail of the file sent.
The thumbnail should be in JPEG format and less than 200 KB in size.
A thumbnail's width and height should not exceed 320 pixels.
Thumbnails can't be reused and can be only uploaded as a new file.
caption (``str``, *optional*):
Caption of the document to be sent, 0-1024 characters.
If not specified, the original caption is kept. Pass "" (empty string) to remove the caption.
parse_mode (:obj:`~hydrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
caption_entities (List of :obj:`~hydrogram.types.MessageEntity`):
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
show_caption_above_media (``bool``, *optional*):
Wether the caption should be shown above the document.
"""
def __init__(
self,
media: str | BinaryIO,
thumb: str | BinaryIO | None = None,
caption: str = "",
parse_mode: enums.ParseMode | None = None,
caption_entities: list[MessageEntity] | None = None,
show_caption_above_media: bool | None = None,
):
super().__init__(media, caption, parse_mode, caption_entities, show_caption_above_media)
self.thumb = thumb