class Hamilton::Types::InputMediaPhoto

Overview

Represents a photo to be sent.

Included Modules

Hamilton::Types::Common
JSON::Serializable

Defined in:

types/input_media.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 photo to be sent, 0-1024 characters after entities parsing.
#caption=(caption : String | Nil)
Caption of the photo 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.
#has_spoiler : Bool | Nil
Pass True if the photo needs to be covered with a spoiler animation.
#has_spoiler=(has_spoiler : Bool | Nil)
Pass True if the photo needs to be covered with a spoiler animation.
#media : Hamilton::Types::InputFile | String
File to send.
#media=(media : Hamilton::Types::InputFile | String)
File to send.
#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 photo caption.
#parse_mode=(parse_mode : String | Nil)
Mode for parsing entities in the photo caption.
#show_caption_above_media : Bool | Nil
Pass True, if the caption must be shown above the message media.
#show_caption_above_media=(show_caption_above_media : Bool | Nil)
Pass True, if the caption must be shown above the message media.
#type : String
Type of the result, must be "photo".
#type=(type : String)
Type of the result, must be "photo".

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 photo to be sent, 0-1024 characters after entities parsing.

def caption=(caption : String | Nil) #

Caption of the photo 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 has_spoiler : Bool | Nil #

Pass True if the photo needs to be covered with a spoiler animation.

def has_spoiler=(has_spoiler : Bool | Nil) #

Pass True if the photo needs to be covered with a spoiler animation.

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) #

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

def parse_mode=(parse_mode : String | Nil) #

Mode for parsing entities in the photo caption.

def show_caption_above_media : Bool | Nil #

Pass True, if the caption must be shown above the message media.

def show_caption_above_media=(show_caption_above_media : Bool | Nil) #

Pass True, if the caption must be shown above the message media.

def type : String #

Type of the result, must be "photo".

def type=(type : String) #