List of all members | Public Fields | Public Instance Methods | Static Public Attributes
sponsoredMessage Class Referencefinal

Inherits Object.

Description

Describes a sponsored message.

Public Fields

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.
 
object_ptr< messageSponsorsponsor_
 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.
 

Public Instance Methods

 sponsoredMessage ()
 
 sponsoredMessage (int53 message_id_, bool is_recommended_, bool can_be_reported_, object_ptr< MessageContent > &&content_, object_ptr< messageSponsor > &&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 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 = -1215476699
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ sponsoredMessage() [1/2]

Describes a sponsored message.

◆ sponsoredMessage() [2/2]

sponsoredMessage ( int53  message_id_,
bool  is_recommended_,
bool  can_be_reported_,
object_ptr< MessageContent > &&  content_,
object_ptr< messageSponsor > &&  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.
[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.

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: