MadelineProto/docs/TD_docs/constructors/user.md
Daniil Gentili 9d77dc0919 AMP fixes
2017-08-20 09:05:56 +00:00

2.9 KiB

title description
user Represents user

Constructor: user

Back to constructors index

Represents user

Attributes:

Name Type Required Description
id int Yes User identifier
first_name string Yes User first name
last_name string Yes User last name
username string Yes User username
phone_number string Yes User's phone number
status UserStatus Yes User's online status
profile_photo profilePhoto Yes User profile photo, nullable
my_link LinkState Yes Relationships from me to other user
foreign_link LinkState Yes Relationships from other user to me
is_verified Bool Yes True, if user is verified
restriction_reason string Yes If non-empty, contains the reason, why access to this user must be restricted. Format of the string is "{type}: {description}". -{type} contains type of the restriction and at least one of the suffixes "-all", "-ios", "-android", "-wp", which describes platforms on which access should be restricted. For example, "terms-ios-android". {description} contains human-readable description of the restriction, which can be showed to the user
have_access Bool Yes If false, the user is inaccessible and the only known information about it is inside this class. It can't be passed to any method except GetUser. Currently it can be false only for inaccessible authors of the channel posts
type UserType Yes Type of the user

Type: User

Example:

$user = ['_' => 'user', 'id' => int, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string', 'phone_number' => 'string', 'status' => UserStatus, 'profile_photo' => profilePhoto, 'my_link' => LinkState, 'foreign_link' => LinkState, 'is_verified' => Bool, 'restriction_reason' => 'string', 'have_access' => Bool, 'type' => UserType];

PWRTelegram json-encoded version:

{"_": "user", "id": int, "first_name": "string", "last_name": "string", "username": "string", "phone_number": "string", "status": UserStatus, "profile_photo": profilePhoto, "my_link": LinkState, "foreign_link": LinkState, "is_verified": Bool, "restriction_reason": "string", "have_access": Bool, "type": UserType}

Or, if you're into Lua:

user={_='user', id=int, first_name='string', last_name='string', username='string', phone_number='string', status=UserStatus, profile_photo=profilePhoto, my_link=LinkState, foreign_link=LinkState, is_verified=Bool, restriction_reason='string', have_access=Bool, type=UserType}