tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::user Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::user:
td::td_api::Object td::TlObject

Public Member Functions

 user ()
 
 user (int53 id_, string const &first_name_, string const &last_name_, object_ptr< usernames > &&usernames_, string const &phone_number_, object_ptr< UserStatus > &&status_, object_ptr< profilePhoto > &&profile_photo_, int32 accent_color_id_, int64 background_custom_emoji_id_, object_ptr< upgradedGiftColors > &&upgraded_gift_colors_, int32 profile_accent_color_id_, int64 profile_background_custom_emoji_id_, object_ptr< emojiStatus > &&emoji_status_, bool is_contact_, bool is_mutual_contact_, bool is_close_friend_, object_ptr< verificationStatus > &&verification_status_, bool is_premium_, bool is_support_, object_ptr< restrictionInfo > &&restriction_info_, object_ptr< ActiveStoryState > &&active_story_state_, bool restricts_new_chats_, int53 paid_message_star_count_, bool have_access_, object_ptr< UserType > &&type_, string const &language_code_, bool added_to_attachment_menu_)
 
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

int53 id_
 User identifier.
 
string first_name_
 First name of the user.
 
string last_name_
 Last name of the user.
 
object_ptr< usernamesusernames_
 Usernames of the user; may be null.
 
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.
 
int32 accent_color_id_
 Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview.
 
int64 background_custom_emoji_id_
 Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none.
 
object_ptr< upgradedGiftColorsupgraded_gift_colors_
 Color scheme based on an upgraded gift to be used for the user instead of accent_color_id and background_custom_emoji_id; may be null if none.
 
int32 profile_accent_color_id_
 Identifier of the accent color for the user&#x27;s profile; -1 if none.
 
int64 profile_background_custom_emoji_id_
 Identifier of a custom emoji to be shown on the background of the user&#x27;s profile; 0 if none.
 
object_ptr< emojiStatusemoji_status_
 Emoji status to be shown instead of the default Telegram Premium badge; 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_close_friend_
 The user is a close friend of the current user; implies that the user is a contact.
 
object_ptr< verificationStatusverification_status_
 Information about verification status of the user; may be null if none.
 
bool is_premium_
 True, if the user is a Telegram Premium user.
 
bool is_support_
 True, if the user is Telegram support account.
 
object_ptr< restrictionInforestriction_info_
 Information about restrictions that must be applied to the corresponding private chat; may be null if none.
 
object_ptr< ActiveStoryStateactive_story_state_
 State of active stories of the user; may be null if the user has no active stories.
 
bool restricts_new_chats_
 True, if the user may restrict new chats with non-contacts. Use canSendMessageToUser to check whether the current user can message the user or try to create a chat with them.
 
int53 paid_message_star_count_
 Number of Telegram Stars that must be paid by general user for each sent message to the user. If positive and userFullInfo is unknown, use canSendMessageToUser to check whether the current user must pay.
 
bool have_access_
 If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can&#x27;t be passed to any method.
 
object_ptr< UserTypetype_
 Type of the user.
 
string language_code_
 IETF language tag of the user&#x27;s language; only available to bots.
 
bool added_to_attachment_menu_
 True, if the user added the current bot to attachment menu; only available to bots.
 

Static Public Attributes

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

Detailed Description

Represents a user.

Definition at line 84709 of file td_api.h.

Constructor & Destructor Documentation

◆ user() [1/2]

td::td_api::user::user ( )

Represents a user.

◆ user() [2/2]

td::td_api::user::user ( int53  id_,
string const &  first_name_,
string const &  last_name_,
object_ptr< usernames > &&  usernames_,
string const &  phone_number_,
object_ptr< UserStatus > &&  status_,
object_ptr< profilePhoto > &&  profile_photo_,
int32  accent_color_id_,
int64  background_custom_emoji_id_,
object_ptr< upgradedGiftColors > &&  upgraded_gift_colors_,
int32  profile_accent_color_id_,
int64  profile_background_custom_emoji_id_,
object_ptr< emojiStatus > &&  emoji_status_,
bool  is_contact_,
bool  is_mutual_contact_,
bool  is_close_friend_,
object_ptr< verificationStatus > &&  verification_status_,
bool  is_premium_,
bool  is_support_,
object_ptr< restrictionInfo > &&  restriction_info_,
object_ptr< ActiveStoryState > &&  active_story_state_,
bool  restricts_new_chats_,
int53  paid_message_star_count_,
bool  have_access_,
object_ptr< UserType > &&  type_,
string const &  language_code_,
bool  added_to_attachment_menu_ 
)

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]usernames_Usernames of the user; may be null.
[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]accent_color_id_Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview.
[in]background_custom_emoji_id_Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none.
[in]upgraded_gift_colors_Color scheme based on an upgraded gift to be used for the user instead of accent_color_id and background_custom_emoji_id; may be null if none.
[in]profile_accent_color_id_Identifier of the accent color for the user&#x27;s profile; -1 if none.
[in]profile_background_custom_emoji_id_Identifier of a custom emoji to be shown on the background of the user&#x27;s profile; 0 if none.
[in]emoji_status_Emoji status to be shown instead of the default Telegram Premium badge; 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_close_friend_The user is a close friend of the current user; implies that the user is a contact.
[in]verification_status_Information about verification status of the user; may be null if none.
[in]is_premium_True, if the user is a Telegram Premium user.
[in]is_support_True, if the user is Telegram support account.
[in]restriction_info_Information about restrictions that must be applied to the corresponding private chat; may be null if none.
[in]active_story_state_State of active stories of the user; may be null if the user has no active stories.
[in]restricts_new_chats_True, if the user may restrict new chats with non-contacts. Use canSendMessageToUser to check whether the current user can message the user or try to create a chat with them.
[in]paid_message_star_count_Number of Telegram Stars that must be paid by general user for each sent message to the user. If positive and userFullInfo is unknown, use canSendMessageToUser to check whether the current user must pay.
[in]have_access_If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can&#x27;t be passed to any method.
[in]type_Type of the user.
[in]language_code_IETF language tag of the user&#x27;s language; only available to bots.
[in]added_to_attachment_menu_True, if the user added the current bot to attachment menu; only available to bots.

