Class: TD::Types::InputMessageContent::Photo

Inherits:
TD::Types::InputMessageContent show all
Defined in:
lib/tdlib/types/input_message_content/photo.rb

Overview

A photo message.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#added_sticker_file_ids ⇒ Array<Integer>

File identifiers of the stickers added to the photo, if applicable.

Returns:

  • (Array<Integer>) —

    the current value of added_sticker_file_ids



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def added_sticker_file_ids
  @added_sticker_file_ids
end

#caption ⇒ TD::Types::FormattedText

Photo caption; pass null to use an empty caption; 0-getOption(“message_caption_length_max”) characters.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def caption
  @caption
end

#has_spoiler ⇒ Boolean

True, if the photo preview must be covered by a spoiler animation; not supported in secret chats.

Returns:

  • (Boolean) —

    the current value of has_spoiler



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def has_spoiler
  @has_spoiler
end

#height ⇒ Integer

Photo height.

Returns:

  • (Integer) —

    the current value of height



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def height
  @height
end

#photo ⇒ TD::Types::InputFile

Photo to send. The photo must be at most 10 MB in size. The photo’s width and height must not exceed 10000 in total. Width and height ratio must be at most 20.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def photo
  @photo
end

#self_destruct_type ⇒ TD::Types::MessageSelfDestructType

Photo self-destruct type; pass null if none; private chats only.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def self_destruct_type
  @self_destruct_type
end

#show_caption_above_media ⇒ Boolean

True, if the caption must be shown above the photo; otherwise, the caption must be shown below the photo; not supported in secret chats.

Returns:

  • (Boolean) —

    the current value of show_caption_above_media



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def show_caption_above_media
  @show_caption_above_media
end

#thumbnail ⇒ TD::Types::InputThumbnail

Photo thumbnail to be sent; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def thumbnail
  @thumbnail
end

#width ⇒ Integer

Photo width.

Returns:

  • (Integer) —

    the current value of width



21
22
23
 
# File 'lib/tdlib/types/input_message_content/photo.rb', line 21

def width
  @width
end