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

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

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

Public Member Functions

 messageCopyOptions ()
 
 messageCopyOptions (bool send_copy_, bool replace_caption_, object_ptr< formattedText > &&new_caption_, bool new_show_caption_above_media_)
 
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

bool send_copy_
 True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.
 
bool replace_caption_
 True, if media caption of the message copy needs to be replaced. Ignored if send_copy is false.
 
object_ptr< formattedTextnew_caption_
 New message caption; pass null to copy message without caption. Ignored if replace_caption is false.
 
bool new_show_caption_above_media_
 True, if new caption must be shown above the media; otherwise, new caption must be shown below the media; not supported in secret chats. Ignored if replace_caption is false.
 

Static Public Attributes

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

Detailed Description

Options to be used when a message content is copied without reference to the original sender. Service messages, messages with messageInvoice, messagePaidMedia, messageGiveaway, or messageGiveawayWinners content can&#x27;t be copied.

Definition at line 43344 of file td_api.h.

Constructor & Destructor Documentation

◆ messageCopyOptions() [1/2]

td::td_api::messageCopyOptions::messageCopyOptions ( )

Options to be used when a message content is copied without reference to the original sender. Service messages, messages with messageInvoice, messagePaidMedia, messageGiveaway, or messageGiveawayWinners content can&#x27;t be copied.

◆ messageCopyOptions() [2/2]

td::td_api::messageCopyOptions::messageCopyOptions ( bool  send_copy_,
bool  replace_caption_,
object_ptr< formattedText > &&  new_caption_,
bool  new_show_caption_above_media_ 
)

Options to be used when a message content is copied without reference to the original sender. Service messages, messages with messageInvoice, messagePaidMedia, messageGiveaway, or messageGiveawayWinners content can&#x27;t be copied.

Parameters
[in]send_copy_True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.
[in]replace_caption_True, if media caption of the message copy needs to be replaced. Ignored if send_copy is false.
[in]new_caption_New message caption; pass null to copy message without caption. Ignored if replace_caption is false.
[in]new_show_caption_above_media_True, if new caption must be shown above the media; otherwise, new caption must be shown below the media; not supported in secret chats. Ignored if replace_caption is false.

Member Function Documentation

◆ store()

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

◆ ID

const std::int32_t td::td_api::messageCopyOptions::ID = 1079772090
static

Identifier uniquely determining a type of the object.

Definition at line 43379 of file td_api.h.

◆ new_caption_

object_ptr<formattedText> td::td_api::messageCopyOptions::new_caption_

New message caption; pass null to copy message without caption. Ignored if replace_caption is false.

Definition at line 43359 of file td_api.h.

◆ new_show_caption_above_media_

bool td::td_api::messageCopyOptions::new_show_caption_above_media_

True, if new caption must be shown above the media; otherwise, new caption must be shown below the media; not supported in secret chats. Ignored if replace_caption is false.

Definition at line 43361 of file td_api.h.

◆ replace_caption_

bool td::td_api::messageCopyOptions::replace_caption_

True, if media caption of the message copy needs to be replaced. Ignored if send_copy is false.

Definition at line 43357 of file td_api.h.

◆ send_copy_

bool td::td_api::messageCopyOptions::send_copy_

True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.

Definition at line 43355 of file td_api.h.


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