user Class Referencefinal
Inherits Object.
Description
Represents a user.
Public Member Functions | |
| void | store (TlStorerToString &s, const char *field_name) const final |
| 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_) | |
| 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 | |
| int32 | accent_color_id_ |
| Identifier of the accent color for name, and backgrounds of profile photo, reply header, and link preview. | |
| object_ptr< ActiveStoryState > | active_story_state_ |
| State of active stories of the user; may be null if the user has no active stories. | |
| bool | added_to_attachment_menu_ |
| True, if the user added the current bot to attachment menu; only available to bots. | |
| 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< emojiStatus > | emoji_status_ |
| Emoji status to be shown instead of the default Telegram Premium badge; may be null. | |
| string | first_name_ |
| First name of the user. | |
| 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't be passed to any method. | |
| int53 | id_ |
| User identifier. | |
| bool | is_close_friend_ |
| The user is a close friend of the current user; implies that the user is a contact. | |
| 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_premium_ |
| True, if the user is a Telegram Premium user. | |
| bool | is_support_ |
| True, if the user is Telegram support account. | |
| string | language_code_ |
| IETF language tag of the user's language; only available to bots. | |
| string | last_name_ |
| Last name of the user. | |
| 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. | |
| string | phone_number_ |
| Phone number of the user. | |
| int32 | profile_accent_color_id_ |
| Identifier of the accent color for the user'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's profile; 0 if none. | |
| object_ptr< profilePhoto > | profile_photo_ |
| Profile photo of the user; may be null. | |
| object_ptr< restrictionInfo > | restriction_info_ |
| Information about restrictions that must be applied to the corresponding private chat; may be null if none. | |
| 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. | |
| object_ptr< UserStatus > | status_ |
| Current online status of the user. | |
| object_ptr< UserType > | type_ |
| Type of the user. | |
| object_ptr< upgradedGiftColors > | 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. | |
| object_ptr< usernames > | usernames_ |
| Usernames of the user; may be null. | |
| object_ptr< verificationStatus > | verification_status_ |
| Information about verification status of the user; may be null if none. | |
Static Public Attributes | |
| static const std::int32_t | ID = 1874921182 |
| 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_, | ||
| 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'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'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't be passed to any method. [in] type_ Type of the user. [in] language_code_ IETF language tag of the user'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()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h
Generated by
1.17.0