TDLib
Loading...
Searching...
No Matches
td::td_api::error Class Referencefinal

Inherits td::td_api::Object.

Public Member Functions

 error ()
 
 error (int32 code_, string const &message_)
 
std::int32_t get_id () const final
 
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

int32 code_
 Error code; subject to future changes. If the error code is 406, the error message must not be processed in any way and must not be displayed to the user.
 
string message_
 Error message; subject to future changes.
 

Static Public Attributes

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

Detailed Description

An object of this type can be returned on every function call, in case of an error.

Constructor & Destructor Documentation

◆ error() [1/2]

td::td_api::error::error ( )

An object of this type can be returned on every function call, in case of an error.

◆ error() [2/2]

td::td_api::error::error ( int32  code_,
string const &  message_ 
)

An object of this type can be returned on every function call, in case of an error.

Parameters
[in]code_Error code; subject to future changes. If the error code is 406, the error message must not be processed in any way and must not be displayed to the user.
[in]message_Error message; subject to future changes.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::error::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

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


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