List of all members | Public Fields | Public Instance Methods | Static Public Attributes
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 Fields

int53 star_count_
 The number of stars that must be paid to see the media; 1-getOption("paid_media_message_star_count_max").
 
array< object_ptr< inputPaidMedia > > paid_media_
 The content of the paid media.
 
object_ptr< formattedTextcaption_
 Message 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 video; otherwise, the caption must be shown below the video; not supported in secret chats.
 

Public Instance Methods

 inputMessagePaidMedia ()
 
 inputMessagePaidMedia (int53 star_count_, array< object_ptr< inputPaidMedia >> &&paid_media_, object_ptr< formattedText > &&caption_, bool show_caption_above_media_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ inputMessagePaidMedia() [1/2]

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_ 
)

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 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 video; otherwise, the caption must be shown below the video; not supported in secret chats.

Method 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: