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

Inherits Function.

Description

Edits the caption of a message sent on behalf of a business account; for bots only.

Returns object_ptr<BusinessMessage>.

Public Fields

string business_connection_id_
 Unique identifier of business connection on behalf of which the message was sent.
 
int53 chat_id_
 The chat the message belongs to.
 
int53 message_id_
 Identifier of the message.
 
object_ptr< ReplyMarkupreply_markup_
 The new message reply markup; pass null if none.
 
object_ptr< formattedTextcaption_
 New message content caption; pass null to remove caption; 0-getOption("message_caption_length_max") characters.
 
bool show_caption_above_media_
 Pass true to show the caption above the media; otherwise, the caption will be shown below the media. Can be true only for animation, photo, and video messages.
 

Public Types

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

Public Instance Methods

 editBusinessMessageCaption ()
 
 editBusinessMessageCaption (string const &business_connection_id_, 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 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 = -1071562045
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ editBusinessMessageCaption() [1/2]

Default constructor for a function, which edits the caption of a message sent on behalf of a business account; for bots only.

Returns object_ptr<BusinessMessage>.

◆ editBusinessMessageCaption() [2/2]

editBusinessMessageCaption ( string const &  business_connection_id_,
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 caption of a message sent on behalf of a business account; for bots only.

Returns object_ptr<BusinessMessage>.

Parameters
[in]business_connection_id_Unique identifier of business connection on behalf of which the message was sent.
[in]chat_id_The chat the message belongs to.
[in]message_id_Identifier of the message.
[in]reply_markup_The new message reply markup; pass null if none.
[in]caption_New message content caption; pass null to remove caption; 0-getOption("message_caption_length_max") characters.
[in]show_caption_above_media_Pass true to show the caption above the media; otherwise, the caption will be shown below the media. Can be true only for animation, photo, and video messages.

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: