Module

x/grammy/types.web.ts>InlineQueryResultDocument

The Telegram Bot Framework.
grammyjs/grammY
Very Popular
Go to Latest
interface InlineQueryResultDocument
import { type InlineQueryResultDocument } from "https://dotland.deno.dev/x/grammy@v1.18.3/types.web.ts";

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.

Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.

Properties

type: "document"

Type of the result, must be document

id: string

Unique identifier for this result, 1-64 bytes

title: string

Title for the result

optional
caption: string

Caption of the document to be sent, 0-1024 characters after entities parsing

optional
parse_mode: ParseMode

Mode for parsing entities in the document caption. See formatting options for more details.

optional
caption_entities: MessageEntity[]

List of special entities that appear in the caption, which can be specified instead of parse_mode

document_url: string

A valid URL for the file

mime_type: "application/pdf" | "application/zip"

MIME type of the content of the file, either “application/pdf” or “application/zip”

optional
description: string

Short description of the result

optional
reply_markup: InlineKeyboardMarkup

Inline keyboard attached to the message

optional
input_message_content: InputMessageContent

Content of the message to be sent instead of the file

optional
thumbnail_url: string

URL of the thumbnail (JPEG only) for the file

optional
thumbnail_width: number

Thumbnail width

optional
thumbnail_height: number

Thumbnail height