tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::inputMessagePhoto Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::inputMessagePhoto:
td::td_api::InputMessageContent td::td_api::Object td::TlObject

Public Member Functions

 inputMessagePhoto ()
 
 inputMessagePhoto (object_ptr< InputFile > &&photo_, object_ptr< inputThumbnail > &&thumbnail_, object_ptr< InputFile > &&video_, 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 Member Functions inherited from td::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
 

Public Attributes

object_ptr< InputFilephoto_
 Photo to send. The photo must be at most 10 MB in size. The photo&#x27;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.
 
object_ptr< InputFilevideo_
 Video of the live photo; not supported in secret chats; pass null if the photo isn&#x27;t a live photo.
 
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.
 

Static Public Attributes

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

Detailed Description

A photo message.

Definition at line 29241 of file td_api.h.

Constructor & Destructor Documentation

◆ inputMessagePhoto() [1/2]

td::td_api::inputMessagePhoto::inputMessagePhoto ( )

A photo message.

◆ inputMessagePhoto() [2/2]

td::td_api::inputMessagePhoto::inputMessagePhoto ( object_ptr< InputFile > &&  photo_,
object_ptr< inputThumbnail > &&  thumbnail_,
object_ptr< InputFile > &&  video_,
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&#x27;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]video_Video of the live photo; not supported in secret chats; pass null if the photo isn&#x27;t a live photo.
[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.

Member Function Documentation

◆ store()

void td::td_api::inputMessagePhoto::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 td::TlObject.

Member Data Documentation

◆ added_sticker_file_ids_

array<int32> td::td_api::inputMessagePhoto::added_sticker_file_ids_

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

Definition at line 29258 of file td_api.h.

◆ caption_

object_ptr<formattedText> td::td_api::inputMessagePhoto::caption_

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

Definition at line 29264 of file td_api.h.

◆ has_spoiler_

bool td::td_api::inputMessagePhoto::has_spoiler_

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

Definition at line 29270 of file td_api.h.

◆ height_

int32 td::td_api::inputMessagePhoto::height_

Photo height.

Definition at line 29262 of file td_api.h.

◆ ID

const std::int32_t td::td_api::inputMessagePhoto::ID = 163591772
static

Identifier uniquely determining a type of the object.

Definition at line 29294 of file td_api.h.

◆ photo_

object_ptr<InputFile> td::td_api::inputMessagePhoto::photo_

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

Definition at line 29252 of file td_api.h.

◆ self_destruct_type_

object_ptr<MessageSelfDestructType> td::td_api::inputMessagePhoto::self_destruct_type_

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

Definition at line 29268 of file td_api.h.

◆ show_caption_above_media_

bool td::td_api::inputMessagePhoto::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.

Definition at line 29266 of file td_api.h.

◆ thumbnail_

object_ptr<inputThumbnail> td::td_api::inputMessagePhoto::thumbnail_

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

Definition at line 29254 of file td_api.h.

◆ video_

object_ptr<InputFile> td::td_api::inputMessagePhoto::video_

Video of the live photo; not supported in secret chats; pass null if the photo isn&#x27;t a live photo.

Definition at line 29256 of file td_api.h.

◆ width_

int32 td::td_api::inputMessagePhoto::width_

Photo width.

Definition at line 29260 of file td_api.h.


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