TDLib
Loading...
Searching...
No Matches
translateMessageText Class Referencefinal

Inherits Function.

Description

Extracts text or caption of the given message and translates it to the given language; must not be used in secret chats. If the current user is a Telegram Premium user, then text formatting is preserved.

Returns object_ptr<FormattedText>.

Public Types

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

Public Member Functions

void store (TlStorerToString &s, const char *field_name) const final
 translateMessageText ()
 translateMessageText (int53 chat_id_, int53 message_id_, string const &to_language_code_, string const &tone_)
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 the message belongs.
int53 message_id_
 Identifier of the message.
string to_language_code_
 Language code of the language to which the message is translated. See translateText.to_language_code for the list of supported values.
string tone_
 Tone of the translation; see translateText.tone for the list of supported values.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ translateMessageText() [1/2]

translateMessageText ( )

Default constructor for a function, which extracts text or caption of the given message and translates it to the given language; must not be used in secret chats. If the current user is a Telegram Premium user, then text formatting is preserved.

Returns object_ptr<FormattedText>.

◆ translateMessageText() [2/2]

translateMessageText ( int53 chat_id_,
int53 message_id_,
string const & to_language_code_,
string const & tone_ )

Creates a function, which extracts text or caption of the given message and translates it to the given language; must not be used in secret chats. If the current user is a Telegram Premium user, then text formatting is preserved.

Returns object_ptr<FormattedText>.

Parameters
[in]chat_id_Identifier of the chat to which the message belongs.
[in]message_id_Identifier of the message.
[in]to_language_code_Language code of the language to which the message is translated. See translateText.to_language_code for the list of supported values.
[in]tone_Tone of the translation; see translateText.tone for the list of supported values.

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]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: