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::inputMessageAnimation Class Referencefinal

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

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

Public Member Functions

 inputMessageAnimation ()
 
 inputMessageAnimation (object_ptr< InputFile > &&animation_, object_ptr< inputThumbnail > &&thumbnail_, array< int32 > &&added_sticker_file_ids_, int32 duration_, int32 width_, int32 height_, object_ptr< formattedText > &&caption_, bool show_caption_above_media_, 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< InputFileanimation_
 Animation file to be sent.
 
object_ptr< inputThumbnailthumbnail_
 Animation thumbnail; pass null to skip thumbnail uploading.
 
array< int32added_sticker_file_ids_
 File identifiers of the stickers added to the animation, if applicable.
 
int32 duration_
 Duration of the animation, in seconds.
 
int32 width_
 Width of the animation; may be replaced by the server.
 
int32 height_
 Height of the animation; may be replaced by the server.
 
object_ptr< formattedTextcaption_
 Animation 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 animation; otherwise, the caption must be shown below the animation; not supported in secret chats.
 
bool has_spoiler_
 True, if the animation preview must be covered by a spoiler animation; not supported in secret chats.
 

Static Public Attributes

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

Detailed Description

An animation message (GIF-style).

Definition at line 29025 of file td_api.h.

Constructor & Destructor Documentation

◆ inputMessageAnimation() [1/2]

td::td_api::inputMessageAnimation::inputMessageAnimation ( )

An animation message (GIF-style).

◆ inputMessageAnimation() [2/2]

td::td_api::inputMessageAnimation::inputMessageAnimation ( object_ptr< InputFile > &&  animation_,
object_ptr< inputThumbnail > &&  thumbnail_,
array< int32 > &&  added_sticker_file_ids_,
int32  duration_,
int32  width_,
int32  height_,
object_ptr< formattedText > &&  caption_,
bool  show_caption_above_media_,
bool  has_spoiler_ 
)

An animation message (GIF-style).

Parameters
[in]animation_Animation file to be sent.
[in]thumbnail_Animation thumbnail; pass null to skip thumbnail uploading.
[in]added_sticker_file_ids_File identifiers of the stickers added to the animation, if applicable.
[in]duration_Duration of the animation, in seconds.
[in]width_Width of the animation; may be replaced by the server.
[in]height_Height of the animation; may be replaced by the server.
[in]caption_Animation 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 animation; otherwise, the caption must be shown below the animation; not supported in secret chats.
[in]has_spoiler_True, if the animation preview must be covered by a spoiler animation; not supported in secret chats.

Member Function Documentation

◆ store()

void td::td_api::inputMessageAnimation::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::inputMessageAnimation::added_sticker_file_ids_

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

Definition at line 29040 of file td_api.h.

◆ animation_

object_ptr<InputFile> td::td_api::inputMessageAnimation::animation_

Animation file to be sent.

Definition at line 29036 of file td_api.h.

◆ caption_

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

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

Definition at line 29048 of file td_api.h.

◆ duration_

int32 td::td_api::inputMessageAnimation::duration_

Duration of the animation, in seconds.

Definition at line 29042 of file td_api.h.

◆ has_spoiler_

bool td::td_api::inputMessageAnimation::has_spoiler_

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

Definition at line 29052 of file td_api.h.

◆ height_

int32 td::td_api::inputMessageAnimation::height_

Height of the animation; may be replaced by the server.

Definition at line 29046 of file td_api.h.

◆ ID

const std::int32_t td::td_api::inputMessageAnimation::ID = -210404059
static

Identifier uniquely determining a type of the object.

Definition at line 29075 of file td_api.h.

◆ show_caption_above_media_

bool td::td_api::inputMessageAnimation::show_caption_above_media_

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

Definition at line 29050 of file td_api.h.

◆ thumbnail_

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

Animation thumbnail; pass null to skip thumbnail uploading.

Definition at line 29038 of file td_api.h.

◆ width_

int32 td::td_api::inputMessageAnimation::width_

Width of the animation; may be replaced by the server.

Definition at line 29044 of file td_api.h.


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