danog/MadelineProtoDocs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update schema

Browse Source
This commit is contained in:
Daniil Gentili 2020-09-12 12:47:38 +02:00
parent 86f8d410ea
commit b8ee95c143
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
4287 changed files with 111304 additions and 4223 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/API_docs/constructors/channelFull.md
View File

@ -18,9 +18,9 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we set the channel's username?|
|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can we [associate](../methods/channels.setStickers.md) a stickerpack to the supergroup?|
|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Is the history before we joined hidden to us?|
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user view [channel statistics](https://core.telegram.org/api/stats) for this channel|
|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can we set the geolocation of this group (for geogroups)|
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available|
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user view [channel statistics](https://core.telegram.org/api/stats) for this channel|
|id|[int](../types/int.md) | Yes|ID of the channel|
|about|[string](../types/string.md) | Yes|Info about the channel|
|participants\_count|[int](../types/int.md) | Optional|Number of participants of the channel|
@ -56,14 +56,14 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
### Example:
```php
$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'can_view_stats' => Bool, 'can_set_location' => Bool, 'has_scheduled' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'online_count' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'migrated_from_chat_id' => int, 'migrated_from_max_id' => int, 'pinned_msg_id' => int, 'stickerset' => StickerSet, 'available_min_id' => int, 'folder_id' => int, 'linked_chat_id' => int, 'location' => ChannelLocation, 'slowmode_seconds' => int, 'slowmode_next_send_date' => int, 'stats_dc' => int, 'pts' => int];
$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'can_set_location' => Bool, 'has_scheduled' => Bool, 'can_view_stats' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'online_count' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'migrated_from_chat_id' => int, 'migrated_from_max_id' => int, 'pinned_msg_id' => int, 'stickerset' => StickerSet, 'available_min_id' => int, 'folder_id' => int, 'linked_chat_id' => int, 'location' => ChannelLocation, 'slowmode_seconds' => int, 'slowmode_next_send_date' => int, 'stats_dc' => int, 'pts' => int];
```
Or, if you're into Lua:
```lua
channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, can_view_stats=Bool, can_set_location=Bool, has_scheduled=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, online_count=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=int, pinned_msg_id=int, stickerset=StickerSet, available_min_id=int, folder_id=int, linked_chat_id=int, location=ChannelLocation, slowmode_seconds=int, slowmode_next_send_date=int, stats_dc=int, pts=int}
channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, can_set_location=Bool, has_scheduled=Bool, can_view_stats=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, online_count=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=int, pinned_msg_id=int, stickerset=StickerSet, available_min_id=int, folder_id=int, linked_chat_id=int, location=ChannelLocation, slowmode_seconds=int, slowmode_next_send_date=int, stats_dc=int, pts=int}
```

37
docs/API_docs/constructors/chatInvitePeek.md Normal file
View File

@ -0,0 +1,37 @@
---
title: chatInvitePeek
description: chatInvitePeek attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: chatInvitePeek
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|chat|[Chat](../types/Chat.md) | Optional|
|expires|[int](../types/int.md) | Yes|
### Type: [ChatInvite](../types/ChatInvite.md)
### Example:
```php
$chatInvitePeek = ['_' => 'chatInvitePeek', 'chat' => Chat, 'expires' => int];
```
Or, if you're into Lua:
```lua
chatInvitePeek={_='chatInvitePeek', chat=Chat, expires=int}
```

5
docs/API_docs/constructors/chatPhoto.md
View File

@ -14,6 +14,7 @@ Group profile photo.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|has\_video|[Bool](../types/Bool.md) | Optional|
|photo\_small|[FileLocation](../types/FileLocation.md) | Yes|Location of the file corresponding to the small thumbnail for group profile photo|
|photo\_big|[FileLocation](../types/FileLocation.md) | Yes|Location of the file corresponding to the small thumbnail for group profile photo|
|dc\_id|[int](../types/int.md) | Yes|DC where this photo is stored|
@ -26,14 +27,14 @@ Group profile photo.
### Example:
```php
$chatPhoto = ['_' => 'chatPhoto', 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int];
$chatPhoto = ['_' => 'chatPhoto', 'has_video' => Bool, 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int];
```
Or, if you're into Lua:
```lua
chatPhoto={_='chatPhoto', photo_small=FileLocation, photo_big=FileLocation, dc_id=int}
chatPhoto={_='chatPhoto', has_video=Bool, photo_small=FileLocation, photo_big=FileLocation, dc_id=int}
```

5
docs/API_docs/constructors/document.md
View File

@ -21,6 +21,7 @@ Document
|mime\_type|[string](../types/string.md) | Yes|MIME type|
|size|[int](../types/int.md) | Yes|Size|
|thumbs|Array of [PhotoSize](../types/PhotoSize.md) | Optional|Thumbnails|
|video\_thumbs|Array of [VideoSize](../types/VideoSize.md) | Optional|
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes|
@ -32,14 +33,14 @@ Document
### Example:
```php
$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumbs' => [PhotoSize, PhotoSize], 'dc_id' => int, 'attributes' => [DocumentAttribute, DocumentAttribute]];
$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumbs' => [PhotoSize, PhotoSize], 'video_thumbs' => [VideoSize, VideoSize], 'dc_id' => int, 'attributes' => [DocumentAttribute, DocumentAttribute]];
```
Or, if you're into Lua:
```lua
document={_='document', id=long, access_hash=long, file_reference='bytes', date=int, mime_type='string', size=int, thumbs={PhotoSize}, dc_id=int, attributes={DocumentAttribute}}
document={_='document', id=long, access_hash=long, file_reference='bytes', date=int, mime_type='string', size=int, thumbs={PhotoSize}, video_thumbs={VideoSize}, dc_id=int, attributes={DocumentAttribute}}
```

5
docs/API_docs/constructors/encryptedChatRequested.md
View File

@ -14,6 +14,7 @@ Request to create an encrypted chat.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|folder\_id|[int](../types/int.md) | Optional|
|id|[int](../types/int.md) | Yes|Chat ID|
|access\_hash|[long](../types/long.md) | Yes|Check sum depending on user ID|
|date|[int](../types/int.md) | Yes|Chat creation date|
@ -29,14 +30,14 @@ Request to create an encrypted chat.
### Example:
```php
$encryptedChatRequested = ['_' => 'encryptedChatRequested', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a' => 'bytes'];
$encryptedChatRequested = ['_' => 'encryptedChatRequested', 'folder_id' => int, 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a' => 'bytes'];
```
Or, if you're into Lua:
```lua
encryptedChatRequested={_='encryptedChatRequested', id=int, access_hash=long, date=int, admin_id=int, participant_id=int, g_a='bytes'}
encryptedChatRequested={_='encryptedChatRequested', folder_id=int, id=int, access_hash=long, date=int, admin_id=int, participant_id=int, g_a='bytes'}
```

36
docs/API_docs/constructors/globalPrivacySettings.md Normal file
View File

@ -0,0 +1,36 @@
---
title: globalPrivacySettings
description: globalPrivacySettings attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: globalPrivacySettings
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|archive\_and\_mute\_new\_noncontact\_peers|[Bool](../types/Bool.md) | Optional|
### Type: [GlobalPrivacySettings](../types/GlobalPrivacySettings.md)
### Example:
```php
$globalPrivacySettings = ['_' => 'globalPrivacySettings', 'archive_and_mute_new_noncontact_peers' => Bool];
```
Or, if you're into Lua:
```lua
globalPrivacySettings={_='globalPrivacySettings', archive_and_mute_new_noncontact_peers=Bool}
```

66
docs/API_docs/constructors/index.md
View File

@ -241,7 +241,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$channelForbidden](../constructors/channelForbidden.md) = \['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'until_date' => [int](../types/int.md), \];<a name="channelForbidden"></a>
***
<br><br>[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'can_set_stickers' => [Bool](../types/Bool.md), 'hidden_prehistory' => [Bool](../types/Bool.md), 'can_view_stats' => [Bool](../types/Bool.md), 'can_set_location' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants_count' => [int](../types/int.md), 'admins_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'online_count' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], 'migrated_from_chat_id' => [int](../types/int.md), 'migrated_from_max_id' => [int](../types/int.md), 'pinned_msg_id' => [int](../types/int.md), 'stickerset' => [StickerSet](../types/StickerSet.md), 'available_min_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), 'linked_chat_id' => [int](../types/int.md), 'location' => [ChannelLocation](../types/ChannelLocation.md), 'slowmode_seconds' => [int](../types/int.md), 'slowmode_next_send_date' => [int](../types/int.md), 'stats_dc' => [int](../types/int.md), 'pts' => [int](../types/int.md), \];<a name="channelFull"></a>
<br><br>[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'can_set_stickers' => [Bool](../types/Bool.md), 'hidden_prehistory' => [Bool](../types/Bool.md), 'can_set_location' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'can_view_stats' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants_count' => [int](../types/int.md), 'admins_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'online_count' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], 'migrated_from_chat_id' => [int](../types/int.md), 'migrated_from_max_id' => [int](../types/int.md), 'pinned_msg_id' => [int](../types/int.md), 'stickerset' => [StickerSet](../types/StickerSet.md), 'available_min_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), 'linked_chat_id' => [int](../types/int.md), 'location' => [ChannelLocation](../types/ChannelLocation.md), 'slowmode_seconds' => [int](../types/int.md), 'slowmode_next_send_date' => [int](../types/int.md), 'stats_dc' => [int](../types/int.md), 'pts' => [int](../types/int.md), \];<a name="channelFull"></a>
***
<br><br>[$channelLocation](../constructors/channelLocation.md) = \['geo_point' => [GeoPoint](../types/GeoPoint.md), 'address' => [string](../types/string.md), \];<a name="channelLocation"></a>
@ -333,6 +333,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$chatInviteExported](../constructors/chatInviteExported.md) = \['link' => [string](../types/string.md), \];<a name="chatInviteExported"></a>
***
<br><br>[$chatInvitePeek](../constructors/chatInvitePeek.md) = \['chat' => [Chat](../types/Chat.md), 'expires' => [int](../types/int.md), \];<a name="chatInvitePeek"></a>
***
<br><br>[$chatOnlines](../constructors/chatOnlines.md) = \['onlines' => [int](../types/int.md), \];<a name="chatOnlines"></a>
@ -352,7 +355,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$chatParticipantsForbidden](../constructors/chatParticipantsForbidden.md) = \['chat_id' => [int](../types/int.md), 'self_participant' => [ChatParticipant](../types/ChatParticipant.md), \];<a name="chatParticipantsForbidden"></a>
***
<br><br>[$chatPhoto](../constructors/chatPhoto.md) = \['photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), 'dc_id' => [int](../types/int.md), \];<a name="chatPhoto"></a>
<br><br>[$chatPhoto](../constructors/chatPhoto.md) = \['has_video' => [Bool](../types/Bool.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), 'dc_id' => [int](../types/int.md), \];<a name="chatPhoto"></a>
***
<br><br>[$chatPhotoEmpty](../constructors/chatPhotoEmpty.md) = \[\];<a name="chatPhotoEmpty"></a>
@ -505,7 +508,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$dialogPeerFolder](../constructors/dialogPeerFolder.md) = \['folder_id' => [int](../types/int.md), \];<a name="dialogPeerFolder"></a>
***
<br><br>[$document](../constructors/document.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumbs' => \[[PhotoSize](../types/PhotoSize.md)\], 'dc_id' => [int](../types/int.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \];<a name="document"></a>
<br><br>[$document](../constructors/document.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumbs' => \[[PhotoSize](../types/PhotoSize.md)\], 'video_thumbs' => \[[VideoSize](../types/VideoSize.md)\], 'dc_id' => [int](../types/int.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \];<a name="document"></a>
***
<br><br>[$documentAttributeAnimated](../constructors/documentAttributeAnimated.md) = \[\];<a name="documentAttributeAnimated"></a>
@ -562,7 +565,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$encryptedChatEmpty](../constructors/encryptedChatEmpty.md) = \['id' => [int](../types/int.md), \];<a name="encryptedChatEmpty"></a>
***
<br><br>[$encryptedChatRequested](../constructors/encryptedChatRequested.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a' => [bytes](../types/bytes.md), \];<a name="encryptedChatRequested"></a>
<br><br>[$encryptedChatRequested](../constructors/encryptedChatRequested.md) = \['folder_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a' => [bytes](../types/bytes.md), \];<a name="encryptedChatRequested"></a>
***
<br><br>[$encryptedChatWaiting](../constructors/encryptedChatWaiting.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), \];<a name="encryptedChatWaiting"></a>
@ -603,12 +606,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$folderPeer](../constructors/folderPeer.md) = \['peer' => [Peer](../types/Peer.md), 'folder_id' => [int](../types/int.md), \];<a name="folderPeer"></a>
***
<br><br>[$foundGif](../constructors/foundGif.md) = \['url' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'content_url' => [string](../types/string.md), 'content_type' => [string](../types/string.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \];<a name="foundGif"></a>
***
<br><br>[$foundGifCached](../constructors/foundGifCached.md) = \['url' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), \];<a name="foundGifCached"></a>
***
<br><br>[$game](../constructors/game.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'short_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), \];<a name="game"></a>
@ -618,6 +615,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$geoPointEmpty](../constructors/geoPointEmpty.md) = \[\];<a name="geoPointEmpty"></a>
***
<br><br>[$globalPrivacySettings](../constructors/globalPrivacySettings.md) = \['archive_and_mute_new_noncontact_peers' => [Bool](../types/Bool.md), \];<a name="globalPrivacySettings"></a>
***
<br><br>[$help.appUpdate](../constructors/help.appUpdate.md) = \['can_not_skip' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'version' => [string](../types/string.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'document' => [Document](../types/Document.md), 'url' => [string](../types/string.md), \];<a name="help.appUpdate"></a>
@ -730,7 +730,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$inputChatPhotoEmpty](../constructors/inputChatPhotoEmpty.md) = \[\];<a name="inputChatPhotoEmpty"></a>
***
<br><br>[$inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), \];<a name="inputChatUploadedPhoto"></a>
<br><br>[$inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'video' => [InputFile](../types/InputFile.md), 'video_start_ts' => [double](../types/double.md), \];<a name="inputChatUploadedPhoto"></a>
***
<br><br>[$inputCheckPasswordEmpty](../constructors/inputCheckPasswordEmpty.md) = \[\];<a name="inputCheckPasswordEmpty"></a>
@ -825,9 +825,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$inputMediaGeoPoint](../constructors/inputMediaGeoPoint.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \];<a name="inputMediaGeoPoint"></a>
***
<br><br>[$inputMediaGifExternal](../constructors/inputMediaGifExternal.md) = \['url' => [string](../types/string.md), 'q' => [string](../types/string.md), \];<a name="inputMediaGifExternal"></a>
***
<br><br>[$inputMediaInvoice](../constructors/inputMediaInvoice.md) = \['title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [InputWebDocument](../types/InputWebDocument.md), 'invoice' => [Invoice](../types/Invoice.md), 'payload' => [bytes](../types/bytes.md), 'provider' => [string](../types/string.md), 'provider_data' => [DataJSON](../types/DataJSON.md), 'start_param' => [string](../types/string.md), \];<a name="inputMediaInvoice"></a>
@ -841,7 +838,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'correct_answers' => \[[bytes](../types/bytes.md)\], 'solution' => [string](../types/string.md), 'solution_entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];<a name="inputMediaPoll"></a>
***
<br><br>[$inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) = \['nosound_video' => [Bool](../types/Bool.md), 'file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaUploadedDocument"></a>
<br><br>[$inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) = \['nosound_video' => [Bool](../types/Bool.md), 'force_file' => [Bool](../types/Bool.md), 'file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaUploadedDocument"></a>
***
<br><br>[$inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaUploadedPhoto"></a>
@ -1458,9 +1455,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) = \['count' => [int](../types/int.md), \];<a name="messages.featuredStickersNotModified"></a>
***
<br><br>[$messages.foundGifs](../constructors/messages.foundGifs.md) = \['next_offset' => [int](../types/int.md), 'results' => \[[FoundGif](../types/FoundGif.md)\], \];<a name="messages.foundGifs"></a>
***
<br><br>[$messages.foundStickerSets](../constructors/messages.foundStickerSets.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \];<a name="messages.foundStickerSets"></a>
@ -1711,7 +1705,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$peerSelfLocated](../constructors/peerSelfLocated.md) = \['expires' => [int](../types/int.md), \];<a name="peerSelfLocated"></a>
***
<br><br>[$peerSettings](../constructors/peerSettings.md) = \['report_spam' => [Bool](../types/Bool.md), 'add_contact' => [Bool](../types/Bool.md), 'block_contact' => [Bool](../types/Bool.md), 'share_contact' => [Bool](../types/Bool.md), 'need_contacts_exception' => [Bool](../types/Bool.md), 'report_geo' => [Bool](../types/Bool.md), \];<a name="peerSettings"></a>
<br><br>[$peerSettings](../constructors/peerSettings.md) = \['report_spam' => [Bool](../types/Bool.md), 'add_contact' => [Bool](../types/Bool.md), 'block_contact' => [Bool](../types/Bool.md), 'share_contact' => [Bool](../types/Bool.md), 'need_contacts_exception' => [Bool](../types/Bool.md), 'report_geo' => [Bool](../types/Bool.md), 'autoarchived' => [Bool](../types/Bool.md), 'geo_distance' => [int](../types/int.md), \];<a name="peerSettings"></a>
***
<br><br>[$peerUser](../constructors/peerUser.md) = \['user_id' => [int](../types/int.md), \];<a name="peerUser"></a>
@ -1720,7 +1714,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$phone.phoneCall](../constructors/phone.phoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), 'users' => \[[User](../types/User.md)\], \];<a name="phone.phoneCall"></a>
***
<br><br>[$phoneCall](../constructors/phoneCall.md) = \['p2p_allowed' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a_or_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), 'connections' => \[[PhoneConnection](../types/PhoneConnection.md)\], 'start_date' => [int](../types/int.md), \];<a name="phoneCall"></a>
<br><br>[$phoneCall](../constructors/phoneCall.md) = \['p2p_allowed' => [Bool](../types/Bool.md), 'video' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a_or_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), 'connections' => \[[PhoneConnection](../types/PhoneConnection.md)\], 'start_date' => [int](../types/int.md), \];<a name="phoneCall"></a>
***
<br><br>[$phoneCallAccepted](../constructors/phoneCallAccepted.md) = \['video' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_b' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \];<a name="phoneCallAccepted"></a>
@ -1756,7 +1750,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$phoneConnection](../constructors/phoneConnection.md) = \['id' => [long](../types/long.md), 'ip' => [string](../types/string.md), 'ipv6' => [string](../types/string.md), 'port' => [int](../types/int.md), 'peer_tag' => [bytes](../types/bytes.md), \];<a name="phoneConnection"></a>
***
<br><br>[$photo](../constructors/photo.md) = \['has_stickers' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], 'dc_id' => [int](../types/int.md), \];<a name="photo"></a>
<br><br>[$phoneConnectionWebrtc](../constructors/phoneConnectionWebrtc.md) = \['turn' => [Bool](../types/Bool.md), 'stun' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'ip' => [string](../types/string.md), 'ipv6' => [string](../types/string.md), 'port' => [int](../types/int.md), 'username' => [string](../types/string.md), 'password' => [string](../types/string.md), \];<a name="phoneConnectionWebrtc"></a>
***
<br><br>[$photo](../constructors/photo.md) = \['has_stickers' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], 'video_sizes' => \[[VideoSize](../types/VideoSize.md)\], 'dc_id' => [int](../types/int.md), \];<a name="photo"></a>
***
<br><br>[$photoCachedSize](../constructors/photoCachedSize.md) = \['type' => [string](../types/string.md), 'location' => [FileLocation](../types/FileLocation.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \];<a name="photoCachedSize"></a>
@ -2037,6 +2034,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$stats.broadcastStats](../constructors/stats.broadcastStats.md) = \['period' => [StatsDateRangeDays](../types/StatsDateRangeDays.md), 'followers' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'views_per_post' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'shares_per_post' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'enabled_notifications' => [StatsPercentValue](../types/StatsPercentValue.md), 'growth_graph' => [StatsGraph](../types/StatsGraph.md), 'followers_graph' => [StatsGraph](../types/StatsGraph.md), 'mute_graph' => [StatsGraph](../types/StatsGraph.md), 'top_hours_graph' => [StatsGraph](../types/StatsGraph.md), 'interactions_graph' => [StatsGraph](../types/StatsGraph.md), 'iv_interactions_graph' => [StatsGraph](../types/StatsGraph.md), 'views_by_source_graph' => [StatsGraph](../types/StatsGraph.md), 'new_followers_by_source_graph' => [StatsGraph](../types/StatsGraph.md), 'languages_graph' => [StatsGraph](../types/StatsGraph.md), 'recent_message_interactions' => \[[MessageInteractionCounters](../types/MessageInteractionCounters.md)\], \];<a name="stats.broadcastStats"></a>
***
<br><br>[$stats.megagroupStats](../constructors/stats.megagroupStats.md) = \['period' => [StatsDateRangeDays](../types/StatsDateRangeDays.md), 'members' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'messages' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'viewers' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'posters' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'growth_graph' => [StatsGraph](../types/StatsGraph.md), 'members_graph' => [StatsGraph](../types/StatsGraph.md), 'new_members_by_source_graph' => [StatsGraph](../types/StatsGraph.md), 'languages_graph' => [StatsGraph](../types/StatsGraph.md), 'messages_graph' => [StatsGraph](../types/StatsGraph.md), 'actions_graph' => [StatsGraph](../types/StatsGraph.md), 'top_hours_graph' => [StatsGraph](../types/StatsGraph.md), 'weekdays_graph' => [StatsGraph](../types/StatsGraph.md), 'top_posters' => \[[StatsGroupTopPoster](../types/StatsGroupTopPoster.md)\], 'top_admins' => \[[StatsGroupTopAdmin](../types/StatsGroupTopAdmin.md)\], 'top_inviters' => \[[StatsGroupTopInviter](../types/StatsGroupTopInviter.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="stats.megagroupStats"></a>
***
<br><br>[$statsAbsValueAndPrev](../constructors/statsAbsValueAndPrev.md) = \['current' => [double](../types/double.md), 'previous' => [double](../types/double.md), \];<a name="statsAbsValueAndPrev"></a>
@ -2052,6 +2052,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$statsGraphError](../constructors/statsGraphError.md) = \['error' => [string](../types/string.md), \];<a name="statsGraphError"></a>
***
<br><br>[$statsGroupTopAdmin](../constructors/statsGroupTopAdmin.md) = \['user_id' => [int](../types/int.md), 'deleted' => [int](../types/int.md), 'kicked' => [int](../types/int.md), 'banned' => [int](../types/int.md), \];<a name="statsGroupTopAdmin"></a>
***
<br><br>[$statsGroupTopInviter](../constructors/statsGroupTopInviter.md) = \['user_id' => [int](../types/int.md), 'invitations' => [int](../types/int.md), \];<a name="statsGroupTopInviter"></a>
***
<br><br>[$statsGroupTopPoster](../constructors/statsGroupTopPoster.md) = \['user_id' => [int](../types/int.md), 'messages' => [int](../types/int.md), 'avg_chars' => [int](../types/int.md), \];<a name="statsGroupTopPoster"></a>
***
<br><br>[$statsPercentValue](../constructors/statsPercentValue.md) = \['part' => [double](../types/double.md), 'total' => [double](../types/double.md), \];<a name="statsPercentValue"></a>
@ -2217,6 +2226,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$updateChannelMessageViews](../constructors/updateChannelMessageViews.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'views' => [int](../types/int.md), \];<a name="updateChannelMessageViews"></a>
***
<br><br>[$updateChannelParticipant](../constructors/updateChannelParticipant.md) = \['channel_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'prev_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'new_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'qts' => [int](../types/int.md), \];<a name="updateChannelParticipant"></a>
***
<br><br>[$updateChannelPinnedMessage](../constructors/updateChannelPinnedMessage.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), \];<a name="updateChannelPinnedMessage"></a>
@ -2358,6 +2370,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$updatePhoneCall](../constructors/updatePhoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), \];<a name="updatePhoneCall"></a>
***
<br><br>[$updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md) = \['phone_call_id' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), \];<a name="updatePhoneCallSignalingData"></a>
***
<br><br>[$updatePinnedDialogs](../constructors/updatePinnedDialogs.md) = \['folder_id' => [int](../types/int.md), 'order' => \[[DialogPeer](../types/DialogPeer.md)\], \];<a name="updatePinnedDialogs"></a>
@ -2497,16 +2512,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$urlAuthResultRequest](../constructors/urlAuthResultRequest.md) = \['request_write_access' => [Bool](../types/Bool.md), 'bot' => [User](../types/User.md), 'domain' => [string](../types/string.md), \];<a name="urlAuthResultRequest"></a>
***
<br><br>[$user](../constructors/user.md) = \['self' => [Bool](../types/Bool.md), 'contact' => [Bool](../types/Bool.md), 'mutual_contact' => [Bool](../types/Bool.md), 'deleted' => [Bool](../types/Bool.md), 'bot' => [Bool](../types/Bool.md), 'bot_chat_history' => [Bool](../types/Bool.md), 'bot_nochats' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'bot_inline_geo' => [Bool](../types/Bool.md), 'support' => [Bool](../types/Bool.md), 'scam' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), 'phone' => [string](../types/string.md), 'photo' => [UserProfilePhoto](../types/UserProfilePhoto.md), 'status' => [UserStatus](../types/UserStatus.md), 'bot_info_version' => [int](../types/int.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], 'bot_inline_placeholder' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \];<a name="user"></a>
<br><br>[$user](../constructors/user.md) = \['self' => [Bool](../types/Bool.md), 'contact' => [Bool](../types/Bool.md), 'mutual_contact' => [Bool](../types/Bool.md), 'deleted' => [Bool](../types/Bool.md), 'bot' => [Bool](../types/Bool.md), 'bot_chat_history' => [Bool](../types/Bool.md), 'bot_nochats' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'bot_inline_geo' => [Bool](../types/Bool.md), 'support' => [Bool](../types/Bool.md), 'scam' => [Bool](../types/Bool.md), 'apply_min_photo' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), 'phone' => [string](../types/string.md), 'photo' => [UserProfilePhoto](../types/UserProfilePhoto.md), 'status' => [UserStatus](../types/UserStatus.md), 'bot_info_version' => [int](../types/int.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], 'bot_inline_placeholder' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \];<a name="user"></a>
***
<br><br>[$userEmpty](../constructors/userEmpty.md) = \['id' => [int](../types/int.md), \];<a name="userEmpty"></a>
***
<br><br>[$userFull](../constructors/userFull.md) = \['blocked' => [Bool](../types/Bool.md), 'phone_calls_available' => [Bool](../types/Bool.md), 'phone_calls_private' => [Bool](../types/Bool.md), 'can_pin_message' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'settings' => [PeerSettings](../types/PeerSettings.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'pinned_msg_id' => [int](../types/int.md), 'common_chats_count' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), \];<a name="userFull"></a>
<br><br>[$userFull](../constructors/userFull.md) = \['blocked' => [Bool](../types/Bool.md), 'phone_calls_available' => [Bool](../types/Bool.md), 'phone_calls_private' => [Bool](../types/Bool.md), 'can_pin_message' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'video_calls_available' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'settings' => [PeerSettings](../types/PeerSettings.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'pinned_msg_id' => [int](../types/int.md), 'common_chats_count' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), \];<a name="userFull"></a>
***
<br><br>[$userProfilePhoto](../constructors/userProfilePhoto.md) = \['photo_id' => [long](../types/long.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), 'dc_id' => [int](../types/int.md), \];<a name="userProfilePhoto"></a>
<br><br>[$userProfilePhoto](../constructors/userProfilePhoto.md) = \['has_video' => [Bool](../types/Bool.md), 'photo_id' => [long](../types/long.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), 'dc_id' => [int](../types/int.md), \];<a name="userProfilePhoto"></a>
***
<br><br>[$userProfilePhotoEmpty](../constructors/userProfilePhotoEmpty.md) = \[\];<a name="userProfilePhotoEmpty"></a>
@ -2529,6 +2544,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$userStatusRecently](../constructors/userStatusRecently.md) = \[\];<a name="userStatusRecently"></a>
***
<br><br>[$videoSize](../constructors/videoSize.md) = \['type' => [string](../types/string.md), 'location' => [FileLocation](../types/FileLocation.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'size' => [int](../types/int.md), 'video_start_ts' => [double](../types/double.md), \];<a name="videoSize"></a>
***
<br><br>[$wallPaper](../constructors/wallPaper.md) = \['id' => [long](../types/long.md), 'creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'pattern' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \];<a name="wallPaper"></a>

8
docs/API_docs/constructors/inputChatUploadedPhoto.md
View File

@ -14,7 +14,9 @@ New photo to be set as group profile photo.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|file|[File path or InputFile](../types/InputFile.md) | Yes|File saved in parts using the method [upload.saveFilePart](../methods/upload.saveFilePart.md)|
|file|[File path or InputFile](../types/InputFile.md) | Optional|File saved in parts using the method [upload.saveFilePart](../methods/upload.saveFilePart.md)|
|video|[File path or InputFile](../types/InputFile.md) | Optional|
|video\_start\_ts|[double](../types/double.md) | Optional|
@ -24,14 +26,14 @@ New photo to be set as group profile photo.
### Example:
```php
$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile];
$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile, 'video' => InputFile, 'video_start_ts' => double];
```
Or, if you're into Lua:
```lua
inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile}
inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile, video=InputFile, video_start_ts=double}
```

5
docs/API_docs/constructors/inputMediaUploadedDocument.md
View File

@ -15,6 +15,7 @@ New document
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|nosound\_video|[Bool](../types/Bool.md) | Optional|Whether the specified document is a video file with no audio tracks (a GIF animation (even as MPEG4), for example)|
|force\_file|[Bool](../types/Bool.md) | Optional|
|file|[File path or InputFile](../types/InputFile.md) | Yes|The [uploaded file](https://core.telegram.org/api/files)|
|thumb|[File path or InputFile](../types/InputFile.md) | Optional|Thumbnail of the document, uploaded as for the file|
|mime\_type|[string](../types/string.md) | Optional|MIME type of document|
@ -30,14 +31,14 @@ New document
### Example:
```php
$inputMediaUploadedDocument = ['_' => 'inputMediaUploadedDocument', 'nosound_video' => Bool, 'file' => InputFile, 'thumb' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute], 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int];
$inputMediaUploadedDocument = ['_' => 'inputMediaUploadedDocument', 'nosound_video' => Bool, 'force_file' => Bool, 'file' => InputFile, 'thumb' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute], 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int];
```
Or, if you're into Lua:
```lua
inputMediaUploadedDocument={_='inputMediaUploadedDocument', nosound_video=Bool, file=InputFile, thumb=InputFile, mime_type='string', attributes={DocumentAttribute}, stickers={InputDocument}, ttl_seconds=int}
inputMediaUploadedDocument={_='inputMediaUploadedDocument', nosound_video=Bool, force_file=Bool, file=InputFile, thumb=InputFile, mime_type='string', attributes={DocumentAttribute}, stickers={InputDocument}, ttl_seconds=int}
```

6
docs/API_docs/constructors/peerSettings.md
View File

@ -20,6 +20,8 @@ Peer settings
|share\_contact|[Bool](../types/Bool.md) | Optional|Whether we can share the user's contact|
|need\_contacts\_exception|[Bool](../types/Bool.md) | Optional|Whether a special exception for contacts is needed|
|report\_geo|[Bool](../types/Bool.md) | Optional|Whether we can report a geogroup is irrelevant for this location|
|autoarchived|[Bool](../types/Bool.md) | Optional|
|geo\_distance|[int](../types/int.md) | Optional|
@ -29,14 +31,14 @@ Peer settings
### Example:
```php
$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool, 'add_contact' => Bool, 'block_contact' => Bool, 'share_contact' => Bool, 'need_contacts_exception' => Bool, 'report_geo' => Bool];
$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool, 'add_contact' => Bool, 'block_contact' => Bool, 'share_contact' => Bool, 'need_contacts_exception' => Bool, 'report_geo' => Bool, 'autoarchived' => Bool, 'geo_distance' => int];
```
Or, if you're into Lua:
```lua
peerSettings={_='peerSettings', report_spam=Bool, add_contact=Bool, block_contact=Bool, share_contact=Bool, need_contacts_exception=Bool, report_geo=Bool}
peerSettings={_='peerSettings', report_spam=Bool, add_contact=Bool, block_contact=Bool, share_contact=Bool, need_contacts_exception=Bool, report_geo=Bool, autoarchived=Bool, geo_distance=int}
```

5
docs/API_docs/constructors/phoneCall.md
View File

@ -15,6 +15,7 @@ Phone call
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|p2p\_allowed|[Bool](../types/Bool.md) | Optional|Whether P2P connection to the other peer is allowed|
|video|[Bool](../types/Bool.md) | Optional|
|id|[long](../types/long.md) | Yes|Call ID|
|access\_hash|[long](../types/long.md) | Yes|Access hash|
|date|[int](../types/int.md) | Yes|Date of creation of the call|
@ -34,14 +35,14 @@ Phone call
### Example:
```php
$phoneCall = ['_' => 'phoneCall', 'p2p_allowed' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, 'connections' => [PhoneConnection, PhoneConnection], 'start_date' => int];
$phoneCall = ['_' => 'phoneCall', 'p2p_allowed' => Bool, 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, 'connections' => [PhoneConnection, PhoneConnection], 'start_date' => int];
```
Or, if you're into Lua:
```lua
phoneCall={_='phoneCall', p2p_allowed=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_or_b='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, connections={PhoneConnection}, start_date=int}
phoneCall={_='phoneCall', p2p_allowed=Bool, video=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_or_b='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, connections={PhoneConnection}, start_date=int}
```

43
docs/API_docs/constructors/phoneConnectionWebrtc.md Normal file
View File

@ -0,0 +1,43 @@
---
title: phoneConnectionWebrtc
description: phoneConnectionWebrtc attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: phoneConnectionWebrtc
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|turn|[Bool](../types/Bool.md) | Optional|
|stun|[Bool](../types/Bool.md) | Optional|
|id|[long](../types/long.md) | Yes|
|ip|[string](../types/string.md) | Yes|
|ipv6|[string](../types/string.md) | Yes|
|port|[int](../types/int.md) | Yes|
|username|[string](../types/string.md) | Yes|
|password|[string](../types/string.md) | Yes|
### Type: [PhoneConnection](../types/PhoneConnection.md)
### Example:
```php
$phoneConnectionWebrtc = ['_' => 'phoneConnectionWebrtc', 'turn' => Bool, 'stun' => Bool, 'id' => long, 'ip' => 'string', 'ipv6' => 'string', 'port' => int, 'username' => 'string', 'password' => 'string'];
```
Or, if you're into Lua:
```lua
phoneConnectionWebrtc={_='phoneConnectionWebrtc', turn=Bool, stun=Bool, id=long, ip='string', ipv6='string', port=int, username='string', password='string'}
```

5
docs/API_docs/constructors/photo.md
View File

@ -20,6 +20,7 @@ Photo
|file\_reference|[bytes](../types/bytes.md) | Yes|[file reference](https://core.telegram.org/api/file_reference)|
|date|[int](../types/int.md) | Yes|Date of upload|
|sizes|Array of [PhotoSize](../types/PhotoSize.md) | Yes|Available sizes for download|
|video\_sizes|Array of [VideoSize](../types/VideoSize.md) | Optional|
|dc\_id|[int](../types/int.md) | Yes|DC ID to use for download|
@ -30,14 +31,14 @@ Photo
### Example:
```php
$photo = ['_' => 'photo', 'has_stickers' => Bool, 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'sizes' => [PhotoSize, PhotoSize], 'dc_id' => int];
$photo = ['_' => 'photo', 'has_stickers' => Bool, 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'sizes' => [PhotoSize, PhotoSize], 'video_sizes' => [VideoSize, VideoSize], 'dc_id' => int];
```
Or, if you're into Lua:
```lua
photo={_='photo', has_stickers=Bool, id=long, access_hash=long, file_reference='bytes', date=int, sizes={PhotoSize}, dc_id=int}
photo={_='photo', has_stickers=Bool, id=long, access_hash=long, file_reference='bytes', date=int, sizes={PhotoSize}, video_sizes={VideoSize}, dc_id=int}
```

1
docs/API_docs/constructors/photoStrippedSize.md
View File

@ -16,6 +16,7 @@ Just the image's content
|----------|---------------|----------|-------------|
|type|[string](../types/string.md) | Yes|Thumbnail type|
|bytes|[bytes](../types/bytes.md) | Yes|Thumbnail data|
|inflated|[bytes](../types/bytes.md) | Yes|JPG image data|

53
docs/API_docs/constructors/stats.megagroupStats.md Normal file
View File

@ -0,0 +1,53 @@
---
title: stats.megagroupStats
description: stats.megagroupStats attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/constructors/stats_megagroupStats.html
---
# Constructor: stats.megagroupStats
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|period|[StatsDateRangeDays](../types/StatsDateRangeDays.md) | Yes|
|members|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|
|messages|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|
|viewers|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|
|posters|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|
|growth\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|members\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|new\_members\_by\_source\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|languages\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|messages\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|actions\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|top\_hours\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|weekdays\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|
|top\_posters|Array of [StatsGroupTopPoster](../types/StatsGroupTopPoster.md) | Yes|
|top\_admins|Array of [StatsGroupTopAdmin](../types/StatsGroupTopAdmin.md) | Yes|
|top\_inviters|Array of [StatsGroupTopInviter](../types/StatsGroupTopInviter.md) | Yes|
|users|Array of [User](../types/User.md) | Yes|
### Type: [stats.MegagroupStats](../types/stats.MegagroupStats.md)
### Example:
```php
$stats.megagroupStats = ['_' => 'stats.megagroupStats', 'period' => StatsDateRangeDays, 'members' => StatsAbsValueAndPrev, 'messages' => StatsAbsValueAndPrev, 'viewers' => StatsAbsValueAndPrev, 'posters' => StatsAbsValueAndPrev, 'growth_graph' => StatsGraph, 'members_graph' => StatsGraph, 'new_members_by_source_graph' => StatsGraph, 'languages_graph' => StatsGraph, 'messages_graph' => StatsGraph, 'actions_graph' => StatsGraph, 'top_hours_graph' => StatsGraph, 'weekdays_graph' => StatsGraph, 'top_posters' => [StatsGroupTopPoster, StatsGroupTopPoster], 'top_admins' => [StatsGroupTopAdmin, StatsGroupTopAdmin], 'top_inviters' => [StatsGroupTopInviter, StatsGroupTopInviter], 'users' => [User, User]];
```
Or, if you're into Lua:
```lua
stats.megagroupStats={_='stats.megagroupStats', period=StatsDateRangeDays, members=StatsAbsValueAndPrev, messages=StatsAbsValueAndPrev, viewers=StatsAbsValueAndPrev, posters=StatsAbsValueAndPrev, growth_graph=StatsGraph, members_graph=StatsGraph, new_members_by_source_graph=StatsGraph, languages_graph=StatsGraph, messages_graph=StatsGraph, actions_graph=StatsGraph, top_hours_graph=StatsGraph, weekdays_graph=StatsGraph, top_posters={StatsGroupTopPoster}, top_admins={StatsGroupTopAdmin}, top_inviters={StatsGroupTopInviter}, users={User}}
```

39
docs/API_docs/constructors/statsGroupTopAdmin.md Normal file
View File

@ -0,0 +1,39 @@
---
title: statsGroupTopAdmin
description: statsGroupTopAdmin attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: statsGroupTopAdmin
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|user\_id|[int](../types/int.md) | Yes|
|deleted|[int](../types/int.md) | Yes|
|kicked|[int](../types/int.md) | Yes|
|banned|[int](../types/int.md) | Yes|
### Type: [StatsGroupTopAdmin](../types/StatsGroupTopAdmin.md)
### Example:
```php
$statsGroupTopAdmin = ['_' => 'statsGroupTopAdmin', 'user_id' => int, 'deleted' => int, 'kicked' => int, 'banned' => int];
```
Or, if you're into Lua:
```lua
statsGroupTopAdmin={_='statsGroupTopAdmin', user_id=int, deleted=int, kicked=int, banned=int}
```

37
docs/API_docs/constructors/statsGroupTopInviter.md Normal file
View File

@ -0,0 +1,37 @@
---
title: statsGroupTopInviter
description: statsGroupTopInviter attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: statsGroupTopInviter
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|user\_id|[int](../types/int.md) | Yes|
|invitations|[int](../types/int.md) | Yes|
### Type: [StatsGroupTopInviter](../types/StatsGroupTopInviter.md)
### Example:
```php
$statsGroupTopInviter = ['_' => 'statsGroupTopInviter', 'user_id' => int, 'invitations' => int];
```
Or, if you're into Lua:
```lua
statsGroupTopInviter={_='statsGroupTopInviter', user_id=int, invitations=int}
```

38
docs/API_docs/constructors/statsGroupTopPoster.md Normal file
View File

@ -0,0 +1,38 @@
---
title: statsGroupTopPoster
description: statsGroupTopPoster attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: statsGroupTopPoster
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|user\_id|[int](../types/int.md) | Yes|
|messages|[int](../types/int.md) | Yes|
|avg\_chars|[int](../types/int.md) | Yes|
### Type: [StatsGroupTopPoster](../types/StatsGroupTopPoster.md)
### Example:
```php
$statsGroupTopPoster = ['_' => 'statsGroupTopPoster', 'user_id' => int, 'messages' => int, 'avg_chars' => int];
```
Or, if you're into Lua:
```lua
statsGroupTopPoster={_='statsGroupTopPoster', user_id=int, messages=int, avg_chars=int}
```

41
docs/API_docs/constructors/updateChannelParticipant.md Normal file
View File

@ -0,0 +1,41 @@
---
title: updateChannelParticipant
description: updateChannelParticipant attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: updateChannelParticipant
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|channel\_id|[int](../types/int.md) | Yes|
|date|[int](../types/int.md) | Yes|
|user\_id|[int](../types/int.md) | Yes|
|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Optional|
|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Optional|
|qts|[int](../types/int.md) | Yes|
### Type: [Update](../types/Update.md)
### Example:
```php
$updateChannelParticipant = ['_' => 'updateChannelParticipant', 'channel_id' => int, 'date' => int, 'user_id' => int, 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant, 'qts' => int];
```
Or, if you're into Lua:
```lua
updateChannelParticipant={_='updateChannelParticipant', channel_id=int, date=int, user_id=int, prev_participant=ChannelParticipant, new_participant=ChannelParticipant, qts=int}
```

37
docs/API_docs/constructors/updatePhoneCallSignalingData.md Normal file
View File

@ -0,0 +1,37 @@
---
title: updatePhoneCallSignalingData
description: updatePhoneCallSignalingData attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: updatePhoneCallSignalingData
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|phone\_call\_id|[long](../types/long.md) | Yes|
|data|[bytes](../types/bytes.md) | Yes|
### Type: [Update](../types/Update.md)
### Example:
```php
$updatePhoneCallSignalingData = ['_' => 'updatePhoneCallSignalingData', 'phone_call_id' => long, 'data' => 'bytes'];
```
Or, if you're into Lua:
```lua
updatePhoneCallSignalingData={_='updatePhoneCallSignalingData', phone_call_id=long, data='bytes'}
```

5
docs/API_docs/constructors/user.md
View File

@ -27,6 +27,7 @@ Indicates info about a certain user
|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional|Whether the bot can request our geolocation in inline mode|
|support|[Bool](../types/Bool.md) | Optional|Whether this is an official support user|
|scam|[Bool](../types/Bool.md) | Optional|This may be a scam user|
|apply\_min\_photo|[Bool](../types/Bool.md) | Optional|
|id|[int](../types/int.md) | Yes|ID of the user|
|access\_hash|[long](../types/long.md) | Optional|Access hash of the user|
|first\_name|[string](../types/string.md) | Optional|First name|
@ -48,14 +49,14 @@ Indicates info about a certain user
### Example:
```php
$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, 'support' => Bool, 'scam' => 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' => [RestrictionReason, RestrictionReason], 'bot_inline_placeholder' => 'string', 'lang_code' => 'string'];
$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, 'support' => Bool, 'scam' => Bool, 'apply_min_photo' => 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' => [RestrictionReason, RestrictionReason], 'bot_inline_placeholder' => 'string', 'lang_code' => 'string'];
```
Or, if you're into Lua:
```lua
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, support=Bool, scam=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={RestrictionReason}, bot_inline_placeholder='string', lang_code='string'}
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, support=Bool, scam=Bool, apply_min_photo=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={RestrictionReason}, bot_inline_placeholder='string', lang_code='string'}
```

5
docs/API_docs/constructors/userFull.md
View File

@ -19,6 +19,7 @@ Extended user info
|phone\_calls\_private|[Bool](../types/Bool.md) | Optional|Whether this user's privacy settings allow you to call him|
|can\_pin\_message|[Bool](../types/Bool.md) | Optional|Whether you can pin messages in the chat with this user, you can do this only for a chat with yourself|
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available|
|video\_calls\_available|[Bool](../types/Bool.md) | Optional|
|user|[User](../types/User.md) | Optional|Remaining user info|
|about|[string](../types/string.md) | Optional|Bio of the user|
|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Peer settings|
@ -37,14 +38,14 @@ Extended user info
### Example:
```php
$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'can_pin_message' => Bool, 'has_scheduled' => Bool, 'user' => User, 'about' => 'string', 'settings' => PeerSettings, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'pinned_msg_id' => int, 'common_chats_count' => int, 'folder_id' => int];
$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'can_pin_message' => Bool, 'has_scheduled' => Bool, 'video_calls_available' => Bool, 'user' => User, 'about' => 'string', 'settings' => PeerSettings, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'pinned_msg_id' => int, 'common_chats_count' => int, 'folder_id' => int];
```
Or, if you're into Lua:
```lua
userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, can_pin_message=Bool, has_scheduled=Bool, user=User, about='string', settings=PeerSettings, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, pinned_msg_id=int, common_chats_count=int, folder_id=int}
userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, can_pin_message=Bool, has_scheduled=Bool, video_calls_available=Bool, user=User, about='string', settings=PeerSettings, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, pinned_msg_id=int, common_chats_count=int, folder_id=int}
```

5
docs/API_docs/constructors/userProfilePhoto.md
View File

@ -14,6 +14,7 @@ User profile photo.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|has\_video|[Bool](../types/Bool.md) | Optional|
|photo\_id|[long](../types/long.md) | Yes|Identifier of the respective photo<br>Parameter added in [Layer 2](https://core.telegram.org/api/layers#layer-2)|
|photo\_small|[FileLocation](../types/FileLocation.md) | Yes|Location of the file, corresponding to the small profile photo thumbnail|
|photo\_big|[FileLocation](../types/FileLocation.md) | Yes|Location of the file, corresponding to the big profile photo thumbnail|
@ -27,14 +28,14 @@ User profile photo.
### Example:
```php
$userProfilePhoto = ['_' => 'userProfilePhoto', 'photo_id' => long, 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int];
$userProfilePhoto = ['_' => 'userProfilePhoto', 'has_video' => Bool, 'photo_id' => long, 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int];
```
Or, if you're into Lua:
```lua
userProfilePhoto={_='userProfilePhoto', photo_id=long, photo_small=FileLocation, photo_big=FileLocation, dc_id=int}
userProfilePhoto={_='userProfilePhoto', has_video=Bool, photo_id=long, photo_small=FileLocation, photo_big=FileLocation, dc_id=int}
```

41
docs/API_docs/constructors/videoSize.md Normal file
View File

@ -0,0 +1,41 @@
---
title: videoSize
description: videoSize attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: videoSize
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|type|[string](../types/string.md) | Yes|
|location|[FileLocation](../types/FileLocation.md) | Yes|
|w|[int](../types/int.md) | Yes|
|h|[int](../types/int.md) | Yes|
|size|[int](../types/int.md) | Yes|
|video\_start\_ts|[double](../types/double.md) | Optional|
### Type: [VideoSize](../types/VideoSize.md)
### Example:
```php
$videoSize = ['_' => 'videoSize', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'size' => int, 'video_start_ts' => double];
```
Or, if you're into Lua:
```lua
videoSize={_='videoSize', type='string', location=FileLocation, w=int, h=int, size=int, video_start_ts=double}
```

6
docs/API_docs/index.md
View File

@ -1,9 +1,9 @@
---
title: MadelineProto API documentation (layer 113)
description: MadelineProto API documentation (layer 113)
title: MadelineProto API documentation (layer 117)
description: MadelineProto API documentation (layer 117)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# MadelineProto API documentation (layer 113)
# MadelineProto API documentation (layer 117)
[Back to main documentation](..)

7
docs/API_docs/methods/account.deleteAccount.md
View File

@ -44,3 +44,10 @@ Or, if you're into Lua:
Bool = account.deleteAccount({reason='string', })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|420|2FA_CONFIRM_WAIT_X|Since this account is active and protected by a 2FA password, we will delete it in 1 week for security purposes. You can cancel this process at any time, you'll be able to reset your account in X seconds.|

39
docs/API_docs/methods/account.getGlobalPrivacySettings.md Normal file
View File

@ -0,0 +1,39 @@
---
title: account.getGlobalPrivacySettings
description: account.getGlobalPrivacySettings parameters, return type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/account_getGlobalPrivacySettings.html
---
# Method: account.getGlobalPrivacySettings
[Back to methods index](index.md)
### Return type: [GlobalPrivacySettings](../types/GlobalPrivacySettings.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$GlobalPrivacySettings = $MadelineProto->account->getGlobalPrivacySettings();
```
Or, if you're into Lua:
```lua
GlobalPrivacySettings = account.getGlobalPrivacySettings({})
```

8
docs/API_docs/methods/account.getTheme.md
View File

@ -46,3 +46,11 @@ Or, if you're into Lua:
Theme = account.getTheme({format='string', theme=InputTheme, document_id=long, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|THEME_FORMAT_INVALID|Invalid theme format provided|
|400|THEME_INVALID|Invalid theme provided|

44
docs/API_docs/methods/account.setGlobalPrivacySettings.md Normal file
View File

@ -0,0 +1,44 @@
---
title: account.setGlobalPrivacySettings
description: account.setGlobalPrivacySettings parameters, return type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/account_setGlobalPrivacySettings.html
---
# Method: account.setGlobalPrivacySettings
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|settings|[GlobalPrivacySettings](../types/GlobalPrivacySettings.md) | Yes|
### Return type: [GlobalPrivacySettings](../types/GlobalPrivacySettings.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$GlobalPrivacySettings = $MadelineProto->account->setGlobalPrivacySettings(['settings' => GlobalPrivacySettings, ]);
```
Or, if you're into Lua:
```lua
GlobalPrivacySettings = account.setGlobalPrivacySettings({settings=GlobalPrivacySettings, })
```

28
docs/API_docs/methods/api_index.md
View File

@ -102,6 +102,10 @@ $MadelineProto->[account->getContactSignUpNotification](account.getContactSignUp
<br><br>
$MadelineProto->[account->getContentSettings](account.getContentSettings.md)(\[\]) === [$account.ContentSettings](../types/account.ContentSettings.md)<a name="account.getContentSettings"></a>
***
<br><br>
$MadelineProto->[account->getGlobalPrivacySettings](account.getGlobalPrivacySettings.md)(\[\]) === [$GlobalPrivacySettings](../types/GlobalPrivacySettings.md)<a name="account.getGlobalPrivacySettings"></a>
***
<br><br>
$MadelineProto->[account->getMultiWallPapers](account.getMultiWallPapers.md)(\['wallpapers' => \[[InputWallPaper](../types/InputWallPaper.md)\], \]) === [$Vector\_of\_WallPaper](../types/WallPaper.md)<a name="account.getMultiWallPapers"></a>
@ -242,6 +246,10 @@ $MadelineProto->[account->setContactSignUpNotification](account.setContactSignUp
<br><br>
$MadelineProto->[account->setContentSettings](account.setContentSettings.md)(\['sensitive_enabled' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md)<a name="account.setContentSettings"></a>
***
<br><br>
$MadelineProto->[account->setGlobalPrivacySettings](account.setGlobalPrivacySettings.md)(\['settings' => [GlobalPrivacySettings](../types/GlobalPrivacySettings.md), \]) === [$GlobalPrivacySettings](../types/GlobalPrivacySettings.md)<a name="account.setGlobalPrivacySettings"></a>
***
<br><br>
$MadelineProto->[account->setPrivacy](account.setPrivacy.md)(\['key' => [InputPrivacyKey](../types/InputPrivacyKey.md), 'rules' => \[[InputPrivacyRule](../types/InputPrivacyRule.md)\], \]) === [$account.PrivacyRules](../types/account.PrivacyRules.md)<a name="account.setPrivacy"></a>
@ -606,6 +614,10 @@ $MadelineProto->[folders->editPeerFolders](folders.editPeerFolders.md)(\['folder
<br><br>
$MadelineProto->[help->acceptTermsOfService](help.acceptTermsOfService.md)(\['id' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md)<a name="help.acceptTermsOfService"></a>
***
<br><br>
$MadelineProto->[help->dismissSuggestion](help.dismissSuggestion.md)(\['suggestion' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md)<a name="help.dismissSuggestion"></a>
***
<br><br>
$MadelineProto->[help->editUserInfo](help.editUserInfo.md)(\['user_id' => [InputUser](../types/InputUser.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$help.UserInfo](../types/help.UserInfo.md)<a name="help.editUserInfo"></a>
@ -1106,10 +1118,6 @@ $MadelineProto->[messages->saveRecentSticker](messages.saveRecentSticker.md)(\['
<br><br>
$MadelineProto->[messages->search](messages.search.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'q' => [string](../types/string.md), 'from_id' => [InputUser](../types/InputUser.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'min_date' => [int](../types/int.md), 'max_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'add_offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'min_id' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md)<a name="messages.search"></a>
***
<br><br>
$MadelineProto->[messages->searchGifs](messages.searchGifs.md)(\['q' => [string](../types/string.md), 'offset' => [int](../types/int.md), \]) === [$messages.FoundGifs](../types/messages.FoundGifs.md)<a name="messages.searchGifs"></a>
***
<br><br>
$MadelineProto->[messages->searchGlobal](messages.searchGlobal.md)(\['folder_id' => [int](../types/int.md), 'q' => [string](../types/string.md), 'offset_rate' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md)<a name="messages.searchGlobal"></a>
@ -1282,6 +1290,10 @@ $MadelineProto->[phone->requestCall](phone.requestCall.md)(\['video' => [Bool](.
<br><br>
$MadelineProto->[phone->saveCallDebug](phone.saveCallDebug.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'debug' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md)<a name="phone.saveCallDebug"></a>
***
<br><br>
$MadelineProto->[phone->sendSignalingData](phone.sendSignalingData.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'data' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md)<a name="phone.sendSignalingData"></a>
***
<br><br>
$MadelineProto->[phone->setCallRating](phone.setCallRating.md)(\['user_initiative' => [Bool](../types/Bool.md), 'peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'rating' => [int](../types/int.md), 'comment' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="phone.setCallRating"></a>
@ -1296,16 +1308,20 @@ $MadelineProto->[photos->getUserPhotos](photos.getUserPhotos.md)(\['user_id' =>
***
<br><br>
$MadelineProto->[photos->updateProfilePhoto](photos.updateProfilePhoto.md)(\['id' => [InputPhoto](../types/InputPhoto.md), \]) === [$UserProfilePhoto](../types/UserProfilePhoto.md)<a name="photos.updateProfilePhoto"></a>
$MadelineProto->[photos->updateProfilePhoto](photos.updateProfilePhoto.md)(\['id' => [InputPhoto](../types/InputPhoto.md), \]) === [$photos.Photo](../types/photos.Photo.md)<a name="photos.updateProfilePhoto"></a>
***
<br><br>
$MadelineProto->[photos->uploadProfilePhoto](photos.uploadProfilePhoto.md)(\['file' => [InputFile](../types/InputFile.md), \]) === [$photos.Photo](../types/photos.Photo.md)<a name="photos.uploadProfilePhoto"></a>
$MadelineProto->[photos->uploadProfilePhoto](photos.uploadProfilePhoto.md)(\['file' => [InputFile](../types/InputFile.md), 'video' => [InputFile](../types/InputFile.md), 'video_start_ts' => [double](../types/double.md), \]) === [$photos.Photo](../types/photos.Photo.md)<a name="photos.uploadProfilePhoto"></a>
***
<br><br>
$MadelineProto->[stats->getBroadcastStats](stats.getBroadcastStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), \]) === [$stats.BroadcastStats](../types/stats.BroadcastStats.md)<a name="stats.getBroadcastStats"></a>
***
<br><br>
$MadelineProto->[stats->getMegagroupStats](stats.getMegagroupStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), \]) === [$stats.MegagroupStats](../types/stats.MegagroupStats.md)<a name="stats.getMegagroupStats"></a>
***
<br><br>
$MadelineProto->[stats->loadAsyncGraph](stats.loadAsyncGraph.md)(\['token' => [string](../types/string.md), 'x' => [long](../types/long.md), \]) === [$StatsGraph](../types/StatsGraph.md)<a name="stats.loadAsyncGraph"></a>

1
docs/API_docs/methods/auth.sendCode.md
View File

@ -60,6 +60,7 @@ auth.SentCode = auth.sendCode({phone_number='string', api_id=int, api_hash='stri
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|400|PHONE_PASSWORD_PROTECTED|This phone is password protected|
|400|SMS_CODE_CREATE_FAILED|An error occurred while creating the SMS code|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|406|PHONE_NUMBER_INVALID|The phone number is invalid|
|406|PHONE_PASSWORD_FLOOD|You have tried logging in too many times|
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|

1
docs/API_docs/methods/auth.signUp.md
View File

@ -52,6 +52,7 @@ auth.Authorization = auth.signUp({phone_number='string', phone_code_hash='string
| Code | Type | Description |
|------|----------|---------------|
|400|FIRSTNAME_INVALID|The first name is invalid|
|400|INPUT_REQUEST_TOO_LONG|The request is too big|
|400|PHONE_CODE_EMPTY|phone_code is missing|
|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)|
|400|PHONE_CODE_INVALID|The provided phone code is invalid|

2
docs/API_docs/methods/channels.deleteChannel.md
View File

@ -50,7 +50,7 @@ Updates = channels.deleteChannel({channel=InputChannel, })
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHANNEL_TOO_LARGE||
|400|CHANNEL_TOO_LARGE|Channel is too large to be deleted; this error is issued when trying to delete channels with more than 1000 members (subject to change)|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|

1
docs/API_docs/methods/channels.deleteMessages.md
View File

@ -53,5 +53,6 @@ messages.AffectedMessages = channels.deleteMessages({channel=InputChannel, id={i
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|MSG_ID_INVALID|Invalid message ID provided|
|403|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/channels.editAdmin.md
View File

@ -58,9 +58,11 @@ Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rig
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|USER_CREATOR|You can't leave this channel, because you're its creator|
|400|USER_ID_INVALID|The provided user ID is invalid|
|400|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact|
|406|FRESH_CHANGE_ADMINS_FORBIDDEN|You were just elected admin, you can't add or modify other admins yet|
|403|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|403|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this|

1
docs/API_docs/methods/channels.getChannels.md
View File

@ -53,5 +53,6 @@ messages.Chats = channels.getChannels({id={InputChannel}, })
|400|MSG_ID_INVALID|Invalid message ID provided|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|-503|Timeout|Timeout while fetching data|

1
docs/API_docs/methods/channels.getParticipant.md
View File

@ -55,5 +55,6 @@ channels.ChannelParticipant = channels.getParticipant({channel=InputChannel, use
|400|MSG_ID_INVALID|Invalid message ID provided|
|400|USER_ID_INVALID|The provided user ID is invalid|
|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/channels.inviteToChannel.md
View File

@ -60,10 +60,12 @@ Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, })
|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels|
|400|USER_BLOCKED|User blocked|
|400|USER_BOT|Bots can only be admins in channels.|
|400|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups|
|400|USER_ID_INVALID|The provided user ID is invalid|
|400|USER_KICKED|This user was kicked from this supergroup/channel|
|400|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact|
|400|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|403|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups|
|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this|

1
docs/API_docs/methods/channels.leaveChannel.md
View File

@ -53,6 +53,7 @@ Updates = channels.leaveChannel({channel=InputChannel, })
|400|MSG_ID_INVALID|Invalid message ID provided|
|400|USER_CREATOR|You can't leave this channel, because you're its creator|
|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|403|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available|

1
docs/API_docs/methods/channels.togglePreHistoryHidden.md
View File

@ -52,6 +52,7 @@ Updates = channels.togglePreHistoryHidden({channel=InputChannel, enabled=Bool, }
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|CHAT_ID_INVALID|The provided chat id is invalid|
|400|CHAT_LINK_EXISTS|The chat is public, you can't hide the history to new users|
|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified|

2
docs/API_docs/methods/channels.toggleSlowMode.md
View File

@ -50,8 +50,6 @@ Updates = channels.toggleSlowMode({channel=InputChannel, seconds=int, })
| Code | Type | Description |
|------|----------|---------------|
|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified|
|400|INPUT_METHOD_INVALID_1192227_X|Invalid method|
|400|INPUT_METHOD_INVALID_1604042050_X|Invalid method|
|400|SECONDS_INVALID|Invalid duration provided|

1
docs/API_docs/methods/contacts.block.md
View File

@ -50,5 +50,6 @@ Bool = contacts.block({id=InputUser, })
|------|----------|---------------|
|400|CONTACT_ID_INVALID|The provided contact ID is invalid|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MSG_ID_INVALID|Invalid message ID provided|

1
docs/API_docs/methods/contacts.getLocated.md
View File

@ -51,5 +51,6 @@ Updates = contacts.getLocated({background=Bool, geo_point=InputGeoPoint, self_ex
| Code | Type | Description |
|------|----------|---------------|
|400|GEO_POINT_INVALID|Invalid geoposition provided|
|406|USERPIC_UPLOAD_REQUIRED|You must have a profile picture to publish your geolocation|

44
docs/API_docs/methods/help.dismissSuggestion.md Normal file
View File

@ -0,0 +1,44 @@
---
title: help.dismissSuggestion
description: help.dismissSuggestion parameters, return type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/help_dismissSuggestion.html
---
# Method: help.dismissSuggestion
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|suggestion|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Bool = $MadelineProto->help->dismissSuggestion(['suggestion' => 'string', ]);
```
Or, if you're into Lua:
```lua
Bool = help.dismissSuggestion({suggestion='string', })
```

1
docs/API_docs/methods/help.getCdnConfig.md
View File

@ -46,6 +46,7 @@ CdnConfig = help.getCdnConfig({})
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|-500|No workers running|Internal error|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/help.getConfig.md
View File

@ -49,6 +49,8 @@ Config = help.getConfig({})
|400|CONNECTION_LAYER_INVALID|Layer invalid|
|400|CONNECTION_NOT_INITED|Connection not initialized|
|400|CONNECTION_SYSTEM_EMPTY|Connection system empty|
|400|CONNECTION_SYSTEM_LANG_CODE_EMPTY|The system_lang_code field is empty|
|400|DATA_INVALID|Encrypted data invalid|
|400|INPUT_LAYER_INVALID|The provided layer is invalid|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/index.md
View File

@ -584,8 +584,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
* <a href="help.saveAppLog.html" name="help.saveAppLog">Saves logs of application on the server: help.saveAppLog</a>
* <a href="messages.searchGifs.html" name="messages.searchGifs">Search for GIFs: messages.searchGifs</a>
* <a href="messages.searchGlobal.html" name="messages.searchGlobal">Search for messages and peers globally: messages.searchGlobal</a>
* <a href="messages.searchStickerSets.html" name="messages.searchStickerSets">Search for stickersets: messages.searchStickerSets</a>

1
docs/API_docs/methods/invokeWithTakeout.md
View File

@ -49,6 +49,5 @@ X = invokeWithTakeout({takeout_id=long, query=!X, })
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_FETCH_FAIL|Failed deserializing TL payload|
|400|INPUT_METHOD_INVALID_1400137063_X|Invalid method|

3
docs/API_docs/methods/messages.deleteHistory.md
View File

@ -51,8 +51,11 @@ messages.AffectedHistory = messages.deleteHistory({just_clear=Bool, revoke=Bool,
| Code | Type | Description |
|------|----------|---------------|
|400|CHAT_ID_INVALID|The provided chat id is invalid|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
|400|MSG_ID_INVALID|Invalid message ID provided|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/messages.editChatAdmin.md
View File

@ -51,6 +51,8 @@ Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bo
| Code | Type | Description |
|------|----------|---------------|
|400|CHAT_ID_INVALID|The provided chat id is invalid|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|USER_ID_INVALID|The provided user ID is invalid|
|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|

1
docs/API_docs/methods/messages.editMessage.md
View File

@ -111,6 +111,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MEDIA_CAPTION_TOO_LONG|The caption is too long|
|400|MEDIA_PREV_INVALID|Previous media invalid|
|400|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.|
|400|MESSAGE_EMPTY|The provided message is empty|

2
docs/API_docs/methods/messages.forwardMessages.md
View File

@ -55,6 +55,7 @@ Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=
| Code | Type | Description |
|------|----------|---------------|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: wait X seconds before sending another message to this chat.|
|400|BROADCAST_PUBLIC_VOTERS_FORBIDDEN|You can't forward polls with public voters|
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
@ -79,7 +80,6 @@ Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=
|403|CHAT_SEND_POLL_FORBIDDEN|You can't send polls in this chat|
|403|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.|
|-503|Timeout|Timeout while fetching data|

1
docs/API_docs/methods/messages.getBotCallbackAnswer.md
View File

@ -51,6 +51,7 @@ messages.BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=Inpu
| Code | Type | Description |
|------|----------|---------------|
|400|BOT_RESPONSE_TIMEOUT|A timeout occurred while fetching data from the bot|
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|DATA_INVALID|Encrypted data invalid|

2
docs/API_docs/methods/messages.getDialogs.md
View File

@ -54,10 +54,12 @@ messages.Dialogs = messages.getDialogs({exclude_pinned=Bool, folder_id=int, offs
| Code | Type | Description |
|------|----------|---------------|
|400|FOLDER_ID_INVALID|Invalid folder ID|
|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid|
|400|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|-504|memory limit exit|Internal error|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/messages.getInlineBotResults.md
View File

@ -54,7 +54,9 @@ messages.BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPee
|------|----------|---------------|
|400|BOT_INLINE_DISABLED|This bot can't be used in inline mode|
|400|BOT_INVALID|This is not a valid bot|
|400|BOT_RESPONSE_TIMEOUT|A timeout occurred while fetching data from the bot|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MSG_ID_INVALID|Invalid message ID provided|
|-503|Timeout|Timeout while fetching data|

2
docs/API_docs/methods/messages.getUnreadMentions.md
View File

@ -53,6 +53,8 @@ messages.Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, a
| Code | Type | Description |
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|PEER_ID_INVALID|The provided peer id is invalid|

1
docs/API_docs/methods/messages.readHistory.md
View File

@ -49,6 +49,7 @@ messages.AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, })
| Code | Type | Description |
|------|----------|---------------|
|400|CHAT_ID_INVALID|The provided chat id is invalid|
|400|MSG_ID_INVALID|Invalid message ID provided|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|

1
docs/API_docs/methods/messages.searchGlobal.md
View File

@ -53,6 +53,7 @@ messages.Messages = messages.searchGlobal({folder_id=int, q='string', offset_rat
| Code | Type | Description |
|------|----------|---------------|
|400|FOLDER_ID_INVALID|Invalid folder ID|
|400|SEARCH_QUERY_EMPTY|The search query is empty|

1
docs/API_docs/methods/messages.sendEncryptedFile.md
View File

@ -51,6 +51,7 @@ messages.SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedC
| Code | Type | Description |
|------|----------|---------------|
|400|DATA_TOO_LONG|Data too long|
|400|ENCRYPTION_DECLINED|The secret chat was declined|
|400|MD5_CHECKSUM_INVALID|The MD5 checksums do not match|
|400|MSG_WAIT_FAILED|A waiting call returned an error|

4
docs/API_docs/methods/messages.sendInlineBotResult.md
View File

@ -56,10 +56,12 @@ Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draf
| Code | Type | Description |
|------|----------|---------------|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: wait X seconds before sending another message to this chat.|
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted|
|400|INLINE_RESULT_EXPIRED|The inline query expired|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MEDIA_EMPTY|The provided media object is invalid|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|QUERY_ID_EMPTY|The query ID is empty|
@ -71,8 +73,8 @@ Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draf
|403|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat|
|403|CHAT_SEND_INLINE_FORBIDDEN|You can't send inline messages in this group|
|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat|
|403|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.|
|-503|Timeout|Timeout while fetching data|

6
docs/API_docs/methods/messages.sendMedia.md
View File

@ -106,6 +106,8 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
| Code | Type | Description |
|------|----------|---------------|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: wait X seconds before sending another message to this chat.|
|400|BROADCAST_PUBLIC_VOTERS_FORBIDDEN|You can't forward polls with public voters|
|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid|
|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid|
|400|BUTTON_URL_INVALID|Button URL invalid|
@ -129,9 +131,11 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
|400|PHOTO_SAVE_FILE_INVALID|Internal issues, try again later|
|400|POLL_ANSWERS_INVALID|Invalid poll answers were provided|
|400|POLL_OPTION_DUPLICATE|Duplicate poll options provided|
|400|POLL_OPTION_INVALID|Invalid poll option provided|
|400|QUIZ_CORRECT_ANSWERS_EMPTY|No correct quiz answer was specified|
|400|REPLY_MARKUP_BUY_EMPTY|Reply markup for buy button empty|
|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid|
|400|SCHEDULE_TOO_MUCH|There are too many scheduled messages|
|400|TTL_MEDIA_INVALID|Invalid media Time To Live was provided|
|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels|
|400|USER_IS_BLOCKED|You were blocked by this user|
@ -144,7 +148,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat|
|403|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.|
|-504|memory limit exit|Internal error|
|-503|Timeout|Timeout while fetching data|

3
docs/API_docs/methods/messages.sendMessage.md
View File

@ -106,6 +106,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
| Code | Type | Description |
|------|----------|---------------|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: wait X seconds before sending another message to this chat.|
|400|BOT_DOMAIN_INVALID|Bot domain invalid|
|400|BOT_INVALID|This is not a valid bot|
|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid|
@ -135,7 +136,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.|
|-504|memory limit exit|Internal error|
|-503|Timeout|Timeout while fetching data|

1
docs/API_docs/methods/messages.sendMultiMedia.md
View File

@ -60,5 +60,6 @@ Updates = messages.sendMultiMedia({silent=Bool, background=Bool, clear_draft=Boo
|400|MULTI_MEDIA_TOO_LONG|Too many media files for album|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|RANDOM_ID_EMPTY|Random ID empty|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|

3
docs/API_docs/methods/messages.setInlineBotResults.md
View File

@ -61,12 +61,15 @@ Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long,
|400|GIF_CONTENT_TYPE_INVALID|GIF content-type invalid|
|400|MESSAGE_EMPTY|The provided message is empty|
|400|MESSAGE_TOO_LONG|The provided message is too long|
|400|PHOTO_CONTENT_TYPE_INVALID|Photo mime-type invalid|
|400|PHOTO_CONTENT_URL_EMPTY|Photo URL invalid|
|400|PHOTO_INVALID|Photo invalid|
|400|PHOTO_THUMB_URL_EMPTY|Photo thumbnail URL is empty|
|400|QUERY_ID_INVALID|The query ID is invalid|
|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid|
|400|RESULT_TYPE_INVALID|Result type invalid|
|400|RESULTS_TOO_MUCH|Too many results were provided|
|400|SEND_MESSAGE_MEDIA_INVALID|Invalid media provided|
|400|SEND_MESSAGE_TYPE_INVALID|The message type is invalid|
|400|START_PARAM_INVALID|Start parameter invalid|
|400|WEBDOCUMENT_INVALID|Invalid webdocument URL provided|

1
docs/API_docs/methods/messages.setTyping.md
View File

@ -61,5 +61,6 @@ Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, })
|400|USER_IS_BOT|Bots can't send messages to other bots|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|-503|Timeout|Timeout while fetching data|

1
docs/API_docs/methods/messages.updatePinnedMessage.md
View File

@ -54,6 +54,7 @@ Updates = messages.updatePinnedMessage({silent=Bool, peer=InputPeer, id=int, })
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
|400|PIN_RESTRICTED|You can't pin messages|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|

1
docs/API_docs/methods/messages.uploadMedia.md
View File

@ -58,5 +58,6 @@ MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, })
|400|PHOTO_EXT_INVALID|The extension of the photo is invalid|
|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|-503|Timeout|Timeout while fetching data|

45
docs/API_docs/methods/phone.sendSignalingData.md Normal file
View File

@ -0,0 +1,45 @@
---
title: phone.sendSignalingData
description: phone.sendSignalingData parameters, return type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/phone_sendSignalingData.html
---
# Method: phone.sendSignalingData
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|
|data|[bytes](../types/bytes.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Bool = $MadelineProto->phone->sendSignalingData(['peer' => InputPhoneCall, 'data' => 'bytes', ]);
```
Or, if you're into Lua:
```lua
Bool = phone.sendSignalingData({peer=InputPhoneCall, data='bytes', })
```

7
docs/API_docs/methods/photos.deletePhotos.md
View File

@ -44,3 +44,10 @@ Or, if you're into Lua:
Vector_of_long = photos.deletePhotos({id={InputPhoto}, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|-503|Timeout|Timeout while fetching data|

7
docs/API_docs/methods/photos.updateProfilePhoto.md
View File

@ -18,7 +18,7 @@ Installs a previously uploaded photo as a profile photo.
|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Input photo | Optional|
### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md)
### Return type: [photos.Photo](../types/photos.Photo.md)
### Can bots use this method: **NO**
@ -35,13 +35,13 @@ include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$UserProfilePhoto = $MadelineProto->photos->updateProfilePhoto(['id' => InputPhoto, ]);
$photos.Photo = $MadelineProto->photos->updateProfilePhoto(['id' => InputPhoto, ]);
```
Or, if you're into Lua:
```lua
UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, })
photos.Photo = photos.updateProfilePhoto({id=InputPhoto, })
```
### Errors
@ -53,5 +53,6 @@ UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, })
|400|LOCATION_INVALID|The provided location is invalid|
|400|PHOTO_CROP_SIZE_SMALL|Photo is too small|
|400|PHOTO_EXT_INVALID|The extension of the photo is invalid|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|

9
docs/API_docs/methods/photos.uploadProfilePhoto.md
View File

@ -15,7 +15,9 @@ Updates current user profile photo.
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|file|[File path or InputFile](../types/InputFile.md) | File saved in parts by means of [upload.saveFilePart](../methods/upload.saveFilePart.md) method | Yes|
|file|[File path or InputFile](../types/InputFile.md) | File saved in parts by means of [upload.saveFilePart](../methods/upload.saveFilePart.md) method | Optional|
|video|[File path or InputFile](../types/InputFile.md) | | Optional|
|video\_start\_ts|[double](../types/double.md) | | Optional|
### Return type: [photos.Photo](../types/photos.Photo.md)
@ -35,13 +37,13 @@ include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$photos.Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, ]);
$photos.Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, 'video' => InputFile, 'video_start_ts' => double, ]);
```
Or, if you're into Lua:
```lua
photos.Photo = photos.uploadProfilePhoto({file=InputFile, })
photos.Photo = photos.uploadProfilePhoto({file=InputFile, video=InputFile, video_start_ts=double, })
```
### Errors
@ -53,5 +55,6 @@ photos.Photo = photos.uploadProfilePhoto({file=InputFile, })
|400|PHOTO_CROP_FILE_MISSING|Photo crop file missing|
|400|PHOTO_CROP_SIZE_SMALL|Photo is too small|
|400|PHOTO_EXT_INVALID|The extension of the photo is invalid|
|-503|Timeout|Timeout while fetching data|

45
docs/API_docs/methods/stats.getMegagroupStats.md Normal file
View File

@ -0,0 +1,45 @@
---
title: stats.getMegagroupStats
description: stats.getMegagroupStats parameters, return type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/methods/stats_getMegagroupStats.html
---
# Method: stats.getMegagroupStats
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|dark|[Bool](../types/Bool.md) | Optional|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|
### Return type: [stats.MegagroupStats](../types/stats.MegagroupStats.md)
### Can bots use this method: **YES**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$stats.MegagroupStats = $MadelineProto->stats->getMegagroupStats(['dark' => Bool, 'channel' => InputChannel, ]);
```
Or, if you're into Lua:
```lua
stats.MegagroupStats = stats.getMegagroupStats({dark=Bool, channel=InputChannel, })
```

1
docs/API_docs/methods/updates.getDifference.md
View File

@ -59,6 +59,7 @@ updates.Difference = updates.getDifference({pts=int, pts_total_limit=int, date=i
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|-500|No workers running|Internal error|
|-504|memory limit exit|Internal error|
|-503|Timeout|Timeout while fetching data|

4
docs/API_docs/types/ChatInvite.md
View File

@ -14,6 +14,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[chatInvite](../constructors/chatInvite.md)
[chatInvitePeek](../constructors/chatInvitePeek.md)
### Methods that return an object of this type (methods):
@ -26,5 +28,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[chatInvite](../constructors/chatInvite.md)
[chatInvitePeek](../constructors/chatInvitePeek.md)
[$MadelineProto->messages->checkChatInvite](../methods/messages.checkChatInvite.md)

30
docs/API_docs/types/GlobalPrivacySettings.md Normal file
View File

@ -0,0 +1,30 @@
---
title: GlobalPrivacySettings
description: constructors and methods of type GlobalPrivacySettings
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Type: GlobalPrivacySettings
[Back to types index](index.md)
### Possible values (constructors):
[globalPrivacySettings](../constructors/globalPrivacySettings.md)
### Methods that return an object of this type (methods):
[$MadelineProto->account->getGlobalPrivacySettings](../methods/account.getGlobalPrivacySettings.md)
[$MadelineProto->account->setGlobalPrivacySettings](../methods/account.setGlobalPrivacySettings.md)
[globalPrivacySettings](../constructors/globalPrivacySettings.md)
[$MadelineProto->account->getGlobalPrivacySettings](../methods/account.getGlobalPrivacySettings.md)
[$MadelineProto->account->setGlobalPrivacySettings](../methods/account.setGlobalPrivacySettings.md)

4
docs/API_docs/types/InputMedia.md
View File

@ -27,8 +27,6 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [
[inputMediaVenue](../constructors/inputMediaVenue.md)
[inputMediaGifExternal](../constructors/inputMediaGifExternal.md)
[inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md)
[inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md)
@ -65,8 +63,6 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [
[inputMediaVenue](../constructors/inputMediaVenue.md)
[inputMediaGifExternal](../constructors/inputMediaGifExternal.md)
[inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md)
[inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md)

4
docs/API_docs/types/PhoneConnection.md
View File

@ -12,6 +12,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[phoneConnection](../constructors/phoneConnection.md)
[phoneConnectionWebrtc](../constructors/phoneConnectionWebrtc.md)
### Methods that return an object of this type (methods):
@ -20,3 +22,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[phoneConnection](../constructors/phoneConnection.md)
[phoneConnectionWebrtc](../constructors/phoneConnectionWebrtc.md)

22
docs/API_docs/types/StatsGroupTopAdmin.md Normal file
View File

@ -0,0 +1,22 @@
---
title: StatsGroupTopAdmin
description: constructors and methods of type StatsGroupTopAdmin
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Type: StatsGroupTopAdmin
[Back to types index](index.md)
### Possible values (constructors):
[statsGroupTopAdmin](../constructors/statsGroupTopAdmin.md)
### Methods that return an object of this type (methods):
[statsGroupTopAdmin](../constructors/statsGroupTopAdmin.md)

22
docs/API_docs/types/StatsGroupTopInviter.md Normal file
View File

@ -0,0 +1,22 @@
---
title: StatsGroupTopInviter
description: constructors and methods of type StatsGroupTopInviter
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Type: StatsGroupTopInviter
[Back to types index](index.md)
### Possible values (constructors):
[statsGroupTopInviter](../constructors/statsGroupTopInviter.md)
### Methods that return an object of this type (methods):
[statsGroupTopInviter](../constructors/statsGroupTopInviter.md)

22
docs/API_docs/types/StatsGroupTopPoster.md Normal file
View File

@ -0,0 +1,22 @@
---
title: StatsGroupTopPoster
description: constructors and methods of type StatsGroupTopPoster
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Type: StatsGroupTopPoster
[Back to types index](index.md)
### Possible values (constructors):
[statsGroupTopPoster](../constructors/statsGroupTopPoster.md)
### Methods that return an object of this type (methods):
[statsGroupTopPoster](../constructors/statsGroupTopPoster.md)

8
docs/API_docs/types/Update.md
View File

@ -170,6 +170,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[updateDialogFilters](../constructors/updateDialogFilters.md)
[updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md)
[updateChannelParticipant](../constructors/updateChannelParticipant.md)
### Methods that return an object of this type (methods):
@ -336,3 +340,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[updateDialogFilters](../constructors/updateDialogFilters.md)
[updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md)
[updateChannelParticipant](../constructors/updateChannelParticipant.md)

4
docs/API_docs/types/UserProfilePhoto.md
View File

@ -18,13 +18,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
### Methods that return an object of this type (methods):
[$MadelineProto->photos->updateProfilePhoto](../methods/photos.updateProfilePhoto.md)
[userProfilePhotoEmpty](../constructors/userProfilePhotoEmpty.md)
[userProfilePhoto](../constructors/userProfilePhoto.md)
[$MadelineProto->photos->updateProfilePhoto](../methods/photos.updateProfilePhoto.md)

22
docs/API_docs/types/VideoSize.md Normal file
View File

@ -0,0 +1,22 @@
---
title: VideoSize
description: constructors and methods of type VideoSize
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Type: VideoSize
[Back to types index](index.md)
### Possible values (constructors):
[videoSize](../constructors/videoSize.md)
### Methods that return an object of this type (methods):
[videoSize](../constructors/videoSize.md)

16
docs/API_docs/types/index.md
View File

@ -126,12 +126,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[FolderPeer](FolderPeer.md)<a name="FolderPeer"></a>
[FoundGif](FoundGif.md)<a name="FoundGif"></a>
[Game](Game.md)<a name="Game"></a>
[GeoPoint](GeoPoint.md)<a name="GeoPoint"></a>
[GlobalPrivacySettings](GlobalPrivacySettings.md)<a name="GlobalPrivacySettings"></a>
[HighScore](HighScore.md)<a name="HighScore"></a>
[ImportedContact](ImportedContact.md)<a name="ImportedContact"></a>
@ -368,6 +368,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[StatsGraph](StatsGraph.md)<a name="StatsGraph"></a>
[StatsGroupTopAdmin](StatsGroupTopAdmin.md)<a name="StatsGroupTopAdmin"></a>
[StatsGroupTopInviter](StatsGroupTopInviter.md)<a name="StatsGroupTopInviter"></a>
[StatsGroupTopPoster](StatsGroupTopPoster.md)<a name="StatsGroupTopPoster"></a>
[StatsPercentValue](StatsPercentValue.md)<a name="StatsPercentValue"></a>
[StatsURL](StatsURL.md)<a name="StatsURL"></a>
@ -404,6 +410,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[UserStatus](UserStatus.md)<a name="UserStatus"></a>
[VideoSize](VideoSize.md)<a name="VideoSize"></a>
[WallPaper](WallPaper.md)<a name="WallPaper"></a>
[WallPaperSettings](WallPaperSettings.md)<a name="WallPaperSettings"></a>
@ -528,8 +536,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[messages.FeaturedStickers](messages.FeaturedStickers.md)<a name="messages.FeaturedStickers"></a>
[messages.FoundGifs](messages.FoundGifs.md)<a name="messages.FoundGifs"></a>
[messages.FoundStickerSets](messages.FoundStickerSets.md)<a name="messages.FoundStickerSets"></a>
[messages.HighScores](messages.HighScores.md)<a name="messages.HighScores"></a>
@ -578,6 +584,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[stats.BroadcastStats](stats.BroadcastStats.md)<a name="stats.BroadcastStats"></a>
[stats.MegagroupStats](stats.MegagroupStats.md)<a name="stats.MegagroupStats"></a>
[storage.FileType](storage.FileType.md)<a name="storage.FileType"></a>
[updates.ChannelDifference](updates.ChannelDifference.md)<a name="updates.ChannelDifference"></a>

4
docs/API_docs/types/photos.Photo.md
View File

@ -17,11 +17,15 @@ redirect_from: /API_docs/types/photos_Photo.html
### Methods that return an object of this type (methods):
[$MadelineProto->photos->updateProfilePhoto](../methods/photos.updateProfilePhoto.md)
[$MadelineProto->photos->uploadProfilePhoto](../methods/photos.uploadProfilePhoto.md)
[photos.photo](../constructors/photos.photo.md)
[$MadelineProto->photos->updateProfilePhoto](../methods/photos.updateProfilePhoto.md)
[$MadelineProto->photos->uploadProfilePhoto](../methods/photos.uploadProfilePhoto.md)

27
docs/API_docs/types/stats.MegagroupStats.md Normal file
View File

@ -0,0 +1,27 @@
---
title: stats.MegagroupStats
description: constructors and methods of type stats.MegagroupStats
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/types/stats_MegagroupStats.html
---
# Type: stats.MegagroupStats
[Back to types index](index.md)
### Possible values (constructors):
[stats.megagroupStats](../constructors/stats.megagroupStats.md)
### Methods that return an object of this type (methods):
[$MadelineProto->stats->getMegagroupStats](../methods/stats.getMegagroupStats.md)
[stats.megagroupStats](../constructors/stats.megagroupStats.md)
[$MadelineProto->stats->getMegagroupStats](../methods/stats.getMegagroupStats.md)

40
docs/MTProto_docs/constructors/photoStrippedSize.md Normal file
View File

@ -0,0 +1,40 @@
---
title: photoStrippedSize
description: Just the image's content
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: photoStrippedSize
[Back to constructors index](index.md)
Just the image's content
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|type|[string](../types/string.md) | Yes|Thumbnail type|
|bytes|[bytes](../types/bytes.md) | Yes|Thumbnail data|
|inflated|[bytes](../types/bytes.md) | Yes|JPG image data|
### Type: [PhotoSize](../types/PhotoSize.md)
### Example:
```php
$photoStrippedSize = ['_' => 'photoStrippedSize', 'type' => 'string', 'bytes' => 'bytes'];
```
Or, if you're into Lua:
```lua
photoStrippedSize={_='photoStrippedSize', type='string', bytes='bytes'}
```

7
docs/MTProto_docs/methods/req_DH_params.md
View File

@ -46,10 +46,3 @@ Or, if you're into Lua:
Server_DH_Params = req_DH_params({nonce=int128, server_nonce=int128, p='string', q='string', public_key_fingerprint=long, encrypted_data='string', })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_METHOD_INVALID_3608339646_X|Invalid method|

7
docs/MTProto_docs/methods/req_pq.md
View File

@ -41,10 +41,3 @@ Or, if you're into Lua:
ResPQ = req_pq({nonce=int128, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_METHOD_INVALID_1615239032_X|Invalid method, use req_pq_multi instead|

7
docs/MTProto_docs/methods/req_pq_multi.md
View File

@ -41,10 +41,3 @@ Or, if you're into Lua:
ResPQ = req_pq_multi({nonce=int128, })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_METHOD_INVALID_3195965169_X|Invalid method|

7
docs/MTProto_docs/methods/set_client_DH_params.md
View File

@ -43,10 +43,3 @@ Or, if you're into Lua:
Set_client_DH_params_answer = set_client_DH_params({nonce=int128, server_nonce=int128, encrypted_data='string', })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_METHOD_INVALID_4110704415_X|Invalid method|

1
docs/docs/ASYNC.md
View File

@ -653,6 +653,5 @@ $loop->start();
```
Unlike `GenericLoop`, the callback will **not** be bound to the GenericLoop instance.
You can still command the loop by using the pause/waitSignal methods from the outside or by capturing the loop instance in a closure like shown above.
s
<a href="https://docs.madelineproto.xyz/docs/USING_METHODS.html">Next section</a>

2
docs/docs/CALLS.md
View File

@ -104,4 +104,4 @@ class PonyHandler extends \danog\MadelineProto\EventHandler
}
```
<a href="https://docs.madelineproto.xyz/docs/FILES.html">Next section</a>
<a href="https://docs.madelineproto.xyz/docs/FILES.html">Next section</a>

2
docs/docs/CHAT_INFO.md
View File

@ -58,4 +58,4 @@ You can also use `getId` to get chat ID from updates, messages and other objects
* Speed: very fast
* Caching: full
<a href="https://docs.madelineproto.xyz/docs/DIALOGS.html">Next section</a>
<a href="https://docs.madelineproto.xyz/docs/DIALOGS.html">Next section</a>

2
docs/docs/USING_METHODS.md
View File

@ -7,7 +7,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
There are simplifications for many, if not all of, these methods.
A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 113)](https://docs.madelineproto.xyz/API_docs/).
A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 117)](https://docs.madelineproto.xyz/API_docs/).
[Now fully async!](https://docs.madelineproto.xyz/docs/ASYNC.html)

1
docs/index.md
View File

@ -473,7 +473,6 @@ You can find examples for nearly every MadelineProto function in
* <a href="https://docs.madelineproto.xyz/API_docs/methods/upload.saveBigFilePart.html" name="upload.saveBigFilePart">Saves a part of a large file (over 10Mb in size) to be later passed to one of the methods: upload.saveBigFilePart</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/upload.saveFilePart.html" name="upload.saveFilePart">Saves a part of file for futher sending to one of the methods: upload.saveFilePart</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/help.saveAppLog.html" name="help.saveAppLog">Saves logs of application on the server: help.saveAppLog</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages.searchGifs.html" name="messages.searchGifs">Search for GIFs: messages.searchGifs</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages.searchGlobal.html" name="messages.searchGlobal">Search for messages and peers globally: messages.searchGlobal</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages.searchStickerSets.html" name="messages.searchStickerSets">Search for stickersets: messages.searchStickerSets</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account.saveSecureValue.html" name="account.saveSecureValue">Securely save Telegram Passport document, for more info see the passport docs »: account.saveSecureValue</a>

40
old_docs/API_docs_v0/constructors/photoStrippedSize.md Normal file
View File

@ -0,0 +1,40 @@
---
title: photoStrippedSize
description: Just the image's content
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: photoStrippedSize
[Back to constructors index](index.md)
Just the image's content
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|type|[string](../types/string.md) | Yes|Thumbnail type|
|bytes|[bytes](../types/bytes.md) | Yes|Thumbnail data|
|inflated|[bytes](../types/bytes.md) | Yes|JPG image data|
### Type: [PhotoSize](../types/PhotoSize.md)
### Example:
```php
$photoStrippedSize = ['_' => 'photoStrippedSize', 'type' => 'string', 'bytes' => 'bytes'];
```
Or, if you're into Lua:
```lua
photoStrippedSize={_='photoStrippedSize', type='string', bytes='bytes'}
```

1
old_docs/API_docs_v0/methods/auth.sendCode.md
View File

@ -61,6 +61,7 @@ auth.SentCode = auth.sendCode({phone_number='string', sms_type=int, api_id=int,
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|400|PHONE_PASSWORD_PROTECTED|This phone is password protected|
|400|SMS_CODE_CREATE_FAILED|An error occurred while creating the SMS code|
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
|406|PHONE_NUMBER_INVALID|The phone number is invalid|
|406|PHONE_PASSWORD_FLOOD|You have tried logging in too many times|
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|

1
old_docs/API_docs_v0/methods/auth.signUp.md
View File

@ -53,6 +53,7 @@ auth.Authorization = auth.signUp({phone_number='string', phone_code_hash='string
| Code | Type | Description |
|------|----------|---------------|
|400|FIRSTNAME_INVALID|The first name is invalid|
|400|INPUT_REQUEST_TOO_LONG|The request is too big|
|400|PHONE_CODE_EMPTY|phone_code is missing|
|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)|
|400|PHONE_CODE_INVALID|The provided phone code is invalid|

1
old_docs/API_docs_v0/methods/contacts.block.md
View File

@ -50,5 +50,6 @@ Bool = contacts.block({id=InputUser, })
|------|----------|---------------|
|400|CONTACT_ID_INVALID|The provided contact ID is invalid|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|MSG_ID_INVALID|Invalid message ID provided|

Some files were not shown because too many files have changed in this diff Show More