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

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

Inheritance diagram for td::td_api::sponsoredMessage:
td::td_api::Object td::TlObject

Public Member Functions

 sponsoredMessage ()
 
 sponsoredMessage (int53 message_id_, bool is_recommended_, bool can_be_reported_, object_ptr< MessageContent > &&content_, object_ptr< advertisementSponsor > &&sponsor_, string const &title_, string const &button_text_, int32 accent_color_id_, int64 background_custom_emoji_id_, string const &additional_info_)
 
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 message_id_
 Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages.
 
bool is_recommended_
 True, if the message needs to be labeled as "recommended" instead of "sponsored".
 
bool can_be_reported_
 True, if the message can be reported to Telegram moderators through reportChatSponsoredMessage.
 
object_ptr< MessageContentcontent_
 Content of the message. Currently, can be only of the types messageText, messageAnimation, messagePhoto, or messageVideo. Video messages can be viewed fullscreen. The content must be fully downloaded before the message is shown.
 
object_ptr< advertisementSponsorsponsor_
 Information about the sponsor of the message.
 
string title_
 Title of the sponsored message.
 
string button_text_
 Text for the message action button.
 
int32 accent_color_id_
 Identifier of the accent color for title, button text and message background.
 
int64 background_custom_emoji_id_
 Identifier of a custom emoji to be shown on the message background; 0 if none.
 
string additional_info_
 If non-empty, additional information about the sponsored message to be shown along with the message.
 

Static Public Attributes

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

Detailed Description

Describes a sponsored message.

Definition at line 64120 of file td_api.h.

Constructor & Destructor Documentation

◆ sponsoredMessage() [1/2]

td::td_api::sponsoredMessage::sponsoredMessage ( )

Describes a sponsored message.

◆ sponsoredMessage() [2/2]

td::td_api::sponsoredMessage::sponsoredMessage ( int53  message_id_,
bool  is_recommended_,
bool  can_be_reported_,
object_ptr< MessageContent > &&  content_,
object_ptr< advertisementSponsor > &&  sponsor_,
string const &  title_,
string const &  button_text_,
int32  accent_color_id_,
int64  background_custom_emoji_id_,
string const &  additional_info_ 
)

Describes a sponsored message.

Parameters
[in]message_id_Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages.
[in]is_recommended_True, if the message needs to be labeled as "recommended" instead of "sponsored".
[in]can_be_reported_True, if the message can be reported to Telegram moderators through reportChatSponsoredMessage.
[in]content_Content of the message. Currently, can be only of the types messageText, messageAnimation, messagePhoto, or messageVideo. Video messages can be viewed fullscreen. The content must be fully downloaded before the message is shown.
[in]sponsor_Information about the sponsor of the message.
[in]title_Title of the sponsored message.
[in]button_text_Text for the message action button.
[in]accent_color_id_Identifier of the accent color for title, button text and message background.
[in]background_custom_emoji_id_Identifier of a custom emoji to be shown on the message background; 0 if none.
[in]additional_info_If non-empty, additional information about the sponsored message to be shown along with the message.

Member Function Documentation

◆ store()

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

◆ accent_color_id_

int32 td::td_api::sponsoredMessage::accent_color_id_

Identifier of the accent color for title, button text and message background.

Definition at line 64145 of file td_api.h.

◆ additional_info_

string td::td_api::sponsoredMessage::additional_info_

If non-empty, additional information about the sponsored message to be shown along with the message.

Definition at line 64149 of file td_api.h.

◆ background_custom_emoji_id_

int64 td::td_api::sponsoredMessage::background_custom_emoji_id_

Identifier of a custom emoji to be shown on the message background; 0 if none.

Definition at line 64147 of file td_api.h.

◆ button_text_

string td::td_api::sponsoredMessage::button_text_

Text for the message action button.

Definition at line 64143 of file td_api.h.

◆ can_be_reported_

bool td::td_api::sponsoredMessage::can_be_reported_

True, if the message can be reported to Telegram moderators through reportChatSponsoredMessage.

Definition at line 64135 of file td_api.h.

◆ content_

object_ptr<MessageContent> td::td_api::sponsoredMessage::content_

Content of the message. Currently, can be only of the types messageText, messageAnimation, messagePhoto, or messageVideo. Video messages can be viewed fullscreen. The content must be fully downloaded before the message is shown.

Definition at line 64137 of file td_api.h.

◆ ID

const std::int32_t td::td_api::sponsoredMessage::ID = 1521782216
static

Identifier uniquely determining a type of the object.

Definition at line 64173 of file td_api.h.

◆ is_recommended_

bool td::td_api::sponsoredMessage::is_recommended_

True, if the message needs to be labeled as "recommended" instead of "sponsored".

Definition at line 64133 of file td_api.h.

◆ message_id_

int53 td::td_api::sponsoredMessage::message_id_

Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages.

Definition at line 64131 of file td_api.h.

◆ sponsor_

object_ptr<advertisementSponsor> td::td_api::sponsoredMessage::sponsor_

Information about the sponsor of the message.

Definition at line 64139 of file td_api.h.

◆ title_

string td::td_api::sponsoredMessage::title_

Title of the sponsored message.

Definition at line 64141 of file td_api.h.


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