class Tourmaline::InlineQueryResultDocument

Overview

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.

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def caption : String | Nil #

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


[View source]
def caption=(caption : String | Nil) #

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


[View source]
def 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]
def 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]
def description : String | Nil #

Optional. Short description of the result


[View source]
def description=(description : String | Nil) #

Optional. Short description of the result


[View source]
def document_url : String #

A valid URL for the file


[View source]
def document_url=(document_url : String) #

A valid URL for the file


[View source]
def id : String #

Unique identifier for this result, 1-64 bytes


[View source]
def id=(id : String) #

Unique identifier for this result, 1-64 bytes


[View source]
def input_message_content : Tourmaline::InputMessageContent | Nil #

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


[View source]
def input_message_content=(input_message_content : Tourmaline::InputMessageContent | Nil) #

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


[View source]
def mime_type : String #

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


[View source]
def mime_type=(mime_type : String) #

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


[View source]
def parse_mode : ParseMode #

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


[View source]
def parse_mode=(parse_mode : ParseMode) #

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


[View source]
def reply_markup : Tourmaline::InlineKeyboardMarkup | Nil #

Optional. Inline keyboard attached to the message


[View source]
def reply_markup=(reply_markup : Tourmaline::InlineKeyboardMarkup | Nil) #

Optional. Inline keyboard attached to the message


[View source]
def thumbnail_height : Int32 | Int64 | Nil #

Optional. Thumbnail height


[View source]
def thumbnail_height=(thumbnail_height : Int32 | Int64 | Nil) #

Optional. Thumbnail height


[View source]
def thumbnail_url : String | Nil #

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


[View source]
def thumbnail_url=(thumbnail_url : String | Nil) #

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


[View source]
def thumbnail_width : Int32 | Int64 | Nil #

Optional. Thumbnail width


[View source]
def thumbnail_width=(thumbnail_width : Int32 | Int64 | Nil) #

Optional. Thumbnail width


[View source]
def title : String #

Title for the result


[View source]
def title=(title : String) #

Title for the result


[View source]
def type : String #

Type of the result, must be document


[View source]
def type=(type : String) #

Type of the result, must be document


[View source]