TDLib
Loading...
Searching...
No Matches
inputMessagePhoto Class Referencefinal

Inherits InputMessageContent.

Description

A photo message.

Public Member Functions

 inputMessagePhoto ()
 inputMessagePhoto (object_ptr< inputPhoto > &&photo_, 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 Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

object_ptr< formattedText > caption_
 Photo caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.
bool has_spoiler_
 True, if the photo preview must be covered by a spoiler animation; not supported in secret chats.
object_ptr< inputPhoto > photo_
 Photo to be sent.
object_ptr< MessageSelfDestructType > self_destruct_type_
 Photo self-destruct type; pass null if none; private chats only.
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.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ inputMessagePhoto() [1/2]

inputMessagePhoto ( )

A photo message.

◆ inputMessagePhoto() [2/2]

inputMessagePhoto ( object_ptr< inputPhoto > && photo_,
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 be sent.
[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.

Member Function 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: