MadelineProtoDocs/old_docs/API_docs_v62/constructors/user.md

60 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: user
2019-12-27 17:48:04 +01:00
description: Indicates info about a certain user
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Constructor: user
2018-04-01 13:19:25 +02:00
[Back to constructors index](index.md)
2019-12-27 17:48:04 +01:00
Indicates info about a certain user
2018-12-26 02:56:50 +01:00
2018-04-01 13:19:25 +02:00
### Attributes:
2018-12-26 02:56:50 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|self|[Bool](../types/Bool.md) | Optional|Whether this user indicates the currently logged in user|
|contact|[Bool](../types/Bool.md) | Optional|Whether this user is a contact|
|mutual\_contact|[Bool](../types/Bool.md) | Optional|Whether this user is a mutual contact|
|deleted|[Bool](../types/Bool.md) | Optional|Whether the account of this user was deleted|
|bot|[Bool](../types/Bool.md) | Optional|Is this user a bot?|
|bot\_chat\_history|[Bool](../types/Bool.md) | Optional|Can the bot see all messages in groups?|
|bot\_nochats|[Bool](../types/Bool.md) | Optional|Can the bot be added to groups?|
|verified|[Bool](../types/Bool.md) | Optional|Whether this user is verified|
|restricted|[Bool](../types/Bool.md) | Optional|Access to this user must be restricted for the reason specified in `restriction_reason`|
|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)|
|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional|Whether the bot can request our geolocation in inline mode|
|id|[int](../types/int.md) | Yes|ID of the user|
|access\_hash|[long](../types/long.md) | Optional|Access hash of the user|
2018-12-26 02:56:50 +01:00
|first\_name|[string](../types/string.md) | Optional|First name|
|last\_name|[string](../types/string.md) | Optional|Last name|
|username|[string](../types/string.md) | Optional|Username|
2019-12-27 17:48:04 +01:00
|phone|[string](../types/string.md) | Optional|Phone number|
|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional|Profile picture of user|
|status|[UserStatus](../types/UserStatus.md) | Optional|Online status of user|
|bot\_info\_version|[int](../types/int.md) | Optional|Version of the [bot\_info field in userFull](../constructors/userFull.md), incremented every time it changes|
2018-12-26 02:56:50 +01:00
|restriction\_reason|[string](../types/string.md) | Optional|Restriction reason|
2019-12-27 17:48:04 +01:00
|bot\_inline\_placeholder|[string](../types/string.md) | Optional|Inline placeholder for this inline bot|
2018-04-01 13:19:25 +02:00
### Type: [User](../types/User.md)
### Example:
```php
2018-04-01 13:24:46 +02:00
$user = ['_' => 'user', 'self' => Bool, 'contact' => Bool, 'mutual_contact' => Bool, 'deleted' => Bool, 'bot' => Bool, 'bot_chat_history' => Bool, 'bot_nochats' => Bool, 'verified' => Bool, 'restricted' => Bool, 'min' => Bool, 'bot_inline_geo' => Bool, 'id' => int, 'access_hash' => long, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string', 'phone' => 'string', 'photo' => UserProfilePhoto, 'status' => UserStatus, 'bot_info_version' => int, 'restriction_reason' => 'string', 'bot_inline_placeholder' => 'string'];
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
2018-04-01 13:19:25 +02:00
```lua
2018-04-01 13:24:46 +02:00
user={_='user', self=Bool, contact=Bool, mutual_contact=Bool, deleted=Bool, bot=Bool, bot_chat_history=Bool, bot_nochats=Bool, verified=Bool, restricted=Bool, min=Bool, bot_inline_geo=Bool, id=int, access_hash=long, first_name='string', last_name='string', username='string', phone='string', photo=UserProfilePhoto, status=UserStatus, bot_info_version=int, restriction_reason='string', bot_inline_placeholder='string'}
2018-04-01 13:19:25 +02:00
```