Member Function Documentation

◆ store()

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

Member Data Documentation

◆ accent_color_id_

int32 td::td_api::user::accent_color_id_

Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview.

Definition at line 84734 of file td_api.h.

◆ active_story_state_

object_ptr<ActiveStoryState> td::td_api::user::active_story_state_

State of active stories of the user; may be null if the user has no active stories.

Definition at line 84760 of file td_api.h.

◆ added_to_attachment_menu_

bool td::td_api::user::added_to_attachment_menu_

True, if the user added the current bot to attachment menu; only available to bots.

Definition at line 84772 of file td_api.h.

◆ background_custom_emoji_id_

int64 td::td_api::user::background_custom_emoji_id_

Identifier of a custom emoji to be shown on the reply header and link preview background; 0 if none.

Definition at line 84736 of file td_api.h.

◆ emoji_status_

object_ptr<emojiStatus> td::td_api::user::emoji_status_

Emoji status to be shown instead of the default Telegram Premium badge; may be null.

Definition at line 84744 of file td_api.h.

◆ first_name_

string td::td_api::user::first_name_

First name of the user.

Definition at line 84722 of file td_api.h.

◆ have_access_

bool td::td_api::user::have_access_

If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can&#x27;t be passed to any method.

Definition at line 84766 of file td_api.h.

◆ ID

const std::int32_t td::td_api::user::ID = 1874921182
static

Identifier uniquely determining a type of the object.

Definition at line 84813 of file td_api.h.

◆ id_

int53 td::td_api::user::id_

User identifier.

Definition at line 84720 of file td_api.h.

◆ is_close_friend_

bool td::td_api::user::is_close_friend_

The user is a close friend of the current user; implies that the user is a contact.

Definition at line 84750 of file td_api.h.

◆ is_contact_

bool td::td_api::user::is_contact_

The user is a contact of the current user.

Definition at line 84746 of file td_api.h.

◆ is_mutual_contact_

bool td::td_api::user::is_mutual_contact_

The user is a contact of the current user and the current user is a contact of the user.

Definition at line 84748 of file td_api.h.

◆ is_premium_

bool td::td_api::user::is_premium_

True, if the user is a Telegram Premium user.

Definition at line 84754 of file td_api.h.

◆ is_support_

bool td::td_api::user::is_support_

True, if the user is Telegram support account.

Definition at line 84756 of file td_api.h.

◆ language_code_

string td::td_api::user::language_code_

IETF language tag of the user&#x27;s language; only available to bots.

Definition at line 84770 of file td_api.h.

◆ last_name_

string td::td_api::user::last_name_

Last name of the user.

Definition at line 84724 of file td_api.h.

◆ paid_message_star_count_

int53 td::td_api::user::paid_message_star_count_

Number of Telegram Stars that must be paid by general user for each sent message to the user. If positive and userFullInfo is unknown, use canSendMessageToUser to check whether the current user must pay.

Definition at line 84764 of file td_api.h.

◆ phone_number_

string td::td_api::user::phone_number_

Phone number of the user.

Definition at line 84728 of file td_api.h.

◆ profile_accent_color_id_

int32 td::td_api::user::profile_accent_color_id_

Identifier of the accent color for the user&#x27;s profile; -1 if none.

Definition at line 84740 of file td_api.h.

◆ profile_background_custom_emoji_id_

int64 td::td_api::user::profile_background_custom_emoji_id_

Identifier of a custom emoji to be shown on the background of the user&#x27;s profile; 0 if none.

Definition at line 84742 of file td_api.h.

◆ profile_photo_

object_ptr<profilePhoto> td::td_api::user::profile_photo_

Profile photo of the user; may be null.

Definition at line 84732 of file td_api.h.

◆ restriction_info_

object_ptr<restrictionInfo> td::td_api::user::restriction_info_

Information about restrictions that must be applied to the corresponding private chat; may be null if none.

Definition at line 84758 of file td_api.h.

◆ restricts_new_chats_

bool td::td_api::user::restricts_new_chats_

True, if the user may restrict new chats with non-contacts. Use canSendMessageToUser to check whether the current user can message the user or try to create a chat with them.

Definition at line 84762 of file td_api.h.

◆ status_

object_ptr<UserStatus> td::td_api::user::status_

Current online status of the user.

Definition at line 84730 of file td_api.h.

◆ type_

object_ptr<UserType> td::td_api::user::type_

Type of the user.

Definition at line 84768 of file td_api.h.

◆ upgraded_gift_colors_

object_ptr<upgradedGiftColors> td::td_api::user::upgraded_gift_colors_

Color scheme based on an upgraded gift to be used for the user instead of accent_color_id and background_custom_emoji_id; may be null if none.

Definition at line 84738 of file td_api.h.

◆ usernames_

object_ptr<usernames> td::td_api::user::usernames_

Usernames of the user; may be null.

Definition at line 84726 of file td_api.h.

◆ verification_status_

object_ptr<verificationStatus> td::td_api::user::verification_status_

Information about verification status of the user; may be null if none.

Definition at line 84752 of file td_api.h.


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