MadelineProto/docs/API_docs/constructors/user.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
title: user
2016-12-20 13:32:11 +01:00
description: user attributes, type and example
2016-12-20 13:15:22 +01:00
---
## Constructor: user
2016-12-20 13:15:22 +01:00
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|:-------------:|---------:|
|self|[Bool](../types/Bool.md) | Optional|
|contact|[Bool](../types/Bool.md) | Optional|
|mutual\_contact|[Bool](../types/Bool.md) | Optional|
|deleted|[Bool](../types/Bool.md) | Optional|
|bot|[Bool](../types/Bool.md) | Optional|
|bot\_chat\_history|[Bool](../types/Bool.md) | Optional|
|bot\_nochats|[Bool](../types/Bool.md) | Optional|
|verified|[Bool](../types/Bool.md) | Optional|
|restricted|[Bool](../types/Bool.md) | Optional|
|min|[Bool](../types/Bool.md) | Optional|
|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional|
|id|[int](../types/int.md) | Required|
|access\_hash|[long](../types/long.md) | Optional|
|first\_name|[string](../types/string.md) | Optional|
|last\_name|[string](../types/string.md) | Optional|
|username|[string](../types/string.md) | Optional|
|phone|[string](../types/string.md) | Optional|
|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional|
|status|[UserStatus](../types/UserStatus.md) | Optional|
|bot\_info\_version|[int](../types/int.md) | Optional|
|restriction\_reason|[string](../types/string.md) | Optional|
|bot\_inline\_placeholder|[string](../types/string.md) | Optional|
2016-12-19 18:56:05 +01:00
### Type: [User](../types/User.md)
### Example:
```
2016-12-30 21:21:36 +01:00
$user = ['_' => 'user', 'self' => true, 'contact' => true, 'mutual_contact' => true, 'deleted' => true, 'bot' => true, 'bot_chat_history' => true, 'bot_nochats' => true, 'verified' => true, 'restricted' => true, 'min' => true, 'bot_inline_geo' => true, '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, ];
```
The following syntaxes can also be used:
```
$user = '@username'; // Username
$user = 44700; // bot API id (users)
$user = -492772765; // bot API id (chats)
$user = -10038575794; // bot API id (channels)
$user = 'user#44700'; // tg-cli style id (users)
$user = 'chat#492772765'; // tg-cli style id (chats)
$user = 'channel#38575794'; // tg-cli style id (channels)
```