editMessageCaption Class Reference

Inherits Function.

Description

Edits the message content caption. Returns the edited message after the edit is completed on the server side.

Returns object_ptr<Message>.

Public Types
using	ReturnType = object_ptr<message>
	Typedef for the type returned by the function.

Public Member Functions
	editMessageCaption ()
	editMessageCaption (int53 chat_id_, int53 message_id_, object_ptr< ReplyMarkup > &&reply_markup_, object_ptr< formattedText > &&caption_, bool show_caption_above_media_)
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
object_ptr< formattedText >	caption_
	New message content caption; 0-getOption("message_caption_length_max") characters; pass null to remove caption.
int53	chat_id_
	The chat the message belongs to.
int53	message_id_
	Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited.
object_ptr< ReplyMarkup >	reply_markup_
	The new message reply markup; pass null if none; for bots only.
bool	show_caption_above_media_
	Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages.

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

Constructor & Destructor Documentation

editMessageCaption() [1/2]

editMessageCaption

(

)

Default constructor for a function, which edits the message content caption. Returns the edited message after the edit is completed on the server side.

Returns object_ptr<Message>.

editMessageCaption() [2/2]

editMessageCaption	(	int53	chat_id_,
		int53	message_id_,
		object_ptr< ReplyMarkup > &&	reply_markup_,
		object_ptr< formattedText > &&	caption_,
		bool	show_caption_above_media_ )

Creates a function, which edits the message content caption. Returns the edited message after the edit is completed on the server side.

Returns object_ptr<Message>.

Parameters

[in]	chat_id_	The chat the message belongs to.
[in]	message_id_	Identifier of the message. Use messageProperties.can_be_edited to check whether the message can be edited.
[in]	reply_markup_	The new message reply markup; pass null if none; for bots only.
[in]	caption_	New message content caption; 0-getOption("message_caption_length_max") characters; pass null to remove caption.
[in]	show_caption_above_media_	Pass true to show the caption above the media; otherwise, the caption will be shown below the media. May be true only for animation, photo, and video messages.

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