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

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

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

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

int53 star_count_
 The number of Telegram 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 media; otherwise, the caption must be shown below the media; not supported in secret chats.
 
string payload_
 Bot-provided data for the paid media; bots only.
 

Static Public Attributes

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

Detailed Description

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

Definition at line 29190 of file td_api.h.

Constructor & Destructor Documentation

◆ inputMessagePaidMedia() [1/2]

td::td_api::inputMessagePaidMedia::inputMessagePaidMedia ( )

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

◆ inputMessagePaidMedia() [2/2]

td::td_api::inputMessagePaidMedia::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 td::td_api::inputMessagePaidMedia::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

◆ caption_

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

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

Definition at line 29205 of file td_api.h.

◆ ID

const std::int32_t td::td_api::inputMessagePaidMedia::ID = -1274819374
static

Identifier uniquely determining a type of the object.

Definition at line 29228 of file td_api.h.

◆ paid_media_

array<object_ptr<inputPaidMedia> > td::td_api::inputMessagePaidMedia::paid_media_

The content of the paid media.

Definition at line 29203 of file td_api.h.

◆ payload_

string td::td_api::inputMessagePaidMedia::payload_

Bot-provided data for the paid media; bots only.

Definition at line 29209 of file td_api.h.

◆ show_caption_above_media_

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

Definition at line 29207 of file td_api.h.

◆ star_count_

int53 td::td_api::inputMessagePaidMedia::star_count_

The number of Telegram Stars that must be paid to see the media; 1-getOption("paid_media_message_star_count_max").

Definition at line 29201 of file td_api.h.


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