forwardMessages Class Reference

Inherits Function.

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't be forwarded, null will be returned instead of the message.

Returns object_ptr<Messages>.

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 TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int53	chat_id_
	Identifier of the chat to which to forward messages.
int53	from_chat_id_
	Identifier of the chat from which to forward messages.
array< int53 >	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.
object_ptr< messageSendOptions >	options_
	Options to be used to send the messages; pass null to use default options.
bool	remove_caption_
	Pass true to remove media captions of message copies. Ignored if send_copy is false.
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.
object_ptr< MessageTopic >	topic_id_
	Topic in which the messages will be forwarded; message threads aren't supported; pass null if none.

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

Constructor & Destructor Documentation

forwardMessages() [1/2]

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't be forwarded, null will be returned instead of the message.

Returns object_ptr<Messages>.

forwardMessages() [2/2]

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'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'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 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h