class Tourmaline::InlineQueryResultDocument
inherits Reference

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.

Included modules

JSON::Serializable

Constructors

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

View source

.new(pull : JSON::PullParser)

View source

Methods

#caption : String?

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

View source

#caption=(caption : String?)

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

View source

#caption_entities : Array(Tourmaline::MessageEntity)

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

View 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

View source

#description : String?

Optional. Short description of the result

View source

#description=(description : String?)

Optional. Short description of the result

View source

#document_url : String

A valid URL for the file

View source

#document_url=(document_url : String)

A valid URL for the file

View source

#id : String

Unique identifier for this result, 1-64 bytes

View source

#id=(id : String)

Unique identifier for this result, 1-64 bytes

View source

#input_message_content : Tourmaline::InputMessageContent?

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

View source

#input_message_content=(input_message_content : Tourmaline::InputMessageContent?)

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

View source

#mime_type : String

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

View source

#mime_type=(mime_type : String)

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

View source

#parse_mode : ParseMode

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

View source

#parse_mode=(parse_mode : ParseMode)

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

View source

#reply_markup : Tourmaline::InlineKeyboardMarkup?

Optional. Inline keyboard attached to the message

View source

#reply_markup=(reply_markup : Tourmaline::InlineKeyboardMarkup?)

Optional. Inline keyboard attached to the message

View source

#thumbnail_height : Int32 | Int64 | Nil

Optional. Thumbnail height

View source

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

Optional. Thumbnail height

View source

#thumbnail_url : String?

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

View source

#thumbnail_url=(thumbnail_url : String?)

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

View source

#thumbnail_width : Int32 | Int64 | Nil

Optional. Thumbnail width

View source

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

Optional. Thumbnail width

View source

#title : String

Title for the result

View source

#title=(title : String)

Title for the result

View source

#type : String

Type of the result, must be document

View source

#type=(type : String)

Type of the result, must be document

View source