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

Inherits Object.

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't be copied.

Public Fields

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

Public Instance Methods

 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 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 = 1079772090
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ messageCopyOptions() [1/2]

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't be copied.

◆ messageCopyOptions() [2/2]

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'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_saved 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.

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: