TDLib
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
inputMessageAnimation Class Referencefinal

Inherits InputMessageContent.

Description

An animation message (GIF-style).

Public Member Functions

 inputMessageAnimation ()
 
 inputMessageAnimation (object_ptr< inputAnimation > &&animation_, 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 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< inputAnimation > animation_
 The animation to be sent.
 
object_ptr< formattedText > caption_
 Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.
 
bool has_spoiler_
 True, if the animation preview must be covered by a spoiler animation; not supported in secret chats.
 
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.
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ inputMessageAnimation() [1/2]

An animation message (GIF-style).

◆ inputMessageAnimation() [2/2]

inputMessageAnimation ( object_ptr< inputAnimation > &&  animation_,
object_ptr< formattedText > &&  caption_,
bool  show_caption_above_media_,
bool  has_spoiler_ 
)

An animation message (GIF-style).

Parameters
[in]animation_The animation to be sent.
[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 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: