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

Inherits InputMessageContent.

Description

A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed.

Public Member Functions

 inputMessagePaidMedia ()
 inputMessagePaidMedia (int53 star_count_, array< object_ptr< inputPaidMedia > > &&paid_media_, object_ptr< formattedText > &&caption_, bool show_caption_above_media_, string const &payload_)
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_
 Message caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters.
array< object_ptr< inputPaidMedia > > paid_media_
 The content of the paid media.
string payload_
 Bot-provided data for the paid media; bots only.
bool show_caption_above_media_
 True, if the caption must be shown above the media; otherwise, the caption must be shown below the media; not supported in secret chats.
int53 star_count_
 The number of Telegram Stars that must be paid to see the media; 1-getOption("paid_media_message_star_count_max").

Static Public Attributes

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

Constructor & Destructor Documentation

◆ inputMessagePaidMedia() [1/2]

inputMessagePaidMedia ( )

A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed.

◆ inputMessagePaidMedia() [2/2]

inputMessagePaidMedia ( int53 star_count_,
array< object_ptr< inputPaidMedia > > && paid_media_,
object_ptr< formattedText > && caption_,
bool show_caption_above_media_,
string const & payload_ )

A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed.

Parameters
[in]star_count_The number of Telegram Stars that must be paid to see the media; 1-getOption("paid_media_message_star_count_max").
[in]paid_media_The content of the paid media.
[in]caption_Message 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 media; otherwise, the caption must be shown below the media; not supported in secret chats.
[in]payload_Bot-provided data for the paid media; bots only.

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: