class

Tourmaline::InlineQueryResultDocument

Inherits JSON::Serializable / Reference / Object

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.

Constructors

new(id : String, title : String, document_url : String, mime_type : String, type : String = "document", caption : String | Nil = nil, parse_mode : ParseMode = ParseMode::Markdown, caption_entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, description : String | Nil = nil, reply_markup : Tourmaline::InlineKeyboardMarkup | Nil = nil, input_message_content : Tourmaline::InputMessageContent | Nil = nil, thumbnail_url : String | Nil = nil, thumbnail_width : Int32 | Int64 | Nil = nil, thumbnail_height : Int32 | Int64 | Nil = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

caption

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

Source
caption=(caption : String | Nil)

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

Source
caption_entities

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

Source
caption_entities=(caption_entities : Array(Tourmaline::MessageEntity))

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

Source
description

Optional. Short description of the result

Source
description=(description : String | Nil)

Optional. Short description of the result

Source
document_url

A valid URL for the file

Source
document_url=(document_url : String)

A valid URL for the file

Source
id

Unique identifier for this result, 1-64 bytes

Source
id=(id : String)

Unique identifier for this result, 1-64 bytes

Source
input_message_content

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

Source
input_message_content=(input_message_content : Tourmaline::InputMessageContent | Nil)

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

Source
mime_type

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

Source
mime_type=(mime_type : String)

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

Source
parse_mode

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

Source
parse_mode=(parse_mode : ParseMode)

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

Source
reply_markup

Optional. Inline keyboard attached to the message

Source
reply_markup=(reply_markup : Tourmaline::InlineKeyboardMarkup | Nil)

Optional. Inline keyboard attached to the message

Source
thumbnail_height

Optional. Thumbnail height

Source
thumbnail_height=(thumbnail_height : Int32 | Int64 | Nil)

Optional. Thumbnail height

Source
thumbnail_url

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

Source
thumbnail_url=(thumbnail_url : String | Nil)

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

Source
thumbnail_width

Optional. Thumbnail width

Source
thumbnail_width=(thumbnail_width : Int32 | Int64 | Nil)

Optional. Thumbnail width

Source
title

Title for the result

Source
title=(title : String)

Title for the result

Source
type

Type of the result, must be document

Source
type=(type : String)

Type of the result, must be document

Source