List of all members | Public Fields | Public Instance Methods | Static Public Attributes
inputMessagePhoto Class Referencefinal

Inherits InputMessageContent.

Description

A photo message.

Public Fields

object_ptr< InputFilephoto_
 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.
 
object_ptr< inputThumbnailthumbnail_
 Photo thumbnail to be sent; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats.
 
array< int32added_sticker_file_ids_
 File identifiers of the stickers added to the photo, if applicable.
 
int32 width_
 Photo width.
 
int32 height_
 Photo height.
 
object_ptr< formattedTextcaption_
 Photo caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.
 
bool show_caption_above_media_
 True, if the caption must be shown above the photo; otherwise, the caption must be shown below the photo; not supported in secret chats.
 
object_ptr< MessageSelfDestructTypeself_destruct_type_
 Photo self-destruct type; pass null if none; private chats only.
 
bool has_spoiler_
 True, if the photo preview must be covered by a spoiler animation; not supported in secret chats.
 

Public Instance Methods

 inputMessagePhoto ()
 
 inputMessagePhoto (object_ptr< InputFile > &&photo_, object_ptr< inputThumbnail > &&thumbnail_, array< int32 > &&added_sticker_file_ids_, int32 width_, int32 height_, object_ptr< formattedText > &&caption_, bool show_caption_above_media_, object_ptr< MessageSelfDestructType > &&self_destruct_type_, bool has_spoiler_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -810129442
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ inputMessagePhoto() [1/2]

A photo message.

◆ inputMessagePhoto() [2/2]

inputMessagePhoto ( object_ptr< InputFile > &&  photo_,
object_ptr< inputThumbnail > &&  thumbnail_,
array< int32 > &&  added_sticker_file_ids_,
int32  width_,
int32  height_,
object_ptr< formattedText > &&  caption_,
bool  show_caption_above_media_,
object_ptr< MessageSelfDestructType > &&  self_destruct_type_,
bool  has_spoiler_ 
)

A photo message.

Parameters
[in]photo_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.
[in]thumbnail_Photo thumbnail to be sent; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats.
[in]added_sticker_file_ids_File identifiers of the stickers added to the photo, if applicable.
[in]width_Photo width.
[in]height_Photo height.
[in]caption_Photo caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.
[in]show_caption_above_media_True, if the caption must be shown above the photo; otherwise, the caption must be shown below the photo; not supported in secret chats.
[in]self_destruct_type_Photo self-destruct type; pass null if none; private chats only.
[in]has_spoiler_True, if the photo preview must be covered by a spoiler animation; not supported in secret chats.

Method Documentation

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: