GramIO API Reference / gramio/dist / TelegramInputMediaDocument
Interface: TelegramInputMediaDocument
Defined in: @gramio/types/out/objects.d.ts:5856
Represents a general file to be sent.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
caption? | string | { toString: string; } | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing | @gramio/types/out/objects.d.ts:5872 |
caption_entities? | TelegramMessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | @gramio/types/out/objects.d.ts:5880 |
disable_content_type_detection? | boolean | Optional. 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. | @gramio/types/out/objects.d.ts:5884 |
media | string | Blob | 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://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » | @gramio/types/out/objects.d.ts:5864 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Optional. Mode for parsing entities in the document caption. See formatting options for more details. | @gramio/types/out/objects.d.ts:5876 |
thumbnail? | string | Blob | Optional. 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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | @gramio/types/out/objects.d.ts:5868 |
type | "document" | Type of the result, must be document | @gramio/types/out/objects.d.ts:5860 |