GramIO API Reference / gramio/dist / TelegramInlineQueryResultDocument
Interface: TelegramInlineQueryResultDocument
Defined in: @gramio/types/out/objects.d.ts:6992
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
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:7008 |
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:7016 |
description? | string | Optional. Short description of the result | @gramio/types/out/objects.d.ts:7028 |
document_url | string | A valid URL for the file | @gramio/types/out/objects.d.ts:7020 |
id | string | Unique identifier for this result, 1-64 bytes | @gramio/types/out/objects.d.ts:7000 |
input_message_content? | TelegramInputMessageContent | Optional. Content of the message to be sent instead of the file | @gramio/types/out/objects.d.ts:7038 |
mime_type | TelegramInlineQueryResultDocumentMimeType | MIME type of the content of the file, either “application/pdf” or “application/zip” | @gramio/types/out/objects.d.ts:7024 |
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:7012 |
reply_markup? | TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; } | Optional. Inline keyboard attached to the message | @gramio/types/out/objects.d.ts:7032 |
thumbnail_height? | number | Optional. Thumbnail height | @gramio/types/out/objects.d.ts:7050 |
thumbnail_url? | string | Optional. URL of the thumbnail (JPEG only) for the file | @gramio/types/out/objects.d.ts:7042 |
thumbnail_width? | number | Optional. Thumbnail width | @gramio/types/out/objects.d.ts:7046 |
title | string | Title for the result | @gramio/types/out/objects.d.ts:7004 |
type | "document" | Type of the result, must be document | @gramio/types/out/objects.d.ts:6996 |