InlineQueryResultDocument

class telegram.InlineQueryResultDocument(id, document_url, title, mime_type, caption=None, description=None, reply_markup=None, input_message_content=None, parse_mode=None, caption_entities=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None, *, api_kwargs=None)[source]

Bases: telegram.InlineQueryResult

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.

Changed in version 20.5: Removed the deprecated arguments and attributes thumb_*.

Parameters:
type[source]

'document'.

Type:

str

id[source]

Unique identifier for this result, 1- 64 Bytes.

Type:

str

title[source]

Title for the result.

Type:

str

caption[source]

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

Type:

str

parse_mode[source]

Optional. Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

Type:

str

caption_entities[source]

Optional. Tuple of special entities that appear in the caption, which can be specified instead of parse_mode.

Changed in version 20.0:

  • This attribute is now an immutable tuple.

  • This attribute is now always a tuple, that may be empty.

Type:

tuple[telegram.MessageEntity]

document_url[source]

A valid URL for the file.

Type:

str

mime_type[source]

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

Type:

str

description[source]

Optional. Short description of the result.

Type:

str

reply_markup[source]

Optional. Inline keyboard attached to the message.

Type:

telegram.InlineKeyboardMarkup

input_message_content[source]

Optional. Content of the message to be sent instead of the file.

Type:

telegram.InputMessageContent

thumbnail_url[source]

Optional. URL of the thumbnail (JPEG only) for the file.

Added in version 20.2.

Type:

str

thumbnail_width[source]

Optional. Thumbnail width.

Added in version 20.2.

Type:

int

thumbnail_height[source]

Optional. Thumbnail height.

Added in version 20.2.

Type:

int