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

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

Inheritance diagram for td::td_api::forwardMessages:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< messages >
 Typedef for the type returned by the function.
 

Public Member Functions

 forwardMessages ()
 
 forwardMessages (int53 chat_id_, object_ptr< MessageTopic > &&topic_id_, int53 from_chat_id_, array< int53 > &&message_ids_, object_ptr< messageSendOptions > &&options_, bool send_copy_, bool remove_caption_)
 
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 chat_id_
 Identifier of the chat to which to forward messages.
 
object_ptr< MessageTopictopic_id_
 Topic in which the messages will be forwarded; message threads aren&#x27;t supported; pass null if none.
 
int53 from_chat_id_
 Identifier of the chat from which to forward messages.
 
array< int53message_ids_
 Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously. A message can be forwarded only if messageProperties.can_be_forwarded.
 
object_ptr< messageSendOptionsoptions_
 Options to be used to send the messages; pass null to use default options.
 
bool send_copy_
 Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.
 
bool remove_caption_
 Pass true to remove media captions of message copies. Ignored if send_copy is false.
 

Static Public Attributes

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

Detailed Description

Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can&#x27;t be forwarded, null will be returned instead of the message.

Returns object_ptr<Messages>.

Definition at line 99698 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 99749 of file td_api.h.

Constructor & Destructor Documentation

◆ forwardMessages() [1/2]

td::td_api::forwardMessages::forwardMessages ( )

Default constructor for a function, which forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can&#x27;t be forwarded, null will be returned instead of the message.

Returns object_ptr<Messages>.

◆ forwardMessages() [2/2]

td::td_api::forwardMessages::forwardMessages ( int53  chat_id_,
object_ptr< MessageTopic > &&  topic_id_,
int53  from_chat_id_,
array< int53 > &&  message_ids_,
object_ptr< messageSendOptions > &&  options_,
bool  send_copy_,
bool  remove_caption_ 
)

Creates a function, which forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can&#x27;t be forwarded, null will be returned instead of the message.

Returns object_ptr<Messages>.

Parameters
[in]chat_id_Identifier of the chat to which to forward messages.
[in]topic_id_Topic in which the messages will be forwarded; message threads aren&#x27;t supported; pass null if none.
[in]from_chat_id_Identifier of the chat from which to forward messages.
[in]message_ids_Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously. A message can be forwarded only if messageProperties.can_be_forwarded.
[in]options_Options to be used to send the messages; pass null to use default options.
[in]send_copy_Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.
[in]remove_caption_Pass true to remove media captions of message copies. Ignored if send_copy is false.

Member Function Documentation

◆ store()

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

◆ chat_id_

int53 td::td_api::forwardMessages::chat_id_

Identifier of the chat to which to forward messages.

Definition at line 99709 of file td_api.h.

◆ from_chat_id_

int53 td::td_api::forwardMessages::from_chat_id_

Identifier of the chat from which to forward messages.

Definition at line 99713 of file td_api.h.

◆ ID

const std::int32_t td::td_api::forwardMessages::ID = -247889118
static

Identifier uniquely determining a type of the object.

Definition at line 99746 of file td_api.h.

◆ message_ids_

array<int53> td::td_api::forwardMessages::message_ids_

Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously. A message can be forwarded only if messageProperties.can_be_forwarded.

Definition at line 99715 of file td_api.h.

◆ options_

object_ptr<messageSendOptions> td::td_api::forwardMessages::options_

Options to be used to send the messages; pass null to use default options.

Definition at line 99717 of file td_api.h.

◆ remove_caption_

bool td::td_api::forwardMessages::remove_caption_

Pass true to remove media captions of message copies. Ignored if send_copy is false.

Definition at line 99721 of file td_api.h.

◆ send_copy_

bool td::td_api::forwardMessages::send_copy_

Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local. Use messageProperties.can_be_copied and messageProperties.can_be_copied_to_secret_chat to check whether the message is suitable.

Definition at line 99719 of file td_api.h.

◆ topic_id_

object_ptr<MessageTopic> td::td_api::forwardMessages::topic_id_

Topic in which the messages will be forwarded; message threads aren&#x27;t supported; pass null if none.

Definition at line 99711 of file td_api.h.


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