class Hamilton::Types::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.

Included Modules

Defined in:

types/inline_query_result.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 description : String | Nil #

Short description of the result.


def description=(description : String | Nil) #

Short description of the result.


def document_url : String #

A valid URL for the file.


def document_url=(document_url : String) #

A valid URL for the file.


def id : String #

Unique identifier for this result, 1-64 Bytes.


def id=(id : String) #

Unique identifier for this result, 1-64 Bytes.


def input_message_content : Hamilton::Types::InputMessageContent | Nil #

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


def input_message_content=(input_message_content : Hamilton::Types::InputMessageContent | Nil) #

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


def mime_type : String #

MIME type of the content of the file, either “application/pdf” or “application/zip”.


def mime_type=(mime_type : String) #

MIME type of the content of the file, either “application/pdf” or “application/zip”.


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. See formatting options for more details.


def parse_mode=(parse_mode : String | Nil) #

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


def reply_markup : Hamilton::Types::InlineKeyboardMarkup | Nil #

Inline keyboard attached to the message.


def reply_markup=(reply_markup : Hamilton::Types::InlineKeyboardMarkup | Nil) #

Inline keyboard attached to the message.


def thumbnail_height : Int32 | Nil #

Thumbnail height.


def thumbnail_height=(thumbnail_height : Int32 | Nil) #

Thumbnail height.


def thumbnail_url : String | Nil #

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


def thumbnail_url=(thumbnail_url : String | Nil) #

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


def thumbnail_width : Int32 | Nil #

Thumbnail width.


def thumbnail_width=(thumbnail_width : Int32 | Nil) #

Thumbnail width.


def title : String #

Title for the result.


def title=(title : String) #

Title for the result.


def type : String #

Type of the result, must be "document".


def type=(type : String) #

Type of the result, must be "document".