class Hamilton::Types::InputMediaDocument

Overview

Represents a general file to be sent.

Included Modules

Defined in:

types/input_media.cr

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : Hamilton::Any) ==

Instance methods inherited from class Object

===(other : Hamilton::Any) ===

Constructor Detail

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

def self.new(params) #

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

def self.new(**params) #

Instance Method Detail

def caption : String | Nil #

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


def caption=(caption : String | Nil) #

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


def caption_entities : Array(Hamilton::Types::MessageEntity) | Nil #

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


def caption_entities=(caption_entities : Array(Hamilton::Types::MessageEntity) | Nil) #

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


def disable_content_type_detection : Bool | Nil #

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.


def disable_content_type_detection=(disable_content_type_detection : Bool | Nil) #

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.


def media : Hamilton::Types::InputFile | 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.


def media=(media : Hamilton::Types::InputFile | 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.


def non_nil_fields : Array(String) #

List of available non-nil fields.


def non_nil_fields=(non_nil_fields : Array(String)) #

List of available non-nil fields.


def parse_mode : String | Nil #

Mode for parsing entities in the document caption.


def parse_mode=(parse_mode : String | Nil) #

Mode for parsing entities in the document caption.


def thumbnail : Hamilton::Types::InputFile | String | Nil #

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>.


def thumbnail=(thumbnail : Hamilton::Types::InputFile | String | Nil) #

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>.


def type : String #

Type of the result, must be "document".


def type=(type : String) #

Type of the result, must be "document".