class Tourmaline::Document

Overview

This object represents a general file (as opposed to photos, voice messages and audio files).

Included Modules

Defined in:

tourmaline/types/api.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(file_id : String, file_unique_id : String, thumbnail : Tourmaline::PhotoSize | Nil = nil, file_name : String | Nil = nil, mime_type : String | Nil = nil, file_size : Int32 | Int64 | Nil = nil) #

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

[View source]

Instance Method Detail

def file_id : String #

Identifier for this file, which can be used to download or reuse the file


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

Identifier for this file, which can be used to download or reuse the file


[View source]
def file_name : String | Nil #

Optional. Original filename as defined by the sender


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

Optional. Original filename as defined by the sender


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

Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.


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

Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.


[View source]
def file_unique_id : String #

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.


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

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.


[View source]
def mime_type : String | Nil #

Optional. MIME type of the file as defined by the sender


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

Optional. MIME type of the file as defined by the sender


[View source]
def thumbnail : Tourmaline::PhotoSize | Nil #

Optional. Document thumbnail as defined by the sender


[View source]
def thumbnail=(thumbnail : Tourmaline::PhotoSize | Nil) #

Optional. Document thumbnail as defined by the sender


[View source]