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

Inherits Object.

Description

Represents a user.

Public Fields

int53 id_
 User identifier.
 
string first_name_
 First name of the user.
 
string last_name_
 Last name of the user.
 
string username_
 Username of the user.
 
string phone_number_
 Phone number of the user.
 
object_ptr< UserStatusstatus_
 Current online status of the user.
 
object_ptr< profilePhotoprofile_photo_
 Profile photo of the user; may be null.
 
bool is_contact_
 The user is a contact of the current user.
 
bool is_mutual_contact_
 The user is a contact of the current user and the current user is a contact of the user.
 
bool is_verified_
 True, if the user is verified.
 
bool is_support_
 True, if the user is Telegram support account.
 
string restriction_reason_
 If non-empty, it contains a human-readable description of the reason why access to this user must be restricted.
 
bool is_scam_
 True, if many users reported this user as a scam.
 
bool is_fake_
 True, if many users reported this user as a fake account.
 
bool have_access_
 If false, the user is inaccessible, and the only information known about the user is inside this class. It can't be passed to any method except GetUser.
 
object_ptr< UserTypetype_
 Type of the user.
 
string language_code_
 IETF language tag of the user's language; only available to bots.
 

Public Instance Methods

 user ()
 
 user (int53 id_, string const &first_name_, string const &last_name_, string const &username_, string const &phone_number_, object_ptr< UserStatus > &&status_, object_ptr< profilePhoto > &&profile_photo_, bool is_contact_, bool is_mutual_contact_, bool is_verified_, bool is_support_, string const &restriction_reason_, bool is_scam_, bool is_fake_, bool have_access_, object_ptr< UserType > &&type_, string const &language_code_)
 
std::int32_t get_id () const final
 
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 = -537797015
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ user() [1/2]

user ( )

Represents a user.

◆ user() [2/2]

user ( int53  id_,
string const &  first_name_,
string const &  last_name_,
string const &  username_,
string const &  phone_number_,
object_ptr< UserStatus > &&  status_,
object_ptr< profilePhoto > &&  profile_photo_,
bool  is_contact_,
bool  is_mutual_contact_,
bool  is_verified_,
bool  is_support_,
string const &  restriction_reason_,
bool  is_scam_,
bool  is_fake_,
bool  have_access_,
object_ptr< UserType > &&  type_,
string const &  language_code_ 
)

Represents a user.

Parameters
[in]id_User identifier.
[in]first_name_First name of the user.
[in]last_name_Last name of the user.
[in]username_Username of the user.
[in]phone_number_Phone number of the user.
[in]status_Current online status of the user.
[in]profile_photo_Profile photo of the user; may be null.
[in]is_contact_The user is a contact of the current user.
[in]is_mutual_contact_The user is a contact of the current user and the current user is a contact of the user.
[in]is_verified_True, if the user is verified.
[in]is_support_True, if the user is Telegram support account.
[in]restriction_reason_If non-empty, it contains a human-readable description of the reason why access to this user must be restricted.
[in]is_scam_True, if many users reported this user as a scam.
[in]is_fake_True, if many users reported this user as a fake account.
[in]have_access_If false, the user is inaccessible, and the only information known about the user is inside this class. It can't be passed to any method except GetUser.
[in]type_Type of the user.
[in]language_code_IETF language tag of the user's language; only available to bots.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

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