class Hamilton::Types::InlineQueryResultCachedDocument

Hamilton::Types::InlineQueryResultCachedDocument
Reference
Object

Overview

Represents a link to a file stored on the Telegram servers. 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.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/inline_query_result.cr

Constructors

.new(pull : JSON::PullParser)
.new(params)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)
.new(**params)

Instance Method Summary

#caption : String | Nil
Caption of the document to be sent, 0-1024 characters after entities parsing.
#caption=(caption : String | Nil)
Caption of the document to be sent, 0-1024 characters after entities parsing.
#caption_entities : Array(Hamilton::Types::MessageEntity) | Nil
List of special entities that appear in the caption, which can be specified instead of #parse_mode.
#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.
#description : String | Nil
Short description of the result
#description=(description : String | Nil)
Short description of the result
#document_file_id : String
A valid file identifier for the file.
#document_file_id=(document_file_id : String)
A valid file identifier for the file.
#id : String
Unique identifier for this result, 1-64 Bytes.
#id=(id : String)
Unique identifier for this result, 1-64 Bytes.
#input_message_content : Hamilton::Types::InputMessageContent | Nil
Content of the message to be sent instead of the file.
#input_message_content=(input_message_content : Hamilton::Types::InputMessageContent | Nil)
Content of the message to be sent instead of the file.
#non_nil_fields : Array(String)
List of available non-nil fields.
#non_nil_fields=(non_nil_fields : Array(String))
List of available non-nil fields.
#parse_mode : String | Nil
Mode for parsing entities in the document caption.
#parse_mode=(parse_mode : String | Nil)
Mode for parsing entities in the document caption.
#reply_markup : Hamilton::Types::InlineKeyboardMarkup | Nil
Inline keyboard attached to the message.
#reply_markup=(reply_markup : Hamilton::Types::InlineKeyboardMarkup | Nil)
Inline keyboard attached to the message.
#title : String
Title for the result.
#title=(title : String)
Title for the result.
#type : String
Type of the result, must be "document".
#type=(type : String)
Type of the result, must be "document".

Instance methods inherited from class `Reference`

Instance methods inherited from class `Object`

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_file_id : String #

A valid file identifier for the file.

def document_file_id=(document_file_id : String) #

A valid file identifier 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 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 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) #