class Tourmaline::InputMediaDocument

Overview

Represents a general file to be sent.

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(media : String, type : String = "document", thumbnail : ::File | String | Nil = nil, caption : String | Nil = nil, parse_mode : ParseMode = ParseMode::Markdown, caption_entities : Array(Tourmaline::MessageEntity) = [] of Tourmaline::MessageEntity, disable_content_type_detection : Bool | Nil = nil) #

[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 disable_content_type_detection=(disable_content_type_detection : Bool | Nil) #

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.


[View source]
def disable_content_type_detection? : Bool | Nil #

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.


[View source]
def media : String #

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files


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

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files


[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 thumbnail : ::File | String | Nil #

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files


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

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files


[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]