diff --git a/docs/API_docs/constructors/botCommand.md b/docs/API_docs/constructors/botCommand.md
index 6c85fc3e..0ef50e29 100644
--- a/docs/API_docs/constructors/botCommand.md
+++ b/docs/API_docs/constructors/botCommand.md
@@ -1,6 +1,6 @@
---
title: botCommand
-description: Represents command supported by bot
+description: Describes a bot command that can be used in a chat
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: botCommand
@@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
-Represents command supported by bot
+Describes a bot command that can be used in a chat
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|command|[string](../types/string.md) | Yes|Text of the bot command|
-|description|[string](../types/string.md) | Yes|Description of the bot command|
+|command|[string](../types/string.md) | Yes|`/command` name|
+|description|[string](../types/string.md) | Yes|Description of the command|
diff --git a/docs/API_docs/constructors/channelFull.md b/docs/API_docs/constructors/channelFull.md
index 517e7d1d..ad57fd00 100644
--- a/docs/API_docs/constructors/channelFull.md
+++ b/docs/API_docs/constructors/channelFull.md
@@ -21,6 +21,7 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/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|
+|blocked|[Bool](../types/Bool.md) | Optional|
|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 +57,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_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];
+$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, 'blocked' => 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_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}
+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, blocked=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}
```
diff --git a/docs/API_docs/constructors/channelParticipantCreator.md b/docs/API_docs/constructors/channelParticipantCreator.md
index 0de76c13..c95ca3a4 100644
--- a/docs/API_docs/constructors/channelParticipantCreator.md
+++ b/docs/API_docs/constructors/channelParticipantCreator.md
@@ -15,6 +15,7 @@ Channel/supergroup creator
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|User ID|
+|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|
|rank|[string](../types/string.md) | Optional|The role (rank) of the group creator in the group: just an arbitrary string, `admin` by default|
@@ -25,14 +26,14 @@ Channel/supergroup creator
### Example:
```php
-$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int, 'rank' => 'string'];
+$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int, 'admin_rights' => ChatAdminRights, 'rank' => 'string'];
```
Or, if you're into Lua:
```lua
-channelParticipantCreator={_='channelParticipantCreator', user_id=int, rank='string'}
+channelParticipantCreator={_='channelParticipantCreator', user_id=int, admin_rights=ChatAdminRights, rank='string'}
```
diff --git a/docs/API_docs/constructors/chatAdminRights.md b/docs/API_docs/constructors/chatAdminRights.md
index f80ff21b..b0540e84 100644
--- a/docs/API_docs/constructors/chatAdminRights.md
+++ b/docs/API_docs/constructors/chatAdminRights.md
@@ -22,6 +22,7 @@ Represents the rights of an admin in a [channel/supergroup](https://core.telegra
|invite\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to invite users in the [channel/supergroup](https://core.telegram.org/api/channel)|
|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to pin messages in the [channel/supergroup](https://core.telegram.org/api/channel)|
|add\_admins|[Bool](../types/Bool.md) | Optional|If set, allows the admin to add other admins with the same (or more limited) permissions in the [channel/supergroup](https://core.telegram.org/api/channel)|
+|anonymous|[Bool](../types/Bool.md) | Optional|
@@ -31,14 +32,14 @@ Represents the rights of an admin in a [channel/supergroup](https://core.telegra
### Example:
```php
-$chatAdminRights = ['_' => 'chatAdminRights', 'change_info' => Bool, 'post_messages' => Bool, 'edit_messages' => Bool, 'delete_messages' => Bool, 'ban_users' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'add_admins' => Bool];
+$chatAdminRights = ['_' => 'chatAdminRights', 'change_info' => Bool, 'post_messages' => Bool, 'edit_messages' => Bool, 'delete_messages' => Bool, 'ban_users' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'add_admins' => Bool, 'anonymous' => Bool];
```
Or, if you're into Lua:
```lua
-chatAdminRights={_='chatAdminRights', change_info=Bool, post_messages=Bool, edit_messages=Bool, delete_messages=Bool, ban_users=Bool, invite_users=Bool, pin_messages=Bool, add_admins=Bool}
+chatAdminRights={_='chatAdminRights', change_info=Bool, post_messages=Bool, edit_messages=Bool, delete_messages=Bool, ban_users=Bool, invite_users=Bool, pin_messages=Bool, add_admins=Bool, anonymous=Bool}
```
diff --git a/docs/API_docs/constructors/chatBannedRights.md b/docs/API_docs/constructors/chatBannedRights.md
index a678973a..f53db6d3 100644
--- a/docs/API_docs/constructors/chatBannedRights.md
+++ b/docs/API_docs/constructors/chatBannedRights.md
@@ -26,7 +26,7 @@ Represents the rights of a normal user in a [supergroup/channel/chat](https://co
|change\_info|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to change the description of a [supergroup/chat](https://core.telegram.org/api/channel)|
|invite\_users|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to invite users in a [supergroup/chat](https://core.telegram.org/api/channel)|
|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to pin messages in a [supergroup/chat](https://core.telegram.org/api/channel)|
-|until\_date|[int](../types/int.md) | Yes|Validity of said permissions (it is considered forever any value less then 30 seconds or more then 366 days).|
+|until\_date|[int](../types/int.md) | Yes|Validity of said permissions (0 = forever, forever = 2^31-1 for now).|
diff --git a/docs/API_docs/constructors/contactBlocked.md b/docs/API_docs/constructors/contactBlocked.md
deleted file mode 100644
index 43052f8d..00000000
--- a/docs/API_docs/constructors/contactBlocked.md
+++ /dev/null
@@ -1,39 +0,0 @@
----
-title: contactBlocked
-description: A blocked user.
-image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
----
-# Constructor: contactBlocked
-[Back to constructors index](index.md)
-
-
-
-A blocked user.
-
-### Attributes:
-
-| Name | Type | Required | Description |
-|----------|---------------|----------|-------------|
-|user\_id|[int](../types/int.md) | Yes|User identifier|
-|date|[int](../types/int.md) | Yes|Date blacklisted|
-
-
-
-### Type: [ContactBlocked](../types/ContactBlocked.md)
-
-
-### Example:
-
-```php
-$contactBlocked = ['_' => 'contactBlocked', 'user_id' => int, 'date' => int];
-```
-
-
-Or, if you're into Lua:
-
-```lua
-contactBlocked={_='contactBlocked', user_id=int, date=int}
-
-```
-
-
diff --git a/docs/API_docs/constructors/contacts.blocked.md b/docs/API_docs/constructors/contacts.blocked.md
index ffb372a0..6d811e23 100644
--- a/docs/API_docs/constructors/contacts.blocked.md
+++ b/docs/API_docs/constructors/contacts.blocked.md
@@ -15,7 +15,8 @@ Full list of blocked users.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|List of blocked users|
+|blocked|Array of [PeerBlocked](../types/PeerBlocked.md) | Yes|List of blocked users|
+|chats|Array of [Chat](../types/Chat.md) | Yes|
|users|Array of [User](../types/User.md) | Yes|List of users|
@@ -26,14 +27,14 @@ Full list of blocked users.
### Example:
```php
-$contacts.blocked = ['_' => 'contacts.blocked', 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
+$contacts.blocked = ['_' => 'contacts.blocked', 'blocked' => [PeerBlocked, PeerBlocked], 'chats' => [Chat, Chat], 'users' => [User, User]];
```
Or, if you're into Lua:
```lua
-contacts.blocked={_='contacts.blocked', blocked={ContactBlocked}, users={User}}
+contacts.blocked={_='contacts.blocked', blocked={PeerBlocked}, chats={Chat}, users={User}}
```
diff --git a/docs/API_docs/constructors/contacts.blockedSlice.md b/docs/API_docs/constructors/contacts.blockedSlice.md
index 53ac1194..044e1058 100644
--- a/docs/API_docs/constructors/contacts.blockedSlice.md
+++ b/docs/API_docs/constructors/contacts.blockedSlice.md
@@ -16,7 +16,8 @@ Incomplete list of blocked users.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|count|[int](../types/int.md) | Yes|Total number of elements in the list|
-|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|List of blocked users|
+|blocked|Array of [PeerBlocked](../types/PeerBlocked.md) | Yes|List of blocked users|
+|chats|Array of [Chat](../types/Chat.md) | Yes|
|users|Array of [User](../types/User.md) | Yes|List of users|
@@ -27,14 +28,14 @@ Incomplete list of blocked users.
### Example:
```php
-$contacts.blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
+$contacts.blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [PeerBlocked, PeerBlocked], 'chats' => [Chat, Chat], 'users' => [User, User]];
```
Or, if you're into Lua:
```lua
-contacts.blockedSlice={_='contacts.blockedSlice', count=int, blocked={ContactBlocked}, users={User}}
+contacts.blockedSlice={_='contacts.blockedSlice', count=int, blocked={PeerBlocked}, chats={Chat}, users={User}}
```
diff --git a/docs/API_docs/constructors/help.countriesList.md b/docs/API_docs/constructors/help.countriesList.md
new file mode 100644
index 00000000..d48a6863
--- /dev/null
+++ b/docs/API_docs/constructors/help.countriesList.md
@@ -0,0 +1,38 @@
+---
+title: help.countriesList
+description: help.countriesList attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/help_countriesList.html
+---
+# Constructor: help.countriesList
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|countries|Array of [help.Country](../constructors/help.Country.md) | Yes|
+|hash|[int](../types/int.md) | Yes|
+
+
+
+### Type: [help.CountriesList](../types/help.CountriesList.md)
+
+
+### Example:
+
+```php
+$help.countriesList = ['_' => 'help.countriesList', 'countries' => [help.Country, help.Country], 'hash' => int];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+help.countriesList={_='help.countriesList', countries={help.Country}, hash=int}
+
+```
+
+
diff --git a/docs/API_docs/constructors/help.countriesListNotModified.md b/docs/API_docs/constructors/help.countriesListNotModified.md
new file mode 100644
index 00000000..443e182d
--- /dev/null
+++ b/docs/API_docs/constructors/help.countriesListNotModified.md
@@ -0,0 +1,32 @@
+---
+title: help.countriesListNotModified
+description: help.countriesListNotModified attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/help_countriesListNotModified.html
+---
+# Constructor: help.countriesListNotModified
+[Back to constructors index](index.md)
+
+
+
+
+
+
+### Type: [help.CountriesList](../types/help.CountriesList.md)
+
+
+### Example:
+
+```php
+$help.countriesListNotModified = ['_' => 'help.countriesListNotModified'];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+help.countriesListNotModified={_='help.countriesListNotModified'}
+
+```
+
+
diff --git a/docs/API_docs/constructors/help.country.md b/docs/API_docs/constructors/help.country.md
new file mode 100644
index 00000000..c34ae315
--- /dev/null
+++ b/docs/API_docs/constructors/help.country.md
@@ -0,0 +1,41 @@
+---
+title: help.country
+description: help.country attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/help_country.html
+---
+# Constructor: help.country
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|hidden|[Bool](../types/Bool.md) | Optional|
+|iso2|[string](../types/string.md) | Yes|
+|default\_name|[string](../types/string.md) | Yes|
+|name|[string](../types/string.md) | Optional|
+|country\_codes|Array of [help.CountryCode](../constructors/help.CountryCode.md) | Yes|
+
+
+
+### Type: [help.Country](../types/help.Country.md)
+
+
+### Example:
+
+```php
+$help.country = ['_' => 'help.country', 'hidden' => Bool, 'iso2' => 'string', 'default_name' => 'string', 'name' => 'string', 'country_codes' => [help.CountryCode, help.CountryCode]];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+help.country={_='help.country', hidden=Bool, iso2='string', default_name='string', name='string', country_codes={help.CountryCode}}
+
+```
+
+
diff --git a/docs/API_docs/constructors/help.countryCode.md b/docs/API_docs/constructors/help.countryCode.md
new file mode 100644
index 00000000..a7eaf256
--- /dev/null
+++ b/docs/API_docs/constructors/help.countryCode.md
@@ -0,0 +1,39 @@
+---
+title: help.countryCode
+description: help.countryCode attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/help_countryCode.html
+---
+# Constructor: help.countryCode
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|country\_code|[string](../types/string.md) | Yes|
+|prefixes|Array of [string](../types/string.md) | Optional|
+|patterns|Array of [string](../types/string.md) | Optional|
+
+
+
+### Type: [help.CountryCode](../types/help.CountryCode.md)
+
+
+### Example:
+
+```php
+$help.countryCode = ['_' => 'help.countryCode', 'country_code' => 'string', 'prefixes' => ['string', 'string'], 'patterns' => ['string', 'string']];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+help.countryCode={_='help.countryCode', country_code='string', prefixes={'string'}, patterns={'string'}}
+
+```
+
+
diff --git a/docs/API_docs/constructors/index.md b/docs/API_docs/constructors/index.md
index 47747eb8..fb48fced 100644
--- a/docs/API_docs/constructors/index.md
+++ b/docs/API_docs/constructors/index.md
@@ -241,7 +241,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$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), \];
***
-
[$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), \];
+
[$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), 'blocked' => [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), \];
***
[$channelLocation](../constructors/channelLocation.md) = \['geo_point' => [GeoPoint](../types/GeoPoint.md), 'address' => [string](../types/string.md), \];
@@ -265,7 +265,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$channelParticipantBanned](../constructors/channelParticipantBanned.md) = \['left' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'kicked_by' => [int](../types/int.md), 'date' => [int](../types/int.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \];
***
-
[$channelParticipantCreator](../constructors/channelParticipantCreator.md) = \['user_id' => [int](../types/int.md), 'rank' => [string](../types/string.md), \];
+
[$channelParticipantCreator](../constructors/channelParticipantCreator.md) = \['user_id' => [int](../types/int.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'rank' => [string](../types/string.md), \];
***
[$channelParticipantSelf](../constructors/channelParticipantSelf.md) = \['user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \];
@@ -307,7 +307,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$chat](../constructors/chat.md) = \['creator' => [Bool](../types/Bool.md), 'kicked' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'deactivated' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'participants_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'migrated_to' => [InputChannel](../types/InputChannel.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \];
***
-
[$chatAdminRights](../constructors/chatAdminRights.md) = \['change_info' => [Bool](../types/Bool.md), 'post_messages' => [Bool](../types/Bool.md), 'edit_messages' => [Bool](../types/Bool.md), 'delete_messages' => [Bool](../types/Bool.md), 'ban_users' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'add_admins' => [Bool](../types/Bool.md), \];
+
[$chatAdminRights](../constructors/chatAdminRights.md) = \['change_info' => [Bool](../types/Bool.md), 'post_messages' => [Bool](../types/Bool.md), 'edit_messages' => [Bool](../types/Bool.md), 'delete_messages' => [Bool](../types/Bool.md), 'ban_users' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'add_admins' => [Bool](../types/Bool.md), 'anonymous' => [Bool](../types/Bool.md), \];
***
[$chatBannedRights](../constructors/chatBannedRights.md) = \['view_messages' => [Bool](../types/Bool.md), 'send_messages' => [Bool](../types/Bool.md), 'send_media' => [Bool](../types/Bool.md), 'send_stickers' => [Bool](../types/Bool.md), 'send_gifs' => [Bool](../types/Bool.md), 'send_games' => [Bool](../types/Bool.md), 'send_inline' => [Bool](../types/Bool.md), 'embed_links' => [Bool](../types/Bool.md), 'send_polls' => [Bool](../types/Bool.md), 'change_info' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'until_date' => [int](../types/int.md), \];
@@ -369,17 +369,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$contact](../constructors/contact.md) = \['user_id' => [int](../types/int.md), 'mutual' => [Bool](../types/Bool.md), \];
-***
-
[$contactBlocked](../constructors/contactBlocked.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \];
-
***
[$contactStatus](../constructors/contactStatus.md) = \['user_id' => [int](../types/int.md), 'status' => [UserStatus](../types/UserStatus.md), \];
***
-
[$contacts.blocked](../constructors/contacts.blocked.md) = \['blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \];
+
[$contacts.blocked](../constructors/contacts.blocked.md) = \['blocked' => \[[PeerBlocked](../types/PeerBlocked.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
***
-
[$contacts.blockedSlice](../constructors/contacts.blockedSlice.md) = \['count' => [int](../types/int.md), 'blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \];
+
[$contacts.blockedSlice](../constructors/contacts.blockedSlice.md) = \['count' => [int](../types/int.md), 'blocked' => \[[PeerBlocked](../types/PeerBlocked.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
***
[$contacts.contacts](../constructors/contacts.contacts.md) = \['contacts' => \[[Contact](../types/Contact.md)\], 'saved_count' => [int](../types/int.md), 'users' => \[[User](../types/User.md)\], \];
@@ -621,6 +618,18 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$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), \];
+***
+
[$help.countriesList](../constructors/help.countriesList.md) = \['countries' => \[[help.Country](../types/help.Country.md)\], 'hash' => [int](../types/int.md), \];
+
+***
+
[$help.countriesListNotModified](../constructors/help.countriesListNotModified.md) = \[\];
+
+***
+
[$help.country](../constructors/help.country.md) = \['hidden' => [Bool](../types/Bool.md), 'iso2' => [string](../types/string.md), 'default_name' => [string](../types/string.md), 'name' => [string](../types/string.md), 'country_codes' => \[[help.CountryCode](../types/help.CountryCode.md)\], \];
+
+***
+
[$help.countryCode](../constructors/help.countryCode.md) = \['country_code' => [string](../types/string.md), 'prefixes' => \[[string](../types/string.md)\], 'patterns' => \[[string](../types/string.md)\], \];
+
***
[$help.deepLinkInfo](../constructors/help.deepLinkInfo.md) = \['update_app' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
@@ -1159,7 +1168,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$keyboardButtonBuy](../constructors/keyboardButtonBuy.md) = \['text' => [string](../types/string.md), \];
***
-
[$keyboardButtonCallback](../constructors/keyboardButtonCallback.md) = \['text' => [string](../types/string.md), 'data' => [bytes](../types/bytes.md), \];
+
[$keyboardButtonCallback](../constructors/keyboardButtonCallback.md) = \['requires_password' => [Bool](../types/Bool.md), 'text' => [string](../types/string.md), 'data' => [bytes](../types/bytes.md), \];
***
[$keyboardButtonGame](../constructors/keyboardButtonGame.md) = \['text' => [string](../types/string.md), \];
@@ -1207,7 +1216,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$maskCoords](../constructors/maskCoords.md) = \['n' => [int](../types/int.md), 'x' => [double](../types/double.md), 'y' => [double](../types/double.md), 'zoom' => [double](../types/double.md), \];
***
-
[$message](../constructors/message.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'from_scheduled' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'edit_hide' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'views' => [int](../types/int.md), 'edit_date' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'grouped_id' => [long](../types/long.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], \];
+
[$message](../constructors/message.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'from_scheduled' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'edit_hide' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [Peer](../types/Peer.md), 'peer_id' => [Peer](../types/Peer.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to' => [MessageReplyHeader](../types/MessageReplyHeader.md), 'date' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'views' => [int](../types/int.md), 'forwards' => [int](../types/int.md), 'replies' => [MessageReplies](../types/MessageReplies.md), 'edit_date' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'grouped_id' => [long](../types/long.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], \];
***
[$messageActionBotAllowed](../constructors/messageActionBotAllowed.md) = \['domain' => [string](../types/string.md), \];
@@ -1336,7 +1345,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messageEntityUrl](../constructors/messageEntityUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];
***
-
[$messageFwdHeader](../constructors/messageFwdHeader.md) = \['from_id' => [int](../types/int.md), 'from_name' => [string](../types/string.md), 'date' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'channel_post' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'saved_from_peer' => [Peer](../types/Peer.md), 'saved_from_msg_id' => [int](../types/int.md), 'psa_type' => [string](../types/string.md), \];
+
[$messageFwdHeader](../constructors/messageFwdHeader.md) = \['from_id' => [Peer](../types/Peer.md), 'from_name' => [string](../types/string.md), 'date' => [int](../types/int.md), 'channel_post' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'saved_from_peer' => [Peer](../types/Peer.md), 'saved_from_msg_id' => [int](../types/int.md), 'psa_type' => [string](../types/string.md), \];
***
[$messageInteractionCounters](../constructors/messageInteractionCounters.md) = \['msg_id' => [int](../types/int.md), 'views' => [int](../types/int.md), 'forwards' => [int](../types/int.md), \];
@@ -1384,7 +1393,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messageRange](../constructors/messageRange.md) = \['min_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), \];
***
-
[$messageService](../constructors/messageService.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'action' => [MessageAction](../types/MessageAction.md), \];
+
[$messageReplies](../constructors/messageReplies.md) = \['comments' => [Bool](../types/Bool.md), 'replies' => [int](../types/int.md), 'replies_pts' => [int](../types/int.md), 'recent_repliers' => \[[Peer](../types/Peer.md)\], 'channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'read_max_id' => [int](../types/int.md), \];
+
+***
+
[$messageReplyHeader](../constructors/messageReplyHeader.md) = \['reply_to_msg_id' => [int](../types/int.md), 'reply_to_peer_id' => [Peer](../types/Peer.md), 'reply_to_top_id' => [int](../types/int.md), \];
+
+***
+
[$messageService](../constructors/messageService.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [Peer](../types/Peer.md), 'peer_id' => [Peer](../types/Peer.md), 'reply_to' => [MessageReplyHeader](../types/MessageReplyHeader.md), 'date' => [int](../types/int.md), 'action' => [MessageAction](../types/MessageAction.md), \];
***
[$messageUserVote](../constructors/messageUserVote.md) = \['user_id' => [int](../types/int.md), 'option' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), \];
@@ -1395,6 +1410,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) = \['user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], 'date' => [int](../types/int.md), \];
+***
+
[$messageViews](../constructors/messageViews.md) = \['views' => [int](../types/int.md), 'forwards' => [int](../types/int.md), 'replies' => [MessageReplies](../types/MessageReplies.md), \];
+
***
[$messages.affectedHistory](../constructors/messages.affectedHistory.md) = \['pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'offset' => [int](../types/int.md), \];
@@ -1443,6 +1461,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$messages.dialogsSlice](../constructors/messages.dialogsSlice.md) = \['count' => [int](../types/int.md), 'dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
+***
+
[$messages.discussionMessage](../constructors/messages.discussionMessage.md) = \['messages' => \[[Message](../types/Message.md)\], 'max_id' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
+
***
[$messages.favedStickers](../constructors/messages.favedStickers.md) = \['hash' => [int](../types/int.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'stickers' => \[[Document](../types/Document.md)\], \];
@@ -1470,6 +1491,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$messages.messageEditData](../constructors/messages.messageEditData.md) = \['caption' => [Bool](../types/Bool.md), \];
+***
+
[$messages.messageViews](../constructors/messages.messageViews.md) = \['views' => \[[MessageViews](../types/MessageViews.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
+
***
[$messages.messages](../constructors/messages.messages.md) = \['messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];
@@ -1689,6 +1713,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$payments.validatedRequestedInfo](../constructors/payments.validatedRequestedInfo.md) = \['id' => [string](../types/string.md), 'shipping_options' => \[[ShippingOption](../types/ShippingOption.md)\], \];
+***
+
[$peerBlocked](../constructors/peerBlocked.md) = \['peer_id' => [Peer](../types/Peer.md), 'date' => [int](../types/int.md), \];
+
***
[$peerChannel](../constructors/peerChannel.md) = \['channel_id' => [int](../types/int.md), \];
@@ -1767,6 +1794,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$photoSizeEmpty](../constructors/photoSizeEmpty.md) = \['type' => [string](../types/string.md), \];
+***
+
[$photoSizeProgressive](../constructors/photoSizeProgressive.md) = \['type' => [string](../types/string.md), 'location' => [FileLocation](../types/FileLocation.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'sizes' => \[[int](../types/int.md)\], \];
+
***
[$photoStrippedSize](../constructors/photoStrippedSize.md) = \['type' => [string](../types/string.md), 'bytes' => [bytes](../types/bytes.md), \];
@@ -2037,6 +2067,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$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)\], \];
+***
+
[$stats.messageStats](../constructors/stats.messageStats.md) = \['views_graph' => [StatsGraph](../types/StatsGraph.md), \];
+
***
[$statsAbsValueAndPrev](../constructors/statsAbsValueAndPrev.md) = \['current' => [double](../types/double.md), 'previous' => [double](../types/double.md), \];
@@ -2223,6 +2256,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$updateChannelAvailableMessages](../constructors/updateChannelAvailableMessages.md) = \['channel_id' => [int](../types/int.md), 'available_min_id' => [int](../types/int.md), \];
+***
+
[$updateChannelMessageForwards](../constructors/updateChannelMessageForwards.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'forwards' => [int](../types/int.md), \];
+
***
[$updateChannelMessageViews](../constructors/updateChannelMessageViews.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'views' => [int](../types/int.md), \];
@@ -2238,6 +2274,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$updateChannelTooLong](../constructors/updateChannelTooLong.md) = \['channel_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), \];
+***
+
[$updateChannelUserTyping](../constructors/updateChannelUserTyping.md) = \['channel_id' => [int](../types/int.md), 'top_msg_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \];
+
***
[$updateChannelWebPage](../constructors/updateChannelWebPage.md) = \['channel_id' => [int](../types/int.md), 'webpage' => [WebPage](../types/WebPage.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \];
@@ -2361,6 +2400,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$updateNotifySettings](../constructors/updateNotifySettings.md) = \['peer' => [NotifyPeer](../types/NotifyPeer.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), \];
+***
+
[$updatePeerBlocked](../constructors/updatePeerBlocked.md) = \['peer_id' => [Peer](../types/Peer.md), 'blocked' => [Bool](../types/Bool.md), \];
+
***
[$updatePeerLocated](../constructors/updatePeerLocated.md) = \['peers' => \[[PeerLocated](../types/PeerLocated.md)\], \];
@@ -2382,6 +2424,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$updatePtsChanged](../constructors/updatePtsChanged.md) = \[\];
+***
+
[$updateReadChannelDiscussionInbox](../constructors/updateReadChannelDiscussionInbox.md) = \['channel_id' => [int](../types/int.md), 'top_msg_id' => [int](../types/int.md), 'read_max_id' => [int](../types/int.md), 'broadcast_id' => [int](../types/int.md), 'broadcast_post' => [int](../types/int.md), \];
+
+***
+
[$updateReadChannelDiscussionOutbox](../constructors/updateReadChannelDiscussionOutbox.md) = \['channel_id' => [int](../types/int.md), 'top_msg_id' => [int](../types/int.md), 'read_max_id' => [int](../types/int.md), \];
+
***
[$updateReadChannelInbox](../constructors/updateReadChannelInbox.md) = \['folder_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'still_unread_count' => [int](../types/int.md), 'pts' => [int](../types/int.md), \];
@@ -2413,10 +2461,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$updateShort](../constructors/updateShort.md) = \['update' => [Update](../types/Update.md), 'date' => [int](../types/int.md), \];
***
-
[$updateShortChatMessage](../constructors/updateShortChatMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'chat_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
+
[$updateShortChatMessage](../constructors/updateShortChatMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'chat_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to' => [MessageReplyHeader](../types/MessageReplyHeader.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
***
-
[$updateShortMessage](../constructors/updateShortMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
+
[$updateShortMessage](../constructors/updateShortMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to' => [MessageReplyHeader](../types/MessageReplyHeader.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
***
[$updateShortSentMessage](../constructors/updateShortSentMessage.md) = \['out' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];
@@ -2430,9 +2478,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
[$updateTheme](../constructors/updateTheme.md) = \['theme' => [Theme](../types/Theme.md), \];
-***
-
[$updateUserBlocked](../constructors/updateUserBlocked.md) = \['user_id' => [int](../types/int.md), 'blocked' => [Bool](../types/Bool.md), \];
-
***
[$updateUserName](../constructors/updateUserName.md) = \['user_id' => [int](../types/int.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), \];
diff --git a/docs/API_docs/constructors/keyboardButtonCallback.md b/docs/API_docs/constructors/keyboardButtonCallback.md
index 19251d80..a6b40ac8 100644
--- a/docs/API_docs/constructors/keyboardButtonCallback.md
+++ b/docs/API_docs/constructors/keyboardButtonCallback.md
@@ -14,6 +14,7 @@ Callback button
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
+|requires\_password|[Bool](../types/Bool.md) | Optional|
|text|[string](../types/string.md) | Yes|Button text|
|data|[bytes](../types/bytes.md) | Yes|Callback data|
@@ -25,14 +26,14 @@ Callback button
### Example:
```php
-$keyboardButtonCallback = ['_' => 'keyboardButtonCallback', 'text' => 'string', 'data' => 'bytes'];
+$keyboardButtonCallback = ['_' => 'keyboardButtonCallback', 'requires_password' => Bool, 'text' => 'string', 'data' => 'bytes'];
```
Or, if you're into Lua:
```lua
-keyboardButtonCallback={_='keyboardButtonCallback', text='string', data='bytes'}
+keyboardButtonCallback={_='keyboardButtonCallback', requires_password=Bool, text='string', data='bytes'}
```
diff --git a/docs/API_docs/constructors/message.md b/docs/API_docs/constructors/message.md
index 9a51204b..05322fc4 100644
--- a/docs/API_docs/constructors/message.md
+++ b/docs/API_docs/constructors/message.md
@@ -23,17 +23,19 @@ A message
|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer|
|edit\_hide|[Bool](../types/Bool.md) | Optional|Whether the message should be shown as not modified to the user, even if an edit date is present|
|id|[int](../types/int.md) | Yes|ID of the message|
-|from\_id|[int](../types/int.md) | Optional|ID of the sender of the message|
-|to\_id|[Peer](../types/Peer.md) | Yes|ID of the chat were the message was sent|
+|from\_id|[Peer](../types/Peer.md) | Optional|
+|peer\_id|[Peer](../types/Peer.md) | Yes|
|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about forwarded messages|
|via\_bot\_id|[int](../types/int.md) | Optional|ID of the inline bot that generated the message|
-|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to|
+|reply\_to|[MessageReplyHeader](../types/MessageReplyHeader.md) | Optional|
|date|[int](../types/int.md) | Yes|Date of the message|
|message|[string](../types/string.md) | Yes|The message|
|media|[MessageMedia](../types/MessageMedia.md) | Optional|Media attachment|
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup (bot/inline keyboards)|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text|
|views|[int](../types/int.md) | Optional|View count for channel posts|
+|forwards|[int](../types/int.md) | Optional|
+|replies|[MessageReplies](../types/MessageReplies.md) | Optional|
|edit\_date|[int](../types/int.md) | Optional|Last edit date of this message|
|post\_author|[string](../types/string.md) | Optional|Name of the author of this message for channel posts (with signatures enabled)|
|grouped\_id|[long](../types/long.md) | Optional|Multiple media messages sent using [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md) with the same grouped ID indicate an album|
@@ -47,14 +49,14 @@ A message
### Example:
```php
-$message = ['_' => 'message', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'from_scheduled' => Bool, 'legacy' => Bool, 'edit_hide' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'date' => int, 'message' => 'string', 'media' => MessageMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'views' => int, 'edit_date' => int, 'post_author' => 'string', 'grouped_id' => long, 'restriction_reason' => [RestrictionReason, RestrictionReason]];
+$message = ['_' => 'message', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'from_scheduled' => Bool, 'legacy' => Bool, 'edit_hide' => Bool, 'id' => int, 'from_id' => Peer, 'peer_id' => Peer, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to' => MessageReplyHeader, 'date' => int, 'message' => 'string', 'media' => MessageMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'views' => int, 'forwards' => int, 'replies' => MessageReplies, 'edit_date' => int, 'post_author' => 'string', 'grouped_id' => long, 'restriction_reason' => [RestrictionReason, RestrictionReason]];
```
Or, if you're into Lua:
```lua
-message={_='message', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, from_scheduled=Bool, legacy=Bool, edit_hide=Bool, id=int, from_id=int, to_id=Peer, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, date=int, message='string', media=MessageMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, views=int, edit_date=int, post_author='string', grouped_id=long, restriction_reason={RestrictionReason}}
+message={_='message', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, from_scheduled=Bool, legacy=Bool, edit_hide=Bool, id=int, from_id=Peer, peer_id=Peer, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to=MessageReplyHeader, date=int, message='string', media=MessageMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, views=int, forwards=int, replies=MessageReplies, edit_date=int, post_author='string', grouped_id=long, restriction_reason={RestrictionReason}}
```
diff --git a/docs/API_docs/constructors/messageFwdHeader.md b/docs/API_docs/constructors/messageFwdHeader.md
index 56f2bc67..cddd32ec 100644
--- a/docs/API_docs/constructors/messageFwdHeader.md
+++ b/docs/API_docs/constructors/messageFwdHeader.md
@@ -14,10 +14,9 @@ Info about a forwarded message
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|from\_id|[int](../types/int.md) | Optional|The ID of the user that originally sent the message|
+|from\_id|[Peer](../types/Peer.md) | Optional|
|from\_name|[string](../types/string.md) | Optional|The name of the user that originally sent the message|
|date|[int](../types/int.md) | Yes|When was the message originally sent|
-|channel\_id|[int](../types/int.md) | Optional|ID of the channel from which the message was forwarded|
|channel\_post|[int](../types/int.md) | Optional|ID of the channel message that was forwarded|
|post\_author|[string](../types/string.md) | Optional|For channels and if signatures are enabled, author of the channel message|
|saved\_from\_peer|[Peer](../types/Peer.md) | Optional|Only for messages forwarded to the current user (inputPeerSelf), full info about the user/channel that originally sent the message|
@@ -32,14 +31,14 @@ Info about a forwarded message
### Example:
```php
-$messageFwdHeader = ['_' => 'messageFwdHeader', 'from_id' => int, 'from_name' => 'string', 'date' => int, 'channel_id' => int, 'channel_post' => int, 'post_author' => 'string', 'saved_from_peer' => Peer, 'saved_from_msg_id' => int, 'psa_type' => 'string'];
+$messageFwdHeader = ['_' => 'messageFwdHeader', 'from_id' => Peer, 'from_name' => 'string', 'date' => int, 'channel_post' => int, 'post_author' => 'string', 'saved_from_peer' => Peer, 'saved_from_msg_id' => int, 'psa_type' => 'string'];
```
Or, if you're into Lua:
```lua
-messageFwdHeader={_='messageFwdHeader', from_id=int, from_name='string', date=int, channel_id=int, channel_post=int, post_author='string', saved_from_peer=Peer, saved_from_msg_id=int, psa_type='string'}
+messageFwdHeader={_='messageFwdHeader', from_id=Peer, from_name='string', date=int, channel_post=int, post_author='string', saved_from_peer=Peer, saved_from_msg_id=int, psa_type='string'}
```
diff --git a/docs/API_docs/constructors/messageReplies.md b/docs/API_docs/constructors/messageReplies.md
new file mode 100644
index 00000000..694bdc03
--- /dev/null
+++ b/docs/API_docs/constructors/messageReplies.md
@@ -0,0 +1,42 @@
+---
+title: messageReplies
+description: messageReplies attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: messageReplies
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|comments|[Bool](../types/Bool.md) | Optional|
+|replies|[int](../types/int.md) | Yes|
+|replies\_pts|[int](../types/int.md) | Yes|
+|recent\_repliers|Array of [Peer](../types/Peer.md) | Optional|
+|channel\_id|[int](../types/int.md) | Optional|
+|max\_id|[int](../types/int.md) | Optional|
+|read\_max\_id|[int](../types/int.md) | Optional|
+
+
+
+### Type: [MessageReplies](../types/MessageReplies.md)
+
+
+### Example:
+
+```php
+$messageReplies = ['_' => 'messageReplies', 'comments' => Bool, 'replies' => int, 'replies_pts' => int, 'recent_repliers' => [Peer, Peer], 'channel_id' => int, 'max_id' => int, 'read_max_id' => int];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+messageReplies={_='messageReplies', comments=Bool, replies=int, replies_pts=int, recent_repliers={Peer}, channel_id=int, max_id=int, read_max_id=int}
+
+```
+
+
diff --git a/docs/API_docs/constructors/messageReplyHeader.md b/docs/API_docs/constructors/messageReplyHeader.md
new file mode 100644
index 00000000..1d5da47f
--- /dev/null
+++ b/docs/API_docs/constructors/messageReplyHeader.md
@@ -0,0 +1,38 @@
+---
+title: messageReplyHeader
+description: messageReplyHeader attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: messageReplyHeader
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|reply\_to\_msg\_id|[int](../types/int.md) | Yes|
+|reply\_to\_peer\_id|[Peer](../types/Peer.md) | Optional|
+|reply\_to\_top\_id|[int](../types/int.md) | Optional|
+
+
+
+### Type: [MessageReplyHeader](../types/MessageReplyHeader.md)
+
+
+### Example:
+
+```php
+$messageReplyHeader = ['_' => 'messageReplyHeader', 'reply_to_msg_id' => int, 'reply_to_peer_id' => Peer, 'reply_to_top_id' => int];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+messageReplyHeader={_='messageReplyHeader', reply_to_msg_id=int, reply_to_peer_id=Peer, reply_to_top_id=int}
+
+```
+
+
diff --git a/docs/API_docs/constructors/messageService.md b/docs/API_docs/constructors/messageService.md
index 553a4973..11345275 100644
--- a/docs/API_docs/constructors/messageService.md
+++ b/docs/API_docs/constructors/messageService.md
@@ -21,9 +21,9 @@ Indicates a service message
|post|[Bool](../types/Bool.md) | Optional|Whether it's a channel post|
|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer|
|id|[int](../types/int.md) | Yes|Message ID|
-|from\_id|[int](../types/int.md) | Optional|Id of te sender of the message|
-|to\_id|[Peer](../types/Peer.md) | Yes|ID of the destination of the message|
-|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to|
+|from\_id|[Peer](../types/Peer.md) | Optional|
+|peer\_id|[Peer](../types/Peer.md) | Yes|
+|reply\_to|[MessageReplyHeader](../types/MessageReplyHeader.md) | Optional|
|date|[int](../types/int.md) | Yes|Message date|
|action|[MessageAction](../types/MessageAction.md) | Optional|Event connected with the service message|
@@ -35,14 +35,14 @@ Indicates a service message
### Example:
```php
-$messageService = ['_' => 'messageService', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'legacy' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'reply_to_msg_id' => int, 'date' => int, 'action' => MessageAction];
+$messageService = ['_' => 'messageService', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'legacy' => Bool, 'id' => int, 'from_id' => Peer, 'peer_id' => Peer, 'reply_to' => MessageReplyHeader, 'date' => int, 'action' => MessageAction];
```
Or, if you're into Lua:
```lua
-messageService={_='messageService', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, legacy=Bool, id=int, from_id=int, to_id=Peer, reply_to_msg_id=int, date=int, action=MessageAction}
+messageService={_='messageService', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, legacy=Bool, id=int, from_id=Peer, peer_id=Peer, reply_to=MessageReplyHeader, date=int, action=MessageAction}
```
diff --git a/docs/API_docs/constructors/messageViews.md b/docs/API_docs/constructors/messageViews.md
new file mode 100644
index 00000000..b23d52e4
--- /dev/null
+++ b/docs/API_docs/constructors/messageViews.md
@@ -0,0 +1,38 @@
+---
+title: messageViews
+description: messageViews attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: messageViews
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|views|[int](../types/int.md) | Optional|
+|forwards|[int](../types/int.md) | Optional|
+|replies|[MessageReplies](../types/MessageReplies.md) | Optional|
+
+
+
+### Type: [MessageViews](../types/MessageViews.md)
+
+
+### Example:
+
+```php
+$messageViews = ['_' => 'messageViews', 'views' => int, 'forwards' => int, 'replies' => MessageReplies];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+messageViews={_='messageViews', views=int, forwards=int, replies=MessageReplies}
+
+```
+
+
diff --git a/docs/API_docs/constructors/messages.discussionMessage.md b/docs/API_docs/constructors/messages.discussionMessage.md
new file mode 100644
index 00000000..108bd87a
--- /dev/null
+++ b/docs/API_docs/constructors/messages.discussionMessage.md
@@ -0,0 +1,42 @@
+---
+title: messages.discussionMessage
+description: messages.discussionMessage attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/messages_discussionMessage.html
+---
+# Constructor: messages.discussionMessage
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|messages|Array of [Message](../types/Message.md) | Yes|
+|max\_id|[int](../types/int.md) | Optional|
+|read\_inbox\_max\_id|[int](../types/int.md) | Optional|
+|read\_outbox\_max\_id|[int](../types/int.md) | Optional|
+|chats|Array of [Chat](../types/Chat.md) | Yes|
+|users|Array of [User](../types/User.md) | Yes|
+
+
+
+### Type: [messages.DiscussionMessage](../types/messages.DiscussionMessage.md)
+
+
+### Example:
+
+```php
+$messages.discussionMessage = ['_' => 'messages.discussionMessage', 'messages' => [Message, Message], 'max_id' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'chats' => [Chat, Chat], 'users' => [User, User]];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+messages.discussionMessage={_='messages.discussionMessage', messages={Message}, max_id=int, read_inbox_max_id=int, read_outbox_max_id=int, chats={Chat}, users={User}}
+
+```
+
+
diff --git a/docs/API_docs/constructors/messages.messageViews.md b/docs/API_docs/constructors/messages.messageViews.md
new file mode 100644
index 00000000..dc0344eb
--- /dev/null
+++ b/docs/API_docs/constructors/messages.messageViews.md
@@ -0,0 +1,39 @@
+---
+title: messages.messageViews
+description: messages.messageViews attributes, type and example
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/messages_messageViews.html
+---
+# Constructor: messages.messageViews
+[Back to constructors index](index.md)
+
+
+
+### Attributes:
+
+| Name | Type | Required |
+|----------|---------------|----------|
+|views|Array of [MessageViews](../types/MessageViews.md) | Yes|
+|chats|Array of [Chat](../types/Chat.md) | Yes|
+|users|Array of [User](../types/User.md) | Yes|
+
+
+
+### Type: [messages.MessageViews](../types/messages.MessageViews.md)
+
+
+### Example:
+
+```php
+$messages.messageViews = ['_' => 'messages.messageViews', 'views' => [MessageViews, MessageViews], 'chats' => [Chat, Chat], 'users' => [User, User]];
+```
+
+
+Or, if you're into Lua:
+
+```lua
+messages.messageViews={_='messages.messageViews', views={MessageViews}, chats={Chat}, users={User}}
+
+```
+
+
diff --git a/docs/API_docs/constructors/pageBlockAnchor.md b/docs/API_docs/constructors/pageBlockAnchor.md
index 40fe9041..f1a6a0cf 100644
--- a/docs/API_docs/constructors/pageBlockAnchor.md
+++ b/docs/API_docs/constructors/pageBlockAnchor.md
@@ -1,6 +1,6 @@
---
title: pageBlockAnchor
-description: Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
+description: Link to section within the page itself (like `anchor`)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: pageBlockAnchor
@@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
-Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
+Link to section within the page itself (like `anchor`)
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|name|[string](../types/string.md) | Yes|Name of the anchor|
+|name|[string](../types/string.md) | Yes|Name of target section|
diff --git a/docs/API_docs/constructors/pageBlockCover.md b/docs/API_docs/constructors/pageBlockCover.md
index f1309a7b..ce197e51 100644
--- a/docs/API_docs/constructors/pageBlockCover.md
+++ b/docs/API_docs/constructors/pageBlockCover.md
@@ -1,6 +1,6 @@
---
title: pageBlockCover
-description: Page cover
+description: A page cover
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: pageBlockCover
@@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
-Page cover
+A page cover
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|cover|[PageBlock](../types/PageBlock.md) | Yes|The cover|
+|cover|[PageBlock](../types/PageBlock.md) | Yes|Cover|
diff --git a/docs/API_docs/constructors/pageBlockDivider.md b/docs/API_docs/constructors/pageBlockDivider.md
index b0fc81e8..ee75b91c 100644
--- a/docs/API_docs/constructors/pageBlockDivider.md
+++ b/docs/API_docs/constructors/pageBlockDivider.md
@@ -1,6 +1,6 @@
---
title: pageBlockDivider
-description: An empty block separating parts of a page
+description: An empty block separating a page
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: pageBlockDivider
@@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
-An empty block separating parts of a page
+An empty block separating a page
diff --git a/docs/API_docs/constructors/pageBlockParagraph.md b/docs/API_docs/constructors/pageBlockParagraph.md
index f4284003..0c25d546 100644
--- a/docs/API_docs/constructors/pageBlockParagraph.md
+++ b/docs/API_docs/constructors/pageBlockParagraph.md
@@ -1,6 +1,6 @@
---
title: pageBlockParagraph
-description: A text paragraph
+description: A paragraph
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: pageBlockParagraph
@@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
-A text paragraph
+A paragraph
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
-|text|[RichText](../types/RichText.md) | Yes|Paragraph text|
+|text|[RichText](../types/RichText.md) | Yes|Text|
diff --git a/docs/API_docs/constructors/pageBlockPreformatted.md b/docs/API_docs/constructors/pageBlockPreformatted.md
index 4333f2fd..837c444a 100644
--- a/docs/API_docs/constructors/pageBlockPreformatted.md
+++ b/docs/API_docs/constructors/pageBlockPreformatted.md
@@ -1,6 +1,6 @@
---
title: pageBlockPreformatted
-description: Preformatted text paragraph
+description: Preformatted (`
` text) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: pageBlockPreformatted @@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -Preformatted text paragraph +Preformatted (`` text) ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|text|[RichText](../types/RichText.md) | Yes|Paragraph text| -|language|[string](../types/string.md) | Yes|Programming language for which the text should be formatted| +|text|[RichText](../types/RichText.md) | Yes|Text| +|language|[string](../types/string.md) | Yes|Programming language of preformatted text| diff --git a/docs/API_docs/constructors/peerBlocked.md b/docs/API_docs/constructors/peerBlocked.md new file mode 100644 index 00000000..c3b52bd4 --- /dev/null +++ b/docs/API_docs/constructors/peerBlocked.md @@ -0,0 +1,37 @@ +--- +title: peerBlocked +description: peerBlocked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerBlocked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer\_id|[Peer](../types/Peer.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [PeerBlocked](../types/PeerBlocked.md) + + +### Example: + +```php +$peerBlocked = ['_' => 'peerBlocked', 'peer_id' => Peer, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerBlocked={_='peerBlocked', peer_id=Peer, date=int} + +``` + + diff --git a/docs/API_docs/constructors/photoSizeProgressive.md b/docs/API_docs/constructors/photoSizeProgressive.md new file mode 100644 index 00000000..6f04a535 --- /dev/null +++ b/docs/API_docs/constructors/photoSizeProgressive.md @@ -0,0 +1,40 @@ +--- +title: photoSizeProgressive +description: photoSizeProgressive attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoSizeProgressive +[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| +|sizes|Array of [int](../types/int.md) | Yes| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +```php +$photoSizeProgressive = ['_' => 'photoSizeProgressive', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'sizes' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +photoSizeProgressive={_='photoSizeProgressive', type='string', location=FileLocation, w=int, h=int, sizes={int}} + +``` + + diff --git a/docs/API_docs/constructors/privacyKeyChatInvite.md b/docs/API_docs/constructors/privacyKeyChatInvite.md index d7d802e9..5acbff55 100644 --- a/docs/API_docs/constructors/privacyKeyChatInvite.md +++ b/docs/API_docs/constructors/privacyKeyChatInvite.md @@ -1,6 +1,6 @@ --- title: privacyKeyChatInvite -description: Privacy key for managing ability of invitation of the user to chats +description: Whether the user can be invited to chats image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: privacyKeyChatInvite @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -Privacy key for managing ability of invitation of the user to chats +Whether the user can be invited to chats diff --git a/docs/API_docs/constructors/stats.messageStats.md b/docs/API_docs/constructors/stats.messageStats.md new file mode 100644 index 00000000..8857bc8c --- /dev/null +++ b/docs/API_docs/constructors/stats.messageStats.md @@ -0,0 +1,37 @@ +--- +title: stats.messageStats +description: stats.messageStats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/stats_messageStats.html +--- +# Constructor: stats.messageStats +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|views\_graph|[StatsGraph](../types/StatsGraph.md) | Yes| + + + +### Type: [stats.MessageStats](../types/stats.MessageStats.md) + + +### Example: + +```php +$stats.messageStats = ['_' => 'stats.messageStats', 'views_graph' => StatsGraph]; +``` + + +Or, if you're into Lua: + +```lua +stats.messageStats={_='stats.messageStats', views_graph=StatsGraph} + +``` + + diff --git a/docs/API_docs/constructors/updateChannelMessageForwards.md b/docs/API_docs/constructors/updateChannelMessageForwards.md new file mode 100644 index 00000000..e750bf2d --- /dev/null +++ b/docs/API_docs/constructors/updateChannelMessageForwards.md @@ -0,0 +1,38 @@ +--- +title: updateChannelMessageForwards +description: updateChannelMessageForwards attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelMessageForwards +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|id|[int](../types/int.md) | Yes| +|forwards|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelMessageForwards = ['_' => 'updateChannelMessageForwards', 'channel_id' => int, 'id' => int, 'forwards' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelMessageForwards={_='updateChannelMessageForwards', channel_id=int, id=int, forwards=int} + +``` + + diff --git a/docs/API_docs/constructors/updateChannelPinnedMessage.md b/docs/API_docs/constructors/updateChannelPinnedMessage.md index 7897b806..51ec6752 100644 --- a/docs/API_docs/constructors/updateChannelPinnedMessage.md +++ b/docs/API_docs/constructors/updateChannelPinnedMessage.md @@ -8,8 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). -This update is also typically emitted as an [updateNewChannelMessage](updateNewChannelMessage.md) with [messageService](messageService.md). +A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). ### Attributes: diff --git a/docs/API_docs/constructors/updateChannelUserTyping.md b/docs/API_docs/constructors/updateChannelUserTyping.md new file mode 100644 index 00000000..4e15ea0c --- /dev/null +++ b/docs/API_docs/constructors/updateChannelUserTyping.md @@ -0,0 +1,39 @@ +--- +title: updateChannelUserTyping +description: updateChannelUserTyping attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelUserTyping +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|top\_msg\_id|[int](../types/int.md) | Optional| +|user\_id|[int](../types/int.md) | Yes| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelUserTyping = ['_' => 'updateChannelUserTyping', 'channel_id' => int, 'top_msg_id' => int, 'user_id' => int, 'action' => SendMessageAction]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelUserTyping={_='updateChannelUserTyping', channel_id=int, top_msg_id=int, user_id=int, action=SendMessageAction} + +``` + + diff --git a/docs/API_docs/constructors/updateChatParticipantAdd.md b/docs/API_docs/constructors/updateChatParticipantAdd.md index 559d6361..baaef950 100644 --- a/docs/API_docs/constructors/updateChatParticipantAdd.md +++ b/docs/API_docs/constructors/updateChatParticipantAdd.md @@ -8,8 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -New group member. -This update is also typically emitted as an [updateNewMessage](updateNewMessage.md) with [messageService](messageService.md). +New group member. ### Attributes: diff --git a/docs/API_docs/constructors/updateChatParticipantDelete.md b/docs/API_docs/constructors/updateChatParticipantDelete.md index b57882e0..31872336 100644 --- a/docs/API_docs/constructors/updateChatParticipantDelete.md +++ b/docs/API_docs/constructors/updateChatParticipantDelete.md @@ -8,8 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -A member has left the group. -This update is also typically emitted as an [updateNewMessage](updateNewMessage.md) with [messageService](messageService.md). +A member has left the group. ### Attributes: diff --git a/docs/API_docs/constructors/updateChatPinnedMessage.md b/docs/API_docs/constructors/updateChatPinnedMessage.md index b678f413..1f3c75c5 100644 --- a/docs/API_docs/constructors/updateChatPinnedMessage.md +++ b/docs/API_docs/constructors/updateChatPinnedMessage.md @@ -8,8 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -A message was pinned in a [legacy group](https://core.telegram.org/api/channel) -This update is also typically emitted as an [updateNewMessage](updateNewMessage.md) with [messageService](messageService.md). +A message was pinned in a [legacy group](https://core.telegram.org/api/channel) ### Attributes: diff --git a/docs/API_docs/constructors/updateNewMessage.md b/docs/API_docs/constructors/updateNewMessage.md index 32d33fb4..571e660a 100644 --- a/docs/API_docs/constructors/updateNewMessage.md +++ b/docs/API_docs/constructors/updateNewMessage.md @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -New message in a private chat or in a [legacy group](https://core.telegram.org/api/channel) +New message. ### Attributes: diff --git a/docs/API_docs/constructors/updatePeerBlocked.md b/docs/API_docs/constructors/updatePeerBlocked.md new file mode 100644 index 00000000..056a3fbd --- /dev/null +++ b/docs/API_docs/constructors/updatePeerBlocked.md @@ -0,0 +1,37 @@ +--- +title: updatePeerBlocked +description: updatePeerBlocked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePeerBlocked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer\_id|[Peer](../types/Peer.md) | Yes| +|blocked|[Bool](../types/Bool.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePeerBlocked = ['_' => 'updatePeerBlocked', 'peer_id' => Peer, 'blocked' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +updatePeerBlocked={_='updatePeerBlocked', peer_id=Peer, blocked=Bool} + +``` + + diff --git a/docs/API_docs/constructors/updateReadChannelDiscussionInbox.md b/docs/API_docs/constructors/updateReadChannelDiscussionInbox.md new file mode 100644 index 00000000..9a113dc3 --- /dev/null +++ b/docs/API_docs/constructors/updateReadChannelDiscussionInbox.md @@ -0,0 +1,40 @@ +--- +title: updateReadChannelDiscussionInbox +description: updateReadChannelDiscussionInbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelDiscussionInbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|top\_msg\_id|[int](../types/int.md) | Yes| +|read\_max\_id|[int](../types/int.md) | Yes| +|broadcast\_id|[int](../types/int.md) | Optional| +|broadcast\_post|[int](../types/int.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadChannelDiscussionInbox = ['_' => 'updateReadChannelDiscussionInbox', 'channel_id' => int, 'top_msg_id' => int, 'read_max_id' => int, 'broadcast_id' => int, 'broadcast_post' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadChannelDiscussionInbox={_='updateReadChannelDiscussionInbox', channel_id=int, top_msg_id=int, read_max_id=int, broadcast_id=int, broadcast_post=int} + +``` + + diff --git a/docs/API_docs/constructors/updateReadChannelDiscussionOutbox.md b/docs/API_docs/constructors/updateReadChannelDiscussionOutbox.md new file mode 100644 index 00000000..cfe84d39 --- /dev/null +++ b/docs/API_docs/constructors/updateReadChannelDiscussionOutbox.md @@ -0,0 +1,38 @@ +--- +title: updateReadChannelDiscussionOutbox +description: updateReadChannelDiscussionOutbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelDiscussionOutbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|top\_msg\_id|[int](../types/int.md) | Yes| +|read\_max\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadChannelDiscussionOutbox = ['_' => 'updateReadChannelDiscussionOutbox', 'channel_id' => int, 'top_msg_id' => int, 'read_max_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadChannelDiscussionOutbox={_='updateReadChannelDiscussionOutbox', channel_id=int, top_msg_id=int, read_max_id=int} + +``` + + diff --git a/docs/API_docs/constructors/updateShortChatMessage.md b/docs/API_docs/constructors/updateShortChatMessage.md index 81ee36e7..c5f2de17 100644 --- a/docs/API_docs/constructors/updateShortChatMessage.md +++ b/docs/API_docs/constructors/updateShortChatMessage.md @@ -27,7 +27,7 @@ Shortened constructor containing info on one new incoming text message from a ch |date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| |fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| |via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|reply\_to|[MessageReplyHeader](../types/MessageReplyHeader.md) | Optional| |entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Entities](https://core.telegram.org/api/entities) for styled text| @@ -38,14 +38,14 @@ Shortened constructor containing info on one new incoming text message from a ch ### Example: ```php -$updateShortChatMessage = ['_' => 'updateShortChatMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'from_id' => int, 'chat_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +$updateShortChatMessage = ['_' => 'updateShortChatMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'from_id' => int, 'chat_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to' => MessageReplyHeader, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateShortChatMessage={_='updateShortChatMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, from_id=int, chat_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} +updateShortChatMessage={_='updateShortChatMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, from_id=int, chat_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to=MessageReplyHeader, entities={MessageEntity}} ``` diff --git a/docs/API_docs/constructors/updateShortMessage.md b/docs/API_docs/constructors/updateShortMessage.md index 29cfb3c4..cc040fc3 100644 --- a/docs/API_docs/constructors/updateShortMessage.md +++ b/docs/API_docs/constructors/updateShortMessage.md @@ -26,7 +26,7 @@ Info about a message sent to (received from) another user |date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| |fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| |via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|reply\_to|[MessageReplyHeader](../types/MessageReplyHeader.md) | Optional| |entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Entities](https://core.telegram.org/api/entities) for styled text| @@ -37,14 +37,14 @@ Info about a message sent to (received from) another user ### Example: ```php -$updateShortMessage = ['_' => 'updateShortMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'user_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +$updateShortMessage = ['_' => 'updateShortMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'user_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to' => MessageReplyHeader, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateShortMessage={_='updateShortMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, user_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} +updateShortMessage={_='updateShortMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, user_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to=MessageReplyHeader, entities={MessageEntity}} ``` diff --git a/docs/API_docs/constructors/updateUserBlocked.md b/docs/API_docs/constructors/updateUserBlocked.md deleted file mode 100644 index 7d4da3c6..00000000 --- a/docs/API_docs/constructors/updateUserBlocked.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: updateUserBlocked -description: User was added to the blacklist (method [contacts.block](../methods/contacts.block.md)) or removed from the blacklist (method [contacts.unblock](../methods/contacts.unblock.md)). -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateUserBlocked -[Back to constructors index](index.md) - - - -User was added to the blacklist (method [contacts.block](../methods/contacts.block.md)) or removed from the blacklist (method [contacts.unblock](../methods/contacts.unblock.md)). - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User id| -|blocked|[Bool](../types/Bool.md) | Yes|([boolTrue](../constructors/boolTrue.md)) if the the user is blocked| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateUserBlocked = ['_' => 'updateUserBlocked', 'user_id' => int, 'blocked' => Bool]; -``` - - -Or, if you're into Lua: - -```lua -updateUserBlocked={_='updateUserBlocked', user_id=int, blocked=Bool} - -``` - - diff --git a/docs/API_docs/constructors/updateUserStatus.md b/docs/API_docs/constructors/updateUserStatus.md index 1df39801..719b2da4 100644 --- a/docs/API_docs/constructors/updateUserStatus.md +++ b/docs/API_docs/constructors/updateUserStatus.md @@ -1,6 +1,6 @@ --- title: updateUserStatus -description: User went online/offline +description: Contact status update. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: updateUserStatus @@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User went online/offline +Contact status update. ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[int](../types/int.md) | Yes|User identifier| -|status|[UserStatus](../types/UserStatus.md) | Optional|New user status| +|status|[UserStatus](../types/UserStatus.md) | Optional|New status| diff --git a/docs/API_docs/constructors/userStatusEmpty.md b/docs/API_docs/constructors/userStatusEmpty.md index fdfb87bd..5633eaf0 100644 --- a/docs/API_docs/constructors/userStatusEmpty.md +++ b/docs/API_docs/constructors/userStatusEmpty.md @@ -1,6 +1,6 @@ --- title: userStatusEmpty -description: User status was newer changed +description: User status has not been set yet. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusEmpty @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User status was newer changed +User status has not been set yet. diff --git a/docs/API_docs/constructors/userStatusLastMonth.md b/docs/API_docs/constructors/userStatusLastMonth.md index 5d48d36a..50da248f 100644 --- a/docs/API_docs/constructors/userStatusLastMonth.md +++ b/docs/API_docs/constructors/userStatusLastMonth.md @@ -1,6 +1,6 @@ --- title: userStatusLastMonth -description: User is offline, but was online last month +description: Online status: last seen last month image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusLastMonth @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User is offline, but was online last month +Online status: last seen last month diff --git a/docs/API_docs/constructors/userStatusLastWeek.md b/docs/API_docs/constructors/userStatusLastWeek.md index 90560b68..b2de898d 100644 --- a/docs/API_docs/constructors/userStatusLastWeek.md +++ b/docs/API_docs/constructors/userStatusLastWeek.md @@ -1,6 +1,6 @@ --- title: userStatusLastWeek -description: User is offline, but was online last week +description: Online status: last seen last week image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusLastWeek @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User is offline, but was online last week +Online status: last seen last week diff --git a/docs/API_docs/constructors/userStatusOffline.md b/docs/API_docs/constructors/userStatusOffline.md index 12310c00..d0de96c9 100644 --- a/docs/API_docs/constructors/userStatusOffline.md +++ b/docs/API_docs/constructors/userStatusOffline.md @@ -1,6 +1,6 @@ --- title: userStatusOffline -description: User is offline +description: The user's offline status. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusOffline @@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User is offline +The user's offline status. ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|was\_online|[int](../types/int.md) | Yes|Unix time user was online last time| +|was\_online|[int](../types/int.md) | Yes|Time the user was last seen online| diff --git a/docs/API_docs/constructors/userStatusOnline.md b/docs/API_docs/constructors/userStatusOnline.md index 65d3ddea..361a0a5a 100644 --- a/docs/API_docs/constructors/userStatusOnline.md +++ b/docs/API_docs/constructors/userStatusOnline.md @@ -1,6 +1,6 @@ --- title: userStatusOnline -description: User is online +description: Online status of the user. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusOnline @@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User is online +Online status of the user. ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|expires|[int](../types/int.md) | Yes|Unix time when user's online status will expire| +|expires|[int](../types/int.md) | Yes|Time to expiration of the current online status| diff --git a/docs/API_docs/constructors/userStatusRecently.md b/docs/API_docs/constructors/userStatusRecently.md index 45c74017..d740bd77 100644 --- a/docs/API_docs/constructors/userStatusRecently.md +++ b/docs/API_docs/constructors/userStatusRecently.md @@ -1,6 +1,6 @@ --- title: userStatusRecently -description: User was online recently +description: Online status: last seen recently image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: userStatusRecently @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -User was online recently +Online status: last seen recently diff --git a/docs/API_docs/index.md b/docs/API_docs/index.md index 15ff178e..d6168d3a 100644 --- a/docs/API_docs/index.md +++ b/docs/API_docs/index.md @@ -1,9 +1,9 @@ --- -title: MadelineProto API documentation (layer 117) -description: MadelineProto API documentation (layer 117) +title: MadelineProto API documentation (layer 119) +description: MadelineProto API documentation (layer 119) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# MadelineProto API documentation (layer 117) +# MadelineProto API documentation (layer 119) [Back to main documentation](..) diff --git a/docs/API_docs/methods/api_index.md b/docs/API_docs/methods/api_index.md index 05b55bc9..42a119c0 100644 --- a/docs/API_docs/methods/api_index.md +++ b/docs/API_docs/methods/api_index.md @@ -436,7 +436,7 @@ $MadelineProto->[channels->editTitle](channels.editTitle.md)(\['channel' => [Inp ***
-$MadelineProto->[channels->exportMessageLink](channels.exportMessageLink.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => [int](../types/int.md), 'grouped' => [Bool](../types/Bool.md), \]) === [$ExportedMessageLink](../types/ExportedMessageLink.md) +$MadelineProto->[channels->exportMessageLink](channels.exportMessageLink.md)(\['grouped' => [Bool](../types/Bool.md), 'thread' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), 'id' => [int](../types/int.md), \]) === [$ExportedMessageLink](../types/ExportedMessageLink.md) ***
@@ -536,7 +536,11 @@ $MadelineProto->[contacts->addContact](contacts.addContact.md)(\['add_phone_priv ***
-$MadelineProto->[contacts->block](contacts.block.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[contacts->block](contacts.block.md)(\['id' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[contacts->blockFromReplies](contacts.blockFromReplies.md)(\['delete_message' => [Bool](../types/Bool.md), 'delete_history' => [Bool](../types/Bool.md), 'report_spam' => [Bool](../types/Bool.md), 'msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
@@ -600,7 +604,7 @@ $MadelineProto->[contacts->toggleTopPeers](contacts.toggleTopPeers.md)(\['enable ***
-$MadelineProto->[contacts->unblock](contacts.unblock.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[contacts->unblock](contacts.unblock.md)(\['id' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) ***
@@ -642,6 +646,10 @@ $MadelineProto->[help->getCdnConfig](help.getCdnConfig.md)(\[\]) === [$CdnConfig
$MadelineProto->[help->getConfig](help.getConfig.md)(\[\]) === [$Config](../types/Config.md) +*** +
+$MadelineProto->[help->getCountriesList](help.getCountriesList.md)(\['lang_code' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$help.CountriesList](../types/help.CountriesList.md) + ***
$MadelineProto->[help->getDeepLinkInfo](help.getDeepLinkInfo.md)(\['path' => [string](../types/string.md), \]) === [$help.DeepLinkInfo](../types/help.DeepLinkInfo.md) @@ -828,7 +836,7 @@ $MadelineProto->[messages->faveSticker](messages.faveSticker.md)(\['id' => [Inpu ***
-$MadelineProto->[messages->forwardMessages](messages.forwardMessages.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'with_my_score' => [Bool](../types/Bool.md), 'grouped' => [Bool](../types/Bool.md), 'from_peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'to_peer' => [InputPeer](../types/InputPeer.md), 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->forwardMessages](messages.forwardMessages.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'with_my_score' => [Bool](../types/Bool.md), 'from_peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'to_peer' => [InputPeer](../types/InputPeer.md), 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
@@ -852,7 +860,7 @@ $MadelineProto->[messages->getAttachedStickers](messages.getAttachedStickers.md) ***
-$MadelineProto->[messages->getBotCallbackAnswer](messages.getBotCallbackAnswer.md)(\['game' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'data' => [bytes](../types/bytes.md), \]) === [$messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) +$MadelineProto->[messages->getBotCallbackAnswer](messages.getBotCallbackAnswer.md)(\['game' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'data' => [bytes](../types/bytes.md), 'password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) ***
@@ -878,6 +886,10 @@ $MadelineProto->[messages->getDialogUnreadMarks](messages.getDialogUnreadMarks.m
$MadelineProto->[messages->getDialogs](messages.getDialogs.md)(\['exclude_pinned' => [Bool](../types/Bool.md), 'folder_id' => [int](../types/int.md), 'offset_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages.Dialogs](../types/messages.Dialogs.md) +*** +
+$MadelineProto->[messages->getDiscussionMessage](messages.getDiscussionMessage.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), \]) === [$messages.DiscussionMessage](../types/messages.DiscussionMessage.md) + ***
$MadelineProto->[messages->getDocumentByHash](messages.getDocumentByHash.md)(\['sha256' => [bytes](../types/bytes.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), \]) === [$Document](../types/Document.md) @@ -940,7 +952,7 @@ $MadelineProto->[messages->getMessages](messages.getMessages.md)(\['id' => \[[In ***
-$MadelineProto->[messages->getMessagesViews](messages.getMessagesViews.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'increment' => [Bool](../types/Bool.md), \]) === [$Vector\_of\_int](../types/int.md) +$MadelineProto->[messages->getMessagesViews](messages.getMessagesViews.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'increment' => [Bool](../types/Bool.md), \]) === [$messages.MessageViews](../types/messages.MessageViews.md) ***
@@ -978,6 +990,10 @@ $MadelineProto->[messages->getRecentLocations](messages.getRecentLocations.md)(\
$MadelineProto->[messages->getRecentStickers](messages.getRecentStickers.md)(\['attached' => [Bool](../types/Bool.md), 'hash' => [int](../types/int.md), \]) === [$messages.RecentStickers](../types/messages.RecentStickers.md) +*** +
+$MadelineProto->[messages->getReplies](messages.getReplies.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_date' => [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) + ***
$MadelineProto->[messages->getSavedGifs](messages.getSavedGifs.md)(\['hash' => [int](../types/int.md), \]) === [$messages.SavedGifs](../types/messages.SavedGifs.md) @@ -1046,6 +1062,10 @@ $MadelineProto->[messages->markDialogUnread](messages.markDialogUnread.md)(\['un
$MadelineProto->[messages->migrateChat](messages.migrateChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Updates](../types/Updates.md) +*** +
+$MadelineProto->[messages->readDiscussion](messages.readDiscussion.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'read_max_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[messages->readEncryptedHistory](messages.readEncryptedHistory.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'max_date' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) @@ -1116,11 +1136,11 @@ $MadelineProto->[messages->saveRecentSticker](messages.saveRecentSticker.md)(\[' ***
-$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) +$MadelineProto->[messages->search](messages.search.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'q' => [string](../types/string.md), 'from_id' => [InputUser](../types/InputUser.md), 'top_msg_id' => [int](../types/int.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) ***
-$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) +$MadelineProto->[messages->searchGlobal](messages.searchGlobal.md)(\['folder_id' => [int](../types/int.md), 'q' => [string](../types/string.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'min_date' => [int](../types/int.md), 'max_date' => [int](../types/int.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) ***
@@ -1128,11 +1148,11 @@ $MadelineProto->[messages->searchStickerSets](messages.searchStickerSets.md)(\[' ***
-$MadelineProto->[messages->sendEncrypted](messages.sendEncrypted.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) +$MadelineProto->[messages->sendEncrypted](messages.sendEncrypted.md)(\['silent' => [Bool](../types/Bool.md), 'peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) ***
-$MadelineProto->[messages->sendEncryptedFile](messages.sendEncryptedFile.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) +$MadelineProto->[messages->sendEncryptedFile](messages.sendEncryptedFile.md)(\['silent' => [Bool](../types/Bool.md), 'peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) ***
@@ -1196,7 +1216,7 @@ $MadelineProto->[messages->setInlineGameScore](messages.setInlineGameScore.md)(\ ***
-$MadelineProto->[messages->setTyping](messages.setTyping.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[messages->setTyping](messages.setTyping.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'top_msg_id' => [int](../types/int.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]) === [$Bool](../types/Bool.md) ***
@@ -1322,6 +1342,14 @@ $MadelineProto->[stats->getBroadcastStats](stats.getBroadcastStats.md)(\['dark'
$MadelineProto->[stats->getMegagroupStats](stats.getMegagroupStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), \]) === [$stats.MegagroupStats](../types/stats.MegagroupStats.md) +*** +
+$MadelineProto->[stats->getMessagePublicForwards](stats.getMessagePublicForwards.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'msg_id' => [int](../types/int.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) + +*** +
+$MadelineProto->[stats->getMessageStats](stats.getMessageStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), 'msg_id' => [int](../types/int.md), \]) === [$stats.MessageStats](../types/stats.MessageStats.md) + ***
$MadelineProto->[stats->loadAsyncGraph](stats.loadAsyncGraph.md)(\['token' => [string](../types/string.md), 'x' => [long](../types/long.md), \]) === [$StatsGraph](../types/StatsGraph.md) diff --git a/docs/API_docs/methods/channels.exportMessageLink.md b/docs/API_docs/methods/channels.exportMessageLink.md index e2184816..2f03f4ee 100644 --- a/docs/API_docs/methods/channels.exportMessageLink.md +++ b/docs/API_docs/methods/channels.exportMessageLink.md @@ -15,9 +15,10 @@ Get link and embed info of a message in a [channel/supergroup](https://core.tele | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|grouped|[Bool](../types/Bool.md) | | Optional| +|thread|[Bool](../types/Bool.md) | | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| |id|[int](../types/int.md) | Message ID | Yes| -|grouped|[Bool](../types/Bool.md) | Whether to include other grouped media (for albums) | Yes| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) @@ -37,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$ExportedMessageLink = $MadelineProto->channels->exportMessageLink(['channel' => InputChannel, 'id' => int, 'grouped' => Bool, ]); +$ExportedMessageLink = $MadelineProto->channels->exportMessageLink(['grouped' => Bool, 'thread' => Bool, 'channel' => InputChannel, 'id' => int, ]); ``` Or, if you're into Lua: ```lua -ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, grouped=Bool, }) +ExportedMessageLink = channels.exportMessageLink({grouped=Bool, thread=Bool, channel=InputChannel, id=int, }) ``` ### Errors diff --git a/docs/API_docs/methods/channels.getParticipants.md b/docs/API_docs/methods/channels.getParticipants.md index b4d66989..bcb34180 100644 --- a/docs/API_docs/methods/channels.getParticipants.md +++ b/docs/API_docs/methods/channels.getParticipants.md @@ -9,7 +9,7 @@ redirect_from: /API_docs/methods/channels_getParticipants.html -Get the participants of a supergroup/channel +Get the participants of a channel ### Parameters: diff --git a/docs/API_docs/methods/contacts.block.md b/docs/API_docs/methods/contacts.block.md index 6b58f991..854c3636 100644 --- a/docs/API_docs/methods/contacts.block.md +++ b/docs/API_docs/methods/contacts.block.md @@ -15,7 +15,7 @@ Adds the user to the blacklist. | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->contacts->block(['id' => InputUser, ]); +$Bool = $MadelineProto->contacts->block(['id' => InputPeer, ]); ``` Or, if you're into Lua: ```lua -Bool = contacts.block({id=InputUser, }) +Bool = contacts.block({id=InputPeer, }) ``` ### Errors diff --git a/docs/API_docs/methods/contacts.blockFromReplies.md b/docs/API_docs/methods/contacts.blockFromReplies.md new file mode 100644 index 00000000..d735fb6f --- /dev/null +++ b/docs/API_docs/methods/contacts.blockFromReplies.md @@ -0,0 +1,47 @@ +--- +title: contacts.blockFromReplies +description: contacts.blockFromReplies parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_blockFromReplies.html +--- +# Method: contacts.blockFromReplies +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|delete\_message|[Bool](../types/Bool.md) | Optional| +|delete\_history|[Bool](../types/Bool.md) | Optional| +|report\_spam|[Bool](../types/Bool.md) | Optional| +|msg\_id|[int](../types/int.md) | Yes| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->contacts->blockFromReplies(['delete_message' => Bool, 'delete_history' => Bool, 'report_spam' => Bool, 'msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.blockFromReplies({delete_message=Bool, delete_history=Bool, report_spam=Bool, msg_id=int, }) +``` + diff --git a/docs/API_docs/methods/contacts.unblock.md b/docs/API_docs/methods/contacts.unblock.md index 86542ae1..5d57a3d1 100644 --- a/docs/API_docs/methods/contacts.unblock.md +++ b/docs/API_docs/methods/contacts.unblock.md @@ -15,7 +15,7 @@ Deletes the user from the blacklist. | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->contacts->unblock(['id' => InputUser, ]); +$Bool = $MadelineProto->contacts->unblock(['id' => InputPeer, ]); ``` Or, if you're into Lua: ```lua -Bool = contacts.unblock({id=InputUser, }) +Bool = contacts.unblock({id=InputPeer, }) ``` ### Errors diff --git a/docs/API_docs/methods/help.getCountriesList.md b/docs/API_docs/methods/help.getCountriesList.md new file mode 100644 index 00000000..2c0601d4 --- /dev/null +++ b/docs/API_docs/methods/help.getCountriesList.md @@ -0,0 +1,45 @@ +--- +title: help.getCountriesList +description: help.getCountriesList parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getCountriesList.html +--- +# Method: help.getCountriesList +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|lang\_code|[string](../types/string.md) | Yes| +|hash|Array of [int](../types/int.md) | Optional| + + +### Return type: [help.CountriesList](../types/help.CountriesList.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(); + +$help.CountriesList = $MadelineProto->help->getCountriesList(['lang_code' => 'string', 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +help.CountriesList = help.getCountriesList({lang_code='string', hash={int}, }) +``` + diff --git a/docs/API_docs/methods/messages.forwardMessages.md b/docs/API_docs/methods/messages.forwardMessages.md index cd39fe32..ee670ec8 100644 --- a/docs/API_docs/methods/messages.forwardMessages.md +++ b/docs/API_docs/methods/messages.forwardMessages.md @@ -18,7 +18,6 @@ Forwards messages by their IDs. |silent|[Bool](../types/Bool.md) | Whether to send messages silently (no notification will be triggered on the destination clients) | Optional| |background|[Bool](../types/Bool.md) | Whether to send the message in background | Optional| |with\_my\_score|[Bool](../types/Bool.md) | When forwarding games, whether to include your score in the game | Optional| -|grouped|[Bool](../types/Bool.md) | Whether the specified messages represent an album (grouped media) | Optional| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Source of messages | Optional| |id|Array of [int](../types/int.md) | IDs of messages | Yes| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination peer | Optional| @@ -42,13 +41,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'grouped' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, 'schedule_date' => int, ]); +$Updates = $MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, 'schedule_date' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, schedule_date=int, }) +Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, schedule_date=int, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.getBotCallbackAnswer.md b/docs/API_docs/methods/messages.getBotCallbackAnswer.md index fe5be1f7..ada4ca38 100644 --- a/docs/API_docs/methods/messages.getBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages.getBotCallbackAnswer.md @@ -19,6 +19,7 @@ Press an inline callback button and get a callback answer from the bot |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the inline keyboard sent | Optional| |msg\_id|[int](../types/int.md) | ID of the Message with the inline keyboard | Yes| |data|[bytes](../types/bytes.md) | Callback data | Optional| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | | Optional| ### Return type: [messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) @@ -38,13 +39,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.BotCallbackAnswer = $MadelineProto->messages->getBotCallbackAnswer(['game' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'data' => 'bytes', ]); +$messages.BotCallbackAnswer = $MadelineProto->messages->getBotCallbackAnswer(['game' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'data' => 'bytes', 'password' => InputCheckPasswordSRP, ]); ``` Or, if you're into Lua: ```lua -messages.BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) +messages.BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', password=InputCheckPasswordSRP, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.getDiscussionMessage.md b/docs/API_docs/methods/messages.getDiscussionMessage.md new file mode 100644 index 00000000..649682e0 --- /dev/null +++ b/docs/API_docs/methods/messages.getDiscussionMessage.md @@ -0,0 +1,45 @@ +--- +title: messages.getDiscussionMessage +description: messages.getDiscussionMessage parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDiscussionMessage.html +--- +# Method: messages.getDiscussionMessage +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|msg\_id|[int](../types/int.md) | Yes| + + +### Return type: [messages.DiscussionMessage](../types/messages.DiscussionMessage.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(); + +$messages.DiscussionMessage = $MadelineProto->messages->getDiscussionMessage(['peer' => InputPeer, 'msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.DiscussionMessage = messages.getDiscussionMessage({peer=InputPeer, msg_id=int, }) +``` + diff --git a/docs/API_docs/methods/messages.getMessagesViews.md b/docs/API_docs/methods/messages.getMessagesViews.md index 1a8e9f5d..c6b5f59d 100644 --- a/docs/API_docs/methods/messages.getMessagesViews.md +++ b/docs/API_docs/methods/messages.getMessagesViews.md @@ -20,7 +20,7 @@ Get and increase the view counter of a message sent or forwarded from a [channel |increment|[Bool](../types/Bool.md) | Whether to mark the message as viewed and increment the view counter | Yes| -### Return type: [Vector\_of\_int](../types/int.md) +### Return type: [messages.MessageViews](../types/messages.MessageViews.md) ### Can bots use this method: **NO** @@ -37,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Vector_of_int = $MadelineProto->messages->getMessagesViews(['peer' => InputPeer, 'id' => [int, int], 'increment' => Bool, ]); +$messages.MessageViews = $MadelineProto->messages->getMessagesViews(['peer' => InputPeer, 'id' => [int, int], 'increment' => Bool, ]); ``` Or, if you're into Lua: ```lua -Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) +messages.MessageViews = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.getReplies.md b/docs/API_docs/methods/messages.getReplies.md new file mode 100644 index 00000000..30f4475b --- /dev/null +++ b/docs/API_docs/methods/messages.getReplies.md @@ -0,0 +1,52 @@ +--- +title: messages.getReplies +description: messages.getReplies parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getReplies.html +--- +# Method: messages.getReplies +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|msg\_id|[int](../types/int.md) | Yes| +|offset\_id|[int](../types/int.md) | Yes| +|offset\_date|[int](../types/int.md) | Yes| +|add\_offset|[int](../types/int.md) | Yes| +|limit|[int](../types/int.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| +|min\_id|[int](../types/int.md) | Yes| +|hash|Array of [int](../types/int.md) | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.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(); + +$messages.Messages = $MadelineProto->messages->getReplies(['peer' => InputPeer, 'msg_id' => int, 'offset_id' => int, 'offset_date' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getReplies({peer=InputPeer, msg_id=int, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, }) +``` + diff --git a/docs/API_docs/methods/messages.readDiscussion.md b/docs/API_docs/methods/messages.readDiscussion.md new file mode 100644 index 00000000..a777bc9f --- /dev/null +++ b/docs/API_docs/methods/messages.readDiscussion.md @@ -0,0 +1,46 @@ +--- +title: messages.readDiscussion +description: messages.readDiscussion parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readDiscussion.html +--- +# Method: messages.readDiscussion +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|msg\_id|[int](../types/int.md) | Yes| +|read\_max\_id|[int](../types/int.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->messages->readDiscussion(['peer' => InputPeer, 'msg_id' => int, 'read_max_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.readDiscussion({peer=InputPeer, msg_id=int, read_max_id=int, }) +``` + diff --git a/docs/API_docs/methods/messages.search.md b/docs/API_docs/methods/messages.search.md index bfd87423..6a308913 100644 --- a/docs/API_docs/methods/messages.search.md +++ b/docs/API_docs/methods/messages.search.md @@ -18,6 +18,7 @@ Gets back found messages |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, histories with which are searched, or [(inputPeerEmpty)](../constructors/inputPeerEmpty.md) constructor for global search | Optional| |q|[string](../types/string.md) | Text search request | Yes| |from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Only return messages sent by the specified user ID | Optional| +|top\_msg\_id|[int](../types/int.md) | | Optional| |filter|[MessagesFilter](../types/MessagesFilter.md) | Filter to return only specified message types | Optional| |min\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned | Yes| |max\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned | Yes| @@ -46,13 +47,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]); +$messages.Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'top_msg_id' => int, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, }) +messages.Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, top_msg_id=int, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.searchGlobal.md b/docs/API_docs/methods/messages.searchGlobal.md index f07b5213..04721f13 100644 --- a/docs/API_docs/methods/messages.searchGlobal.md +++ b/docs/API_docs/methods/messages.searchGlobal.md @@ -17,6 +17,9 @@ Search for messages and peers globally |----------|---------------|-------------|----------| |folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Optional| |q|[string](../types/string.md) | Query | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | | Optional| +|min\_date|[int](../types/int.md) | | Yes| +|max\_date|[int](../types/int.md) | | Yes| |offset\_rate|[int](../types/int.md) | Initially 0, then set to the [`next_rate` parameter of messages.messagesSlice](../constructors/messages.messagesSlice.md) | Yes| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Optional| |offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| @@ -40,13 +43,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->searchGlobal(['folder_id' => int, 'q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); +$messages.Messages = $MadelineProto->messages->searchGlobal(['folder_id' => int, 'q' => 'string', 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.searchGlobal({folder_id=int, q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, }) +messages.Messages = messages.searchGlobal({folder_id=int, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.sendEncrypted.md b/docs/API_docs/methods/messages.sendEncrypted.md index ef7dbe53..4f52e694 100644 --- a/docs/API_docs/methods/messages.sendEncrypted.md +++ b/docs/API_docs/methods/messages.sendEncrypted.md @@ -15,6 +15,7 @@ Sends a text message to a secret chat. | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | | Optional| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| |data|[bytes](../types/bytes.md) | TL-serialization of [DecryptedMessage](../types/DecryptedMessage.md) type, encrypted with a key that was created during chat initialization | Yes| @@ -36,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.SentEncryptedMessage = $MadelineProto->messages->sendEncrypted(['peer' => InputEncryptedChat, 'data' => 'bytes', ]); +$messages.SentEncryptedMessage = $MadelineProto->messages->sendEncrypted(['silent' => Bool, 'peer' => InputEncryptedChat, 'data' => 'bytes', ]); ``` Or, if you're into Lua: ```lua -messages.SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, data='bytes', }) +messages.SentEncryptedMessage = messages.sendEncrypted({silent=Bool, peer=InputEncryptedChat, data='bytes', }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.sendEncryptedFile.md b/docs/API_docs/methods/messages.sendEncryptedFile.md index ddc82a90..fafbb35c 100644 --- a/docs/API_docs/methods/messages.sendEncryptedFile.md +++ b/docs/API_docs/methods/messages.sendEncryptedFile.md @@ -15,6 +15,7 @@ Sends a message with a file attachment to a secret chat | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | | Optional| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| |data|[bytes](../types/bytes.md) | TL-serialization of [DecryptedMessage](../types/DecryptedMessage.md) type, encrypted with a key generated during chat initialization | Yes| |file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | File attachment for the secret chat | Optional| @@ -37,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.SentEncryptedMessage = $MadelineProto->messages->sendEncryptedFile(['peer' => InputEncryptedChat, 'data' => 'bytes', 'file' => InputEncryptedFile, ]); +$messages.SentEncryptedMessage = $MadelineProto->messages->sendEncryptedFile(['silent' => Bool, 'peer' => InputEncryptedChat, 'data' => 'bytes', 'file' => InputEncryptedFile, ]); ``` Or, if you're into Lua: ```lua -messages.SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedChat, data='bytes', file=InputEncryptedFile, }) +messages.SentEncryptedMessage = messages.sendEncryptedFile({silent=Bool, peer=InputEncryptedChat, data='bytes', file=InputEncryptedFile, }) ``` ### Errors diff --git a/docs/API_docs/methods/messages.setTyping.md b/docs/API_docs/methods/messages.setTyping.md index 10e565c5..8460e714 100644 --- a/docs/API_docs/methods/messages.setTyping.md +++ b/docs/API_docs/methods/messages.setTyping.md @@ -16,6 +16,7 @@ Sends a current user typing event (see [SendMessageAction](../types/SendMessageA | Name | Type | Description | Required | |----------|---------------|-------------|----------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Target user or group | Optional| +|top\_msg\_id|[int](../types/int.md) | | Optional| |action|[SendMessageAction](../types/SendMessageAction.md) | Type of action
Parameter added in [Layer 17](https://core.telegram.org/api/layers#layer-17). | Yes| @@ -36,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->messages->setTyping(['peer' => InputPeer, 'action' => SendMessageAction, ]); +$Bool = $MadelineProto->messages->setTyping(['peer' => InputPeer, 'top_msg_id' => int, 'action' => SendMessageAction, ]); ``` Or, if you're into Lua: ```lua -Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) +Bool = messages.setTyping({peer=InputPeer, top_msg_id=int, action=SendMessageAction, }) ``` ### Errors diff --git a/docs/API_docs/methods/stats.getMessagePublicForwards.md b/docs/API_docs/methods/stats.getMessagePublicForwards.md new file mode 100644 index 00000000..8321350f --- /dev/null +++ b/docs/API_docs/methods/stats.getMessagePublicForwards.md @@ -0,0 +1,49 @@ +--- +title: stats.getMessagePublicForwards +description: stats.getMessagePublicForwards parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stats_getMessagePublicForwards.html +--- +# Method: stats.getMessagePublicForwards +[Back to methods index](index.md) + + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +|msg\_id|[int](../types/int.md) | Yes| +|offset\_rate|[int](../types/int.md) | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|offset\_id|[int](../types/int.md) | Yes| +|limit|[int](../types/int.md) | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.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(); + +$messages.Messages = $MadelineProto->stats->getMessagePublicForwards(['channel' => InputChannel, 'msg_id' => int, 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = stats.getMessagePublicForwards({channel=InputChannel, msg_id=int, offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, }) +``` + diff --git a/docs/API_docs/methods/stats.getMessageStats.md b/docs/API_docs/methods/stats.getMessageStats.md new file mode 100644 index 00000000..227f4a3a --- /dev/null +++ b/docs/API_docs/methods/stats.getMessageStats.md @@ -0,0 +1,46 @@ +--- +title: stats.getMessageStats +description: stats.getMessageStats parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stats_getMessageStats.html +--- +# Method: stats.getMessageStats +[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| +|msg\_id|[int](../types/int.md) | Yes| + + +### Return type: [stats.MessageStats](../types/stats.MessageStats.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.MessageStats = $MadelineProto->stats->getMessageStats(['dark' => Bool, 'channel' => InputChannel, 'msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +stats.MessageStats = stats.getMessageStats({dark=Bool, channel=InputChannel, msg_id=int, }) +``` + diff --git a/docs/API_docs/types/ContactBlocked.md b/docs/API_docs/types/MessageReplies.md similarity index 50% rename from docs/API_docs/types/ContactBlocked.md rename to docs/API_docs/types/MessageReplies.md index 575f93fe..82f47517 100644 --- a/docs/API_docs/types/ContactBlocked.md +++ b/docs/API_docs/types/MessageReplies.md @@ -1,16 +1,16 @@ --- -title: ContactBlocked -description: constructors and methods of type ContactBlocked +title: MessageReplies +description: constructors and methods of type MessageReplies image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ContactBlocked +# Type: MessageReplies [Back to types index](index.md) ### Possible values (constructors): -[contactBlocked](../constructors/contactBlocked.md) +[messageReplies](../constructors/messageReplies.md) @@ -18,5 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -[contactBlocked](../constructors/contactBlocked.md) +[messageReplies](../constructors/messageReplies.md) diff --git a/docs/API_docs/types/MessageReplyHeader.md b/docs/API_docs/types/MessageReplyHeader.md new file mode 100644 index 00000000..f00bc213 --- /dev/null +++ b/docs/API_docs/types/MessageReplyHeader.md @@ -0,0 +1,22 @@ +--- +title: MessageReplyHeader +description: constructors and methods of type MessageReplyHeader +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageReplyHeader +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageReplyHeader](../constructors/messageReplyHeader.md) + + + +### Methods that return an object of this type (methods): + + + +[messageReplyHeader](../constructors/messageReplyHeader.md) + diff --git a/old_docs/API_docs_v44/types/InputAudio.md b/docs/API_docs/types/MessageViews.md similarity index 52% rename from old_docs/API_docs_v44/types/InputAudio.md rename to docs/API_docs/types/MessageViews.md index db6bf06f..fdadd98b 100644 --- a/old_docs/API_docs_v44/types/InputAudio.md +++ b/docs/API_docs/types/MessageViews.md @@ -1,18 +1,16 @@ --- -title: InputAudio -description: constructors and methods of type InputAudio +title: MessageViews +description: constructors and methods of type MessageViews image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputAudio +# Type: MessageViews [Back to types index](index.md) ### Possible values (constructors): -[inputAudioEmpty](../constructors/inputAudioEmpty.md) - -[inputAudio](../constructors/inputAudio.md) +[messageViews](../constructors/messageViews.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[messageViews](../constructors/messageViews.md) + diff --git a/docs/API_docs/types/PeerBlocked.md b/docs/API_docs/types/PeerBlocked.md new file mode 100644 index 00000000..7a7fb19e --- /dev/null +++ b/docs/API_docs/types/PeerBlocked.md @@ -0,0 +1,22 @@ +--- +title: PeerBlocked +description: constructors and methods of type PeerBlocked +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerBlocked +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerBlocked](../constructors/peerBlocked.md) + + + +### Methods that return an object of this type (methods): + + + +[peerBlocked](../constructors/peerBlocked.md) + diff --git a/docs/API_docs/types/PhotoSize.md b/docs/API_docs/types/PhotoSize.md index 31aab16c..2d9fbfb9 100644 --- a/docs/API_docs/types/PhotoSize.md +++ b/docs/API_docs/types/PhotoSize.md @@ -18,6 +18,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [photoStrippedSize](../constructors/photoStrippedSize.md) +[photoSizeProgressive](../constructors/photoSizeProgressive.md) + ### Methods that return an object of this type (methods): @@ -32,3 +34,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [photoStrippedSize](../constructors/photoStrippedSize.md) +[photoSizeProgressive](../constructors/photoSizeProgressive.md) + diff --git a/docs/API_docs/types/Update.md b/docs/API_docs/types/Update.md index 8e278a0b..e9bd74d8 100644 --- a/docs/API_docs/types/Update.md +++ b/docs/API_docs/types/Update.md @@ -42,8 +42,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateDcOptions](../constructors/updateDcOptions.md) -[updateUserBlocked](../constructors/updateUserBlocked.md) - [updateNotifySettings](../constructors/updateNotifySettings.md) [updateServiceNotification](../constructors/updateServiceNotification.md) @@ -174,6 +172,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateChannelParticipant](../constructors/updateChannelParticipant.md) +[updateChannelMessageForwards](../constructors/updateChannelMessageForwards.md) + +[updateReadChannelDiscussionInbox](../constructors/updateReadChannelDiscussionInbox.md) + +[updateReadChannelDiscussionOutbox](../constructors/updateReadChannelDiscussionOutbox.md) + +[updatePeerBlocked](../constructors/updatePeerBlocked.md) + +[updateChannelUserTyping](../constructors/updateChannelUserTyping.md) + ### Methods that return an object of this type (methods): @@ -212,8 +220,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateDcOptions](../constructors/updateDcOptions.md) -[updateUserBlocked](../constructors/updateUserBlocked.md) - [updateNotifySettings](../constructors/updateNotifySettings.md) [updateServiceNotification](../constructors/updateServiceNotification.md) @@ -344,3 +350,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateChannelParticipant](../constructors/updateChannelParticipant.md) +[updateChannelMessageForwards](../constructors/updateChannelMessageForwards.md) + +[updateReadChannelDiscussionInbox](../constructors/updateReadChannelDiscussionInbox.md) + +[updateReadChannelDiscussionOutbox](../constructors/updateReadChannelDiscussionOutbox.md) + +[updatePeerBlocked](../constructors/updatePeerBlocked.md) + +[updateChannelUserTyping](../constructors/updateChannelUserTyping.md) + diff --git a/docs/API_docs/types/Updates.md b/docs/API_docs/types/Updates.md index bedd677d..206b50b1 100644 --- a/docs/API_docs/types/Updates.md +++ b/docs/API_docs/types/Updates.md @@ -38,6 +38,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->contacts->getLocated](../methods/contacts.getLocated.md) +[$MadelineProto->contacts->blockFromReplies](../methods/contacts.blockFromReplies.md) + [$MadelineProto->messages->sendMessage](../methods/messages.sendMessage.md) [$MadelineProto->messages->sendMedia](../methods/messages.sendMedia.md) @@ -146,6 +148,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->contacts->getLocated](../methods/contacts.getLocated.md) +[$MadelineProto->contacts->blockFromReplies](../methods/contacts.blockFromReplies.md) + [$MadelineProto->messages->sendMessage](../methods/messages.sendMessage.md) [$MadelineProto->messages->sendMedia](../methods/messages.sendMedia.md) diff --git a/docs/API_docs/types/help.CountriesList.md b/docs/API_docs/types/help.CountriesList.md new file mode 100644 index 00000000..6be78432 --- /dev/null +++ b/docs/API_docs/types/help.CountriesList.md @@ -0,0 +1,31 @@ +--- +title: help.CountriesList +description: constructors and methods of type help.CountriesList +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_CountriesList.html +--- +# Type: help.CountriesList +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.countriesListNotModified](../constructors/help.countriesListNotModified.md) + +[help.countriesList](../constructors/help.countriesList.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getCountriesList](../methods/help.getCountriesList.md) + + + +[help.countriesListNotModified](../constructors/help.countriesListNotModified.md) + +[help.countriesList](../constructors/help.countriesList.md) + +[$MadelineProto->help->getCountriesList](../methods/help.getCountriesList.md) + diff --git a/docs/API_docs/types/help.Country.md b/docs/API_docs/types/help.Country.md new file mode 100644 index 00000000..9eb2a7a0 --- /dev/null +++ b/docs/API_docs/types/help.Country.md @@ -0,0 +1,23 @@ +--- +title: help.Country +description: constructors and methods of type help.Country +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_Country.html +--- +# Type: help.Country +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.country](../constructors/help.country.md) + + + +### Methods that return an object of this type (methods): + + + +[help.country](../constructors/help.country.md) + diff --git a/docs/API_docs/types/help.CountryCode.md b/docs/API_docs/types/help.CountryCode.md new file mode 100644 index 00000000..27949073 --- /dev/null +++ b/docs/API_docs/types/help.CountryCode.md @@ -0,0 +1,23 @@ +--- +title: help.CountryCode +description: constructors and methods of type help.CountryCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_CountryCode.html +--- +# Type: help.CountryCode +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.countryCode](../constructors/help.countryCode.md) + + + +### Methods that return an object of this type (methods): + + + +[help.countryCode](../constructors/help.countryCode.md) + diff --git a/docs/API_docs/types/index.md b/docs/API_docs/types/index.md index fccb56ba..cedfa67a 100644 --- a/docs/API_docs/types/index.md +++ b/docs/API_docs/types/index.md @@ -68,8 +68,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Contact](Contact.md) -[ContactBlocked](ContactBlocked.md) - [ContactStatus](ContactStatus.md) [DataJSON](DataJSON.md) @@ -252,8 +250,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [MessageRange](MessageRange.md) +[MessageReplies](MessageReplies.md) + +[MessageReplyHeader](MessageReplyHeader.md) + [MessageUserVote](MessageUserVote.md) +[MessageViews](MessageViews.md) + [MessagesFilter](MessagesFilter.md) [NearestDc](NearestDc.md) @@ -288,6 +292,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Peer](Peer.md) +[PeerBlocked](PeerBlocked.md) + [PeerLocated](PeerLocated.md) [PeerNotifySettings](PeerNotifySettings.md) @@ -488,6 +494,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [help.AppUpdate](help.AppUpdate.md) +[help.CountriesList](help.CountriesList.md) + +[help.Country](help.Country.md) + +[help.CountryCode](help.CountryCode.md) + [help.DeepLinkInfo](help.DeepLinkInfo.md) [help.InviteText](help.InviteText.md) @@ -532,6 +544,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.Dialogs](messages.Dialogs.md) +[messages.DiscussionMessage](messages.DiscussionMessage.md) + [messages.FavedStickers](messages.FavedStickers.md) [messages.FeaturedStickers](messages.FeaturedStickers.md) @@ -544,6 +558,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.MessageEditData](messages.MessageEditData.md) +[messages.MessageViews](messages.MessageViews.md) + [messages.Messages](messages.Messages.md) [messages.PeerDialogs](messages.PeerDialogs.md) @@ -586,6 +602,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [stats.MegagroupStats](stats.MegagroupStats.md) +[stats.MessageStats](stats.MessageStats.md) + [storage.FileType](storage.FileType.md) [updates.ChannelDifference](updates.ChannelDifference.md) diff --git a/docs/API_docs/types/messages.DiscussionMessage.md b/docs/API_docs/types/messages.DiscussionMessage.md new file mode 100644 index 00000000..25088706 --- /dev/null +++ b/docs/API_docs/types/messages.DiscussionMessage.md @@ -0,0 +1,27 @@ +--- +title: messages.DiscussionMessage +description: constructors and methods of type messages.DiscussionMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_DiscussionMessage.html +--- +# Type: messages.DiscussionMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.discussionMessage](../constructors/messages.discussionMessage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDiscussionMessage](../methods/messages.getDiscussionMessage.md) + + + +[messages.discussionMessage](../constructors/messages.discussionMessage.md) + +[$MadelineProto->messages->getDiscussionMessage](../methods/messages.getDiscussionMessage.md) + diff --git a/docs/API_docs/types/messages.MessageViews.md b/docs/API_docs/types/messages.MessageViews.md new file mode 100644 index 00000000..e87ddf49 --- /dev/null +++ b/docs/API_docs/types/messages.MessageViews.md @@ -0,0 +1,27 @@ +--- +title: messages.MessageViews +description: constructors and methods of type messages.MessageViews +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_MessageViews.html +--- +# Type: messages.MessageViews +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.messageViews](../constructors/messages.messageViews.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getMessagesViews](../methods/messages.getMessagesViews.md) + + + +[messages.messageViews](../constructors/messages.messageViews.md) + +[$MadelineProto->messages->getMessagesViews](../methods/messages.getMessagesViews.md) + diff --git a/docs/API_docs/types/messages.Messages.md b/docs/API_docs/types/messages.Messages.md index 83ac41fc..aaaef793 100644 --- a/docs/API_docs/types/messages.Messages.md +++ b/docs/API_docs/types/messages.Messages.md @@ -39,8 +39,12 @@ redirect_from: /API_docs/types/messages_Messages.html [$MadelineProto->messages->getScheduledMessages](../methods/messages.getScheduledMessages.md) +[$MadelineProto->messages->getReplies](../methods/messages.getReplies.md) + [$MadelineProto->channels->getMessages](../methods/channels.getMessages.md) +[$MadelineProto->stats->getMessagePublicForwards](../methods/stats.getMessagePublicForwards.md) + [messages.messages](../constructors/messages.messages.md) @@ -67,5 +71,9 @@ redirect_from: /API_docs/types/messages_Messages.html [$MadelineProto->messages->getScheduledMessages](../methods/messages.getScheduledMessages.md) +[$MadelineProto->messages->getReplies](../methods/messages.getReplies.md) + [$MadelineProto->channels->getMessages](../methods/channels.getMessages.md) +[$MadelineProto->stats->getMessagePublicForwards](../methods/stats.getMessagePublicForwards.md) + diff --git a/docs/API_docs/types/stats.MessageStats.md b/docs/API_docs/types/stats.MessageStats.md new file mode 100644 index 00000000..97a9a6f5 --- /dev/null +++ b/docs/API_docs/types/stats.MessageStats.md @@ -0,0 +1,27 @@ +--- +title: stats.MessageStats +description: constructors and methods of type stats.MessageStats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/stats_MessageStats.html +--- +# Type: stats.MessageStats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stats.messageStats](../constructors/stats.messageStats.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->stats->getMessageStats](../methods/stats.getMessageStats.md) + + + +[stats.messageStats](../constructors/stats.messageStats.md) + +[$MadelineProto->stats->getMessageStats](../methods/stats.getMessageStats.md) + diff --git a/docs/docs/SETTINGS.md b/docs/docs/SETTINGS.md index 2f80bd9f..aedb6b61 100644 --- a/docs/docs/SETTINGS.md +++ b/docs/docs/SETTINGS.md @@ -503,4 +503,4 @@ This helps to reduce latency, improve speed and reduce mysql/postgres/redis load Data will be remove from cache if last access was more than this amount of time. Clean up is done once per minute. -Next section +Next section \ No newline at end of file diff --git a/docs/docs/USING_METHODS.md b/docs/docs/USING_METHODS.md index 3853ce16..e3c4d0e5 100644 --- a/docs/docs/USING_METHODS.md +++ b/docs/docs/USING_METHODS.md @@ -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 117)](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 119)](https://docs.madelineproto.xyz/API_docs/). [Now fully async!](https://docs.madelineproto.xyz/docs/ASYNC.html) diff --git a/old_docs/API_docs_v44/README.md b/old_docs/API_docs_v44/README.md index c93c5e13..38a89a6f 100644 --- a/old_docs/API_docs_v44/README.md +++ b/old_docs/API_docs_v44/README.md @@ -3,7 +3,7 @@ title: MadelineProto API documentation (layer v44) description: MadelineProto API documentation (layer v44) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# MadelineProto API documentation (layer v44) +# MadelineProto API documentation (layer v44) [Back to main documentation](..) @@ -12,4 +12,4 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Constructors](constructors/) -[Types](types/) \ No newline at end of file +[Types](types/) diff --git a/old_docs/API_docs_v44/constructors/README.md b/old_docs/API_docs_v44/constructors/README.md index 10ae5932..88c74c82 100644 --- a/old_docs/API_docs_v44/constructors/README.md +++ b/old_docs/API_docs_v44/constructors/README.md @@ -6,56 +6,125 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png # Constructors [Back to API documentation index](..) +*** +
[$account.authorizationForm](../constructors/account.authorizationForm.md) = \['required_types' => \[[SecureRequiredType](../types/SecureRequiredType.md)\], 'values' => \[[SecureValue](../types/SecureValue.md)\], 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], 'users' => \[[User](../types/User.md)\], 'privacy_policy_url' => [string](../types/string.md), \]; + ***
[$account.authorizations](../constructors/account.authorizations.md) = \['authorizations' => \[[Authorization](../types/Authorization.md)\], \]; *** -
[$account.noPassword](../constructors/account.noPassword.md) = \['new_salt' => [bytes](../types/bytes.md), 'email_unconfirmed_pattern' => [string](../types/string.md), \]; +
[$account.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) = \['low' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'medium' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'high' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), \]; *** -
[$account.password](../constructors/account.password.md) = \['current_salt' => [bytes](../types/bytes.md), 'new_salt' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'has_recovery' => [Bool](../types/Bool.md), 'email_unconfirmed_pattern' => [string](../types/string.md), \]; +
[$account.contentSettings](../constructors/account.contentSettings.md) = \['sensitive_enabled' => [Bool](../types/Bool.md), 'sensitive_can_change' => [Bool](../types/Bool.md), \]; *** -
[$account.passwordInputSettings](../constructors/account.passwordInputSettings.md) = \['new_salt' => [bytes](../types/bytes.md), 'new_password_hash' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'email' => [string](../types/string.md), \]; +
[$account.password](../constructors/account.password.md) = \['has_recovery' => [Bool](../types/Bool.md), 'has_secure_values' => [Bool](../types/Bool.md), 'has_password' => [Bool](../types/Bool.md), 'current_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'srp_B' => [bytes](../types/bytes.md), 'srp_id' => [long](../types/long.md), 'hint' => [string](../types/string.md), 'email_unconfirmed_pattern' => [string](../types/string.md), 'new_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'new_secure_algo' => [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md), 'secure_random' => [bytes](../types/bytes.md), \]; *** -
[$account.passwordSettings](../constructors/account.passwordSettings.md) = \['email' => [string](../types/string.md), \]; +
[$account.passwordInputSettings](../constructors/account.passwordInputSettings.md) = \['new_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'new_password_hash' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'email' => [string](../types/string.md), 'new_secure_settings' => [SecureSecretSettings](../types/SecureSecretSettings.md), \]; *** -
[$account.privacyRules](../constructors/account.privacyRules.md) = \['rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$account.passwordSettings](../constructors/account.passwordSettings.md) = \['email' => [string](../types/string.md), 'secure_settings' => [SecureSecretSettings](../types/SecureSecretSettings.md), \]; *** -
[$account.sentChangePhoneCode](../constructors/account.sentChangePhoneCode.md) = \['phone_code_hash' => [string](../types/string.md), 'send_call_timeout' => [int](../types/int.md), \]; +
[$account.privacyRules](../constructors/account.privacyRules.md) = \['rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$account.sentEmailCode](../constructors/account.sentEmailCode.md) = \['email_pattern' => [string](../types/string.md), 'length' => [int](../types/int.md), \]; + +*** +
[$account.takeout](../constructors/account.takeout.md) = \['id' => [long](../types/long.md), \]; + +*** +
[$account.themes](../constructors/account.themes.md) = \['hash' => [int](../types/int.md), 'themes' => \[[Theme](../types/Theme.md)\], \]; + +*** +
[$account.themesNotModified](../constructors/account.themesNotModified.md) = \[\]; + +*** +
[$account.tmpPassword](../constructors/account.tmpPassword.md) = \['tmp_password' => [bytes](../types/bytes.md), 'valid_until' => [int](../types/int.md), \]; + +*** +
[$account.wallPapers](../constructors/account.wallPapers.md) = \['hash' => [int](../types/int.md), 'wallpapers' => \[[WallPaper](../types/WallPaper.md)\], \]; + +*** +
[$account.wallPapersNotModified](../constructors/account.wallPapersNotModified.md) = \[\]; + +*** +
[$account.webAuthorizations](../constructors/account.webAuthorizations.md) = \['authorizations' => \[[WebAuthorization](../types/WebAuthorization.md)\], 'users' => \[[User](../types/User.md)\], \]; ***
[$accountDaysTTL](../constructors/accountDaysTTL.md) = \['days' => [int](../types/int.md), \]; *** -
[$audio](../constructors/audio.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'dc_id' => [int](../types/int.md), \]; +
[$auth.authorization](../constructors/auth.authorization.md) = \['tmp_sessions' => [int](../types/int.md), 'user' => [User](../types/User.md), \]; *** -
[$audioEmpty](../constructors/audioEmpty.md) = \['id' => [long](../types/long.md), \]; +
[$auth.authorizationSignUpRequired](../constructors/auth.authorizationSignUpRequired.md) = \['terms_of_service' => [help.TermsOfService](../types/help.TermsOfService.md), \]; *** -
[$auth.authorization](../constructors/auth.authorization.md) = \['user' => [User](../types/User.md), \]; +
[$auth.codeTypeCall](../constructors/auth.codeTypeCall.md) = \[\]; *** -
[$auth.checkedPhone](../constructors/auth.checkedPhone.md) = \['phone_registered' => [Bool](../types/Bool.md), \]; +
[$auth.codeTypeFlashCall](../constructors/auth.codeTypeFlashCall.md) = \[\]; + +*** +
[$auth.codeTypeSms](../constructors/auth.codeTypeSms.md) = \[\]; ***
[$auth.exportedAuthorization](../constructors/auth.exportedAuthorization.md) = \['id' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; +*** +
[$auth.loginToken](../constructors/auth.loginToken.md) = \['expires' => [int](../types/int.md), 'token' => [bytes](../types/bytes.md), \]; + +*** +
[$auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) = \['dc_id' => [int](../types/int.md), 'token' => [bytes](../types/bytes.md), \]; + +*** +
[$auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) = \['authorization' => [auth.Authorization](../types/auth.Authorization.md), \]; + ***
[$auth.passwordRecovery](../constructors/auth.passwordRecovery.md) = \['email_pattern' => [string](../types/string.md), \]; *** -
[$auth.sentAppCode](../constructors/auth.sentAppCode.md) = \['phone_registered' => [Bool](../types/Bool.md), 'phone_code_hash' => [string](../types/string.md), 'send_call_timeout' => [int](../types/int.md), 'is_password' => [Bool](../types/Bool.md), \]; +
[$auth.sentCode](../constructors/auth.sentCode.md) = \['type' => [auth.SentCodeType](../types/auth.SentCodeType.md), 'phone_code_hash' => [string](../types/string.md), 'next_type' => [auth.CodeType](../types/auth.CodeType.md), 'timeout' => [int](../types/int.md), \]; *** -
[$auth.sentCode](../constructors/auth.sentCode.md) = \['phone_registered' => [Bool](../types/Bool.md), 'phone_code_hash' => [string](../types/string.md), 'send_call_timeout' => [int](../types/int.md), 'is_password' => [Bool](../types/Bool.md), \]; +
[$auth.sentCodeTypeApp](../constructors/auth.sentCodeTypeApp.md) = \['length' => [int](../types/int.md), \]; *** -
[$authorization](../constructors/authorization.md) = \['hash' => [long](../types/long.md), 'device_model' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'api_id' => [int](../types/int.md), 'app_name' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'date_created' => [int](../types/int.md), 'date_active' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'country' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; +
[$auth.sentCodeTypeCall](../constructors/auth.sentCodeTypeCall.md) = \['length' => [int](../types/int.md), \]; + +*** +
[$auth.sentCodeTypeFlashCall](../constructors/auth.sentCodeTypeFlashCall.md) = \['pattern' => [string](../types/string.md), \]; + +*** +
[$auth.sentCodeTypeSms](../constructors/auth.sentCodeTypeSms.md) = \['length' => [int](../types/int.md), \]; + +*** +
[$authorization](../constructors/authorization.md) = \['current' => [Bool](../types/Bool.md), 'official_app' => [Bool](../types/Bool.md), 'password_pending' => [Bool](../types/Bool.md), 'hash' => [long](../types/long.md), 'device_model' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'api_id' => [int](../types/int.md), 'app_name' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'date_created' => [int](../types/int.md), 'date_active' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'country' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; + +*** +
[$autoDownloadSettings](../constructors/autoDownloadSettings.md) = \['disabled' => [Bool](../types/Bool.md), 'video_preload_large' => [Bool](../types/Bool.md), 'audio_preload_next' => [Bool](../types/Bool.md), 'phonecalls_less_data' => [Bool](../types/Bool.md), 'photo_size_max' => [int](../types/int.md), 'video_size_max' => [int](../types/int.md), 'file_size_max' => [int](../types/int.md), 'video_upload_maxbitrate' => [int](../types/int.md), \]; + +*** +
[$bankCardOpenUrl](../constructors/bankCardOpenUrl.md) = \['url' => [string](../types/string.md), 'name' => [string](../types/string.md), \]; + +*** +
[$baseThemeArctic](../constructors/baseThemeArctic.md) = \[\]; + +*** +
[$baseThemeClassic](../constructors/baseThemeClassic.md) = \[\]; + +*** +
[$baseThemeDay](../constructors/baseThemeDay.md) = \[\]; + +*** +
[$baseThemeNight](../constructors/baseThemeNight.md) = \[\]; + +*** +
[$baseThemeTinted](../constructors/baseThemeTinted.md) = \[\]; ***
[$boolFalse](../constructors/boolFalse.md) = \[\]; @@ -67,25 +136,121 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$botCommand](../constructors/botCommand.md) = \['command' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; *** -
[$botInfo](../constructors/botInfo.md) = \['user_id' => [int](../types/int.md), 'version' => [int](../types/int.md), 'share_text' => [string](../types/string.md), 'description' => [string](../types/string.md), 'commands' => \[[BotCommand](../types/BotCommand.md)\], \]; +
[$botInfo](../constructors/botInfo.md) = \['user_id' => [int](../types/int.md), 'description' => [string](../types/string.md), 'commands' => \[[BotCommand](../types/BotCommand.md)\], \]; *** -
[$botInfoEmpty](../constructors/botInfoEmpty.md) = \[\]; +
[$botInlineMediaResult](../constructors/botInlineMediaResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'send_message' => [BotInlineMessage](../types/BotInlineMessage.md), \]; *** -
[$channel](../constructors/channel.md) = \['creator' => [Bool](../types/Bool.md), 'kicked' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'editor' => [Bool](../types/Bool.md), 'moderator' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'username' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'restiction_reason' => [string](../types/string.md), \]; +
[$botInlineMessageMediaAuto](../constructors/botInlineMessageMediaAuto.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -
[$channelForbidden](../constructors/channelForbidden.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), \]; +
[$botInlineMessageMediaContact](../constructors/botInlineMessageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'vcard' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -
[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [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), 'read_inbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'unread_important_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), \]; +
[$botInlineMessageMediaGeo](../constructors/botInlineMessageMediaGeo.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'period' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -
[$channelMessagesFilter](../constructors/channelMessagesFilter.md) = \['important_only' => [Bool](../types/Bool.md), 'exclude_new_messages' => [Bool](../types/Bool.md), 'ranges' => \[[MessageRange](../types/MessageRange.md)\], \]; +
[$botInlineMessageMediaVenue](../constructors/botInlineMessageMediaVenue.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -
[$channelMessagesFilterCollapsed](../constructors/channelMessagesFilterCollapsed.md) = \[\]; +
[$botInlineMessageText](../constructors/botInlineMessageText.md) = \['no_webpage' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$botInlineResult](../constructors/botInlineResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'url' => [string](../types/string.md), 'thumb' => [WebDocument](../types/WebDocument.md), 'content' => [WebDocument](../types/WebDocument.md), 'send_message' => [BotInlineMessage](../types/BotInlineMessage.md), \]; + +*** +
[$cdnConfig](../constructors/cdnConfig.md) = \['public_keys' => \[[CdnPublicKey](../types/CdnPublicKey.md)\], \]; + +*** +
[$cdnPublicKey](../constructors/cdnPublicKey.md) = \['dc_id' => [int](../types/int.md), 'public_key' => [string](../types/string.md), \]; + +*** +
[$channel](../constructors/channel.md) = \['creator' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'signatures' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'scam' => [Bool](../types/Bool.md), 'has_link' => [Bool](../types/Bool.md), 'has_geo' => [Bool](../types/Bool.md), 'slowmode_enabled' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'username' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'participants_count' => [int](../types/int.md), \]; + +*** +
[$channelAdminLogEvent](../constructors/channelAdminLogEvent.md) = \['id' => [long](../types/long.md), 'date' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'action' => [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md), \]; + +*** +
[$channelAdminLogEventActionChangeAbout](../constructors/channelAdminLogEventActionChangeAbout.md) = \['prev_value' => [string](../types/string.md), 'new_value' => [string](../types/string.md), \]; + +*** +
[$channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md) = \['prev_value' => [int](../types/int.md), 'new_value' => [int](../types/int.md), \]; + +*** +
[$channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md) = \['prev_value' => [ChannelLocation](../types/ChannelLocation.md), 'new_value' => [ChannelLocation](../types/ChannelLocation.md), \]; + +*** +
[$channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) = \['prev_photo' => [Photo](../types/Photo.md), 'new_photo' => [Photo](../types/Photo.md), \]; + +*** +
[$channelAdminLogEventActionChangeStickerSet](../constructors/channelAdminLogEventActionChangeStickerSet.md) = \['prev_stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'new_stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]; + +*** +
[$channelAdminLogEventActionChangeTitle](../constructors/channelAdminLogEventActionChangeTitle.md) = \['prev_value' => [string](../types/string.md), 'new_value' => [string](../types/string.md), \]; + +*** +
[$channelAdminLogEventActionChangeUsername](../constructors/channelAdminLogEventActionChangeUsername.md) = \['prev_value' => [string](../types/string.md), 'new_value' => [string](../types/string.md), \]; + +*** +
[$channelAdminLogEventActionDefaultBannedRights](../constructors/channelAdminLogEventActionDefaultBannedRights.md) = \['prev_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'new_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]; + +*** +
[$channelAdminLogEventActionDeleteMessage](../constructors/channelAdminLogEventActionDeleteMessage.md) = \['message' => [Message](../types/Message.md), \]; + +*** +
[$channelAdminLogEventActionEditMessage](../constructors/channelAdminLogEventActionEditMessage.md) = \['prev_message' => [Message](../types/Message.md), 'new_message' => [Message](../types/Message.md), \]; + +*** +
[$channelAdminLogEventActionParticipantInvite](../constructors/channelAdminLogEventActionParticipantInvite.md) = \['participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +
[$channelAdminLogEventActionParticipantJoin](../constructors/channelAdminLogEventActionParticipantJoin.md) = \[\]; + +*** +
[$channelAdminLogEventActionParticipantLeave](../constructors/channelAdminLogEventActionParticipantLeave.md) = \[\]; + +*** +
[$channelAdminLogEventActionParticipantToggleAdmin](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md) = \['prev_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'new_participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +
[$channelAdminLogEventActionParticipantToggleBan](../constructors/channelAdminLogEventActionParticipantToggleBan.md) = \['prev_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'new_participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +
[$channelAdminLogEventActionStopPoll](../constructors/channelAdminLogEventActionStopPoll.md) = \['message' => [Message](../types/Message.md), \]; + +*** +
[$channelAdminLogEventActionToggleInvites](../constructors/channelAdminLogEventActionToggleInvites.md) = \['new_value' => [Bool](../types/Bool.md), \]; + +*** +
[$channelAdminLogEventActionTogglePreHistoryHidden](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md) = \['new_value' => [Bool](../types/Bool.md), \]; + +*** +
[$channelAdminLogEventActionToggleSignatures](../constructors/channelAdminLogEventActionToggleSignatures.md) = \['new_value' => [Bool](../types/Bool.md), \]; + +*** +
[$channelAdminLogEventActionToggleSlowMode](../constructors/channelAdminLogEventActionToggleSlowMode.md) = \['prev_value' => [int](../types/int.md), 'new_value' => [int](../types/int.md), \]; + +*** +
[$channelAdminLogEventActionUpdatePinned](../constructors/channelAdminLogEventActionUpdatePinned.md) = \['message' => [Message](../types/Message.md), \]; + +*** +
[$channelAdminLogEventsFilter](../constructors/channelAdminLogEventsFilter.md) = \['join' => [Bool](../types/Bool.md), 'leave' => [Bool](../types/Bool.md), 'invite' => [Bool](../types/Bool.md), 'ban' => [Bool](../types/Bool.md), 'unban' => [Bool](../types/Bool.md), 'kick' => [Bool](../types/Bool.md), 'unkick' => [Bool](../types/Bool.md), 'promote' => [Bool](../types/Bool.md), 'demote' => [Bool](../types/Bool.md), 'info' => [Bool](../types/Bool.md), 'settings' => [Bool](../types/Bool.md), 'pinned' => [Bool](../types/Bool.md), 'edit' => [Bool](../types/Bool.md), 'delete' => [Bool](../types/Bool.md), \]; + +*** +
[$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), \]; + +*** +
[$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), \]; + +*** +
[$channelLocation](../constructors/channelLocation.md) = \['geo_point' => [GeoPoint](../types/GeoPoint.md), 'address' => [string](../types/string.md), \]; + +*** +
[$channelLocationEmpty](../constructors/channelLocationEmpty.md) = \[\]; + +*** +
[$channelMessagesFilter](../constructors/channelMessagesFilter.md) = \['exclude_new_messages' => [Bool](../types/Bool.md), 'ranges' => \[[MessageRange](../types/MessageRange.md)\], \]; ***
[$channelMessagesFilterEmpty](../constructors/channelMessagesFilterEmpty.md) = \[\]; @@ -94,16 +259,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$channelParticipant](../constructors/channelParticipant.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; *** -
[$channelParticipantCreator](../constructors/channelParticipantCreator.md) = \['user_id' => [int](../types/int.md), \]; +
[$channelParticipantAdmin](../constructors/channelParticipantAdmin.md) = \['can_edit' => [Bool](../types/Bool.md), 'self' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'promoted_by' => [int](../types/int.md), 'date' => [int](../types/int.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'rank' => [string](../types/string.md), \]; *** -
[$channelParticipantEditor](../constructors/channelParticipantEditor.md) = \['user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; +
[$channelParticipantBanned](../constructors/channelParticipantBanned.md) = \['left' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'kicked_by' => [int](../types/int.md), 'date' => [int](../types/int.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]; *** -
[$channelParticipantKicked](../constructors/channelParticipantKicked.md) = \['user_id' => [int](../types/int.md), 'kicked_by' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; - -*** -
[$channelParticipantModerator](../constructors/channelParticipantModerator.md) = \['user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; +
[$channelParticipantCreator](../constructors/channelParticipantCreator.md) = \['user_id' => [int](../types/int.md), 'rank' => [string](../types/string.md), \]; ***
[$channelParticipantSelf](../constructors/channelParticipantSelf.md) = \['user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; @@ -111,23 +273,26 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$channelParticipantsAdmins](../constructors/channelParticipantsAdmins.md) = \[\]; +*** +
[$channelParticipantsBanned](../constructors/channelParticipantsBanned.md) = \['q' => [string](../types/string.md), \]; + ***
[$channelParticipantsBots](../constructors/channelParticipantsBots.md) = \[\]; *** -
[$channelParticipantsKicked](../constructors/channelParticipantsKicked.md) = \[\]; +
[$channelParticipantsContacts](../constructors/channelParticipantsContacts.md) = \['q' => [string](../types/string.md), \]; + +*** +
[$channelParticipantsKicked](../constructors/channelParticipantsKicked.md) = \['q' => [string](../types/string.md), \]; ***
[$channelParticipantsRecent](../constructors/channelParticipantsRecent.md) = \[\]; *** -
[$channelRoleEditor](../constructors/channelRoleEditor.md) = \[\]; +
[$channelParticipantsSearch](../constructors/channelParticipantsSearch.md) = \['q' => [string](../types/string.md), \]; *** -
[$channelRoleEmpty](../constructors/channelRoleEmpty.md) = \[\]; - -*** -
[$channelRoleModerator](../constructors/channelRoleModerator.md) = \[\]; +
[$channels.adminLogResults](../constructors/channels.adminLogResults.md) = \['events' => \[[ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; ***
[$channels.channelParticipant](../constructors/channels.channelParticipant.md) = \['participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'users' => \[[User](../types/User.md)\], \]; @@ -136,7 +301,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$channels.channelParticipants](../constructors/channels.channelParticipants.md) = \['count' => [int](../types/int.md), 'participants' => \[[ChannelParticipant](../types/ChannelParticipant.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$chat](../constructors/chat.md) = \['creator' => [Bool](../types/Bool.md), 'kicked' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'admins_enabled' => [Bool](../types/Bool.md), 'admin' => [Bool](../types/Bool.md), 'deactivated' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'participants_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'migrated_to' => [InputChannel](../types/InputChannel.md), \]; +
[$channels.channelParticipantsNotModified](../constructors/channels.channelParticipantsNotModified.md) = \[\]; + +*** +
[$chat](../constructors/chat.md) = \['creator' => [Bool](../types/Bool.md), 'kicked' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'deactivated' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'participants_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'migrated_to' => [InputChannel](../types/InputChannel.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]; + +*** +
[$chatAdminRights](../constructors/chatAdminRights.md) = \['change_info' => [Bool](../types/Bool.md), 'post_messages' => [Bool](../types/Bool.md), 'edit_messages' => [Bool](../types/Bool.md), 'delete_messages' => [Bool](../types/Bool.md), 'ban_users' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'add_admins' => [Bool](../types/Bool.md), \]; + +*** +
[$chatBannedRights](../constructors/chatBannedRights.md) = \['view_messages' => [Bool](../types/Bool.md), 'send_messages' => [Bool](../types/Bool.md), 'send_media' => [Bool](../types/Bool.md), 'send_stickers' => [Bool](../types/Bool.md), 'send_gifs' => [Bool](../types/Bool.md), 'send_games' => [Bool](../types/Bool.md), 'send_inline' => [Bool](../types/Bool.md), 'embed_links' => [Bool](../types/Bool.md), 'send_polls' => [Bool](../types/Bool.md), 'change_info' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'until_date' => [int](../types/int.md), \]; ***
[$chatEmpty](../constructors/chatEmpty.md) = \['id' => [int](../types/int.md), \]; @@ -145,10 +319,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$chatForbidden](../constructors/chatForbidden.md) = \['id' => [int](../types/int.md), 'title' => [string](../types/string.md), \]; *** -
[$chatFull](../constructors/chatFull.md) = \['id' => [int](../types/int.md), 'participants' => [ChatParticipants](../types/ChatParticipants.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)\], \]; +
[$chatFull](../constructors/chatFull.md) = \['can_set_username' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants' => [ChatParticipants](../types/ChatParticipants.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)\], 'pinned_msg_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), \]; *** -
[$chatInvite](../constructors/chatInvite.md) = \['channel' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'public' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), \]; +
[$chatInvite](../constructors/chatInvite.md) = \['channel' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'public' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'participants_count' => [int](../types/int.md), 'participants' => \[[User](../types/User.md)\], \]; ***
[$chatInviteAlready](../constructors/chatInviteAlready.md) = \['chat' => [Chat](../types/Chat.md), \]; @@ -159,6 +333,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$chatInviteExported](../constructors/chatInviteExported.md) = \['link' => [string](../types/string.md), \]; +*** +
[$chatInvitePeek](../constructors/chatInvitePeek.md) = \['chat' => [Chat](../types/Chat.md), 'expires' => [int](../types/int.md), \]; + +*** +
[$chatOnlines](../constructors/chatOnlines.md) = \['onlines' => [int](../types/int.md), \]; + ***
[$chatParticipant](../constructors/chatParticipant.md) = \['user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; @@ -175,13 +355,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$chatParticipantsForbidden](../constructors/chatParticipantsForbidden.md) = \['chat_id' => [int](../types/int.md), 'self_participant' => [ChatParticipant](../types/ChatParticipant.md), \]; *** -
[$chatPhoto](../constructors/chatPhoto.md) = \['photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), \]; +
[$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), \]; ***
[$chatPhotoEmpty](../constructors/chatPhotoEmpty.md) = \[\]; *** -
[$config](../constructors/config.md) = \['date' => [int](../types/int.md), 'expires' => [int](../types/int.md), 'test_mode' => [Bool](../types/Bool.md), 'this_dc' => [int](../types/int.md), 'dc_options' => \[[DcOption](../types/DcOption.md)\], 'chat_size_max' => [int](../types/int.md), 'megagroup_size_max' => [int](../types/int.md), 'forwarded_count_max' => [int](../types/int.md), 'online_update_period_ms' => [int](../types/int.md), 'offline_blur_timeout_ms' => [int](../types/int.md), 'offline_idle_timeout_ms' => [int](../types/int.md), 'online_cloud_timeout_ms' => [int](../types/int.md), 'notify_cloud_delay_ms' => [int](../types/int.md), 'notify_default_delay_ms' => [int](../types/int.md), 'chat_big_size' => [int](../types/int.md), 'push_chat_period_ms' => [int](../types/int.md), 'push_chat_limit' => [int](../types/int.md), 'disabled_features' => \[[DisabledFeature](../types/DisabledFeature.md)\], \]; +
[$codeSettings](../constructors/codeSettings.md) = \['allow_flashcall' => [Bool](../types/Bool.md), 'current_number' => [Bool](../types/Bool.md), 'allow_app_hash' => [Bool](../types/Bool.md), \]; + +*** +
[$config](../constructors/config.md) = \['phonecalls_enabled' => [Bool](../types/Bool.md), 'default_p2p_contacts' => [Bool](../types/Bool.md), 'preload_featured_stickers' => [Bool](../types/Bool.md), 'ignore_phone_entities' => [Bool](../types/Bool.md), 'revoke_pm_inbox' => [Bool](../types/Bool.md), 'blocked_mode' => [Bool](../types/Bool.md), 'pfs_enabled' => [Bool](../types/Bool.md), 'date' => [int](../types/int.md), 'expires' => [int](../types/int.md), 'test_mode' => [Bool](../types/Bool.md), 'this_dc' => [int](../types/int.md), 'dc_options' => \[[DcOption](../types/DcOption.md)\], 'dc_txt_domain_name' => [string](../types/string.md), 'chat_size_max' => [int](../types/int.md), 'megagroup_size_max' => [int](../types/int.md), 'forwarded_count_max' => [int](../types/int.md), 'online_update_period_ms' => [int](../types/int.md), 'offline_blur_timeout_ms' => [int](../types/int.md), 'offline_idle_timeout_ms' => [int](../types/int.md), 'online_cloud_timeout_ms' => [int](../types/int.md), 'notify_cloud_delay_ms' => [int](../types/int.md), 'notify_default_delay_ms' => [int](../types/int.md), 'push_chat_period_ms' => [int](../types/int.md), 'push_chat_limit' => [int](../types/int.md), 'saved_gifs_limit' => [int](../types/int.md), 'edit_time_limit' => [int](../types/int.md), 'revoke_time_limit' => [int](../types/int.md), 'revoke_pm_time_limit' => [int](../types/int.md), 'rating_e_decay' => [int](../types/int.md), 'stickers_recent_limit' => [int](../types/int.md), 'stickers_faved_limit' => [int](../types/int.md), 'channels_read_media_period' => [int](../types/int.md), 'tmp_sessions' => [int](../types/int.md), 'pinned_dialogs_count_max' => [int](../types/int.md), 'pinned_infolder_count_max' => [int](../types/int.md), 'call_receive_timeout_ms' => [int](../types/int.md), 'call_ring_timeout_ms' => [int](../types/int.md), 'call_connect_timeout_ms' => [int](../types/int.md), 'call_packet_timeout_ms' => [int](../types/int.md), 'me_url_prefix' => [string](../types/string.md), 'autoupdate_url_prefix' => [string](../types/string.md), 'gif_search_username' => [string](../types/string.md), 'venue_search_username' => [string](../types/string.md), 'img_search_username' => [string](../types/string.md), 'static_maps_provider' => [string](../types/string.md), 'caption_length_max' => [int](../types/int.md), 'message_length_max' => [int](../types/int.md), 'webfile_dc_id' => [int](../types/int.md), 'suggested_lang_code' => [string](../types/string.md), 'lang_pack_version' => [int](../types/int.md), 'base_lang_pack_version' => [int](../types/int.md), \]; ***
[$contact](../constructors/contact.md) = \['user_id' => [int](../types/int.md), 'mutual' => [Bool](../types/Bool.md), \]; @@ -189,24 +372,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$contactBlocked](../constructors/contactBlocked.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; -*** -
[$contactLinkContact](../constructors/contactLinkContact.md) = \[\]; - -*** -
[$contactLinkHasPhone](../constructors/contactLinkHasPhone.md) = \[\]; - -*** -
[$contactLinkNone](../constructors/contactLinkNone.md) = \[\]; - -*** -
[$contactLinkUnknown](../constructors/contactLinkUnknown.md) = \[\]; - ***
[$contactStatus](../constructors/contactStatus.md) = \['user_id' => [int](../types/int.md), 'status' => [UserStatus](../types/UserStatus.md), \]; -*** -
[$contactSuggested](../constructors/contactSuggested.md) = \['user_id' => [int](../types/int.md), 'mutual_contacts' => [int](../types/int.md), \]; - ***
[$contacts.blocked](../constructors/contacts.blocked.md) = \['blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \]; @@ -214,62 +382,101 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$contacts.blockedSlice](../constructors/contacts.blockedSlice.md) = \['count' => [int](../types/int.md), 'blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$contacts.contacts](../constructors/contacts.contacts.md) = \['contacts' => \[[Contact](../types/Contact.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$contacts.contacts](../constructors/contacts.contacts.md) = \['contacts' => \[[Contact](../types/Contact.md)\], 'saved_count' => [int](../types/int.md), 'users' => \[[User](../types/User.md)\], \]; ***
[$contacts.contactsNotModified](../constructors/contacts.contactsNotModified.md) = \[\]; *** -
[$contacts.found](../constructors/contacts.found.md) = \['results' => \[[Peer](../types/Peer.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$contacts.found](../constructors/contacts.found.md) = \['my_results' => \[[Peer](../types/Peer.md)\], 'results' => \[[Peer](../types/Peer.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$contacts.importedContacts](../constructors/contacts.importedContacts.md) = \['imported' => \[[ImportedContact](../types/ImportedContact.md)\], 'retry_contacts' => \[[long](../types/long.md)\], 'users' => \[[User](../types/User.md)\], \]; - -*** -
[$contacts.link](../constructors/contacts.link.md) = \['my_link' => [ContactLink](../types/ContactLink.md), 'foreign_link' => [ContactLink](../types/ContactLink.md), 'user' => [User](../types/User.md), \]; +
[$contacts.importedContacts](../constructors/contacts.importedContacts.md) = \['imported' => \[[ImportedContact](../types/ImportedContact.md)\], 'popular_invites' => \[[PopularContact](../types/PopularContact.md)\], 'retry_contacts' => \[[long](../types/long.md)\], 'users' => \[[User](../types/User.md)\], \]; ***
[$contacts.resolvedPeer](../constructors/contacts.resolvedPeer.md) = \['peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$contacts.suggested](../constructors/contacts.suggested.md) = \['results' => \[[ContactSuggested](../types/ContactSuggested.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$contacts.topPeers](../constructors/contacts.topPeers.md) = \['categories' => \[[TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$dcOption](../constructors/dcOption.md) = \['ipv6' => [Bool](../types/Bool.md), 'media_only' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'ip_address' => [string](../types/string.md), 'port' => [int](../types/int.md), \]; +
[$contacts.topPeersDisabled](../constructors/contacts.topPeersDisabled.md) = \[\]; *** -
[$dialog](../constructors/dialog.md) = \['peer' => [Peer](../types/Peer.md), 'top_message' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), \]; +
[$contacts.topPeersNotModified](../constructors/contacts.topPeersNotModified.md) = \[\]; *** -
[$dialogChannel](../constructors/dialogChannel.md) = \['peer' => [Peer](../types/Peer.md), 'top_message' => [int](../types/int.md), 'top_important_message' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'unread_important_count' => [int](../types/int.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'pts' => [int](../types/int.md), \]; +
[$dataJSON](../constructors/dataJSON.md) = \['data' => [string](../types/string.md), \]; *** -
[$disabledFeature](../constructors/disabledFeature.md) = \['feature' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; +
[$dcOption](../constructors/dcOption.md) = \['ipv6' => [Bool](../types/Bool.md), 'media_only' => [Bool](../types/Bool.md), 'tcpo_only' => [Bool](../types/Bool.md), 'cdn' => [Bool](../types/Bool.md), 'static' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'ip_address' => [string](../types/string.md), 'port' => [int](../types/int.md), 'secret' => [bytes](../types/bytes.md), \]; *** -
[$document](../constructors/document.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'dc_id' => [int](../types/int.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; +
[$dialog](../constructors/dialog.md) = \['pinned' => [Bool](../types/Bool.md), 'unread_mark' => [Bool](../types/Bool.md), 'peer' => [Peer](../types/Peer.md), 'top_message' => [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), 'unread_mentions_count' => [int](../types/int.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'pts' => [int](../types/int.md), 'draft' => [DraftMessage](../types/DraftMessage.md), 'folder_id' => [int](../types/int.md), \]; + +*** +
[$dialogFilter](../constructors/dialogFilter.md) = \['contacts' => [Bool](../types/Bool.md), 'non_contacts' => [Bool](../types/Bool.md), 'groups' => [Bool](../types/Bool.md), 'broadcasts' => [Bool](../types/Bool.md), 'bots' => [Bool](../types/Bool.md), 'exclude_muted' => [Bool](../types/Bool.md), 'exclude_read' => [Bool](../types/Bool.md), 'exclude_archived' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'emoticon' => [string](../types/string.md), 'pinned_peers' => \[[InputPeer](../types/InputPeer.md)\], 'include_peers' => \[[InputPeer](../types/InputPeer.md)\], 'exclude_peers' => \[[InputPeer](../types/InputPeer.md)\], \]; + +*** +
[$dialogFilterSuggested](../constructors/dialogFilterSuggested.md) = \['filter' => [DialogFilter](../types/DialogFilter.md), 'description' => [string](../types/string.md), \]; + +*** +
[$dialogFolder](../constructors/dialogFolder.md) = \['pinned' => [Bool](../types/Bool.md), 'folder' => [Folder](../types/Folder.md), 'peer' => [Peer](../types/Peer.md), 'top_message' => [int](../types/int.md), 'unread_muted_peers_count' => [int](../types/int.md), 'unread_unmuted_peers_count' => [int](../types/int.md), 'unread_muted_messages_count' => [int](../types/int.md), 'unread_unmuted_messages_count' => [int](../types/int.md), \]; + +*** +
[$dialogPeer](../constructors/dialogPeer.md) = \['peer' => [Peer](../types/Peer.md), \]; + +*** +
[$dialogPeerFolder](../constructors/dialogPeerFolder.md) = \['folder_id' => [int](../types/int.md), \]; + +*** +
[$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)\], \]; ***
[$documentAttributeAnimated](../constructors/documentAttributeAnimated.md) = \[\]; *** -
[$documentAttributeAudio](../constructors/documentAttributeAudio.md) = \['duration' => [int](../types/int.md), 'title' => [string](../types/string.md), 'performer' => [string](../types/string.md), \]; +
[$documentAttributeAudio](../constructors/documentAttributeAudio.md) = \['voice' => [Bool](../types/Bool.md), 'duration' => [int](../types/int.md), 'title' => [string](../types/string.md), 'performer' => [string](../types/string.md), 'waveform' => [bytes](../types/bytes.md), \]; ***
[$documentAttributeFilename](../constructors/documentAttributeFilename.md) = \['file_name' => [string](../types/string.md), \]; +*** +
[$documentAttributeHasStickers](../constructors/documentAttributeHasStickers.md) = \[\]; + ***
[$documentAttributeImageSize](../constructors/documentAttributeImageSize.md) = \['w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; *** -
[$documentAttributeSticker](../constructors/documentAttributeSticker.md) = \['alt' => [string](../types/string.md), 'stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]; +
[$documentAttributeSticker](../constructors/documentAttributeSticker.md) = \['mask' => [Bool](../types/Bool.md), 'alt' => [string](../types/string.md), 'stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'mask_coords' => [MaskCoords](../types/MaskCoords.md), \]; *** -
[$documentAttributeVideo](../constructors/documentAttributeVideo.md) = \['duration' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; +
[$documentAttributeVideo](../constructors/documentAttributeVideo.md) = \['round_message' => [Bool](../types/Bool.md), 'supports_streaming' => [Bool](../types/Bool.md), 'duration' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; ***
[$documentEmpty](../constructors/documentEmpty.md) = \['id' => [long](../types/long.md), \]; +*** +
[$draftMessage](../constructors/draftMessage.md) = \['no_webpage' => [Bool](../types/Bool.md), 'reply_to_msg_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'date' => [int](../types/int.md), \]; + +*** +
[$draftMessageEmpty](../constructors/draftMessageEmpty.md) = \['date' => [int](../types/int.md), \]; + +*** +
[$emojiKeyword](../constructors/emojiKeyword.md) = \['keyword' => [string](../types/string.md), 'emoticons' => \[[string](../types/string.md)\], \]; + +*** +
[$emojiKeywordDeleted](../constructors/emojiKeywordDeleted.md) = \['keyword' => [string](../types/string.md), 'emoticons' => \[[string](../types/string.md)\], \]; + +*** +
[$emojiKeywordsDifference](../constructors/emojiKeywordsDifference.md) = \['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), 'version' => [int](../types/int.md), 'keywords' => \[[EmojiKeyword](../types/EmojiKeyword.md)\], \]; + +*** +
[$emojiLanguage](../constructors/emojiLanguage.md) = \['lang_code' => [string](../types/string.md), \]; + +*** +
[$emojiURL](../constructors/emojiURL.md) = \['url' => [string](../types/string.md), \]; + ***
[$encryptedChat](../constructors/encryptedChat.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_or_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), \]; @@ -280,7 +487,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$encryptedChatEmpty](../constructors/encryptedChatEmpty.md) = \['id' => [int](../types/int.md), \]; *** -
[$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), \]; +
[$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), \]; ***
[$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), \]; @@ -301,28 +508,40 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$error](../constructors/error.md) = \['code' => [int](../types/int.md), 'text' => [string](../types/string.md), \]; *** -
[$fileLocation](../constructors/fileLocation.md) = \['dc_id' => [int](../types/int.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; +
[$exportedMessageLink](../constructors/exportedMessageLink.md) = \['link' => [string](../types/string.md), 'html' => [string](../types/string.md), \]; *** -
[$fileLocationUnavailable](../constructors/fileLocationUnavailable.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; +
[$fileHash](../constructors/fileHash.md) = \['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [bytes](../types/bytes.md), \]; *** -
[$foundGif](../constructors/foundGif.md) = \['webpage' => [WebPage](../types/WebPage.md), \]; +
[$fileLocationToBeDeprecated](../constructors/fileLocationToBeDeprecated.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), \]; *** -
[$geoPoint](../constructors/geoPoint.md) = \['long' => [double](../types/double.md), 'lat' => [double](../types/double.md), \]; +
[$folder](../constructors/folder.md) = \['autofill_new_broadcasts' => [Bool](../types/Bool.md), 'autofill_public_groups' => [Bool](../types/Bool.md), 'autofill_new_correspondents' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), \]; + +*** +
[$folderPeer](../constructors/folderPeer.md) = \['peer' => [Peer](../types/Peer.md), 'folder_id' => [int](../types/int.md), \]; + +*** +
[$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), \]; + +*** +
[$geoPoint](../constructors/geoPoint.md) = \['long' => [double](../types/double.md), 'lat' => [double](../types/double.md), 'access_hash' => [long](../types/long.md), \]; ***
[$geoPointEmpty](../constructors/geoPointEmpty.md) = \[\]; *** -
[$help.appChangelog](../constructors/help.appChangelog.md) = \['text' => [string](../types/string.md), \]; +
[$globalPrivacySettings](../constructors/globalPrivacySettings.md) = \['archive_and_mute_new_noncontact_peers' => [Bool](../types/Bool.md), \]; *** -
[$help.appChangelogEmpty](../constructors/help.appChangelogEmpty.md) = \[\]; +
[$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), \]; *** -
[$help.appUpdate](../constructors/help.appUpdate.md) = \['id' => [int](../types/int.md), 'critical' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'text' => [string](../types/string.md), \]; +
[$help.deepLinkInfo](../constructors/help.deepLinkInfo.md) = \['update_app' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +
[$help.deepLinkInfoEmpty](../constructors/help.deepLinkInfoEmpty.md) = \[\]; ***
[$help.inviteText](../constructors/help.inviteText.md) = \['message' => [string](../types/string.md), \]; @@ -330,26 +549,86 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$help.noAppUpdate](../constructors/help.noAppUpdate.md) = \[\]; +*** +
[$help.passportConfig](../constructors/help.passportConfig.md) = \['hash' => [int](../types/int.md), 'countries_langs' => [DataJSON](../types/DataJSON.md), \]; + +*** +
[$help.passportConfigNotModified](../constructors/help.passportConfigNotModified.md) = \[\]; + +*** +
[$help.promoData](../constructors/help.promoData.md) = \['proxy' => [Bool](../types/Bool.md), 'expires' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'psa_type' => [string](../types/string.md), 'psa_message' => [string](../types/string.md), \]; + +*** +
[$help.promoDataEmpty](../constructors/help.promoDataEmpty.md) = \['expires' => [int](../types/int.md), \]; + +*** +
[$help.recentMeUrls](../constructors/help.recentMeUrls.md) = \['urls' => \[[RecentMeUrl](../types/RecentMeUrl.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + ***
[$help.support](../constructors/help.support.md) = \['phone_number' => [string](../types/string.md), 'user' => [User](../types/User.md), \]; *** -
[$help.termsOfService](../constructors/help.termsOfService.md) = \['text' => [string](../types/string.md), \]; +
[$help.supportName](../constructors/help.supportName.md) = \['name' => [string](../types/string.md), \]; + +*** +
[$help.termsOfService](../constructors/help.termsOfService.md) = \['popup' => [Bool](../types/Bool.md), 'id' => [DataJSON](../types/DataJSON.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'min_age_confirm' => [int](../types/int.md), \]; + +*** +
[$help.termsOfServiceUpdate](../constructors/help.termsOfServiceUpdate.md) = \['expires' => [int](../types/int.md), 'terms_of_service' => [help.TermsOfService](../types/help.TermsOfService.md), \]; + +*** +
[$help.termsOfServiceUpdateEmpty](../constructors/help.termsOfServiceUpdateEmpty.md) = \['expires' => [int](../types/int.md), \]; + +*** +
[$help.userInfo](../constructors/help.userInfo.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'author' => [string](../types/string.md), 'date' => [int](../types/int.md), \]; + +*** +
[$help.userInfoEmpty](../constructors/help.userInfoEmpty.md) = \[\]; + +*** +
[$highScore](../constructors/highScore.md) = \['pos' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'score' => [int](../types/int.md), \]; ***
[$importedContact](../constructors/importedContact.md) = \['user_id' => [int](../types/int.md), 'client_id' => [long](../types/long.md), \]; *** -
[$inputAppEvent](../constructors/inputAppEvent.md) = \['time' => [double](../types/double.md), 'type' => [string](../types/string.md), 'peer' => [long](../types/long.md), 'data' => [string](../types/string.md), \]; +
[$inlineBotSwitchPM](../constructors/inlineBotSwitchPM.md) = \['text' => [string](../types/string.md), 'start_param' => [string](../types/string.md), \]; *** -
[$inputAudio](../constructors/inputAudio.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputAppEvent](../constructors/inputAppEvent.md) = \['time' => [double](../types/double.md), 'type' => [string](../types/string.md), 'peer' => [long](../types/long.md), 'data' => [JSONValue](../types/JSONValue.md), \]; *** -
[$inputAudioEmpty](../constructors/inputAudioEmpty.md) = \[\]; +
[$inputBotInlineMessageGame](../constructors/inputBotInlineMessageGame.md) = \['reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -
[$inputAudioFileLocation](../constructors/inputAudioFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputBotInlineMessageID](../constructors/inputBotInlineMessageID.md) = \['dc_id' => [int](../types/int.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$inputBotInlineMessageMediaAuto](../constructors/inputBotInlineMessageMediaAuto.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$inputBotInlineMessageMediaContact](../constructors/inputBotInlineMessageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'vcard' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$inputBotInlineMessageMediaGeo](../constructors/inputBotInlineMessageMediaGeo.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'period' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$inputBotInlineMessageMediaVenue](../constructors/inputBotInlineMessageMediaVenue.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$inputBotInlineMessageText](../constructors/inputBotInlineMessageText.md) = \['no_webpage' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +
[$inputBotInlineResult](../constructors/inputBotInlineResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'url' => [string](../types/string.md), 'thumb' => [InputWebDocument](../types/InputWebDocument.md), 'content' => [InputWebDocument](../types/InputWebDocument.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +
[$inputBotInlineResultDocument](../constructors/inputBotInlineResultDocument.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +
[$inputBotInlineResultGame](../constructors/inputBotInlineResultGame.md) = \['id' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +
[$inputBotInlineResultPhoto](../constructors/inputBotInlineResultPhoto.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'photo' => [InputPhoto](../types/InputPhoto.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; ***
[$inputChannel](../constructors/inputChannel.md) = \['channel_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; @@ -358,22 +637,40 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$inputChannelEmpty](../constructors/inputChannelEmpty.md) = \[\]; *** -
[$inputChatPhoto](../constructors/inputChatPhoto.md) = \['id' => [InputPhoto](../types/InputPhoto.md), 'crop' => [InputPhotoCrop](../types/InputPhotoCrop.md), \]; +
[$inputChannelFromMessage](../constructors/inputChannelFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), \]; + +*** +
[$inputChatPhoto](../constructors/inputChatPhoto.md) = \['id' => [InputPhoto](../types/InputPhoto.md), \]; ***
[$inputChatPhotoEmpty](../constructors/inputChatPhotoEmpty.md) = \[\]; *** -
[$inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'crop' => [InputPhotoCrop](../types/InputPhotoCrop.md), \]; +
[$inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'video' => [InputFile](../types/InputFile.md), 'video_start_ts' => [double](../types/double.md), \]; *** -
[$inputDocument](../constructors/inputDocument.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputCheckPasswordEmpty](../constructors/inputCheckPasswordEmpty.md) = \[\]; + +*** +
[$inputCheckPasswordSRP](../constructors/inputCheckPasswordSRP.md) = \['srp_id' => [long](../types/long.md), 'A' => [bytes](../types/bytes.md), 'M1' => [bytes](../types/bytes.md), \]; + +*** +
[$inputClientProxy](../constructors/inputClientProxy.md) = \['address' => [string](../types/string.md), 'port' => [int](../types/int.md), \]; + +*** +
[$inputDialogPeer](../constructors/inputDialogPeer.md) = \['peer' => [InputPeer](../types/InputPeer.md), \]; + +*** +
[$inputDialogPeerFolder](../constructors/inputDialogPeerFolder.md) = \['folder_id' => [int](../types/int.md), \]; + +*** +
[$inputDocument](../constructors/inputDocument.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), \]; ***
[$inputDocumentEmpty](../constructors/inputDocumentEmpty.md) = \[\]; *** -
[$inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'thumb_size' => [string](../types/string.md), \]; ***
[$inputEncryptedChat](../constructors/inputEncryptedChat.md) = \['chat_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; @@ -400,7 +697,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$inputFileBig](../constructors/inputFileBig.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'name' => [string](../types/string.md), \]; *** -
[$inputFileLocation](../constructors/inputFileLocation.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; +
[$inputFileLocation](../constructors/inputFileLocation.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), \]; + +*** +
[$inputFolderPeer](../constructors/inputFolderPeer.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'folder_id' => [int](../types/int.md), \]; + +*** +
[$inputGameID](../constructors/inputGameID.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$inputGameShortName](../constructors/inputGameShortName.md) = \['bot_id' => [InputUser](../types/InputUser.md), 'short_name' => [string](../types/string.md), \]; ***
[$inputGeoPoint](../constructors/inputGeoPoint.md) = \['lat' => [double](../types/double.md), 'long' => [double](../types/double.md), \]; @@ -409,55 +715,70 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$inputGeoPointEmpty](../constructors/inputGeoPointEmpty.md) = \[\]; *** -
[$inputMediaAudio](../constructors/inputMediaAudio.md) = \['id' => [InputAudio](../types/InputAudio.md), \]; +
[$inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) = \['request_write_access' => [Bool](../types/Bool.md), 'text' => [string](../types/string.md), 'fwd_text' => [string](../types/string.md), 'url' => [string](../types/string.md), 'bot' => [InputUser](../types/InputUser.md), \]; *** -
[$inputMediaContact](../constructors/inputMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]; +
[$inputMediaContact](../constructors/inputMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'vcard' => [string](../types/string.md), \]; *** -
[$inputMediaDocument](../constructors/inputMediaDocument.md) = \['id' => [InputDocument](../types/InputDocument.md), \]; +
[$inputMediaDice](../constructors/inputMediaDice.md) = \['emoticon' => [string](../types/string.md), \]; + +*** +
[$inputMediaDocument](../constructors/inputMediaDocument.md) = \['id' => [InputDocument](../types/InputDocument.md), 'ttl_seconds' => [int](../types/int.md), \]; + +*** +
[$inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md) = \['url' => [string](../types/string.md), 'ttl_seconds' => [int](../types/int.md), \]; ***
[$inputMediaEmpty](../constructors/inputMediaEmpty.md) = \[\]; +*** +
[$inputMediaGame](../constructors/inputMediaGame.md) = \['id' => [InputGame](../types/InputGame.md), \]; + +*** +
[$inputMediaGeoLive](../constructors/inputMediaGeoLive.md) = \['stopped' => [Bool](../types/Bool.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'period' => [int](../types/int.md), \]; + ***
[$inputMediaGeoPoint](../constructors/inputMediaGeoPoint.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]; *** -
[$inputMediaGifExternal](../constructors/inputMediaGifExternal.md) = \['url' => [string](../types/string.md), 'q' => [string](../types/string.md), \]; +
[$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), \]; *** -
[$inputMediaPhoto](../constructors/inputMediaPhoto.md) = \['id' => [InputPhoto](../types/InputPhoto.md), 'caption' => [string](../types/string.md), \]; +
[$inputMediaPhoto](../constructors/inputMediaPhoto.md) = \['id' => [InputPhoto](../types/InputPhoto.md), 'ttl_seconds' => [int](../types/int.md), \]; *** -
[$inputMediaUploadedAudio](../constructors/inputMediaUploadedAudio.md) = \['file' => [InputFile](../types/InputFile.md), 'duration' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), \]; +
[$inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md) = \['url' => [string](../types/string.md), 'ttl_seconds' => [int](../types/int.md), \]; *** -
[$inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) = \['file' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; +
[$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)\], \]; *** -
[$inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'caption' => [string](../types/string.md), \]; +
[$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), \]; *** -
[$inputMediaUploadedThumbDocument](../constructors/inputMediaUploadedThumbDocument.md) = \['file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; +
[$inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \]; *** -
[$inputMediaUploadedThumbVideo](../constructors/inputMediaUploadedThumbVideo.md) = \['file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'duration' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'caption' => [string](../types/string.md), \]; +
[$inputMediaVenue](../constructors/inputMediaVenue.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), \]; *** -
[$inputMediaUploadedVideo](../constructors/inputMediaUploadedVideo.md) = \['file' => [InputFile](../types/InputFile.md), 'duration' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'caption' => [string](../types/string.md), \]; +
[$inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'user_id' => [InputUser](../types/InputUser.md), \]; *** -
[$inputMediaVenue](../constructors/inputMediaVenue.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), \]; +
[$inputMessageID](../constructors/inputMessageID.md) = \['id' => [int](../types/int.md), \]; *** -
[$inputMediaVideo](../constructors/inputMediaVideo.md) = \['id' => [InputVideo](../types/InputVideo.md), 'caption' => [string](../types/string.md), \]; +
[$inputMessagePinned](../constructors/inputMessagePinned.md) = \[\]; *** -
[$inputMessagesFilterAudio](../constructors/inputMessagesFilterAudio.md) = \[\]; +
[$inputMessageReplyTo](../constructors/inputMessageReplyTo.md) = \['id' => [int](../types/int.md), \]; *** -
[$inputMessagesFilterAudioDocuments](../constructors/inputMessagesFilterAudioDocuments.md) = \[\]; +
[$inputMessagesFilterChatPhotos](../constructors/inputMessagesFilterChatPhotos.md) = \[\]; + +*** +
[$inputMessagesFilterContacts](../constructors/inputMessagesFilterContacts.md) = \[\]; ***
[$inputMessagesFilterDocument](../constructors/inputMessagesFilterDocument.md) = \[\]; @@ -465,14 +786,32 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$inputMessagesFilterEmpty](../constructors/inputMessagesFilterEmpty.md) = \[\]; +*** +
[$inputMessagesFilterGeo](../constructors/inputMessagesFilterGeo.md) = \[\]; + +*** +
[$inputMessagesFilterGif](../constructors/inputMessagesFilterGif.md) = \[\]; + +*** +
[$inputMessagesFilterMusic](../constructors/inputMessagesFilterMusic.md) = \[\]; + +*** +
[$inputMessagesFilterMyMentions](../constructors/inputMessagesFilterMyMentions.md) = \[\]; + +*** +
[$inputMessagesFilterPhoneCalls](../constructors/inputMessagesFilterPhoneCalls.md) = \['missed' => [Bool](../types/Bool.md), \]; + ***
[$inputMessagesFilterPhotoVideo](../constructors/inputMessagesFilterPhotoVideo.md) = \[\]; *** -
[$inputMessagesFilterPhotoVideoDocuments](../constructors/inputMessagesFilterPhotoVideoDocuments.md) = \[\]; +
[$inputMessagesFilterPhotos](../constructors/inputMessagesFilterPhotos.md) = \[\]; *** -
[$inputMessagesFilterPhotos](../constructors/inputMessagesFilterPhotos.md) = \[\]; +
[$inputMessagesFilterRoundVideo](../constructors/inputMessagesFilterRoundVideo.md) = \[\]; + +*** +
[$inputMessagesFilterRoundVoice](../constructors/inputMessagesFilterRoundVoice.md) = \[\]; ***
[$inputMessagesFilterUrl](../constructors/inputMessagesFilterUrl.md) = \[\]; @@ -481,7 +820,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$inputMessagesFilterVideo](../constructors/inputMessagesFilterVideo.md) = \[\]; *** -
[$inputNotifyAll](../constructors/inputNotifyAll.md) = \[\]; +
[$inputMessagesFilterVoice](../constructors/inputMessagesFilterVoice.md) = \[\]; + +*** +
[$inputNotifyBroadcasts](../constructors/inputNotifyBroadcasts.md) = \[\]; ***
[$inputNotifyChats](../constructors/inputNotifyChats.md) = \[\]; @@ -492,9 +834,24 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$inputNotifyUsers](../constructors/inputNotifyUsers.md) = \[\]; +*** +
[$inputPaymentCredentials](../constructors/inputPaymentCredentials.md) = \['save' => [Bool](../types/Bool.md), 'data' => [DataJSON](../types/DataJSON.md), \]; + +*** +
[$inputPaymentCredentialsAndroidPay](../constructors/inputPaymentCredentialsAndroidPay.md) = \['payment_token' => [DataJSON](../types/DataJSON.md), 'google_transaction_id' => [string](../types/string.md), \]; + +*** +
[$inputPaymentCredentialsApplePay](../constructors/inputPaymentCredentialsApplePay.md) = \['payment_data' => [DataJSON](../types/DataJSON.md), \]; + +*** +
[$inputPaymentCredentialsSaved](../constructors/inputPaymentCredentialsSaved.md) = \['id' => [string](../types/string.md), 'tmp_password' => [bytes](../types/bytes.md), \]; + ***
[$inputPeerChannel](../constructors/inputPeerChannel.md) = \['channel_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; +*** +
[$inputPeerChannelFromMessage](../constructors/inputPeerChannelFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), \]; + ***
[$inputPeerChat](../constructors/inputPeerChat.md) = \['chat_id' => [int](../types/int.md), \]; @@ -502,13 +859,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$inputPeerEmpty](../constructors/inputPeerEmpty.md) = \[\]; *** -
[$inputPeerNotifyEventsAll](../constructors/inputPeerNotifyEventsAll.md) = \[\]; +
[$inputPeerNotifySettings](../constructors/inputPeerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \]; *** -
[$inputPeerNotifyEventsEmpty](../constructors/inputPeerNotifyEventsEmpty.md) = \[\]; - -*** -
[$inputPeerNotifySettings](../constructors/inputPeerNotifySettings.md) = \['mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), 'show_previews' => [Bool](../types/Bool.md), 'events_mask' => [int](../types/int.md), \]; +
[$inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) = \['big' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), \]; ***
[$inputPeerSelf](../constructors/inputPeerSelf.md) = \[\]; @@ -516,27 +870,57 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$inputPeerUser](../constructors/inputPeerUser.md) = \['user_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; +*** +
[$inputPeerUserFromMessage](../constructors/inputPeerUserFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), \]; + +*** +
[$inputPhoneCall](../constructors/inputPhoneCall.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + ***
[$inputPhoneContact](../constructors/inputPhoneContact.md) = \['client_id' => [long](../types/long.md), 'phone' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]; *** -
[$inputPhoto](../constructors/inputPhoto.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; - -*** -
[$inputPhotoCrop](../constructors/inputPhotoCrop.md) = \['crop_left' => [double](../types/double.md), 'crop_top' => [double](../types/double.md), 'crop_width' => [double](../types/double.md), \]; - -*** -
[$inputPhotoCropAuto](../constructors/inputPhotoCropAuto.md) = \[\]; +
[$inputPhoto](../constructors/inputPhoto.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), \]; ***
[$inputPhotoEmpty](../constructors/inputPhotoEmpty.md) = \[\]; +*** +
[$inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'thumb_size' => [string](../types/string.md), \]; + +*** +
[$inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + +*** +
[$inputPrivacyKeyAddedByPhone](../constructors/inputPrivacyKeyAddedByPhone.md) = \[\]; + +*** +
[$inputPrivacyKeyChatInvite](../constructors/inputPrivacyKeyChatInvite.md) = \[\]; + +*** +
[$inputPrivacyKeyForwards](../constructors/inputPrivacyKeyForwards.md) = \[\]; + +*** +
[$inputPrivacyKeyPhoneCall](../constructors/inputPrivacyKeyPhoneCall.md) = \[\]; + +*** +
[$inputPrivacyKeyPhoneNumber](../constructors/inputPrivacyKeyPhoneNumber.md) = \[\]; + +*** +
[$inputPrivacyKeyPhoneP2P](../constructors/inputPrivacyKeyPhoneP2P.md) = \[\]; + +*** +
[$inputPrivacyKeyProfilePhoto](../constructors/inputPrivacyKeyProfilePhoto.md) = \[\]; + ***
[$inputPrivacyKeyStatusTimestamp](../constructors/inputPrivacyKeyStatusTimestamp.md) = \[\]; ***
[$inputPrivacyValueAllowAll](../constructors/inputPrivacyValueAllowAll.md) = \[\]; +*** +
[$inputPrivacyValueAllowChatParticipants](../constructors/inputPrivacyValueAllowChatParticipants.md) = \['chats' => \[[int](../types/int.md)\], \]; + ***
[$inputPrivacyValueAllowContacts](../constructors/inputPrivacyValueAllowContacts.md) = \[\]; @@ -546,12 +930,24 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$inputPrivacyValueDisallowAll](../constructors/inputPrivacyValueDisallowAll.md) = \[\]; +*** +
[$inputPrivacyValueDisallowChatParticipants](../constructors/inputPrivacyValueDisallowChatParticipants.md) = \['chats' => \[[int](../types/int.md)\], \]; + ***
[$inputPrivacyValueDisallowContacts](../constructors/inputPrivacyValueDisallowContacts.md) = \[\]; ***
[$inputPrivacyValueDisallowUsers](../constructors/inputPrivacyValueDisallowUsers.md) = \['users' => \[[InputUser](../types/InputUser.md)\], \]; +*** +
[$inputReportReasonChildAbuse](../constructors/inputReportReasonChildAbuse.md) = \[\]; + +*** +
[$inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md) = \[\]; + +*** +
[$inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md) = \[\]; + ***
[$inputReportReasonOther](../constructors/inputReportReasonOther.md) = \['text' => [string](../types/string.md), \]; @@ -564,41 +960,173 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$inputReportReasonViolence](../constructors/inputReportReasonViolence.md) = \[\]; +*** +
[$inputSecureFile](../constructors/inputSecureFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$inputSecureFileLocation](../constructors/inputSecureFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$inputSecureFileUploaded](../constructors/inputSecureFileUploaded.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'md5_checksum' => [string](../types/string.md), 'file_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +
[$inputSecureValue](../constructors/inputSecureValue.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data' => [SecureData](../types/SecureData.md), 'front_side' => [InputSecureFile](../types/InputSecureFile.md), 'reverse_side' => [InputSecureFile](../types/InputSecureFile.md), 'selfie' => [InputSecureFile](../types/InputSecureFile.md), 'translation' => \[[InputSecureFile](../types/InputSecureFile.md)\], 'files' => \[[InputSecureFile](../types/InputSecureFile.md)\], 'plain_data' => [SecurePlainData](../types/SecurePlainData.md), \]; + +*** +
[$inputSingleMedia](../constructors/inputSingleMedia.md) = \['media' => [InputMedia](../types/InputMedia.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +
[$inputStickerSetAnimatedEmoji](../constructors/inputStickerSetAnimatedEmoji.md) = \[\]; + +*** +
[$inputStickerSetDice](../constructors/inputStickerSetDice.md) = \['emoticon' => [string](../types/string.md), \]; + ***
[$inputStickerSetEmpty](../constructors/inputStickerSetEmpty.md) = \[\]; ***
[$inputStickerSetID](../constructors/inputStickerSetID.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +*** +
[$inputStickerSetItem](../constructors/inputStickerSetItem.md) = \['document' => [InputDocument](../types/InputDocument.md), 'emoji' => [string](../types/string.md), 'mask_coords' => [MaskCoords](../types/MaskCoords.md), \]; + ***
[$inputStickerSetShortName](../constructors/inputStickerSetShortName.md) = \['short_name' => [string](../types/string.md), \]; +*** +
[$inputStickerSetThumb](../constructors/inputStickerSetThumb.md) = \['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), \]; + +*** +
[$inputStickeredMediaDocument](../constructors/inputStickeredMediaDocument.md) = \['id' => [InputDocument](../types/InputDocument.md), \]; + +*** +
[$inputStickeredMediaPhoto](../constructors/inputStickeredMediaPhoto.md) = \['id' => [InputPhoto](../types/InputPhoto.md), \]; + +*** +
[$inputTakeoutFileLocation](../constructors/inputTakeoutFileLocation.md) = \[\]; + +*** +
[$inputTheme](../constructors/inputTheme.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$inputThemeSettings](../constructors/inputThemeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'wallpaper_settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + +*** +
[$inputThemeSlug](../constructors/inputThemeSlug.md) = \['slug' => [string](../types/string.md), \]; + ***
[$inputUser](../constructors/inputUser.md) = \['user_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; ***
[$inputUserEmpty](../constructors/inputUserEmpty.md) = \[\]; +*** +
[$inputUserFromMessage](../constructors/inputUserFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), \]; + ***
[$inputUserSelf](../constructors/inputUserSelf.md) = \[\]; *** -
[$inputVideo](../constructors/inputVideo.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputWallPaper](../constructors/inputWallPaper.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; *** -
[$inputVideoEmpty](../constructors/inputVideoEmpty.md) = \[\]; +
[$inputWallPaperNoFile](../constructors/inputWallPaperNoFile.md) = \[\]; *** -
[$inputVideoFileLocation](../constructors/inputVideoFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; +
[$inputWallPaperSlug](../constructors/inputWallPaperSlug.md) = \['slug' => [string](../types/string.md), \]; + +*** +
[$inputWebDocument](../constructors/inputWebDocument.md) = \['url' => [string](../types/string.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +
[$inputWebFileGeoPointLocation](../constructors/inputWebFileGeoPointLocation.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'access_hash' => [long](../types/long.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'zoom' => [int](../types/int.md), 'scale' => [int](../types/int.md), \]; + +*** +
[$inputWebFileLocation](../constructors/inputWebFileLocation.md) = \['url' => [string](../types/string.md), 'access_hash' => [long](../types/long.md), \]; + +*** +
[$invoice](../constructors/invoice.md) = \['test' => [Bool](../types/Bool.md), 'name_requested' => [Bool](../types/Bool.md), 'phone_requested' => [Bool](../types/Bool.md), 'email_requested' => [Bool](../types/Bool.md), 'shipping_address_requested' => [Bool](../types/Bool.md), 'flexible' => [Bool](../types/Bool.md), 'phone_to_provider' => [Bool](../types/Bool.md), 'email_to_provider' => [Bool](../types/Bool.md), 'currency' => [string](../types/string.md), 'prices' => \[[LabeledPrice](../types/LabeledPrice.md)\], \]; + +*** +
[$jsonArray](../constructors/jsonArray.md) = \['value' => \[[JSONValue](../types/JSONValue.md)\], \]; + +*** +
[$jsonBool](../constructors/jsonBool.md) = \['value' => [Bool](../types/Bool.md), \]; + +*** +
[$jsonNull](../constructors/jsonNull.md) = \[\]; + +*** +
[$jsonNumber](../constructors/jsonNumber.md) = \['value' => [double](../types/double.md), \]; + +*** +
[$jsonObject](../constructors/jsonObject.md) = \['value' => \[[JSONObjectValue](../types/JSONObjectValue.md)\], \]; + +*** +
[$jsonObjectValue](../constructors/jsonObjectValue.md) = \['key' => [string](../types/string.md), 'value' => [JSONValue](../types/JSONValue.md), \]; + +*** +
[$jsonString](../constructors/jsonString.md) = \['value' => [string](../types/string.md), \]; ***
[$keyboardButton](../constructors/keyboardButton.md) = \['text' => [string](../types/string.md), \]; +*** +
[$keyboardButtonBuy](../constructors/keyboardButtonBuy.md) = \['text' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonCallback](../constructors/keyboardButtonCallback.md) = \['text' => [string](../types/string.md), 'data' => [bytes](../types/bytes.md), \]; + +*** +
[$keyboardButtonGame](../constructors/keyboardButtonGame.md) = \['text' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonRequestGeoLocation](../constructors/keyboardButtonRequestGeoLocation.md) = \['text' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonRequestPhone](../constructors/keyboardButtonRequestPhone.md) = \['text' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) = \['quiz' => [Bool](../types/Bool.md), 'text' => [string](../types/string.md), \]; + ***
[$keyboardButtonRow](../constructors/keyboardButtonRow.md) = \['buttons' => \[[KeyboardButton](../types/KeyboardButton.md)\], \]; *** -
[$message](../constructors/message.md) = \['unread' => [Bool](../types/Bool.md), 'out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'fwd_from_id' => [Peer](../types/Peer.md), 'fwd_date' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'views' => [int](../types/int.md), \]; +
[$keyboardButtonSwitchInline](../constructors/keyboardButtonSwitchInline.md) = \['same_peer' => [Bool](../types/Bool.md), 'text' => [string](../types/string.md), 'query' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonUrl](../constructors/keyboardButtonUrl.md) = \['text' => [string](../types/string.md), 'url' => [string](../types/string.md), \]; + +*** +
[$keyboardButtonUrlAuth](../constructors/keyboardButtonUrlAuth.md) = \['text' => [string](../types/string.md), 'fwd_text' => [string](../types/string.md), 'url' => [string](../types/string.md), 'button_id' => [int](../types/int.md), \]; + +*** +
[$labeledPrice](../constructors/labeledPrice.md) = \['label' => [string](../types/string.md), 'amount' => [long](../types/long.md), \]; + +*** +
[$langPackDifference](../constructors/langPackDifference.md) = \['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), 'version' => [int](../types/int.md), 'strings' => \[[LangPackString](../types/LangPackString.md)\], \]; + +*** +
[$langPackLanguage](../constructors/langPackLanguage.md) = \['official' => [Bool](../types/Bool.md), 'rtl' => [Bool](../types/Bool.md), 'beta' => [Bool](../types/Bool.md), 'name' => [string](../types/string.md), 'native_name' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'base_lang_code' => [string](../types/string.md), 'plural_code' => [string](../types/string.md), 'strings_count' => [int](../types/int.md), 'translated_count' => [int](../types/int.md), 'translations_url' => [string](../types/string.md), \]; + +*** +
[$langPackString](../constructors/langPackString.md) = \['key' => [string](../types/string.md), 'value' => [string](../types/string.md), \]; + +*** +
[$langPackStringDeleted](../constructors/langPackStringDeleted.md) = \['key' => [string](../types/string.md), \]; + +*** +
[$langPackStringPluralized](../constructors/langPackStringPluralized.md) = \['key' => [string](../types/string.md), 'zero_value' => [string](../types/string.md), 'one_value' => [string](../types/string.md), 'two_value' => [string](../types/string.md), 'few_value' => [string](../types/string.md), 'many_value' => [string](../types/string.md), 'other_value' => [string](../types/string.md), \]; + +*** +
[$maskCoords](../constructors/maskCoords.md) = \['n' => [int](../types/int.md), 'x' => [double](../types/double.md), 'y' => [double](../types/double.md), 'zoom' => [double](../types/double.md), \]; + +*** +
[$message](../constructors/message.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'from_scheduled' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'edit_hide' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'views' => [int](../types/int.md), 'edit_date' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'grouped_id' => [long](../types/long.md), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.md)\], \]; + +*** +
[$messageActionBotAllowed](../constructors/messageActionBotAllowed.md) = \['domain' => [string](../types/string.md), \]; ***
[$messageActionChannelCreate](../constructors/messageActionChannelCreate.md) = \['title' => [string](../types/string.md), \]; @@ -630,18 +1158,60 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$messageActionChatMigrateTo](../constructors/messageActionChatMigrateTo.md) = \['channel_id' => [int](../types/int.md), \]; +*** +
[$messageActionContactSignUp](../constructors/messageActionContactSignUp.md) = \[\]; + +*** +
[$messageActionCustomAction](../constructors/messageActionCustomAction.md) = \['message' => [string](../types/string.md), \]; + ***
[$messageActionEmpty](../constructors/messageActionEmpty.md) = \[\]; +*** +
[$messageActionGameScore](../constructors/messageActionGameScore.md) = \['game_id' => [long](../types/long.md), 'score' => [int](../types/int.md), \]; + +*** +
[$messageActionHistoryClear](../constructors/messageActionHistoryClear.md) = \[\]; + +*** +
[$messageActionPaymentSent](../constructors/messageActionPaymentSent.md) = \['currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), \]; + +*** +
[$messageActionPaymentSentMe](../constructors/messageActionPaymentSentMe.md) = \['currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'payload' => [bytes](../types/bytes.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping_option_id' => [string](../types/string.md), 'charge' => [PaymentCharge](../types/PaymentCharge.md), \]; + +*** +
[$messageActionPhoneCall](../constructors/messageActionPhoneCall.md) = \['video' => [Bool](../types/Bool.md), 'call_id' => [long](../types/long.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'duration' => [int](../types/int.md), \]; + +*** +
[$messageActionPinMessage](../constructors/messageActionPinMessage.md) = \[\]; + +*** +
[$messageActionScreenshotTaken](../constructors/messageActionScreenshotTaken.md) = \[\]; + +*** +
[$messageActionSecureValuesSent](../constructors/messageActionSecureValuesSent.md) = \['types' => \[[SecureValueType](../types/SecureValueType.md)\], \]; + +*** +
[$messageActionSecureValuesSentMe](../constructors/messageActionSecureValuesSentMe.md) = \['values' => \[[SecureValue](../types/SecureValue.md)\], 'credentials' => [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md), \]; + ***
[$messageEmpty](../constructors/messageEmpty.md) = \['id' => [int](../types/int.md), \]; +*** +
[$messageEntityBankCard](../constructors/messageEntityBankCard.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + +*** +
[$messageEntityBlockquote](../constructors/messageEntityBlockquote.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + ***
[$messageEntityBold](../constructors/messageEntityBold.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; ***
[$messageEntityBotCommand](../constructors/messageEntityBotCommand.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; +*** +
[$messageEntityCashtag](../constructors/messageEntityCashtag.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + ***
[$messageEntityCode](../constructors/messageEntityCode.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; @@ -657,12 +1227,24 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$messageEntityMention](../constructors/messageEntityMention.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; +*** +
[$messageEntityMentionName](../constructors/messageEntityMentionName.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'user_id' => [int](../types/int.md), \]; + +*** +
[$messageEntityPhone](../constructors/messageEntityPhone.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + ***
[$messageEntityPre](../constructors/messageEntityPre.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'language' => [string](../types/string.md), \]; +*** +
[$messageEntityStrike](../constructors/messageEntityStrike.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + ***
[$messageEntityTextUrl](../constructors/messageEntityTextUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'url' => [string](../types/string.md), \]; +*** +
[$messageEntityUnderline](../constructors/messageEntityUnderline.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; + ***
[$messageEntityUnknown](../constructors/messageEntityUnknown.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; @@ -670,34 +1252,46 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messageEntityUrl](../constructors/messageEntityUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; *** -
[$messageGroup](../constructors/messageGroup.md) = \['min_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'count' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; +
[$messageFwdHeader](../constructors/messageFwdHeader.md) = \['from_id' => [int](../types/int.md), 'from_name' => [string](../types/string.md), 'date' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'channel_post' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'saved_from_peer' => [Peer](../types/Peer.md), 'saved_from_msg_id' => [int](../types/int.md), 'psa_type' => [string](../types/string.md), \]; *** -
[$messageMediaAudio](../constructors/messageMediaAudio.md) = \['audio' => [Audio](../types/Audio.md), \]; +
[$messageInteractionCounters](../constructors/messageInteractionCounters.md) = \['msg_id' => [int](../types/int.md), 'views' => [int](../types/int.md), 'forwards' => [int](../types/int.md), \]; *** -
[$messageMediaContact](../constructors/messageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'user_id' => [int](../types/int.md), \]; +
[$messageMediaContact](../constructors/messageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'vcard' => [string](../types/string.md), 'user_id' => [int](../types/int.md), \]; *** -
[$messageMediaDocument](../constructors/messageMediaDocument.md) = \['document' => [Document](../types/Document.md), \]; +
[$messageMediaDice](../constructors/messageMediaDice.md) = \['value' => [int](../types/int.md), 'emoticon' => [string](../types/string.md), \]; + +*** +
[$messageMediaDocument](../constructors/messageMediaDocument.md) = \['document' => [Document](../types/Document.md), 'ttl_seconds' => [int](../types/int.md), \]; ***
[$messageMediaEmpty](../constructors/messageMediaEmpty.md) = \[\]; +*** +
[$messageMediaGame](../constructors/messageMediaGame.md) = \['game' => [Game](../types/Game.md), \]; + ***
[$messageMediaGeo](../constructors/messageMediaGeo.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), \]; *** -
[$messageMediaPhoto](../constructors/messageMediaPhoto.md) = \['photo' => [Photo](../types/Photo.md), 'caption' => [string](../types/string.md), \]; +
[$messageMediaGeoLive](../constructors/messageMediaGeoLive.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'period' => [int](../types/int.md), \]; + +*** +
[$messageMediaInvoice](../constructors/messageMediaInvoice.md) = \['shipping_address_requested' => [Bool](../types/Bool.md), 'test' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [WebDocument](../types/WebDocument.md), 'receipt_msg_id' => [int](../types/int.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'start_param' => [string](../types/string.md), \]; + +*** +
[$messageMediaPhoto](../constructors/messageMediaPhoto.md) = \['photo' => [Photo](../types/Photo.md), 'ttl_seconds' => [int](../types/int.md), \]; + +*** +
[$messageMediaPoll](../constructors/messageMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'results' => [PollResults](../types/PollResults.md), \]; ***
[$messageMediaUnsupported](../constructors/messageMediaUnsupported.md) = \[\]; *** -
[$messageMediaVenue](../constructors/messageMediaVenue.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), \]; - -*** -
[$messageMediaVideo](../constructors/messageMediaVideo.md) = \['video' => [Video](../types/Video.md), 'caption' => [string](../types/string.md), \]; +
[$messageMediaVenue](../constructors/messageMediaVenue.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), \]; ***
[$messageMediaWebPage](../constructors/messageMediaWebPage.md) = \['webpage' => [WebPage](../types/WebPage.md), \]; @@ -706,7 +1300,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messageRange](../constructors/messageRange.md) = \['min_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), \]; *** -
[$messageService](../constructors/messageService.md) = \['unread' => [Bool](../types/Bool.md), 'out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'date' => [int](../types/int.md), 'action' => [MessageAction](../types/MessageAction.md), \]; +
[$messageService](../constructors/messageService.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'action' => [MessageAction](../types/MessageAction.md), \]; + +*** +
[$messageUserVote](../constructors/messageUserVote.md) = \['user_id' => [int](../types/int.md), 'option' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), \]; + +*** +
[$messageUserVoteInputOption](../constructors/messageUserVoteInputOption.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; + +*** +
[$messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) = \['user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], 'date' => [int](../types/int.md), \]; ***
[$messages.affectedHistory](../constructors/messages.affectedHistory.md) = \['pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'offset' => [int](../types/int.md), \]; @@ -721,7 +1324,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messages.allStickersNotModified](../constructors/messages.allStickersNotModified.md) = \[\]; *** -
[$messages.channelMessages](../constructors/messages.channelMessages.md) = \['pts' => [int](../types/int.md), 'count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'collapsed' => \[[MessageGroup](../types/MessageGroup.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$messages.archivedStickers](../constructors/messages.archivedStickers.md) = \['count' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +*** +
[$messages.botCallbackAnswer](../constructors/messages.botCallbackAnswer.md) = \['alert' => [Bool](../types/Bool.md), 'has_url' => [Bool](../types/Bool.md), 'native_ui' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'url' => [string](../types/string.md), 'cache_time' => [int](../types/int.md), \]; + +*** +
[$messages.botResults](../constructors/messages.botResults.md) = \['gallery' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'next_offset' => [string](../types/string.md), 'switch_pm' => [InlineBotSwitchPM](../types/InlineBotSwitchPM.md), 'results' => \[[BotInlineResult](../types/BotInlineResult.md)\], 'cache_time' => [int](../types/int.md), 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$messages.channelMessages](../constructors/messages.channelMessages.md) = \['inexact' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; ***
[$messages.chatFull](../constructors/messages.chatFull.md) = \['full_chat' => [ChatFull](../types/ChatFull.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; @@ -729,6 +1341,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$messages.chats](../constructors/messages.chats.md) = \['chats' => \[[Chat](../types/Chat.md)\], \]; +*** +
[$messages.chatsSlice](../constructors/messages.chatsSlice.md) = \['count' => [int](../types/int.md), 'chats' => \[[Chat](../types/Chat.md)\], \]; + ***
[$messages.dhConfig](../constructors/messages.dhConfig.md) = \['g' => [int](../types/int.md), 'p' => [bytes](../types/bytes.md), 'version' => [int](../types/int.md), 'random' => [bytes](../types/bytes.md), \]; @@ -738,17 +1353,65 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$messages.dialogs](../constructors/messages.dialogs.md) = \['dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; +*** +
[$messages.dialogsNotModified](../constructors/messages.dialogsNotModified.md) = \['count' => [int](../types/int.md), \]; + ***
[$messages.dialogsSlice](../constructors/messages.dialogsSlice.md) = \['count' => [int](../types/int.md), 'dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$messages.foundGifs](../constructors/messages.foundGifs.md) = \['next_offset' => [int](../types/int.md), 'results' => \[[FoundGif](../types/FoundGif.md)\], \]; +
[$messages.favedStickers](../constructors/messages.favedStickers.md) = \['hash' => [int](../types/int.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'stickers' => \[[Document](../types/Document.md)\], \]; + +*** +
[$messages.favedStickersNotModified](../constructors/messages.favedStickersNotModified.md) = \[\]; + +*** +
[$messages.featuredStickers](../constructors/messages.featuredStickers.md) = \['hash' => [int](../types/int.md), 'count' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], 'unread' => \[[long](../types/long.md)\], \]; + +*** +
[$messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) = \['count' => [int](../types/int.md), \]; + +*** +
[$messages.foundStickerSets](../constructors/messages.foundStickerSets.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +*** +
[$messages.foundStickerSetsNotModified](../constructors/messages.foundStickerSetsNotModified.md) = \[\]; + +*** +
[$messages.highScores](../constructors/messages.highScores.md) = \['scores' => \[[HighScore](../types/HighScore.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$messages.inactiveChats](../constructors/messages.inactiveChats.md) = \['dates' => \[[int](../types/int.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$messages.messageEditData](../constructors/messages.messageEditData.md) = \['caption' => [Bool](../types/Bool.md), \]; ***
[$messages.messages](../constructors/messages.messages.md) = \['messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -
[$messages.messagesSlice](../constructors/messages.messagesSlice.md) = \['count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$messages.messagesNotModified](../constructors/messages.messagesNotModified.md) = \['count' => [int](../types/int.md), \]; + +*** +
[$messages.messagesSlice](../constructors/messages.messagesSlice.md) = \['inexact' => [Bool](../types/Bool.md), 'count' => [int](../types/int.md), 'next_rate' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$messages.peerDialogs](../constructors/messages.peerDialogs.md) = \['dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'state' => [updates.State](../types/updates.State.md), \]; + +*** +
[$messages.recentStickers](../constructors/messages.recentStickers.md) = \['hash' => [int](../types/int.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'stickers' => \[[Document](../types/Document.md)\], 'dates' => \[[int](../types/int.md)\], \]; + +*** +
[$messages.recentStickersNotModified](../constructors/messages.recentStickersNotModified.md) = \[\]; + +*** +
[$messages.savedGifs](../constructors/messages.savedGifs.md) = \['hash' => [int](../types/int.md), 'gifs' => \[[Document](../types/Document.md)\], \]; + +*** +
[$messages.savedGifsNotModified](../constructors/messages.savedGifsNotModified.md) = \[\]; + +*** +
[$messages.searchCounter](../constructors/messages.searchCounter.md) = \['inexact' => [Bool](../types/Bool.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'count' => [int](../types/int.md), \]; ***
[$messages.sentEncryptedFile](../constructors/messages.sentEncryptedFile.md) = \['date' => [int](../types/int.md), 'file' => [EncryptedFile](../types/EncryptedFile.md), \]; @@ -760,16 +1423,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$messages.stickerSet](../constructors/messages.stickerSet.md) = \['set' => [StickerSet](../types/StickerSet.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'documents' => \[[Document](../types/Document.md)\], \]; *** -
[$messages.stickers](../constructors/messages.stickers.md) = \['hash' => [string](../types/string.md), 'stickers' => \[[Document](../types/Document.md)\], \]; +
[$messages.stickerSetInstallResultArchive](../constructors/messages.stickerSetInstallResultArchive.md) = \['sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +*** +
[$messages.stickerSetInstallResultSuccess](../constructors/messages.stickerSetInstallResultSuccess.md) = \[\]; + +*** +
[$messages.stickers](../constructors/messages.stickers.md) = \['hash' => [int](../types/int.md), 'stickers' => \[[Document](../types/Document.md)\], \]; ***
[$messages.stickersNotModified](../constructors/messages.stickersNotModified.md) = \[\]; +*** +
[$messages.votesList](../constructors/messages.votesList.md) = \['count' => [int](../types/int.md), 'votes' => \[[MessageUserVote](../types/MessageUserVote.md)\], 'users' => \[[User](../types/User.md)\], 'next_offset' => [string](../types/string.md), \]; + ***
[$nearestDc](../constructors/nearestDc.md) = \['country' => [string](../types/string.md), 'this_dc' => [int](../types/int.md), 'nearest_dc' => [int](../types/int.md), \]; *** -
[$notifyAll](../constructors/notifyAll.md) = \[\]; +
[$notifyBroadcasts](../constructors/notifyBroadcasts.md) = \[\]; ***
[$notifyChats](../constructors/notifyChats.md) = \[\]; @@ -783,6 +1455,156 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$null](../constructors/null.md) = \[\]; +*** +
[$page](../constructors/page.md) = \['part' => [Bool](../types/Bool.md), 'rtl' => [Bool](../types/Bool.md), 'v2' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'photos' => \[[Photo](../types/Photo.md)\], 'documents' => \[[Document](../types/Document.md)\], 'views' => [int](../types/int.md), \]; + +*** +
[$pageBlockAnchor](../constructors/pageBlockAnchor.md) = \['name' => [string](../types/string.md), \]; + +*** +
[$pageBlockAudio](../constructors/pageBlockAudio.md) = \['audio_id' => [long](../types/long.md), 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockAuthorDate](../constructors/pageBlockAuthorDate.md) = \['author' => [RichText](../types/RichText.md), 'published_date' => [int](../types/int.md), \]; + +*** +
[$pageBlockBlockquote](../constructors/pageBlockBlockquote.md) = \['text' => [RichText](../types/RichText.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockChannel](../constructors/pageBlockChannel.md) = \['channel' => [Chat](../types/Chat.md), \]; + +*** +
[$pageBlockCollage](../constructors/pageBlockCollage.md) = \['items' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockCover](../constructors/pageBlockCover.md) = \['cover' => [PageBlock](../types/PageBlock.md), \]; + +*** +
[$pageBlockDetails](../constructors/pageBlockDetails.md) = \['open' => [Bool](../types/Bool.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'title' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockDivider](../constructors/pageBlockDivider.md) = \[\]; + +*** +
[$pageBlockEmbed](../constructors/pageBlockEmbed.md) = \['full_width' => [Bool](../types/Bool.md), 'allow_scrolling' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'html' => [string](../types/string.md), 'poster_photo_id' => [long](../types/long.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockEmbedPost](../constructors/pageBlockEmbedPost.md) = \['url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), 'author_photo_id' => [long](../types/long.md), 'author' => [string](../types/string.md), 'date' => [int](../types/int.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockFooter](../constructors/pageBlockFooter.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockHeader](../constructors/pageBlockHeader.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockKicker](../constructors/pageBlockKicker.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockList](../constructors/pageBlockList.md) = \['items' => \[[PageListItem](../types/PageListItem.md)\], \]; + +*** +
[$pageBlockMap](../constructors/pageBlockMap.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'zoom' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockOrderedList](../constructors/pageBlockOrderedList.md) = \['items' => \[[PageListOrderedItem](../types/PageListOrderedItem.md)\], \]; + +*** +
[$pageBlockParagraph](../constructors/pageBlockParagraph.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockPhoto](../constructors/pageBlockPhoto.md) = \['photo_id' => [long](../types/long.md), 'caption' => [PageCaption](../types/PageCaption.md), 'url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), \]; + +*** +
[$pageBlockPreformatted](../constructors/pageBlockPreformatted.md) = \['text' => [RichText](../types/RichText.md), 'language' => [string](../types/string.md), \]; + +*** +
[$pageBlockPullquote](../constructors/pageBlockPullquote.md) = \['text' => [RichText](../types/RichText.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockRelatedArticles](../constructors/pageBlockRelatedArticles.md) = \['title' => [RichText](../types/RichText.md), 'articles' => \[[PageRelatedArticle](../types/PageRelatedArticle.md)\], \]; + +*** +
[$pageBlockSlideshow](../constructors/pageBlockSlideshow.md) = \['items' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageBlockSubheader](../constructors/pageBlockSubheader.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockSubtitle](../constructors/pageBlockSubtitle.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockTable](../constructors/pageBlockTable.md) = \['bordered' => [Bool](../types/Bool.md), 'striped' => [Bool](../types/Bool.md), 'title' => [RichText](../types/RichText.md), 'rows' => \[[PageTableRow](../types/PageTableRow.md)\], \]; + +*** +
[$pageBlockTitle](../constructors/pageBlockTitle.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageBlockUnsupported](../constructors/pageBlockUnsupported.md) = \[\]; + +*** +
[$pageBlockVideo](../constructors/pageBlockVideo.md) = \['autoplay' => [Bool](../types/Bool.md), 'loop' => [Bool](../types/Bool.md), 'video_id' => [long](../types/long.md), 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +
[$pageCaption](../constructors/pageCaption.md) = \['text' => [RichText](../types/RichText.md), 'credit' => [RichText](../types/RichText.md), \]; + +*** +
[$pageListItemBlocks](../constructors/pageListItemBlocks.md) = \['blocks' => \[[PageBlock](../types/PageBlock.md)\], \]; + +*** +
[$pageListItemText](../constructors/pageListItemText.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageListOrderedItemBlocks](../constructors/pageListOrderedItemBlocks.md) = \['num' => [string](../types/string.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], \]; + +*** +
[$pageListOrderedItemText](../constructors/pageListOrderedItemText.md) = \['num' => [string](../types/string.md), 'text' => [RichText](../types/RichText.md), \]; + +*** +
[$pageRelatedArticle](../constructors/pageRelatedArticle.md) = \['url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo_id' => [long](../types/long.md), 'author' => [string](../types/string.md), 'published_date' => [int](../types/int.md), \]; + +*** +
[$pageTableCell](../constructors/pageTableCell.md) = \['header' => [Bool](../types/Bool.md), 'align_center' => [Bool](../types/Bool.md), 'align_right' => [Bool](../types/Bool.md), 'valign_middle' => [Bool](../types/Bool.md), 'valign_bottom' => [Bool](../types/Bool.md), 'text' => [RichText](../types/RichText.md), 'colspan' => [int](../types/int.md), 'rowspan' => [int](../types/int.md), \]; + +*** +
[$pageTableRow](../constructors/pageTableRow.md) = \['cells' => \[[PageTableCell](../types/PageTableCell.md)\], \]; + +*** +
[$passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow](../constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md) = \['salt1' => [bytes](../types/bytes.md), 'salt2' => [bytes](../types/bytes.md), 'g' => [int](../types/int.md), 'p' => [bytes](../types/bytes.md), \]; + +*** +
[$passwordKdfAlgoUnknown](../constructors/passwordKdfAlgoUnknown.md) = \[\]; + +*** +
[$paymentCharge](../constructors/paymentCharge.md) = \['id' => [string](../types/string.md), 'provider_charge_id' => [string](../types/string.md), \]; + +*** +
[$paymentRequestedInfo](../constructors/paymentRequestedInfo.md) = \['name' => [string](../types/string.md), 'phone' => [string](../types/string.md), 'email' => [string](../types/string.md), 'shipping_address' => [PostAddress](../types/PostAddress.md), \]; + +*** +
[$paymentSavedCredentialsCard](../constructors/paymentSavedCredentialsCard.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), \]; + +*** +
[$payments.bankCardData](../constructors/payments.bankCardData.md) = \['title' => [string](../types/string.md), 'open_urls' => \[[BankCardOpenUrl](../types/BankCardOpenUrl.md)\], \]; + +*** +
[$payments.paymentForm](../constructors/payments.paymentForm.md) = \['can_save_credentials' => [Bool](../types/Bool.md), 'password_missing' => [Bool](../types/Bool.md), 'bot_id' => [int](../types/int.md), 'invoice' => [Invoice](../types/Invoice.md), 'provider_id' => [int](../types/int.md), 'url' => [string](../types/string.md), 'native_provider' => [string](../types/string.md), 'native_params' => [DataJSON](../types/DataJSON.md), 'saved_info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'saved_credentials' => [PaymentSavedCredentials](../types/PaymentSavedCredentials.md), 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$payments.paymentReceipt](../constructors/payments.paymentReceipt.md) = \['date' => [int](../types/int.md), 'bot_id' => [int](../types/int.md), 'invoice' => [Invoice](../types/Invoice.md), 'provider_id' => [int](../types/int.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping' => [ShippingOption](../types/ShippingOption.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'credentials_title' => [string](../types/string.md), 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$payments.paymentResult](../constructors/payments.paymentResult.md) = \['updates' => [Updates](../types/Updates.md), \]; + +*** +
[$payments.paymentVerificationNeeded](../constructors/payments.paymentVerificationNeeded.md) = \['url' => [string](../types/string.md), \]; + +*** +
[$payments.savedInfo](../constructors/payments.savedInfo.md) = \['has_saved_credentials' => [Bool](../types/Bool.md), 'saved_info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), \]; + +*** +
[$payments.validatedRequestedInfo](../constructors/payments.validatedRequestedInfo.md) = \['id' => [string](../types/string.md), 'shipping_options' => \[[ShippingOption](../types/ShippingOption.md)\], \]; + ***
[$peerChannel](../constructors/peerChannel.md) = \['channel_id' => [int](../types/int.md), \]; @@ -790,22 +1612,64 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$peerChat](../constructors/peerChat.md) = \['chat_id' => [int](../types/int.md), \]; *** -
[$peerNotifyEventsAll](../constructors/peerNotifyEventsAll.md) = \[\]; +
[$peerLocated](../constructors/peerLocated.md) = \['peer' => [Peer](../types/Peer.md), 'expires' => [int](../types/int.md), 'distance' => [int](../types/int.md), \]; *** -
[$peerNotifyEventsEmpty](../constructors/peerNotifyEventsEmpty.md) = \[\]; +
[$peerNotifySettings](../constructors/peerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \]; *** -
[$peerNotifySettings](../constructors/peerNotifySettings.md) = \['mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), 'show_previews' => [Bool](../types/Bool.md), 'events_mask' => [int](../types/int.md), \]; +
[$peerSelfLocated](../constructors/peerSelfLocated.md) = \['expires' => [int](../types/int.md), \]; *** -
[$peerNotifySettingsEmpty](../constructors/peerNotifySettingsEmpty.md) = \[\]; +
[$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), \]; ***
[$peerUser](../constructors/peerUser.md) = \['user_id' => [int](../types/int.md), \]; *** -
[$photo](../constructors/photo.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], \]; +
[$phone.phoneCall](../constructors/phone.phoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), 'users' => \[[User](../types/User.md)\], \]; + +*** +
[$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), \]; + +*** +
[$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), \]; + +*** +
[$phoneCallDiscardReasonBusy](../constructors/phoneCallDiscardReasonBusy.md) = \[\]; + +*** +
[$phoneCallDiscardReasonDisconnect](../constructors/phoneCallDiscardReasonDisconnect.md) = \[\]; + +*** +
[$phoneCallDiscardReasonHangup](../constructors/phoneCallDiscardReasonHangup.md) = \[\]; + +*** +
[$phoneCallDiscardReasonMissed](../constructors/phoneCallDiscardReasonMissed.md) = \[\]; + +*** +
[$phoneCallDiscarded](../constructors/phoneCallDiscarded.md) = \['need_rating' => [Bool](../types/Bool.md), 'need_debug' => [Bool](../types/Bool.md), 'video' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'duration' => [int](../types/int.md), \]; + +*** +
[$phoneCallEmpty](../constructors/phoneCallEmpty.md) = \['id' => [long](../types/long.md), \]; + +*** +
[$phoneCallProtocol](../constructors/phoneCallProtocol.md) = \['udp_p2p' => [Bool](../types/Bool.md), 'udp_reflector' => [Bool](../types/Bool.md), 'min_layer' => [int](../types/int.md), 'max_layer' => [int](../types/int.md), 'library_versions' => \[[string](../types/string.md)\], \]; + +*** +
[$phoneCallRequested](../constructors/phoneCallRequested.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_hash' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]; + +*** +
[$phoneCallWaiting](../constructors/phoneCallWaiting.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), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), 'receive_date' => [int](../types/int.md), \]; + +*** +
[$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), \]; + +*** +
[$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), \]; + +*** +
[$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), \]; ***
[$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), \]; @@ -819,6 +1683,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$photoSizeEmpty](../constructors/photoSizeEmpty.md) = \['type' => [string](../types/string.md), \]; +*** +
[$photoStrippedSize](../constructors/photoStrippedSize.md) = \['type' => [string](../types/string.md), 'bytes' => [bytes](../types/bytes.md), \]; + ***
[$photos.photo](../constructors/photos.photo.md) = \['photo' => [Photo](../types/Photo.md), 'users' => \[[User](../types/User.md)\], \]; @@ -828,12 +1695,54 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$photos.photosSlice](../constructors/photos.photosSlice.md) = \['count' => [int](../types/int.md), 'photos' => \[[Photo](../types/Photo.md)\], 'users' => \[[User](../types/User.md)\], \]; +*** +
[$poll](../constructors/poll.md) = \['id' => [long](../types/long.md), 'closed' => [Bool](../types/Bool.md), 'public_voters' => [Bool](../types/Bool.md), 'multiple_choice' => [Bool](../types/Bool.md), 'quiz' => [Bool](../types/Bool.md), 'question' => [string](../types/string.md), 'answers' => \[[PollAnswer](../types/PollAnswer.md)\], 'close_period' => [int](../types/int.md), 'close_date' => [int](../types/int.md), \]; + +*** +
[$pollAnswer](../constructors/pollAnswer.md) = \['text' => [string](../types/string.md), 'option' => [bytes](../types/bytes.md), \]; + +*** +
[$pollAnswerVoters](../constructors/pollAnswerVoters.md) = \['chosen' => [Bool](../types/Bool.md), 'correct' => [Bool](../types/Bool.md), 'option' => [bytes](../types/bytes.md), 'voters' => [int](../types/int.md), \]; + +*** +
[$pollResults](../constructors/pollResults.md) = \['min' => [Bool](../types/Bool.md), 'results' => \[[PollAnswerVoters](../types/PollAnswerVoters.md)\], 'total_voters' => [int](../types/int.md), 'recent_voters' => \[[int](../types/int.md)\], 'solution' => [string](../types/string.md), 'solution_entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +
[$popularContact](../constructors/popularContact.md) = \['client_id' => [long](../types/long.md), 'importers' => [int](../types/int.md), \]; + +*** +
[$postAddress](../constructors/postAddress.md) = \['street_line1' => [string](../types/string.md), 'street_line2' => [string](../types/string.md), 'city' => [string](../types/string.md), 'state' => [string](../types/string.md), 'country_iso2' => [string](../types/string.md), 'post_code' => [string](../types/string.md), \]; + +*** +
[$privacyKeyAddedByPhone](../constructors/privacyKeyAddedByPhone.md) = \[\]; + +*** +
[$privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) = \[\]; + +*** +
[$privacyKeyForwards](../constructors/privacyKeyForwards.md) = \[\]; + +*** +
[$privacyKeyPhoneCall](../constructors/privacyKeyPhoneCall.md) = \[\]; + +*** +
[$privacyKeyPhoneNumber](../constructors/privacyKeyPhoneNumber.md) = \[\]; + +*** +
[$privacyKeyPhoneP2P](../constructors/privacyKeyPhoneP2P.md) = \[\]; + +*** +
[$privacyKeyProfilePhoto](../constructors/privacyKeyProfilePhoto.md) = \[\]; + ***
[$privacyKeyStatusTimestamp](../constructors/privacyKeyStatusTimestamp.md) = \[\]; ***
[$privacyValueAllowAll](../constructors/privacyValueAllowAll.md) = \[\]; +*** +
[$privacyValueAllowChatParticipants](../constructors/privacyValueAllowChatParticipants.md) = \['chats' => \[[int](../types/int.md)\], \]; + ***
[$privacyValueAllowContacts](../constructors/privacyValueAllowContacts.md) = \[\]; @@ -843,6 +1752,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$privacyValueDisallowAll](../constructors/privacyValueDisallowAll.md) = \[\]; +*** +
[$privacyValueDisallowChatParticipants](../constructors/privacyValueDisallowChatParticipants.md) = \['chats' => \[[int](../types/int.md)\], \]; + ***
[$privacyValueDisallowContacts](../constructors/privacyValueDisallowContacts.md) = \[\]; @@ -852,6 +1764,24 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$receivedNotifyMessage](../constructors/receivedNotifyMessage.md) = \['id' => [int](../types/int.md), \]; +*** +
[$recentMeUrlChat](../constructors/recentMeUrlChat.md) = \['url' => [string](../types/string.md), 'chat_id' => [int](../types/int.md), \]; + +*** +
[$recentMeUrlChatInvite](../constructors/recentMeUrlChatInvite.md) = \['url' => [string](../types/string.md), 'chat_invite' => [ChatInvite](../types/ChatInvite.md), \]; + +*** +
[$recentMeUrlStickerSet](../constructors/recentMeUrlStickerSet.md) = \['url' => [string](../types/string.md), 'set' => [StickerSetCovered](../types/StickerSetCovered.md), \]; + +*** +
[$recentMeUrlUnknown](../constructors/recentMeUrlUnknown.md) = \['url' => [string](../types/string.md), \]; + +*** +
[$recentMeUrlUser](../constructors/recentMeUrlUser.md) = \['url' => [string](../types/string.md), 'user_id' => [int](../types/int.md), \]; + +*** +
[$replyInlineMarkup](../constructors/replyInlineMarkup.md) = \['rows' => \[[KeyboardButtonRow](../types/KeyboardButtonRow.md)\], \]; + ***
[$replyKeyboardForceReply](../constructors/replyKeyboardForceReply.md) = \['single_use' => [Bool](../types/Bool.md), 'selective' => [Bool](../types/Bool.md), \]; @@ -861,18 +1791,138 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$replyKeyboardMarkup](../constructors/replyKeyboardMarkup.md) = \['resize' => [Bool](../types/Bool.md), 'single_use' => [Bool](../types/Bool.md), 'selective' => [Bool](../types/Bool.md), 'rows' => \[[KeyboardButtonRow](../types/KeyboardButtonRow.md)\], \]; +*** +
[$restrictionReason](../constructors/restrictionReason.md) = \['platform' => [string](../types/string.md), 'reason' => [string](../types/string.md), 'text' => [string](../types/string.md), \]; + +*** +
[$savedPhoneContact](../constructors/savedPhoneContact.md) = \['phone' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'date' => [int](../types/int.md), \]; + +*** +
[$secureCredentialsEncrypted](../constructors/secureCredentialsEncrypted.md) = \['data' => [bytes](../types/bytes.md), 'hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +
[$secureData](../constructors/secureData.md) = \['data' => [bytes](../types/bytes.md), 'data_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +
[$secureFile](../constructors/secureFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'size' => [int](../types/int.md), 'dc_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'file_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +
[$secureFileEmpty](../constructors/secureFileEmpty.md) = \[\]; + +*** +
[$securePasswordKdfAlgoPBKDF2HMACSHA512iter100000](../constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md) = \['salt' => [bytes](../types/bytes.md), \]; + +*** +
[$securePasswordKdfAlgoSHA512](../constructors/securePasswordKdfAlgoSHA512.md) = \['salt' => [bytes](../types/bytes.md), \]; + +*** +
[$securePasswordKdfAlgoUnknown](../constructors/securePasswordKdfAlgoUnknown.md) = \[\]; + +*** +
[$securePlainEmail](../constructors/securePlainEmail.md) = \['email' => [string](../types/string.md), \]; + +*** +
[$securePlainPhone](../constructors/securePlainPhone.md) = \['phone' => [string](../types/string.md), \]; + +*** +
[$secureRequiredType](../constructors/secureRequiredType.md) = \['native_names' => [Bool](../types/Bool.md), 'selfie_required' => [Bool](../types/Bool.md), 'translation_required' => [Bool](../types/Bool.md), 'type' => [SecureValueType](../types/SecureValueType.md), \]; + +*** +
[$secureRequiredTypeOneOf](../constructors/secureRequiredTypeOneOf.md) = \['types' => \[[SecureRequiredType](../types/SecureRequiredType.md)\], \]; + +*** +
[$secureSecretSettings](../constructors/secureSecretSettings.md) = \['secure_algo' => [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md), 'secure_secret' => [bytes](../types/bytes.md), 'secure_secret_id' => [long](../types/long.md), \]; + +*** +
[$secureValue](../constructors/secureValue.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data' => [SecureData](../types/SecureData.md), 'front_side' => [SecureFile](../types/SecureFile.md), 'reverse_side' => [SecureFile](../types/SecureFile.md), 'selfie' => [SecureFile](../types/SecureFile.md), 'translation' => \[[SecureFile](../types/SecureFile.md)\], 'files' => \[[SecureFile](../types/SecureFile.md)\], 'plain_data' => [SecurePlainData](../types/SecurePlainData.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +
[$secureValueError](../constructors/secureValueError.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorData](../constructors/secureValueErrorData.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data_hash' => [bytes](../types/bytes.md), 'field' => [string](../types/string.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorFile](../constructors/secureValueErrorFile.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorFiles](../constructors/secureValueErrorFiles.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => \[[bytes](../types/bytes.md)\], 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorFrontSide](../constructors/secureValueErrorFrontSide.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorReverseSide](../constructors/secureValueErrorReverseSide.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorSelfie](../constructors/secureValueErrorSelfie.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorTranslationFile](../constructors/secureValueErrorTranslationFile.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueErrorTranslationFiles](../constructors/secureValueErrorTranslationFiles.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'file_hash' => \[[bytes](../types/bytes.md)\], 'text' => [string](../types/string.md), \]; + +*** +
[$secureValueHash](../constructors/secureValueHash.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +
[$secureValueTypeAddress](../constructors/secureValueTypeAddress.md) = \[\]; + +*** +
[$secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md) = \[\]; + +*** +
[$secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md) = \[\]; + +*** +
[$secureValueTypeEmail](../constructors/secureValueTypeEmail.md) = \[\]; + +*** +
[$secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md) = \[\]; + +*** +
[$secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md) = \[\]; + +*** +
[$secureValueTypePassport](../constructors/secureValueTypePassport.md) = \[\]; + +*** +
[$secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md) = \[\]; + +*** +
[$secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md) = \[\]; + +*** +
[$secureValueTypePhone](../constructors/secureValueTypePhone.md) = \[\]; + +*** +
[$secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md) = \[\]; + +*** +
[$secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md) = \[\]; + +*** +
[$secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md) = \[\]; + ***
[$sendMessageCancelAction](../constructors/sendMessageCancelAction.md) = \[\]; ***
[$sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) = \[\]; +*** +
[$sendMessageGamePlayAction](../constructors/sendMessageGamePlayAction.md) = \[\]; + ***
[$sendMessageGeoLocationAction](../constructors/sendMessageGeoLocationAction.md) = \[\]; ***
[$sendMessageRecordAudioAction](../constructors/sendMessageRecordAudioAction.md) = \[\]; +*** +
[$sendMessageRecordRoundAction](../constructors/sendMessageRecordRoundAction.md) = \[\]; + ***
[$sendMessageRecordVideoAction](../constructors/sendMessageRecordVideoAction.md) = \[\]; @@ -888,14 +1938,62 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$sendMessageUploadPhotoAction](../constructors/sendMessageUploadPhotoAction.md) = \['progress' => [int](../types/int.md), \]; +*** +
[$sendMessageUploadRoundAction](../constructors/sendMessageUploadRoundAction.md) = \['progress' => [int](../types/int.md), \]; + ***
[$sendMessageUploadVideoAction](../constructors/sendMessageUploadVideoAction.md) = \['progress' => [int](../types/int.md), \]; +*** +
[$shippingOption](../constructors/shippingOption.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'prices' => \[[LabeledPrice](../types/LabeledPrice.md)\], \]; + +*** +
[$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)\], \]; + +*** +
[$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)\], \]; + +*** +
[$statsAbsValueAndPrev](../constructors/statsAbsValueAndPrev.md) = \['current' => [double](../types/double.md), 'previous' => [double](../types/double.md), \]; + +*** +
[$statsDateRangeDays](../constructors/statsDateRangeDays.md) = \['min_date' => [int](../types/int.md), 'max_date' => [int](../types/int.md), \]; + +*** +
[$statsGraph](../constructors/statsGraph.md) = \['json' => [DataJSON](../types/DataJSON.md), 'zoom_token' => [string](../types/string.md), \]; + +*** +
[$statsGraphAsync](../constructors/statsGraphAsync.md) = \['token' => [string](../types/string.md), \]; + +*** +
[$statsGraphError](../constructors/statsGraphError.md) = \['error' => [string](../types/string.md), \]; + +*** +
[$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), \]; + +*** +
[$statsGroupTopInviter](../constructors/statsGroupTopInviter.md) = \['user_id' => [int](../types/int.md), 'invitations' => [int](../types/int.md), \]; + +*** +
[$statsGroupTopPoster](../constructors/statsGroupTopPoster.md) = \['user_id' => [int](../types/int.md), 'messages' => [int](../types/int.md), 'avg_chars' => [int](../types/int.md), \]; + +*** +
[$statsPercentValue](../constructors/statsPercentValue.md) = \['part' => [double](../types/double.md), 'total' => [double](../types/double.md), \]; + +*** +
[$statsURL](../constructors/statsURL.md) = \['url' => [string](../types/string.md), \]; + ***
[$stickerPack](../constructors/stickerPack.md) = \['emoticon' => [string](../types/string.md), 'documents' => \[[long](../types/long.md)\], \]; *** -
[$stickerSet](../constructors/stickerSet.md) = \['installed' => [Bool](../types/Bool.md), 'disabled' => [Bool](../types/Bool.md), 'official' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'count' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]; +
[$stickerSet](../constructors/stickerSet.md) = \['archived' => [Bool](../types/Bool.md), 'official' => [Bool](../types/Bool.md), 'masks' => [Bool](../types/Bool.md), 'animated' => [Bool](../types/Bool.md), 'installed_date' => [int](../types/int.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'thumb_dc_id' => [int](../types/int.md), 'count' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]; + +*** +
[$stickerSetCovered](../constructors/stickerSetCovered.md) = \['set' => [StickerSet](../types/StickerSet.md), 'cover' => [Document](../types/Document.md), \]; + +*** +
[$stickerSetMultiCovered](../constructors/stickerSetMultiCovered.md) = \['set' => [StickerSet](../types/StickerSet.md), 'covers' => \[[Document](../types/Document.md)\], \]; ***
[$storage.fileGif](../constructors/storage.fileGif.md) = \[\]; @@ -927,23 +2025,140 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$storage.fileWebp](../constructors/storage.fileWebp.md) = \[\]; +*** +
[$textAnchor](../constructors/textAnchor.md) = \['text' => [RichText](../types/RichText.md), 'name' => [string](../types/string.md), \]; + +*** +
[$textBold](../constructors/textBold.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textConcat](../constructors/textConcat.md) = \['texts' => \[[RichText](../types/RichText.md)\], \]; + +*** +
[$textEmail](../constructors/textEmail.md) = \['text' => [RichText](../types/RichText.md), 'email' => [string](../types/string.md), \]; + +*** +
[$textEmpty](../constructors/textEmpty.md) = \[\]; + +*** +
[$textFixed](../constructors/textFixed.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textImage](../constructors/textImage.md) = \['document_id' => [long](../types/long.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; + +*** +
[$textItalic](../constructors/textItalic.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textMarked](../constructors/textMarked.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textPhone](../constructors/textPhone.md) = \['text' => [RichText](../types/RichText.md), 'phone' => [string](../types/string.md), \]; + +*** +
[$textPlain](../constructors/textPlain.md) = \['text' => [string](../types/string.md), \]; + +*** +
[$textStrike](../constructors/textStrike.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textSubscript](../constructors/textSubscript.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textSuperscript](../constructors/textSuperscript.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textUnderline](../constructors/textUnderline.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +
[$textUrl](../constructors/textUrl.md) = \['text' => [RichText](../types/RichText.md), 'url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), \]; + +*** +
[$theme](../constructors/theme.md) = \['creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [ThemeSettings](../types/ThemeSettings.md), 'installs_count' => [int](../types/int.md), \]; + +*** +
[$themeSettings](../constructors/themeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [WallPaper](../types/WallPaper.md), \]; + +*** +
[$topPeer](../constructors/topPeer.md) = \['peer' => [Peer](../types/Peer.md), 'rating' => [double](../types/double.md), \]; + +*** +
[$topPeerCategoryBotsInline](../constructors/topPeerCategoryBotsInline.md) = \[\]; + +*** +
[$topPeerCategoryBotsPM](../constructors/topPeerCategoryBotsPM.md) = \[\]; + +*** +
[$topPeerCategoryChannels](../constructors/topPeerCategoryChannels.md) = \[\]; + +*** +
[$topPeerCategoryCorrespondents](../constructors/topPeerCategoryCorrespondents.md) = \[\]; + +*** +
[$topPeerCategoryForwardChats](../constructors/topPeerCategoryForwardChats.md) = \[\]; + +*** +
[$topPeerCategoryForwardUsers](../constructors/topPeerCategoryForwardUsers.md) = \[\]; + +*** +
[$topPeerCategoryGroups](../constructors/topPeerCategoryGroups.md) = \[\]; + +*** +
[$topPeerCategoryPeers](../constructors/topPeerCategoryPeers.md) = \['category' => [TopPeerCategory](../types/TopPeerCategory.md), 'count' => [int](../types/int.md), 'peers' => \[[TopPeer](../types/TopPeer.md)\], \]; + +*** +
[$topPeerCategoryPhoneCalls](../constructors/topPeerCategoryPhoneCalls.md) = \[\]; + ***
[$true](../constructors/true.md) = \[\]; +*** +
[$updateBotCallbackQuery](../constructors/updateBotCallbackQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'msg_id' => [int](../types/int.md), 'chat_instance' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), 'game_short_name' => [string](../types/string.md), \]; + +*** +
[$updateBotInlineQuery](../constructors/updateBotInlineQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'query' => [string](../types/string.md), 'geo' => [GeoPoint](../types/GeoPoint.md), 'offset' => [string](../types/string.md), \]; + +*** +
[$updateBotInlineSend](../constructors/updateBotInlineSend.md) = \['user_id' => [int](../types/int.md), 'query' => [string](../types/string.md), 'geo' => [GeoPoint](../types/GeoPoint.md), 'id' => [string](../types/string.md), 'msg_id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), \]; + +*** +
[$updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'payload' => [bytes](../types/bytes.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping_option_id' => [string](../types/string.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), \]; + +*** +
[$updateBotShippingQuery](../constructors/updateBotShippingQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'payload' => [bytes](../types/bytes.md), 'shipping_address' => [PostAddress](../types/PostAddress.md), \]; + +*** +
[$updateBotWebhookJSON](../constructors/updateBotWebhookJSON.md) = \['data' => [DataJSON](../types/DataJSON.md), \]; + +*** +
[$updateBotWebhookJSONQuery](../constructors/updateBotWebhookJSONQuery.md) = \['query_id' => [long](../types/long.md), 'data' => [DataJSON](../types/DataJSON.md), 'timeout' => [int](../types/int.md), \]; + ***
[$updateChannel](../constructors/updateChannel.md) = \['channel_id' => [int](../types/int.md), \]; *** -
[$updateChannelGroup](../constructors/updateChannelGroup.md) = \['channel_id' => [int](../types/int.md), 'group' => [MessageGroup](../types/MessageGroup.md), \]; +
[$updateChannelAvailableMessages](../constructors/updateChannelAvailableMessages.md) = \['channel_id' => [int](../types/int.md), 'available_min_id' => [int](../types/int.md), \]; ***
[$updateChannelMessageViews](../constructors/updateChannelMessageViews.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'views' => [int](../types/int.md), \]; *** -
[$updateChannelTooLong](../constructors/updateChannelTooLong.md) = \['channel_id' => [int](../types/int.md), \]; +
[$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), \]; *** -
[$updateChatAdmins](../constructors/updateChatAdmins.md) = \['chat_id' => [int](../types/int.md), 'enabled' => [Bool](../types/Bool.md), 'version' => [int](../types/int.md), \]; +
[$updateChannelPinnedMessage](../constructors/updateChannelPinnedMessage.md) = \['channel_id' => [int](../types/int.md), 'id' => [int](../types/int.md), \]; + +*** +
[$updateChannelReadMessagesContents](../constructors/updateChannelReadMessagesContents.md) = \['channel_id' => [int](../types/int.md), 'messages' => \[[int](../types/int.md)\], \]; + +*** +
[$updateChannelTooLong](../constructors/updateChannelTooLong.md) = \['channel_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), \]; + +*** +
[$updateChannelWebPage](../constructors/updateChannelWebPage.md) = \['channel_id' => [int](../types/int.md), 'webpage' => [WebPage](../types/WebPage.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +
[$updateChatDefaultBannedRights](../constructors/updateChatDefaultBannedRights.md) = \['peer' => [Peer](../types/Peer.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'version' => [int](../types/int.md), \]; ***
[$updateChatParticipantAdd](../constructors/updateChatParticipantAdd.md) = \['chat_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), \]; @@ -957,14 +2172,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updateChatParticipants](../constructors/updateChatParticipants.md) = \['participants' => [ChatParticipants](../types/ChatParticipants.md), \]; +*** +
[$updateChatPinnedMessage](../constructors/updateChatPinnedMessage.md) = \['chat_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'version' => [int](../types/int.md), \]; + ***
[$updateChatUserTyping](../constructors/updateChatUserTyping.md) = \['chat_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]; *** -
[$updateContactLink](../constructors/updateContactLink.md) = \['user_id' => [int](../types/int.md), 'my_link' => [ContactLink](../types/ContactLink.md), 'foreign_link' => [ContactLink](../types/ContactLink.md), \]; +
[$updateConfig](../constructors/updateConfig.md) = \[\]; *** -
[$updateContactRegistered](../constructors/updateContactRegistered.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; +
[$updateContactsReset](../constructors/updateContactsReset.md) = \[\]; ***
[$updateDcOptions](../constructors/updateDcOptions.md) = \['dc_options' => \[[DcOption](../types/DcOption.md)\], \]; @@ -975,6 +2193,33 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updateDeleteMessages](../constructors/updateDeleteMessages.md) = \['messages' => \[[int](../types/int.md)\], 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; +*** +
[$updateDeleteScheduledMessages](../constructors/updateDeleteScheduledMessages.md) = \['peer' => [Peer](../types/Peer.md), 'messages' => \[[int](../types/int.md)\], \]; + +*** +
[$updateDialogFilter](../constructors/updateDialogFilter.md) = \['id' => [int](../types/int.md), 'filter' => [DialogFilter](../types/DialogFilter.md), \]; + +*** +
[$updateDialogFilterOrder](../constructors/updateDialogFilterOrder.md) = \['order' => \[[int](../types/int.md)\], \]; + +*** +
[$updateDialogFilters](../constructors/updateDialogFilters.md) = \[\]; + +*** +
[$updateDialogPinned](../constructors/updateDialogPinned.md) = \['pinned' => [Bool](../types/Bool.md), 'folder_id' => [int](../types/int.md), 'peer' => [DialogPeer](../types/DialogPeer.md), \]; + +*** +
[$updateDialogUnreadMark](../constructors/updateDialogUnreadMark.md) = \['unread' => [Bool](../types/Bool.md), 'peer' => [DialogPeer](../types/DialogPeer.md), \]; + +*** +
[$updateDraftMessage](../constructors/updateDraftMessage.md) = \['peer' => [Peer](../types/Peer.md), 'draft' => [DraftMessage](../types/DraftMessage.md), \]; + +*** +
[$updateEditChannelMessage](../constructors/updateEditChannelMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +
[$updateEditMessage](../constructors/updateEditMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + ***
[$updateEncryptedChatTyping](../constructors/updateEncryptedChatTyping.md) = \['chat_id' => [int](../types/int.md), \]; @@ -984,11 +2229,35 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updateEncryption](../constructors/updateEncryption.md) = \['chat' => [EncryptedChat](../types/EncryptedChat.md), 'date' => [int](../types/int.md), \]; +*** +
[$updateFavedStickers](../constructors/updateFavedStickers.md) = \[\]; + +*** +
[$updateFolderPeers](../constructors/updateFolderPeers.md) = \['folder_peers' => \[[FolderPeer](../types/FolderPeer.md)\], 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +
[$updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) = \['peer' => [Peer](../types/Peer.md), 'msg_id' => [int](../types/int.md), \]; + +*** +
[$updateInlineBotCallbackQuery](../constructors/updateInlineBotCallbackQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'msg_id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'chat_instance' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), 'game_short_name' => [string](../types/string.md), \]; + +*** +
[$updateLangPack](../constructors/updateLangPack.md) = \['difference' => [LangPackDifference](../types/LangPackDifference.md), \]; + +*** +
[$updateLangPackTooLong](../constructors/updateLangPackTooLong.md) = \['lang_code' => [string](../types/string.md), \]; + +*** +
[$updateLoginToken](../constructors/updateLoginToken.md) = \[\]; + ***
[$updateMessageID](../constructors/updateMessageID.md) = \['id' => [int](../types/int.md), \]; *** -
[$updateNewAuthorization](../constructors/updateNewAuthorization.md) = \['auth_key_id' => [long](../types/long.md), 'date' => [int](../types/int.md), 'device' => [string](../types/string.md), 'location' => [string](../types/string.md), \]; +
[$updateMessagePoll](../constructors/updateMessagePoll.md) = \['poll_id' => [long](../types/long.md), 'poll' => [Poll](../types/Poll.md), 'results' => [PollResults](../types/PollResults.md), \]; + +*** +
[$updateMessagePollVote](../constructors/updateMessagePollVote.md) = \['poll_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], \]; ***
[$updateNewChannelMessage](../constructors/updateNewChannelMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; @@ -999,20 +2268,47 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updateNewMessage](../constructors/updateNewMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; +*** +
[$updateNewScheduledMessage](../constructors/updateNewScheduledMessage.md) = \['message' => [Message](../types/Message.md), \]; + ***
[$updateNewStickerSet](../constructors/updateNewStickerSet.md) = \['stickerset' => [messages.StickerSet](../types/messages.StickerSet.md), \]; ***
[$updateNotifySettings](../constructors/updateNotifySettings.md) = \['peer' => [NotifyPeer](../types/NotifyPeer.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), \]; +*** +
[$updatePeerLocated](../constructors/updatePeerLocated.md) = \['peers' => \[[PeerLocated](../types/PeerLocated.md)\], \]; + +*** +
[$updatePeerSettings](../constructors/updatePeerSettings.md) = \['peer' => [Peer](../types/Peer.md), 'settings' => [PeerSettings](../types/PeerSettings.md), \]; + +*** +
[$updatePhoneCall](../constructors/updatePhoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), \]; + +*** +
[$updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md) = \['phone_call_id' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), \]; + +*** +
[$updatePinnedDialogs](../constructors/updatePinnedDialogs.md) = \['folder_id' => [int](../types/int.md), 'order' => \[[DialogPeer](../types/DialogPeer.md)\], \]; + ***
[$updatePrivacy](../constructors/updatePrivacy.md) = \['key' => [PrivacyKey](../types/PrivacyKey.md), 'rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], \]; *** -
[$updateReadChannelInbox](../constructors/updateReadChannelInbox.md) = \['channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), \]; +
[$updatePtsChanged](../constructors/updatePtsChanged.md) = \[\]; *** -
[$updateReadHistoryInbox](../constructors/updateReadHistoryInbox.md) = \['peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; +
[$updateReadChannelInbox](../constructors/updateReadChannelInbox.md) = \['folder_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'still_unread_count' => [int](../types/int.md), 'pts' => [int](../types/int.md), \]; + +*** +
[$updateReadChannelOutbox](../constructors/updateReadChannelOutbox.md) = \['channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), \]; + +*** +
[$updateReadFeaturedStickers](../constructors/updateReadFeaturedStickers.md) = \[\]; + +*** +
[$updateReadHistoryInbox](../constructors/updateReadHistoryInbox.md) = \['folder_id' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'still_unread_count' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; ***
[$updateReadHistoryOutbox](../constructors/updateReadHistoryOutbox.md) = \['peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; @@ -1021,25 +2317,34 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$updateReadMessagesContents](../constructors/updateReadMessagesContents.md) = \['messages' => \[[int](../types/int.md)\], 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; *** -
[$updateServiceNotification](../constructors/updateServiceNotification.md) = \['type' => [string](../types/string.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'popup' => [Bool](../types/Bool.md), \]; +
[$updateRecentStickers](../constructors/updateRecentStickers.md) = \[\]; + +*** +
[$updateSavedGifs](../constructors/updateSavedGifs.md) = \[\]; + +*** +
[$updateServiceNotification](../constructors/updateServiceNotification.md) = \['popup' => [Bool](../types/Bool.md), 'inbox_date' => [int](../types/int.md), 'type' => [string](../types/string.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; ***
[$updateShort](../constructors/updateShort.md) = \['update' => [Update](../types/Update.md), 'date' => [int](../types/int.md), \]; *** -
[$updateShortChatMessage](../constructors/updateShortChatMessage.md) = \['unread' => [Bool](../types/Bool.md), 'out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'chat_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from_id' => [Peer](../types/Peer.md), 'fwd_date' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; +
[$updateShortChatMessage](../constructors/updateShortChatMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'chat_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; *** -
[$updateShortMessage](../constructors/updateShortMessage.md) = \['unread' => [Bool](../types/Bool.md), 'out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from_id' => [Peer](../types/Peer.md), 'fwd_date' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; +
[$updateShortMessage](../constructors/updateShortMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; *** -
[$updateShortSentMessage](../constructors/updateShortSentMessage.md) = \['unread' => [Bool](../types/Bool.md), 'out' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; +
[$updateShortSentMessage](../constructors/updateShortSentMessage.md) = \['out' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; ***
[$updateStickerSets](../constructors/updateStickerSets.md) = \[\]; *** -
[$updateStickerSetsOrder](../constructors/updateStickerSetsOrder.md) = \['order' => \[[long](../types/long.md)\], \]; +
[$updateStickerSetsOrder](../constructors/updateStickerSetsOrder.md) = \['masks' => [Bool](../types/Bool.md), 'order' => \[[long](../types/long.md)\], \]; + +*** +
[$updateTheme](../constructors/updateTheme.md) = \['theme' => [Theme](../types/Theme.md), \]; ***
[$updateUserBlocked](../constructors/updateUserBlocked.md) = \['user_id' => [int](../types/int.md), 'blocked' => [Bool](../types/Bool.md), \]; @@ -1053,6 +2358,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updateUserPhoto](../constructors/updateUserPhoto.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'photo' => [UserProfilePhoto](../types/UserProfilePhoto.md), 'previous' => [Bool](../types/Bool.md), \]; +*** +
[$updateUserPinnedMessage](../constructors/updateUserPinnedMessage.md) = \['user_id' => [int](../types/int.md), 'id' => [int](../types/int.md), \]; + ***
[$updateUserStatus](../constructors/updateUserStatus.md) = \['user_id' => [int](../types/int.md), 'status' => [UserStatus](../types/UserStatus.md), \]; @@ -1072,7 +2380,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$updates.channelDifferenceEmpty](../constructors/updates.channelDifferenceEmpty.md) = \['final' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'timeout' => [int](../types/int.md), \]; *** -
[$updates.channelDifferenceTooLong](../constructors/updates.channelDifferenceTooLong.md) = \['final' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'timeout' => [int](../types/int.md), 'top_message' => [int](../types/int.md), 'top_important_message' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'unread_important_count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; +
[$updates.channelDifferenceTooLong](../constructors/updates.channelDifferenceTooLong.md) = \['final' => [Bool](../types/Bool.md), 'timeout' => [int](../types/int.md), 'dialog' => [Dialog](../types/Dialog.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; ***
[$updates.difference](../constructors/updates.difference.md) = \['new_messages' => \[[Message](../types/Message.md)\], 'new_encrypted_messages' => \[[EncryptedMessage](../types/EncryptedMessage.md)\], 'other_updates' => \[[Update](../types/Update.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'state' => [updates.State](../types/updates.State.md), \]; @@ -1083,6 +2391,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updates.differenceSlice](../constructors/updates.differenceSlice.md) = \['new_messages' => \[[Message](../types/Message.md)\], 'new_encrypted_messages' => \[[EncryptedMessage](../types/EncryptedMessage.md)\], 'other_updates' => \[[Update](../types/Update.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'intermediate_state' => [updates.State](../types/updates.State.md), \]; +*** +
[$updates.differenceTooLong](../constructors/updates.differenceTooLong.md) = \['pts' => [int](../types/int.md), \]; + ***
[$updates.state](../constructors/updates.state.md) = \['pts' => [int](../types/int.md), 'qts' => [int](../types/int.md), 'date' => [int](../types/int.md), 'seq' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), \]; @@ -1092,20 +2403,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***
[$updatesTooLong](../constructors/updatesTooLong.md) = \[\]; +*** +
[$upload.cdnFile](../constructors/upload.cdnFile.md) = \['bytes' => [bytes](../types/bytes.md), \]; + +*** +
[$upload.cdnFileReuploadNeeded](../constructors/upload.cdnFileReuploadNeeded.md) = \['request_token' => [bytes](../types/bytes.md), \]; + ***
[$upload.file](../constructors/upload.file.md) = \['type' => [storage.FileType](../types/storage.FileType.md), 'mtime' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; *** -
[$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), '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), 'restiction_reason' => [string](../types/string.md), \]; +
[$upload.fileCdnRedirect](../constructors/upload.fileCdnRedirect.md) = \['dc_id' => [int](../types/int.md), 'file_token' => [bytes](../types/bytes.md), 'encryption_key' => [bytes](../types/bytes.md), 'encryption_iv' => [bytes](../types/bytes.md), 'file_hashes' => \[[FileHash](../types/FileHash.md)\], \]; + +*** +
[$upload.webFile](../constructors/upload.webFile.md) = \['size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'file_type' => [storage.FileType](../types/storage.FileType.md), 'mtime' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; + +*** +
[$urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) = \['url' => [string](../types/string.md), \]; + +*** +
[$urlAuthResultDefault](../constructors/urlAuthResultDefault.md) = \[\]; + +*** +
[$urlAuthResultRequest](../constructors/urlAuthResultRequest.md) = \['request_write_access' => [Bool](../types/Bool.md), 'bot' => [User](../types/User.md), 'domain' => [string](../types/string.md), \]; + +*** +
[$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), \]; ***
[$userEmpty](../constructors/userEmpty.md) = \['id' => [int](../types/int.md), \]; *** -
[$userFull](../constructors/userFull.md) = \['user' => [User](../types/User.md), 'link' => [contacts.Link](../types/contacts.Link.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'blocked' => [Bool](../types/Bool.md), 'bot_info' => [BotInfo](../types/BotInfo.md), \]; +
[$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), \]; *** -
[$userProfilePhoto](../constructors/userProfilePhoto.md) = \['photo_id' => [long](../types/long.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), \]; +
[$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), \]; ***
[$userProfilePhotoEmpty](../constructors/userProfilePhotoEmpty.md) = \[\]; @@ -1129,29 +2461,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
[$userStatusRecently](../constructors/userStatusRecently.md) = \[\]; *** -
[$vector](../constructors/vector.md) = \[\]; +
[$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), \]; *** -
[$video](../constructors/video.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'dc_id' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; +
[$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), \]; *** -
[$videoEmpty](../constructors/videoEmpty.md) = \['id' => [long](../types/long.md), \]; +
[$wallPaperNoFile](../constructors/wallPaperNoFile.md) = \['default' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; *** -
[$wallPaper](../constructors/wallPaper.md) = \['id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], 'color' => [int](../types/int.md), \]; +
[$wallPaperSettings](../constructors/wallPaperSettings.md) = \['blur' => [Bool](../types/Bool.md), 'motion' => [Bool](../types/Bool.md), 'background_color' => [int](../types/int.md), 'second_background_color' => [int](../types/int.md), 'intensity' => [int](../types/int.md), 'rotation' => [int](../types/int.md), \]; *** -
[$wallPaperSolid](../constructors/wallPaperSolid.md) = \['id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'bg_color' => [int](../types/int.md), 'color' => [int](../types/int.md), \]; +
[$webAuthorization](../constructors/webAuthorization.md) = \['hash' => [long](../types/long.md), 'bot_id' => [int](../types/int.md), 'domain' => [string](../types/string.md), 'browser' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'date_created' => [int](../types/int.md), 'date_active' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; *** -
[$webPage](../constructors/webPage.md) = \['id' => [long](../types/long.md), 'url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'type' => [string](../types/string.md), 'site_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'embed_url' => [string](../types/string.md), 'embed_type' => [string](../types/string.md), 'embed_width' => [int](../types/int.md), 'embed_height' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'author' => [string](../types/string.md), 'document' => [Document](../types/Document.md), \]; +
[$webDocument](../constructors/webDocument.md) = \['url' => [string](../types/string.md), 'access_hash' => [long](../types/long.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +
[$webDocumentNoProxy](../constructors/webDocumentNoProxy.md) = \['url' => [string](../types/string.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +
[$webPage](../constructors/webPage.md) = \['id' => [long](../types/long.md), 'url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'hash' => [int](../types/int.md), 'type' => [string](../types/string.md), 'site_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'embed_url' => [string](../types/string.md), 'embed_type' => [string](../types/string.md), 'embed_width' => [int](../types/int.md), 'embed_height' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'author' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'cached_page' => [Page](../types/Page.md), 'attributes' => \[[WebPageAttribute](../types/WebPageAttribute.md)\], \]; + +*** +
[$webPageAttributeTheme](../constructors/webPageAttributeTheme.md) = \['documents' => \[[Document](../types/Document.md)\], 'settings' => [ThemeSettings](../types/ThemeSettings.md), \]; ***
[$webPageEmpty](../constructors/webPageEmpty.md) = \['id' => [long](../types/long.md), \]; *** -
[$webPageExternal](../constructors/webPageExternal.md) = \['url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'content_url' => [string](../types/string.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'duration' => [int](../types/int.md), \]; +
[$webPageNotModified](../constructors/webPageNotModified.md) = \['cached_page_views' => [int](../types/int.md), \]; ***
[$webPagePending](../constructors/webPagePending.md) = \['id' => [long](../types/long.md), 'date' => [int](../types/int.md), \]; + diff --git a/old_docs/API_docs_v44/constructors/account.authorizationForm.md b/old_docs/API_docs_v44/constructors/account.authorizationForm.md new file mode 100644 index 00000000..cfb58187 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.authorizationForm.md @@ -0,0 +1,43 @@ +--- +title: account.authorizationForm +description: [Telegram Passport](https://core.telegram.org/passport) authorization form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_authorizationForm.html +--- +# Constructor: account.authorizationForm +[Back to constructors index](index.md) + + + +[Telegram Passport](https://core.telegram.org/passport) authorization form + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required [Telegram Passport](https://core.telegram.org/passport) documents| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Already submitted [Telegram Passport](https://core.telegram.org/passport) documents| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|[Telegram Passport](https://core.telegram.org/passport) errors| +|users|Array of [User](../types/User.md) | Yes|Info about the bot to which the form will be submitted| +|privacy\_policy\_url|[string](../types/string.md) | Optional|URL of the service's privacy policy| + + + +### Type: [account.AuthorizationForm](../types/account.AuthorizationForm.md) + + +### Example: + +```php +$account.authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +account.authorizationForm={_='account.authorizationForm', required_types={SecureRequiredType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.authorizations.md b/old_docs/API_docs_v44/constructors/account.authorizations.md index 409f413b..724bfed4 100644 --- a/old_docs/API_docs_v44/constructors/account.authorizations.md +++ b/old_docs/API_docs_v44/constructors/account.authorizations.md @@ -15,7 +15,7 @@ Logged-in sessions | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Authorizations| +|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Logged-in sessions| diff --git a/old_docs/API_docs_v44/constructors/account.autoDownloadSettings.md b/old_docs/API_docs_v44/constructors/account.autoDownloadSettings.md new file mode 100644 index 00000000..8ee5eae2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.autoDownloadSettings.md @@ -0,0 +1,41 @@ +--- +title: account.autoDownloadSettings +description: Media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_autoDownloadSettings.html +--- +# Constructor: account.autoDownloadSettings +[Back to constructors index](index.md) + + + +Media autodownload settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low data usage preset| +|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium data usage preset| +|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High data usage preset| + + + +### Type: [account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + + +### Example: + +```php +$account.autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings]; +``` + + +Or, if you're into Lua: + +```lua +account.autoDownloadSettings={_='account.autoDownloadSettings', low=AutoDownloadSettings, medium=AutoDownloadSettings, high=AutoDownloadSettings} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.contentSettings.md b/old_docs/API_docs_v44/constructors/account.contentSettings.md new file mode 100644 index 00000000..c97941b1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.contentSettings.md @@ -0,0 +1,40 @@ +--- +title: account.contentSettings +description: Sensitive content settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_contentSettings.html +--- +# Constructor: account.contentSettings +[Back to constructors index](index.md) + + + +Sensitive content settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Optional|Whether viewing of sensitive (NSFW) content is enabled| +|sensitive\_can\_change|[Bool](../types/Bool.md) | Optional|Whether the current client can change the sensitive content settings to view NSFW content| + + + +### Type: [account.ContentSettings](../types/account.ContentSettings.md) + + +### Example: + +```php +$account.contentSettings = ['_' => 'account.contentSettings', 'sensitive_enabled' => Bool, 'sensitive_can_change' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +account.contentSettings={_='account.contentSettings', sensitive_enabled=Bool, sensitive_can_change=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.noPassword.md b/old_docs/API_docs_v44/constructors/account.noPassword.md deleted file mode 100644 index 515edbd9..00000000 --- a/old_docs/API_docs_v44/constructors/account.noPassword.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: account.noPassword -description: No password -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/account_noPassword.html ---- -# Constructor: account.noPassword -[Back to constructors index](index.md) - - - -No password - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|new\_salt|[bytes](../types/bytes.md) | Yes|New salt| -|email\_unconfirmed\_pattern|[string](../types/string.md) | Yes|Email unconfirmed pattern| - - - -### Type: [account.Password](../types/account.Password.md) - - -### Example: - -```php -$account.noPassword = ['_' => 'account.noPassword', 'new_salt' => 'bytes', 'email_unconfirmed_pattern' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -account.noPassword={_='account.noPassword', new_salt='bytes', email_unconfirmed_pattern='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/account.password.md b/old_docs/API_docs_v44/constructors/account.password.md index f00e2a76..aac3a9cb 100644 --- a/old_docs/API_docs_v44/constructors/account.password.md +++ b/old_docs/API_docs_v44/constructors/account.password.md @@ -15,11 +15,17 @@ Configuration for two-factor authorization | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|current\_salt|[bytes](../types/bytes.md) | Yes|Current salt| -|new\_salt|[bytes](../types/bytes.md) | Yes|New salt| -|hint|[string](../types/string.md) | Yes|Text hint for the password| -|has\_recovery|[Bool](../types/Bool.md) | Yes|Has recovery?| -|email\_unconfirmed\_pattern|[string](../types/string.md) | Yes|A [password recovery email](https://core.telegram.org/api/srp#email-verification) with the specified [pattern](https://core.telegram.org/api/pattern) is still awaiting verification| +|has\_recovery|[Bool](../types/Bool.md) | Optional|Whether the user has a recovery method configured| +|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Whether telegram [passport](https://core.telegram.org/passport) is enabled| +|has\_password|[Bool](../types/Bool.md) | Optional|Whether the user has a password| +|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) of the current password| +|srp\_B|[bytes](../types/bytes.md) | Optional|Srp B param for [SRP authorization](https://core.telegram.org/api/srp)| +|srp\_id|[long](../types/long.md) | Optional|Srp ID param for [SRP authorization](https://core.telegram.org/api/srp)| +|hint|[string](../types/string.md) | Optional|Text hint for the password| +|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|A [password recovery email](https://core.telegram.org/api/srp#email-verification) with the specified [pattern](https://core.telegram.org/api/pattern) is still awaiting verification| +|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) to use when creating new passwords| +|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|The KDF algorithm for telegram [passport](https://core.telegram.org/passport)| +|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random string| @@ -29,14 +35,14 @@ Configuration for two-factor authorization ### Example: ```php -$account.password = ['_' => 'account.password', 'current_salt' => 'bytes', 'new_salt' => 'bytes', 'hint' => 'string', 'has_recovery' => Bool, 'email_unconfirmed_pattern' => 'string']; +$account.password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'has_password' => Bool, 'current_algo' => PasswordKdfAlgo, 'srp_B' => 'bytes', 'srp_id' => long, 'hint' => 'string', 'email_unconfirmed_pattern' => 'string', 'new_algo' => PasswordKdfAlgo, 'new_secure_algo' => SecurePasswordKdfAlgo, 'secure_random' => 'bytes']; ``` Or, if you're into Lua: ```lua -account.password={_='account.password', current_salt='bytes', new_salt='bytes', hint='string', has_recovery=Bool, email_unconfirmed_pattern='string'} +account.password={_='account.password', has_recovery=Bool, has_secure_values=Bool, has_password=Bool, current_algo=PasswordKdfAlgo, srp_B='bytes', srp_id=long, hint='string', email_unconfirmed_pattern='string', new_algo=PasswordKdfAlgo, new_secure_algo=SecurePasswordKdfAlgo, secure_random='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/account.passwordInputSettings.md b/old_docs/API_docs_v44/constructors/account.passwordInputSettings.md index 81fea431..5ee5bb14 100644 --- a/old_docs/API_docs_v44/constructors/account.passwordInputSettings.md +++ b/old_docs/API_docs_v44/constructors/account.passwordInputSettings.md @@ -15,10 +15,11 @@ Settings for setting up a new password | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|new\_salt|[bytes](../types/bytes.md) | Optional|`$new_salt = $MadelineProto->account->getPassword()['new_salt'].$MadelineProto->random(8);`| +|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [SRP algorithm](https://core.telegram.org/api/srp) to use| |new\_password\_hash|[bytes](../types/bytes.md) | Optional|The [computed password hash](https://core.telegram.org/api/srp)| |hint|[string](../types/string.md) | Optional|Text hint for the password| |email|[string](../types/string.md) | Optional|Password recovery email| +|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings| @@ -28,14 +29,14 @@ Settings for setting up a new password ### Example: ```php -$account.passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_salt' => 'bytes', 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string']; +$account.passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings]; ``` Or, if you're into Lua: ```lua -account.passwordInputSettings={_='account.passwordInputSettings', new_salt='bytes', new_password_hash='bytes', hint='string', email='string'} +account.passwordInputSettings={_='account.passwordInputSettings', new_algo=PasswordKdfAlgo, new_password_hash='bytes', hint='string', email='string', new_secure_settings=SecureSecretSettings} ``` diff --git a/old_docs/API_docs_v44/constructors/account.passwordSettings.md b/old_docs/API_docs_v44/constructors/account.passwordSettings.md index 14931a62..5d44d472 100644 --- a/old_docs/API_docs_v44/constructors/account.passwordSettings.md +++ b/old_docs/API_docs_v44/constructors/account.passwordSettings.md @@ -1,6 +1,6 @@ --- title: account.passwordSettings -description: Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) +description: Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/constructors/account_passwordSettings.html --- @@ -9,13 +9,14 @@ redirect_from: /API_docs/constructors/account_passwordSettings.html -Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) +Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|email|[string](../types/string.md) | Yes|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)| +|email|[string](../types/string.md) | Optional|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)| +|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings| @@ -25,14 +26,14 @@ Private info associated to the password info (recovery email, telegram [passport ### Example: ```php -$account.passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string']; +$account.passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings]; ``` Or, if you're into Lua: ```lua -account.passwordSettings={_='account.passwordSettings', email='string'} +account.passwordSettings={_='account.passwordSettings', email='string', secure_settings=SecureSecretSettings} ``` diff --git a/old_docs/API_docs_v44/constructors/account.privacyRules.md b/old_docs/API_docs_v44/constructors/account.privacyRules.md index 2a2522cb..6f5da58a 100644 --- a/old_docs/API_docs_v44/constructors/account.privacyRules.md +++ b/old_docs/API_docs_v44/constructors/account.privacyRules.md @@ -15,8 +15,9 @@ Privacy rules | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules| -|users|Array of [User](../types/User.md) | Yes|Users| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Privacy rules| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats to which the rules apply| +|users|Array of [User](../types/User.md) | Yes|Users to which the rules apply| @@ -26,14 +27,14 @@ Privacy rules ### Example: ```php -$account.privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'users' => [User, User]]; +$account.privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -account.privacyRules={_='account.privacyRules', rules={PrivacyRule}, users={User}} +account.privacyRules={_='account.privacyRules', rules={PrivacyRule}, chats={Chat}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/account.sentChangePhoneCode.md b/old_docs/API_docs_v44/constructors/account.sentChangePhoneCode.md deleted file mode 100644 index 14abaa40..00000000 --- a/old_docs/API_docs_v44/constructors/account.sentChangePhoneCode.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: account.sentChangePhoneCode -description: Sent change phone code -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/account_sentChangePhoneCode.html ---- -# Constructor: account.sentChangePhoneCode -[Back to constructors index](index.md) - - - -Sent change phone code - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| -|send\_call\_timeout|[int](../types/int.md) | Yes|Send call timeout| - - - -### Type: [account.SentChangePhoneCode](../types/account.SentChangePhoneCode.md) - - -### Example: - -```php -$account.sentChangePhoneCode = ['_' => 'account.sentChangePhoneCode', 'phone_code_hash' => 'string', 'send_call_timeout' => int]; -``` - - -Or, if you're into Lua: - -```lua -account.sentChangePhoneCode={_='account.sentChangePhoneCode', phone_code_hash='string', send_call_timeout=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/account.sentEmailCode.md b/old_docs/API_docs_v44/constructors/account.sentEmailCode.md new file mode 100644 index 00000000..f8224f8f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.sentEmailCode.md @@ -0,0 +1,40 @@ +--- +title: account.sentEmailCode +description: The sent email code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_sentEmailCode.html +--- +# Constructor: account.sentEmailCode +[Back to constructors index](index.md) + + + +The sent email code + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email\_pattern|[string](../types/string.md) | Yes|The email (to which the code was sent) must match this [pattern](https://core.telegram.org/api/pattern)| +|length|[int](../types/int.md) | Yes|The length of the verification code| + + + +### Type: [account.SentEmailCode](../types/account.SentEmailCode.md) + + +### Example: + +```php +$account.sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +account.sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.takeout.md b/old_docs/API_docs_v44/constructors/account.takeout.md new file mode 100644 index 00000000..5607b9f1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.takeout.md @@ -0,0 +1,39 @@ +--- +title: account.takeout +description: Takout info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_takeout.html +--- +# Constructor: account.takeout +[Back to constructors index](index.md) + + + +Takout info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Takeout ID| + + + +### Type: [account.Takeout](../types/account.Takeout.md) + + +### Example: + +```php +$account.takeout = ['_' => 'account.takeout', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +account.takeout={_='account.takeout', id=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.themes.md b/old_docs/API_docs_v44/constructors/account.themes.md new file mode 100644 index 00000000..66b5e241 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.themes.md @@ -0,0 +1,40 @@ +--- +title: account.themes +description: Installed themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_themes.html +--- +# Constructor: account.themes +[Back to constructors index](index.md) + + + +Installed themes + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|themes|Array of [Theme](../types/Theme.md) | Yes|Themes| + + + +### Type: [account.Themes](../types/account.Themes.md) + + +### Example: + +```php +$account.themes = ['_' => 'account.themes', 'hash' => int, 'themes' => [Theme, Theme]]; +``` + + +Or, if you're into Lua: + +```lua +account.themes={_='account.themes', hash=int, themes={Theme}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.themesNotModified.md b/old_docs/API_docs_v44/constructors/account.themesNotModified.md new file mode 100644 index 00000000..68e94240 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.themesNotModified.md @@ -0,0 +1,34 @@ +--- +title: account.themesNotModified +description: No new themes were installed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_themesNotModified.html +--- +# Constructor: account.themesNotModified +[Back to constructors index](index.md) + + + +No new themes were installed + + + + +### Type: [account.Themes](../types/account.Themes.md) + + +### Example: + +```php +$account.themesNotModified = ['_' => 'account.themesNotModified']; +``` + + +Or, if you're into Lua: + +```lua +account.themesNotModified={_='account.themesNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.tmpPassword.md b/old_docs/API_docs_v44/constructors/account.tmpPassword.md new file mode 100644 index 00000000..3c1e5177 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.tmpPassword.md @@ -0,0 +1,40 @@ +--- +title: account.tmpPassword +description: Temporary payment password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_tmpPassword.html +--- +# Constructor: account.tmpPassword +[Back to constructors index](index.md) + + + +Temporary payment password + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password| +|valid\_until|[int](../types/int.md) | Yes|Validity period| + + + +### Type: [account.TmpPassword](../types/account.TmpPassword.md) + + +### Example: + +```php +$account.tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int]; +``` + + +Or, if you're into Lua: + +```lua +account.tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.wallPapers.md b/old_docs/API_docs_v44/constructors/account.wallPapers.md new file mode 100644 index 00000000..36638466 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.wallPapers.md @@ -0,0 +1,40 @@ +--- +title: account.wallPapers +description: Installed wallpapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_wallPapers.html +--- +# Constructor: account.wallPapers +[Back to constructors index](index.md) + + + +Installed wallpapers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers| + + + +### Type: [account.WallPapers](../types/account.WallPapers.md) + + +### Example: + +```php +$account.wallPapers = ['_' => 'account.wallPapers', 'hash' => int, 'wallpapers' => [WallPaper, WallPaper]]; +``` + + +Or, if you're into Lua: + +```lua +account.wallPapers={_='account.wallPapers', hash=int, wallpapers={WallPaper}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.wallPapersNotModified.md b/old_docs/API_docs_v44/constructors/account.wallPapersNotModified.md new file mode 100644 index 00000000..ea17552d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.wallPapersNotModified.md @@ -0,0 +1,34 @@ +--- +title: account.wallPapersNotModified +description: No new wallpapers were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_wallPapersNotModified.html +--- +# Constructor: account.wallPapersNotModified +[Back to constructors index](index.md) + + + +No new wallpapers were found + + + + +### Type: [account.WallPapers](../types/account.WallPapers.md) + + +### Example: + +```php +$account.wallPapersNotModified = ['_' => 'account.wallPapersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +account.wallPapersNotModified={_='account.wallPapersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/account.webAuthorizations.md b/old_docs/API_docs_v44/constructors/account.webAuthorizations.md new file mode 100644 index 00000000..93fce3ab --- /dev/null +++ b/old_docs/API_docs_v44/constructors/account.webAuthorizations.md @@ -0,0 +1,40 @@ +--- +title: account.webAuthorizations +description: Web authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_webAuthorizations.html +--- +# Constructor: account.webAuthorizations +[Back to constructors index](index.md) + + + +Web authorizations + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Web authorization list| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [account.WebAuthorizations](../types/account.WebAuthorizations.md) + + +### Example: + +```php +$account.webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +account.webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/audio.md b/old_docs/API_docs_v44/constructors/audio.md deleted file mode 100644 index e59287bd..00000000 --- a/old_docs/API_docs_v44/constructors/audio.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: audio -description: Audio -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: audio -[Back to constructors index](index.md) - - - -Audio - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| -|access\_hash|[long](../types/long.md) | Yes|Access hash| -|date|[int](../types/int.md) | Yes|Date| -|duration|[int](../types/int.md) | Yes|Duration| -|mime\_type|[string](../types/string.md) | Yes|Mime type| -|size|[int](../types/int.md) | Yes|Size| -|dc\_id|[int](../types/int.md) | Yes|DC ID| - - - -### Type: [Audio](../types/Audio.md) - - -### Example: - -```php -$audio = ['_' => 'audio', 'id' => long, 'access_hash' => long, 'date' => int, 'duration' => int, 'mime_type' => 'string', 'size' => int, 'dc_id' => int]; -``` - - -Or, if you're into Lua: - -```lua -audio={_='audio', id=long, access_hash=long, date=int, duration=int, mime_type='string', size=int, dc_id=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/auth.authorization.md b/old_docs/API_docs_v44/constructors/auth.authorization.md index 260cf409..e08628fb 100644 --- a/old_docs/API_docs_v44/constructors/auth.authorization.md +++ b/old_docs/API_docs_v44/constructors/auth.authorization.md @@ -15,6 +15,7 @@ Contains user authorization info. | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions| |user|[User](../types/User.md) | Optional|Info on authorized user| @@ -25,14 +26,14 @@ Contains user authorization info. ### Example: ```php -$auth.authorization = ['_' => 'auth.authorization', 'user' => User]; +$auth.authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User]; ``` Or, if you're into Lua: ```lua -auth.authorization={_='auth.authorization', user=User} +auth.authorization={_='auth.authorization', tmp_sessions=int, user=User} ``` diff --git a/old_docs/API_docs_v44/constructors/auth.authorizationSignUpRequired.md b/old_docs/API_docs_v44/constructors/auth.authorizationSignUpRequired.md new file mode 100644 index 00000000..8a91fccb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.authorizationSignUpRequired.md @@ -0,0 +1,39 @@ +--- +title: auth.authorizationSignUpRequired +description: An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_authorizationSignUpRequired.html +--- +# Constructor: auth.authorizationSignUpRequired +[Back to constructors index](index.md) + + + +An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Optional|Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram| + + + +### Type: [auth.Authorization](../types/auth.Authorization.md) + + +### Example: + +```php +$auth.authorizationSignUpRequired = ['_' => 'auth.authorizationSignUpRequired', 'terms_of_service' => help.TermsOfService]; +``` + + +Or, if you're into Lua: + +```lua +auth.authorizationSignUpRequired={_='auth.authorizationSignUpRequired', terms_of_service=help.TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.checkedPhone.md b/old_docs/API_docs_v44/constructors/auth.checkedPhone.md deleted file mode 100644 index 26eb3ea7..00000000 --- a/old_docs/API_docs_v44/constructors/auth.checkedPhone.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: auth.checkedPhone -description: Checked phone -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/auth_checkedPhone.html ---- -# Constructor: auth.checkedPhone -[Back to constructors index](index.md) - - - -Checked phone - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_registered|[Bool](../types/Bool.md) | Yes|Phone registered?| - - - -### Type: [auth.CheckedPhone](../types/auth.CheckedPhone.md) - - -### Example: - -```php -$auth.checkedPhone = ['_' => 'auth.checkedPhone', 'phone_registered' => Bool]; -``` - - -Or, if you're into Lua: - -```lua -auth.checkedPhone={_='auth.checkedPhone', phone_registered=Bool} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/auth.codeTypeCall.md b/old_docs/API_docs_v44/constructors/auth.codeTypeCall.md new file mode 100644 index 00000000..9296b8f4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.codeTypeCall.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeCall +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeCall.html +--- +# Constructor: auth.codeTypeCall +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeCall = ['_' => 'auth.codeTypeCall']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeCall={_='auth.codeTypeCall'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.codeTypeFlashCall.md b/old_docs/API_docs_v44/constructors/auth.codeTypeFlashCall.md new file mode 100644 index 00000000..6e27ca34 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.codeTypeFlashCall.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeFlashCall +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeFlashCall.html +--- +# Constructor: auth.codeTypeFlashCall +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeFlashCall={_='auth.codeTypeFlashCall'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.codeTypeSms.md b/old_docs/API_docs_v44/constructors/auth.codeTypeSms.md new file mode 100644 index 00000000..084bcbd2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.codeTypeSms.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeSms +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeSms.html +--- +# Constructor: auth.codeTypeSms +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeSms = ['_' => 'auth.codeTypeSms']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeSms={_='auth.codeTypeSms'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.exportedAuthorization.md b/old_docs/API_docs_v44/constructors/auth.exportedAuthorization.md index 842ed2e9..2b2826ac 100644 --- a/old_docs/API_docs_v44/constructors/auth.exportedAuthorization.md +++ b/old_docs/API_docs_v44/constructors/auth.exportedAuthorization.md @@ -15,8 +15,8 @@ Data for copying of authorization between data centres. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[int](../types/int.md) | Yes|Current user identifier| -|bytes|[bytes](../types/bytes.md) | Yes|Authorizes key| +|id|[int](../types/int.md) | Yes|current user identifier| +|bytes|[bytes](../types/bytes.md) | Yes|authorizes key| diff --git a/old_docs/API_docs_v44/constructors/auth.loginToken.md b/old_docs/API_docs_v44/constructors/auth.loginToken.md new file mode 100644 index 00000000..109f9abf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.loginToken.md @@ -0,0 +1,40 @@ +--- +title: auth.loginToken +description: Login token (for [QR code login](https://core.telegram.org/api/qr-login)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginToken.html +--- +# Constructor: auth.loginToken +[Back to constructors index](index.md) + + + +Login token (for [QR code login](https://core.telegram.org/api/qr-login)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Expiry date of QR code| +|token|[bytes](../types/bytes.md) | Yes|Token to render in QR code| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginToken = ['_' => 'auth.loginToken', 'expires' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginToken={_='auth.loginToken', expires=int, token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.loginTokenMigrateTo.md b/old_docs/API_docs_v44/constructors/auth.loginTokenMigrateTo.md new file mode 100644 index 00000000..985c02cb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.loginTokenMigrateTo.md @@ -0,0 +1,40 @@ +--- +title: auth.loginTokenMigrateTo +description: Repeat the query to the specified DC +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenMigrateTo.html +--- +# Constructor: auth.loginTokenMigrateTo +[Back to constructors index](index.md) + + + +Repeat the query to the specified DC + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|DC ID| +|token|[bytes](../types/bytes.md) | Yes|Token to use for login| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenMigrateTo = ['_' => 'auth.loginTokenMigrateTo', 'dc_id' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenMigrateTo={_='auth.loginTokenMigrateTo', dc_id=int, token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.loginTokenSuccess.md b/old_docs/API_docs_v44/constructors/auth.loginTokenSuccess.md new file mode 100644 index 00000000..ffc53b53 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.loginTokenSuccess.md @@ -0,0 +1,39 @@ +--- +title: auth.loginTokenSuccess +description: Login via token (QR code) succeded! +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenSuccess.html +--- +# Constructor: auth.loginTokenSuccess +[Back to constructors index](index.md) + + + +Login via token (QR code) succeded! + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|authorization|[auth.Authorization](../constructors/auth.Authorization.md) | Yes|Authorization info| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenSuccess = ['_' => 'auth.loginTokenSuccess', 'authorization' => auth.Authorization]; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenSuccess={_='auth.loginTokenSuccess', authorization=auth.Authorization} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.sentAppCode.md b/old_docs/API_docs_v44/constructors/auth.sentAppCode.md deleted file mode 100644 index 32dfb9ca..00000000 --- a/old_docs/API_docs_v44/constructors/auth.sentAppCode.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: auth.sentAppCode -description: Sent app code -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/auth_sentAppCode.html ---- -# Constructor: auth.sentAppCode -[Back to constructors index](index.md) - - - -Sent app code - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_registered|[Bool](../types/Bool.md) | Yes|Phone registered?| -|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| -|send\_call\_timeout|[int](../types/int.md) | Yes|Send call timeout| -|is\_password|[Bool](../types/Bool.md) | Yes|Is password?| - - - -### Type: [auth.SentCode](../types/auth.SentCode.md) - - -### Example: - -```php -$auth.sentAppCode = ['_' => 'auth.sentAppCode', 'phone_registered' => Bool, 'phone_code_hash' => 'string', 'send_call_timeout' => int, 'is_password' => Bool]; -``` - - -Or, if you're into Lua: - -```lua -auth.sentAppCode={_='auth.sentAppCode', phone_registered=Bool, phone_code_hash='string', send_call_timeout=int, is_password=Bool} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/auth.sentCode.md b/old_docs/API_docs_v44/constructors/auth.sentCode.md index 0338dc5b..6ee30f4d 100644 --- a/old_docs/API_docs_v44/constructors/auth.sentCode.md +++ b/old_docs/API_docs_v44/constructors/auth.sentCode.md @@ -15,10 +15,10 @@ Contains info about a sent verification code. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|phone\_registered|[Bool](../types/Bool.md) | Yes|Phone registered?| +|type|[auth.SentCodeType](../constructors/auth.SentCodeType.md) | Yes|Phone code type| |phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash, to be stored and later re-used with [auth.signIn](../methods/auth.signIn.md)| -|send\_call\_timeout|[int](../types/int.md) | Yes|Send call timeout| -|is\_password|[Bool](../types/Bool.md) | Yes|Is password?| +|next\_type|[auth.CodeType](../constructors/auth.CodeType.md) | Optional|Phone code type that will be sent next, if the phone code is not received within `timeout` seconds: to send it use [auth.resendCode](../methods/auth.resendCode.md)| +|timeout|[int](../types/int.md) | Optional|Timeout for reception of the phone code| @@ -28,14 +28,14 @@ Contains info about a sent verification code. ### Example: ```php -$auth.sentCode = ['_' => 'auth.sentCode', 'phone_registered' => Bool, 'phone_code_hash' => 'string', 'send_call_timeout' => int, 'is_password' => Bool]; +$auth.sentCode = ['_' => 'auth.sentCode', 'type' => auth.SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth.CodeType, 'timeout' => int]; ``` Or, if you're into Lua: ```lua -auth.sentCode={_='auth.sentCode', phone_registered=Bool, phone_code_hash='string', send_call_timeout=int, is_password=Bool} +auth.sentCode={_='auth.sentCode', type=auth.SentCodeType, phone_code_hash='string', next_type=auth.CodeType, timeout=int} ``` diff --git a/old_docs/API_docs_v44/constructors/auth.sentCodeTypeApp.md b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeApp.md new file mode 100644 index 00000000..1f92677c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeApp.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeApp +description: The code was sent through the telegram app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeApp.html +--- +# Constructor: auth.sentCodeTypeApp +[Back to constructors index](index.md) + + + +The code was sent through the telegram app + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the code in bytes| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.sentCodeTypeCall.md b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeCall.md new file mode 100644 index 00000000..9cdce935 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeCall.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeCall +description: The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeCall.html +--- +# Constructor: auth.sentCodeTypeCall +[Back to constructors index](index.md) + + + +The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the verification code| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.sentCodeTypeFlashCall.md b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeFlashCall.md new file mode 100644 index 00000000..38e2b195 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeFlashCall.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeFlashCall +description: The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeFlashCall.html +--- +# Constructor: auth.sentCodeTypeFlashCall +[Back to constructors index](index.md) + + + +The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pattern|[string](../types/string.md) | Yes|[pattern](https://core.telegram.org/api/pattern) to match| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/auth.sentCodeTypeSms.md b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeSms.md new file mode 100644 index 00000000..bb4d5084 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/auth.sentCodeTypeSms.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeSms +description: The code was sent via SMS +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeSms.html +--- +# Constructor: auth.sentCodeTypeSms +[Back to constructors index](index.md) + + + +The code was sent via SMS + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the code in bytes| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/authorization.md b/old_docs/API_docs_v44/constructors/authorization.md index 0d475ac1..a9862412 100644 --- a/old_docs/API_docs_v44/constructors/authorization.md +++ b/old_docs/API_docs_v44/constructors/authorization.md @@ -14,6 +14,9 @@ Logged-in session | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|current|[Bool](../types/Bool.md) | Optional|Whether this is the current session| +|official\_app|[Bool](../types/Bool.md) | Optional|Whether the session is from an official app| +|password\_pending|[Bool](../types/Bool.md) | Optional|Whether the session is still waiting for a 2FA password| |hash|[long](../types/long.md) | Yes|Identifier| |device\_model|[string](../types/string.md) | Yes|Device model| |platform|[string](../types/string.md) | Yes|Platform| @@ -35,14 +38,14 @@ Logged-in session ### Example: ```php -$authorization = ['_' => 'authorization', 'hash' => long, 'device_model' => 'string', 'platform' => 'string', 'system_version' => 'string', 'api_id' => int, 'app_name' => 'string', 'app_version' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'country' => 'string', 'region' => 'string']; +$authorization = ['_' => 'authorization', 'current' => Bool, 'official_app' => Bool, 'password_pending' => Bool, 'hash' => long, 'device_model' => 'string', 'platform' => 'string', 'system_version' => 'string', 'api_id' => int, 'app_name' => 'string', 'app_version' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'country' => 'string', 'region' => 'string']; ``` Or, if you're into Lua: ```lua -authorization={_='authorization', hash=long, device_model='string', platform='string', system_version='string', api_id=int, app_name='string', app_version='string', date_created=int, date_active=int, ip='string', country='string', region='string'} +authorization={_='authorization', current=Bool, official_app=Bool, password_pending=Bool, hash=long, device_model='string', platform='string', system_version='string', api_id=int, app_name='string', app_version='string', date_created=int, date_active=int, ip='string', country='string', region='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/autoDownloadSettings.md b/old_docs/API_docs_v44/constructors/autoDownloadSettings.md new file mode 100644 index 00000000..8d5944e2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/autoDownloadSettings.md @@ -0,0 +1,45 @@ +--- +title: autoDownloadSettings +description: Autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: autoDownloadSettings +[Back to constructors index](index.md) + + + +Autodownload settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|disabled|[Bool](../types/Bool.md) | Optional|Disable automatic media downloads?| +|video\_preload\_large|[Bool](../types/Bool.md) | Optional|Whether to preload the first seconds of videos larger than the specified limit| +|audio\_preload\_next|[Bool](../types/Bool.md) | Optional|Whether to preload the next audio track when you're listening to music| +|phonecalls\_less\_data|[Bool](../types/Bool.md) | Optional|Whether to enable data saving mode in phone calls| +|photo\_size\_max|[int](../types/int.md) | Yes|Maximum size of photos to preload| +|video\_size\_max|[int](../types/int.md) | Yes|Maximum size of videos to preload| +|file\_size\_max|[int](../types/int.md) | Yes|Maximum size of other files to preload| +|video\_upload\_maxbitrate|[int](../types/int.md) | Yes|Maximum suggested bitrate for **uploading** videos| + + + +### Type: [AutoDownloadSettings](../types/AutoDownloadSettings.md) + + +### Example: + +```php +$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'photo_size_max' => int, 'video_size_max' => int, 'file_size_max' => int, 'video_upload_maxbitrate' => int]; +``` + + +Or, if you're into Lua: + +```lua +autoDownloadSettings={_='autoDownloadSettings', disabled=Bool, video_preload_large=Bool, audio_preload_next=Bool, phonecalls_less_data=Bool, photo_size_max=int, video_size_max=int, file_size_max=int, video_upload_maxbitrate=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/bankCardOpenUrl.md b/old_docs/API_docs_v44/constructors/bankCardOpenUrl.md new file mode 100644 index 00000000..e48ff093 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/bankCardOpenUrl.md @@ -0,0 +1,39 @@ +--- +title: bankCardOpenUrl +description: Credit card info URL provided by the bank +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: bankCardOpenUrl +[Back to constructors index](index.md) + + + +Credit card info URL provided by the bank + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Info URL| +|name|[string](../types/string.md) | Yes|Bank name| + + + +### Type: [BankCardOpenUrl](../types/BankCardOpenUrl.md) + + +### Example: + +```php +$bankCardOpenUrl = ['_' => 'bankCardOpenUrl', 'url' => 'string', 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +bankCardOpenUrl={_='bankCardOpenUrl', url='string', name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/baseThemeArctic.md b/old_docs/API_docs_v44/constructors/baseThemeArctic.md new file mode 100644 index 00000000..52a38cd2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/baseThemeArctic.md @@ -0,0 +1,33 @@ +--- +title: baseThemeArctic +description: Arctic theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeArctic +[Back to constructors index](index.md) + + + +Arctic theme + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeArctic = ['_' => 'baseThemeArctic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeArctic={_='baseThemeArctic'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/baseThemeClassic.md b/old_docs/API_docs_v44/constructors/baseThemeClassic.md new file mode 100644 index 00000000..04de5cfc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/baseThemeClassic.md @@ -0,0 +1,33 @@ +--- +title: baseThemeClassic +description: Classic theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeClassic +[Back to constructors index](index.md) + + + +Classic theme + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeClassic = ['_' => 'baseThemeClassic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeClassic={_='baseThemeClassic'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/baseThemeDay.md b/old_docs/API_docs_v44/constructors/baseThemeDay.md new file mode 100644 index 00000000..e540d6d3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/baseThemeDay.md @@ -0,0 +1,33 @@ +--- +title: baseThemeDay +description: Day theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeDay +[Back to constructors index](index.md) + + + +Day theme + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeDay = ['_' => 'baseThemeDay']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeDay={_='baseThemeDay'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/baseThemeNight.md b/old_docs/API_docs_v44/constructors/baseThemeNight.md new file mode 100644 index 00000000..fa37c37f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/baseThemeNight.md @@ -0,0 +1,33 @@ +--- +title: baseThemeNight +description: Night theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeNight +[Back to constructors index](index.md) + + + +Night theme + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeNight = ['_' => 'baseThemeNight']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeNight={_='baseThemeNight'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/baseThemeTinted.md b/old_docs/API_docs_v44/constructors/baseThemeTinted.md new file mode 100644 index 00000000..fb1cea7d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/baseThemeTinted.md @@ -0,0 +1,33 @@ +--- +title: baseThemeTinted +description: Tinted theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeTinted +[Back to constructors index](index.md) + + + +Tinted theme + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeTinted = ['_' => 'baseThemeTinted']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeTinted={_='baseThemeTinted'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/botInfo.md b/old_docs/API_docs_v44/constructors/botInfo.md index b6905568..a1c60668 100644 --- a/old_docs/API_docs_v44/constructors/botInfo.md +++ b/old_docs/API_docs_v44/constructors/botInfo.md @@ -15,10 +15,8 @@ Info about bots (available bot commands, etc) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[int](../types/int.md) | Yes|ID of the bot| -|version|[int](../types/int.md) | Yes|Version| -|share\_text|[string](../types/string.md) | Yes|Share text| |description|[string](../types/string.md) | Yes|Description of the bot| -|commands|Array of [BotCommand](../types/BotCommand.md) | Yes|Commands| +|commands|Array of [BotCommand](../types/BotCommand.md) | Yes|Bot commands that can be used in the chat| @@ -28,14 +26,14 @@ Info about bots (available bot commands, etc) ### Example: ```php -$botInfo = ['_' => 'botInfo', 'user_id' => int, 'version' => int, 'share_text' => 'string', 'description' => 'string', 'commands' => [BotCommand, BotCommand]]; +$botInfo = ['_' => 'botInfo', 'user_id' => int, 'description' => 'string', 'commands' => [BotCommand, BotCommand]]; ``` Or, if you're into Lua: ```lua -botInfo={_='botInfo', user_id=int, version=int, share_text='string', description='string', commands={BotCommand}} +botInfo={_='botInfo', user_id=int, description='string', commands={BotCommand}} ``` diff --git a/old_docs/API_docs_v44/constructors/botInfoEmpty.md b/old_docs/API_docs_v44/constructors/botInfoEmpty.md deleted file mode 100644 index 23c9c490..00000000 --- a/old_docs/API_docs_v44/constructors/botInfoEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: botInfoEmpty -description: Empty bot info -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: botInfoEmpty -[Back to constructors index](index.md) - - - -Empty bot info - - - - -### Type: [BotInfo](../types/BotInfo.md) - - -### Example: - -```php -$botInfoEmpty = ['_' => 'botInfoEmpty']; -``` - - -Or, if you're into Lua: - -```lua -botInfoEmpty={_='botInfoEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/botInlineMediaResult.md b/old_docs/API_docs_v44/constructors/botInlineMediaResult.md new file mode 100644 index 00000000..c128149f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMediaResult.md @@ -0,0 +1,44 @@ +--- +title: botInlineMediaResult +description: Media result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMediaResult +[Back to constructors index](index.md) + + + +Media result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|photo|[Photo](../types/Photo.md) | Optional|If type is `photo`, the photo to send| +|document|[Document](../types/Document.md) | Optional|If type is `document`, the document to send| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Description| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Depending on the `type` and on the [constructor](../types/BotInlineMessage.md), contains the caption of the media or the content of the message to be sent **instead** of the media| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +```php +$botInlineMediaResult = ['_' => 'botInlineMediaResult', 'id' => 'string', 'type' => 'string', 'photo' => Photo, 'document' => Document, 'title' => 'string', 'description' => 'string', 'send_message' => BotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMediaResult={_='botInlineMediaResult', id='string', type='string', photo=Photo, document=Document, title='string', description='string', send_message=BotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/botInlineMessageMediaAuto.md b/old_docs/API_docs_v44/constructors/botInlineMessageMediaAuto.md new file mode 100644 index 00000000..522f3cda --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMessageMediaAuto.md @@ -0,0 +1,46 @@ +--- +title: botInlineMessageMediaAuto +description: Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Caption| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaAuto = ['_' => 'botInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageMediaAuto={_='botInlineMessageMediaAuto', message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/botInlineMessageMediaContact.md b/old_docs/API_docs_v44/constructors/botInlineMessageMediaContact.md new file mode 100644 index 00000000..f9041fb5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMessageMediaContact.md @@ -0,0 +1,48 @@ +--- +title: botInlineMessageMediaContact +description: Send a contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaContact +[Back to constructors index](index.md) + + + +Send a contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|vcard|[string](../types/string.md) | Yes|VCard info| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaContact = ['_' => 'botInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageMediaContact={_='botInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/botInlineMessageMediaGeo.md b/old_docs/API_docs_v44/constructors/botInlineMessageMediaGeo.md new file mode 100644 index 00000000..b9b01f35 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMessageMediaGeo.md @@ -0,0 +1,46 @@ +--- +title: botInlineMessageMediaGeo +description: Send a geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +Send a geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaGeo = ['_' => 'botInlineMessageMediaGeo', 'geo' => GeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageMediaGeo={_='botInlineMessageMediaGeo', geo=GeoPoint, period=int, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/botInlineMessageMediaVenue.md b/old_docs/API_docs_v44/constructors/botInlineMessageMediaVenue.md new file mode 100644 index 00000000..1ac6c581 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMessageMediaVenue.md @@ -0,0 +1,50 @@ +--- +title: botInlineMessageMediaVenue +description: Send a venue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +Send a venue + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation of venue| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Address| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaVenue = ['_' => 'botInlineMessageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageMediaVenue={_='botInlineMessageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/botInlineMessageText.md b/old_docs/API_docs_v44/constructors/botInlineMessageText.md new file mode 100644 index 00000000..1f1d2140 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineMessageText.md @@ -0,0 +1,47 @@ +--- +title: botInlineMessageText +description: Send a simple text message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageText +[Back to constructors index](index.md) + + + +Send a simple text message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageText = ['_' => 'botInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageText={_='botInlineMessageText', no_webpage=Bool, message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/botInlineResult.md b/old_docs/API_docs_v44/constructors/botInlineResult.md new file mode 100644 index 00000000..839d1def --- /dev/null +++ b/old_docs/API_docs_v44/constructors/botInlineResult.md @@ -0,0 +1,45 @@ +--- +title: botInlineResult +description: Generic result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineResult +[Back to constructors index](index.md) + + + +Generic result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|url|[string](../types/string.md) | Optional|URL of article or webpage| +|thumb|[WebDocument](../types/WebDocument.md) | Optional|Thumbnail for the result| +|content|[WebDocument](../types/WebDocument.md) | Optional|Content of the result| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Message to send| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +```php +$botInlineResult = ['_' => 'botInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => WebDocument, 'content' => WebDocument, 'send_message' => BotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +botInlineResult={_='botInlineResult', id='string', type='string', title='string', description='string', url='string', thumb=WebDocument, content=WebDocument, send_message=BotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/cdnConfig.md b/old_docs/API_docs_v44/constructors/cdnConfig.md new file mode 100644 index 00000000..ce815bf2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/cdnConfig.md @@ -0,0 +1,38 @@ +--- +title: cdnConfig +description: Configuration for [CDN](https://core.telegram.org/cdn) file downloads. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnConfig +[Back to constructors index](index.md) + + + +Configuration for [CDN](https://core.telegram.org/cdn) file downloads. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|public\_keys|Array of [CdnPublicKey](../types/CdnPublicKey.md) | Yes|Vector of public keys to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs.| + + + +### Type: [CdnConfig](../types/CdnConfig.md) + + +### Example: + +```php +$cdnConfig = ['_' => 'cdnConfig', 'public_keys' => [CdnPublicKey, CdnPublicKey]]; +``` + + +Or, if you're into Lua: + +```lua +cdnConfig={_='cdnConfig', public_keys={CdnPublicKey}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/cdnPublicKey.md b/old_docs/API_docs_v44/constructors/cdnPublicKey.md new file mode 100644 index 00000000..72642834 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/cdnPublicKey.md @@ -0,0 +1,39 @@ +--- +title: cdnPublicKey +description: Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnPublicKey +[Back to constructors index](index.md) + + + +Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|[CDN DC](https://core.telegram.org/cdn) ID| +|public\_key|[string](../types/string.md) | Yes|RSA public key| + + + +### Type: [CdnPublicKey](../types/CdnPublicKey.md) + + +### Example: + +```php +$cdnPublicKey = ['_' => 'cdnPublicKey', 'dc_id' => int, 'public_key' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +cdnPublicKey={_='cdnPublicKey', dc_id=int, public_key='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channel.md b/old_docs/API_docs_v44/constructors/channel.md index 8f0acb59..5c630af7 100644 --- a/old_docs/API_docs_v44/constructors/channel.md +++ b/old_docs/API_docs_v44/constructors/channel.md @@ -15,22 +15,29 @@ Channel/supergroup info | Name | Type | Required | Description | |----------|---------------|----------|-------------| |creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of this channel| -|kicked|[Bool](../types/Bool.md) | Optional|Kicked?| |left|[Bool](../types/Bool.md) | Optional|Whether the current user has left this channel| -|editor|[Bool](../types/Bool.md) | Optional|Editor?| -|moderator|[Bool](../types/Bool.md) | Optional|Moderator?| |broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel?| |verified|[Bool](../types/Bool.md) | Optional|Is this channel verified by telegram?| |megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup?| |restricted|[Bool](../types/Bool.md) | Optional|Whether viewing/writing in this channel for a reason (see `restriction_reason`| +|signatures|[Bool](../types/Bool.md) | Optional|Whether signatures are enabled (channels)| +|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)| +|scam|[Bool](../types/Bool.md) | Optional|This channel/supergroup is probably a scam| +|has\_link|[Bool](../types/Bool.md) | Optional|Whether this channel has a private join link| +|has\_geo|[Bool](../types/Bool.md) | Optional|Whether this chanel has a geoposition| +|slowmode\_enabled|[Bool](../types/Bool.md) | Optional|Whether slow mode is enabled for groups to prevent flood in chat| |id|[int](../types/int.md) | Yes|ID of the channel| -|access\_hash|[long](../types/long.md) | Yes|Access hash| +|access\_hash|[long](../types/long.md) | Optional|Access hash| |title|[string](../types/string.md) | Yes|Title| |username|[string](../types/string.md) | Optional|Username| |photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Profile photo| -|date|[int](../types/int.md) | Yes|Creation date| +|date|[int](../types/int.md) | Yes|Date when the user joined the supergroup/channel, or if the user isn't a member, its creation date| |version|[int](../types/int.md) | Yes|Version of the channel (always `0`)| -|restiction\_reason|[string](../types/string.md) | Optional|Restiction reason| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Contains the reason why access to this channel must be restricted.| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Banned rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Default chat rights (see [rights](https://core.telegram.org/api/rights))| +|participants\_count|[int](../types/int.md) | Optional|Participant count| @@ -40,14 +47,14 @@ Channel/supergroup info ### Example: ```php -$channel = ['_' => 'channel', 'creator' => Bool, 'kicked' => Bool, 'left' => Bool, 'editor' => Bool, 'moderator' => Bool, 'broadcast' => Bool, 'verified' => Bool, 'megagroup' => Bool, 'restricted' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'username' => 'string', 'photo' => ChatPhoto, 'date' => int, 'version' => int, 'restiction_reason' => 'string']; +$channel = ['_' => 'channel', 'creator' => Bool, 'left' => Bool, 'broadcast' => Bool, 'verified' => Bool, 'megagroup' => Bool, 'restricted' => Bool, 'signatures' => Bool, 'min' => Bool, 'scam' => Bool, 'has_link' => Bool, 'has_geo' => Bool, 'slowmode_enabled' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'username' => 'string', 'photo' => ChatPhoto, 'date' => int, 'version' => int, 'restriction_reason' => [RestrictionReason, RestrictionReason], 'admin_rights' => ChatAdminRights, 'banned_rights' => ChatBannedRights, 'default_banned_rights' => ChatBannedRights, 'participants_count' => int]; ``` Or, if you're into Lua: ```lua -channel={_='channel', creator=Bool, kicked=Bool, left=Bool, editor=Bool, moderator=Bool, broadcast=Bool, verified=Bool, megagroup=Bool, restricted=Bool, id=int, access_hash=long, title='string', username='string', photo=ChatPhoto, date=int, version=int, restiction_reason='string'} +channel={_='channel', creator=Bool, left=Bool, broadcast=Bool, verified=Bool, megagroup=Bool, restricted=Bool, signatures=Bool, min=Bool, scam=Bool, has_link=Bool, has_geo=Bool, slowmode_enabled=Bool, id=int, access_hash=long, title='string', username='string', photo=ChatPhoto, date=int, version=int, restriction_reason={RestrictionReason}, admin_rights=ChatAdminRights, banned_rights=ChatBannedRights, default_banned_rights=ChatBannedRights, participants_count=int} ``` diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEvent.md b/old_docs/API_docs_v44/constructors/channelAdminLogEvent.md new file mode 100644 index 00000000..7256713a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEvent.md @@ -0,0 +1,41 @@ +--- +title: channelAdminLogEvent +description: Admin log event +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEvent +[Back to constructors index](index.md) + + + +Admin log event + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Event ID| +|date|[int](../types/int.md) | Yes|Date| +|user\_id|[int](../types/int.md) | Yes|User ID| +|action|[ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) | Yes|Action| + + + +### Type: [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) + + +### Example: + +```php +$channelAdminLogEvent = ['_' => 'channelAdminLogEvent', 'id' => long, 'date' => int, 'user_id' => int, 'action' => ChannelAdminLogEventAction]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEvent={_='channelAdminLogEvent', id=long, date=int, user_id=int, action=ChannelAdminLogEventAction} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeAbout.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeAbout.md new file mode 100644 index 00000000..1677fc06 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeAbout.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeAbout +description: The description was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeAbout +[Back to constructors index](index.md) + + + +The description was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Previous description| +|new\_value|[string](../types/string.md) | Yes|New description| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeAbout = ['_' => 'channelAdminLogEventActionChangeAbout', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeAbout={_='channelAdminLogEventActionChangeAbout', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLinkedChat.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLinkedChat.md new file mode 100644 index 00000000..fd7ed7bb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLinkedChat.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeLinkedChat +description: The linked chat was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeLinkedChat +[Back to constructors index](index.md) + + + +The linked chat was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[int](../types/int.md) | Yes|Previous linked chat| +|new\_value|[int](../types/int.md) | Yes|New linked chat| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeLinkedChat = ['_' => 'channelAdminLogEventActionChangeLinkedChat', 'prev_value' => int, 'new_value' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeLinkedChat={_='channelAdminLogEventActionChangeLinkedChat', prev_value=int, new_value=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLocation.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLocation.md new file mode 100644 index 00000000..663022fd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeLocation.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeLocation +description: The geogroup location was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeLocation +[Back to constructors index](index.md) + + + +The geogroup location was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|Previous location| +|new\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|New location| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeLocation = ['_' => 'channelAdminLogEventActionChangeLocation', 'prev_value' => ChannelLocation, 'new_value' => ChannelLocation]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeLocation={_='channelAdminLogEventActionChangeLocation', prev_value=ChannelLocation, new_value=ChannelLocation} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangePhoto.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangePhoto.md new file mode 100644 index 00000000..a7726c14 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangePhoto.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangePhoto +description: The channel/supergroup's picture was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangePhoto +[Back to constructors index](index.md) + + + +The channel/supergroup's picture was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_photo|[Photo](../types/Photo.md) | Optional|Previous picture| +|new\_photo|[Photo](../types/Photo.md) | Optional|New picture| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangePhoto = ['_' => 'channelAdminLogEventActionChangePhoto', 'prev_photo' => Photo, 'new_photo' => Photo]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangePhoto={_='channelAdminLogEventActionChangePhoto', prev_photo=Photo, new_photo=Photo} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeStickerSet.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeStickerSet.md new file mode 100644 index 00000000..5a70ab9b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeStickerSet.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeStickerSet +description: The supergroup's stickerset was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeStickerSet +[Back to constructors index](index.md) + + + +The supergroup's stickerset was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Previous stickerset| +|new\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|New stickerset| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeStickerSet = ['_' => 'channelAdminLogEventActionChangeStickerSet', 'prev_stickerset' => InputStickerSet, 'new_stickerset' => InputStickerSet]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeStickerSet={_='channelAdminLogEventActionChangeStickerSet', prev_stickerset=InputStickerSet, new_stickerset=InputStickerSet} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeTitle.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeTitle.md new file mode 100644 index 00000000..46d2cf4e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeTitle.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeTitle +description: Channel/supergroup title was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeTitle +[Back to constructors index](index.md) + + + +Channel/supergroup title was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Previous title| +|new\_value|[string](../types/string.md) | Yes|New title| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeTitle = ['_' => 'channelAdminLogEventActionChangeTitle', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeTitle={_='channelAdminLogEventActionChangeTitle', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeUsername.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeUsername.md new file mode 100644 index 00000000..d83efacf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionChangeUsername.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeUsername +description: Channel/supergroup username was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeUsername +[Back to constructors index](index.md) + + + +Channel/supergroup username was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Old username| +|new\_value|[string](../types/string.md) | Yes|New username| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeUsername = ['_' => 'channelAdminLogEventActionChangeUsername', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeUsername={_='channelAdminLogEventActionChangeUsername', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDefaultBannedRights.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDefaultBannedRights.md new file mode 100644 index 00000000..4c5ad54c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDefaultBannedRights.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionDefaultBannedRights +description: The default banned rights were modified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionDefaultBannedRights +[Back to constructors index](index.md) + + + +The default banned rights were modified + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Previous global [banned rights](https://core.telegram.org/api/rights)| +|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New glboal [banned rights](https://core.telegram.org/api/rights).| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionDefaultBannedRights = ['_' => 'channelAdminLogEventActionDefaultBannedRights', 'prev_banned_rights' => ChatBannedRights, 'new_banned_rights' => ChatBannedRights]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionDefaultBannedRights={_='channelAdminLogEventActionDefaultBannedRights', prev_banned_rights=ChatBannedRights, new_banned_rights=ChatBannedRights} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDeleteMessage.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDeleteMessage.md new file mode 100644 index 00000000..dfc3f998 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionDeleteMessage.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionDeleteMessage +description: A message was deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionDeleteMessage +[Back to constructors index](index.md) + + + +A message was deleted + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The message that was deleted| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionDeleteMessage = ['_' => 'channelAdminLogEventActionDeleteMessage', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionDeleteMessage={_='channelAdminLogEventActionDeleteMessage', message=Message} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionEditMessage.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionEditMessage.md new file mode 100644 index 00000000..1304749d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionEditMessage.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionEditMessage +description: A message was edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionEditMessage +[Back to constructors index](index.md) + + + +A message was edited + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_message|[Message](../types/Message.md) | Optional|Old message| +|new\_message|[Message](../types/Message.md) | Optional|New message| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionEditMessage = ['_' => 'channelAdminLogEventActionEditMessage', 'prev_message' => Message, 'new_message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionEditMessage={_='channelAdminLogEventActionEditMessage', prev_message=Message, new_message=Message} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantInvite.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantInvite.md new file mode 100644 index 00000000..0f7fd685 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantInvite.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionParticipantInvite +description: A user was invited to the group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantInvite +[Back to constructors index](index.md) + + + +A user was invited to the group + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The user that was invited| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantInvite = ['_' => 'channelAdminLogEventActionParticipantInvite', 'participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantInvite={_='channelAdminLogEventActionParticipantInvite', participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantJoin.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantJoin.md new file mode 100644 index 00000000..aabef495 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantJoin.md @@ -0,0 +1,33 @@ +--- +title: channelAdminLogEventActionParticipantJoin +description: A user has joined the group (in the case of big groups, info of the user that has joined isn't shown) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantJoin +[Back to constructors index](index.md) + + + +A user has joined the group (in the case of big groups, info of the user that has joined isn't shown) + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantJoin = ['_' => 'channelAdminLogEventActionParticipantJoin']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantJoin={_='channelAdminLogEventActionParticipantJoin'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantLeave.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantLeave.md new file mode 100644 index 00000000..4a51e021 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantLeave.md @@ -0,0 +1,33 @@ +--- +title: channelAdminLogEventActionParticipantLeave +description: A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantLeave +[Back to constructors index](index.md) + + + +A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown) + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantLeave = ['_' => 'channelAdminLogEventActionParticipantLeave']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantLeave={_='channelAdminLogEventActionParticipantLeave'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleAdmin.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleAdmin.md new file mode 100644 index 00000000..34f97d2f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleAdmin.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionParticipantToggleAdmin +description: The admin [rights](https://core.telegram.org/api/rights) of a user were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleAdmin +[Back to constructors index](index.md) + + + +The admin [rights](https://core.telegram.org/api/rights) of a user were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Previous admin rights| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New admin rights| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantToggleAdmin = ['_' => 'channelAdminLogEventActionParticipantToggleAdmin', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantToggleAdmin={_='channelAdminLogEventActionParticipantToggleAdmin', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleBan.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleBan.md new file mode 100644 index 00000000..e9007cbc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionParticipantToggleBan.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionParticipantToggleBan +description: The banned [rights](https://core.telegram.org/api/rights) of a user were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleBan +[Back to constructors index](index.md) + + + +The banned [rights](https://core.telegram.org/api/rights) of a user were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Old banned rights of user| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New banned rights of user| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantToggleBan = ['_' => 'channelAdminLogEventActionParticipantToggleBan', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantToggleBan={_='channelAdminLogEventActionParticipantToggleBan', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionStopPoll.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionStopPoll.md new file mode 100644 index 00000000..d184c992 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionStopPoll.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionStopPoll +description: A poll was stopped +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionStopPoll +[Back to constructors index](index.md) + + + +A poll was stopped + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The poll that was stopped| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionStopPoll = ['_' => 'channelAdminLogEventActionStopPoll', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionStopPoll={_='channelAdminLogEventActionStopPoll', message=Message} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleInvites.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleInvites.md new file mode 100644 index 00000000..bdcafee5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleInvites.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionToggleInvites +description: Invites were enabled/disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleInvites +[Back to constructors index](index.md) + + + +Invites were enabled/disabled + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleInvites = ['_' => 'channelAdminLogEventActionToggleInvites', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleInvites={_='channelAdminLogEventActionToggleInvites', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md new file mode 100644 index 00000000..c14e2a74 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionTogglePreHistoryHidden +description: The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionTogglePreHistoryHidden +[Back to constructors index](index.md) + + + +The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionTogglePreHistoryHidden = ['_' => 'channelAdminLogEventActionTogglePreHistoryHidden', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionTogglePreHistoryHidden={_='channelAdminLogEventActionTogglePreHistoryHidden', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSignatures.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSignatures.md new file mode 100644 index 00000000..6a73dadb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSignatures.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionToggleSignatures +description: Channel signatures were enabled/disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleSignatures +[Back to constructors index](index.md) + + + +Channel signatures were enabled/disabled + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleSignatures = ['_' => 'channelAdminLogEventActionToggleSignatures', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleSignatures={_='channelAdminLogEventActionToggleSignatures', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSlowMode.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSlowMode.md new file mode 100644 index 00000000..0a653a45 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionToggleSlowMode.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionToggleSlowMode +description: [Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleSlowMode +[Back to constructors index](index.md) + + + +[Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[int](../types/int.md) | Yes|Previous slow mode value| +|new\_value|[int](../types/int.md) | Yes|New slow mode value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleSlowMode = ['_' => 'channelAdminLogEventActionToggleSlowMode', 'prev_value' => int, 'new_value' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleSlowMode={_='channelAdminLogEventActionToggleSlowMode', prev_value=int, new_value=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventActionUpdatePinned.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionUpdatePinned.md new file mode 100644 index 00000000..d1154dc4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventActionUpdatePinned.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionUpdatePinned +description: A message was pinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionUpdatePinned +[Back to constructors index](index.md) + + + +A message was pinned + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The message that was pinned| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionUpdatePinned = ['_' => 'channelAdminLogEventActionUpdatePinned', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionUpdatePinned={_='channelAdminLogEventActionUpdatePinned', message=Message} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelAdminLogEventsFilter.md b/old_docs/API_docs_v44/constructors/channelAdminLogEventsFilter.md new file mode 100644 index 00000000..8ef585ee --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelAdminLogEventsFilter.md @@ -0,0 +1,51 @@ +--- +title: channelAdminLogEventsFilter +description: Filter only certain admin log events +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventsFilter +[Back to constructors index](index.md) + + + +Filter only certain admin log events + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|join|[Bool](../types/Bool.md) | Optional|[Join events](../constructors/channelAdminLogEventActionParticipantJoin.md)| +|leave|[Bool](../types/Bool.md) | Optional|[Leave events](../constructors/channelAdminLogEventActionParticipantLeave.md)| +|invite|[Bool](../types/Bool.md) | Optional|[Invite events](../constructors/channelAdminLogEventActionParticipantInvite.md)| +|ban|[Bool](../types/Bool.md) | Optional|[Ban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|unban|[Bool](../types/Bool.md) | Optional|[Unban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|kick|[Bool](../types/Bool.md) | Optional|[Kick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|unkick|[Bool](../types/Bool.md) | Optional|[Unkick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|promote|[Bool](../types/Bool.md) | Optional|[Admin promotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)| +|demote|[Bool](../types/Bool.md) | Optional|[Admin demotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)| +|info|[Bool](../types/Bool.md) | Optional|Info change events (when [about](../constructors/channelAdminLogEventActionChangeAbout.md), [linked chat](../constructors/channelAdminLogEventActionChangeLinkedChat.md), [location](../constructors/channelAdminLogEventActionChangeLocation.md), [photo](../constructors/channelAdminLogEventActionChangePhoto.md), [stickerset](../constructors/channelAdminLogEventActionChangeStickerSet.md), [title](../constructors/channelAdminLogEventActionChangeTitle.md) or [username](../constructors/channelAdminLogEventActionChangeUsername.md) data of a channel gets modified)| +|settings|[Bool](../types/Bool.md) | Optional|Settings change events ([invites](../constructors/channelAdminLogEventActionToggleInvites.md), [hidden prehistory](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md), [signatures](../constructors/channelAdminLogEventActionToggleSignatures.md), [default banned rights](../constructors/channelAdminLogEventActionDefaultBannedRights.md))| +|pinned|[Bool](../types/Bool.md) | Optional|[Message pin events](../constructors/channelAdminLogEventActionUpdatePinned.md)| +|edit|[Bool](../types/Bool.md) | Optional|[Message edit events](../constructors/channelAdminLogEventActionEditMessage.md)| +|delete|[Bool](../types/Bool.md) | Optional|[Message deletion events](../constructors/channelAdminLogEventActionDeleteMessage.md)| + + + +### Type: [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) + + +### Example: + +```php +$channelAdminLogEventsFilter = ['_' => 'channelAdminLogEventsFilter', 'join' => Bool, 'leave' => Bool, 'invite' => Bool, 'ban' => Bool, 'unban' => Bool, 'kick' => Bool, 'unkick' => Bool, 'promote' => Bool, 'demote' => Bool, 'info' => Bool, 'settings' => Bool, 'pinned' => Bool, 'edit' => Bool, 'delete' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventsFilter={_='channelAdminLogEventsFilter', join=Bool, leave=Bool, invite=Bool, ban=Bool, unban=Bool, kick=Bool, unkick=Bool, promote=Bool, demote=Bool, info=Bool, settings=Bool, pinned=Bool, edit=Bool, delete=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelForbidden.md b/old_docs/API_docs_v44/constructors/channelForbidden.md index 8388f3b5..71c20970 100644 --- a/old_docs/API_docs_v44/constructors/channelForbidden.md +++ b/old_docs/API_docs_v44/constructors/channelForbidden.md @@ -14,9 +14,12 @@ Indicates a channel/supergroup we can't access because we were banned, or for so | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup| |id|[int](../types/int.md) | Yes|Channel ID| |access\_hash|[long](../types/long.md) | Yes|Access hash| |title|[string](../types/string.md) | Yes|Title| +|until\_date|[int](../types/int.md) | Optional|The ban is valid until the specified date| @@ -26,14 +29,14 @@ Indicates a channel/supergroup we can't access because we were banned, or for so ### Example: ```php -$channelForbidden = ['_' => 'channelForbidden', 'id' => int, 'access_hash' => long, 'title' => 'string']; +$channelForbidden = ['_' => 'channelForbidden', 'broadcast' => Bool, 'megagroup' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'until_date' => int]; ``` Or, if you're into Lua: ```lua -channelForbidden={_='channelForbidden', id=int, access_hash=long, title='string'} +channelForbidden={_='channelForbidden', broadcast=Bool, megagroup=Bool, id=int, access_hash=long, title='string', until_date=int} ``` diff --git a/old_docs/API_docs_v44/constructors/channelFull.md b/old_docs/API_docs_v44/constructors/channelFull.md index bc125ac4..517e7d1d 100644 --- a/old_docs/API_docs_v44/constructors/channelFull.md +++ b/old_docs/API_docs_v44/constructors/channelFull.md @@ -15,20 +15,38 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |can\_view\_participants|[Bool](../types/Bool.md) | Optional|Can we vew the participant list?| +|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\_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| |admins\_count|[int](../types/int.md) | Optional|Number of channel admins| |kicked\_count|[int](../types/int.md) | Optional|Number of users [kicked](https://core.telegram.org/api/rights) from the channel| +|banned\_count|[int](../types/int.md) | Optional|Number of users [banned](https://core.telegram.org/api/rights) from the channel| +|online\_count|[int](../types/int.md) | Optional|Number of users currently online| |read\_inbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| |unread\_count|[int](../types/int.md) | Yes|Count of unread messages| -|unread\_important\_count|[int](../types/int.md) | Yes|Unread important count| |chat\_photo|[Photo](../types/Photo.md) | Optional|Channel picture| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|Notification settings| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| |exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Invite link| -|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes|Bot info| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes|Info about bots in the channel/supergrup| |migrated\_from\_chat\_id|[int](../types/int.md) | Optional|The chat ID from which this group was [migrated](https://core.telegram.org/api/channel)| |migrated\_from\_max\_id|[int](../types/int.md) | Optional|The message ID in the original chat at which this group was [migrated](https://core.telegram.org/api/channel)| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message| +|stickerset|[StickerSet](../types/StickerSet.md) | Optional|Associated stickerset| +|available\_min\_id|[int](../types/int.md) | Optional|Identifier of a maximum unavailable message in a channel due to hidden history.| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| +|linked\_chat\_id|[int](../types/int.md) | Optional|ID of the linked discussion chat for channels| +|location|[ChannelLocation](../types/ChannelLocation.md) | Optional|Location of the geogroup| +|slowmode\_seconds|[int](../types/int.md) | Optional|If specified, users in supergroups will only be able to send one message every `slowmode_seconds` seconds| +|slowmode\_next\_send\_date|[int](../types/int.md) | Optional|Indicates when the user will be allowed to send another message in the supergroup (unixdate)| +|stats\_dc|[int](../types/int.md) | Optional|If set, specifies the DC to use for fetching channel statistics| +|pts|[int](../types/int.md) | Yes|Latest [PTS](https://core.telegram.org/api/updates) for this channel| @@ -38,14 +56,14 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel) ### Example: ```php -$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'read_inbox_max_id' => int, 'unread_count' => int, 'unread_important_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]; +$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, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, read_inbox_max_id=int, unread_count=int, unread_important_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=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} ``` diff --git a/old_docs/API_docs_v44/constructors/channelLocation.md b/old_docs/API_docs_v44/constructors/channelLocation.md new file mode 100644 index 00000000..9d533950 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelLocation.md @@ -0,0 +1,39 @@ +--- +title: channelLocation +description: Geographical location of supergroup (geogroups) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelLocation +[Back to constructors index](index.md) + + + +Geographical location of supergroup (geogroups) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[GeoPoint](../types/GeoPoint.md) | Optional|Geographical location of supergrup| +|address|[string](../types/string.md) | Yes|Textual description of the address| + + + +### Type: [ChannelLocation](../types/ChannelLocation.md) + + +### Example: + +```php +$channelLocation = ['_' => 'channelLocation', 'geo_point' => GeoPoint, 'address' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelLocation={_='channelLocation', geo_point=GeoPoint, address='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelLocationEmpty.md b/old_docs/API_docs_v44/constructors/channelLocationEmpty.md new file mode 100644 index 00000000..3cb7f0c7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelLocationEmpty.md @@ -0,0 +1,33 @@ +--- +title: channelLocationEmpty +description: No location (normal supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelLocationEmpty +[Back to constructors index](index.md) + + + +No location (normal supergroup) + + + + +### Type: [ChannelLocation](../types/ChannelLocation.md) + + +### Example: + +```php +$channelLocationEmpty = ['_' => 'channelLocationEmpty']; +``` + + +Or, if you're into Lua: + +```lua +channelLocationEmpty={_='channelLocationEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelMessagesFilter.md b/old_docs/API_docs_v44/constructors/channelMessagesFilter.md index 46eeec8a..0954bb81 100644 --- a/old_docs/API_docs_v44/constructors/channelMessagesFilter.md +++ b/old_docs/API_docs_v44/constructors/channelMessagesFilter.md @@ -14,9 +14,8 @@ Filter for getting only certain types of channel messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Important only?| |exclude\_new\_messages|[Bool](../types/Bool.md) | Optional|Whether to exclude new messages from the search| -|ranges|Array of [MessageRange](../types/MessageRange.md) | Yes|Ranges| +|ranges|Array of [MessageRange](../types/MessageRange.md) | Yes|A range of messages to fetch| @@ -26,14 +25,14 @@ Filter for getting only certain types of channel messages ### Example: ```php -$channelMessagesFilter = ['_' => 'channelMessagesFilter', 'important_only' => Bool, 'exclude_new_messages' => Bool, 'ranges' => [MessageRange, MessageRange]]; +$channelMessagesFilter = ['_' => 'channelMessagesFilter', 'exclude_new_messages' => Bool, 'ranges' => [MessageRange, MessageRange]]; ``` Or, if you're into Lua: ```lua -channelMessagesFilter={_='channelMessagesFilter', important_only=Bool, exclude_new_messages=Bool, ranges={MessageRange}} +channelMessagesFilter={_='channelMessagesFilter', exclude_new_messages=Bool, ranges={MessageRange}} ``` diff --git a/old_docs/API_docs_v44/constructors/channelMessagesFilterCollapsed.md b/old_docs/API_docs_v44/constructors/channelMessagesFilterCollapsed.md deleted file mode 100644 index a9e2acc6..00000000 --- a/old_docs/API_docs_v44/constructors/channelMessagesFilterCollapsed.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: channelMessagesFilterCollapsed -description: Channel messages filter collapsed -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelMessagesFilterCollapsed -[Back to constructors index](index.md) - - - -Channel messages filter collapsed - - - - -### Type: [ChannelMessagesFilter](../types/ChannelMessagesFilter.md) - - -### Example: - -```php -$channelMessagesFilterCollapsed = ['_' => 'channelMessagesFilterCollapsed']; -``` - - -Or, if you're into Lua: - -```lua -channelMessagesFilterCollapsed={_='channelMessagesFilterCollapsed'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelParticipantAdmin.md b/old_docs/API_docs_v44/constructors/channelParticipantAdmin.md new file mode 100644 index 00000000..07be6817 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelParticipantAdmin.md @@ -0,0 +1,45 @@ +--- +title: channelParticipantAdmin +description: Admin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantAdmin +[Back to constructors index](index.md) + + + +Admin + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_edit|[Bool](../types/Bool.md) | Optional|Can this admin promote other admins with the same permissions?| +|self|[Bool](../types/Bool.md) | Optional|Is this the current user| +|user\_id|[int](../types/int.md) | Yes|Admin user ID| +|inviter\_id|[int](../types/int.md) | Optional|User that invited the admin to the channel/group| +|promoted\_by|[int](../types/int.md) | Yes|User that promoted the user to admin| +|date|[int](../types/int.md) | Yes|When did the user join| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|Admin [rights](https://core.telegram.org/api/rights)| +|rank|[string](../types/string.md) | Optional|The role (rank) of the admin in the group: just an arbitrary string, `admin` by default| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantAdmin = ['_' => 'channelParticipantAdmin', 'can_edit' => Bool, 'self' => Bool, 'user_id' => int, 'inviter_id' => int, 'promoted_by' => int, 'date' => int, 'admin_rights' => ChatAdminRights, 'rank' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantAdmin={_='channelParticipantAdmin', can_edit=Bool, self=Bool, user_id=int, inviter_id=int, promoted_by=int, date=int, admin_rights=ChatAdminRights, rank='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelParticipantBanned.md b/old_docs/API_docs_v44/constructors/channelParticipantBanned.md new file mode 100644 index 00000000..e8784630 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelParticipantBanned.md @@ -0,0 +1,42 @@ +--- +title: channelParticipantBanned +description: Banned/kicked user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantBanned +[Back to constructors index](index.md) + + + +Banned/kicked user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|left|[Bool](../types/Bool.md) | Optional|Whether the user has left the group| +|user\_id|[int](../types/int.md) | Yes|User ID| +|kicked\_by|[int](../types/int.md) | Yes|User was kicked by the specified admin| +|date|[int](../types/int.md) | Yes|When did the user join the group| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Banned [rights](https://core.telegram.org/api/rights)| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantBanned = ['_' => 'channelParticipantBanned', 'left' => Bool, 'user_id' => int, 'kicked_by' => int, 'date' => int, 'banned_rights' => ChatBannedRights]; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantBanned={_='channelParticipantBanned', left=Bool, user_id=int, kicked_by=int, date=int, banned_rights=ChatBannedRights} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelParticipantCreator.md b/old_docs/API_docs_v44/constructors/channelParticipantCreator.md index 5c4e2ba7..0de76c13 100644 --- a/old_docs/API_docs_v44/constructors/channelParticipantCreator.md +++ b/old_docs/API_docs_v44/constructors/channelParticipantCreator.md @@ -15,6 +15,7 @@ Channel/supergroup creator | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[int](../types/int.md) | Yes|User ID| +|rank|[string](../types/string.md) | Optional|The role (rank) of the group creator in the group: just an arbitrary string, `admin` by default| @@ -24,14 +25,14 @@ Channel/supergroup creator ### Example: ```php -$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int]; +$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int, 'rank' => 'string']; ``` Or, if you're into Lua: ```lua -channelParticipantCreator={_='channelParticipantCreator', user_id=int} +channelParticipantCreator={_='channelParticipantCreator', user_id=int, rank='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/channelParticipantEditor.md b/old_docs/API_docs_v44/constructors/channelParticipantEditor.md deleted file mode 100644 index ea09b796..00000000 --- a/old_docs/API_docs_v44/constructors/channelParticipantEditor.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: channelParticipantEditor -description: Channel participant editor -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelParticipantEditor -[Back to constructors index](index.md) - - - -Channel participant editor - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|inviter\_id|[int](../types/int.md) | Yes|Inviter ID| -|date|[int](../types/int.md) | Yes|Date| - - - -### Type: [ChannelParticipant](../types/ChannelParticipant.md) - - -### Example: - -```php -$channelParticipantEditor = ['_' => 'channelParticipantEditor', 'user_id' => int, 'inviter_id' => int, 'date' => int]; -``` - - -Or, if you're into Lua: - -```lua -channelParticipantEditor={_='channelParticipantEditor', user_id=int, inviter_id=int, date=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelParticipantKicked.md b/old_docs/API_docs_v44/constructors/channelParticipantKicked.md deleted file mode 100644 index 071c6f31..00000000 --- a/old_docs/API_docs_v44/constructors/channelParticipantKicked.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: channelParticipantKicked -description: Channel participant kicked -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelParticipantKicked -[Back to constructors index](index.md) - - - -Channel participant kicked - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|kicked\_by|[int](../types/int.md) | Yes|Kicked by| -|date|[int](../types/int.md) | Yes|Date| - - - -### Type: [ChannelParticipant](../types/ChannelParticipant.md) - - -### Example: - -```php -$channelParticipantKicked = ['_' => 'channelParticipantKicked', 'user_id' => int, 'kicked_by' => int, 'date' => int]; -``` - - -Or, if you're into Lua: - -```lua -channelParticipantKicked={_='channelParticipantKicked', user_id=int, kicked_by=int, date=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelParticipantModerator.md b/old_docs/API_docs_v44/constructors/channelParticipantModerator.md deleted file mode 100644 index 1fc842d3..00000000 --- a/old_docs/API_docs_v44/constructors/channelParticipantModerator.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: channelParticipantModerator -description: Channel participant moderator -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelParticipantModerator -[Back to constructors index](index.md) - - - -Channel participant moderator - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|inviter\_id|[int](../types/int.md) | Yes|Inviter ID| -|date|[int](../types/int.md) | Yes|Date| - - - -### Type: [ChannelParticipant](../types/ChannelParticipant.md) - - -### Example: - -```php -$channelParticipantModerator = ['_' => 'channelParticipantModerator', 'user_id' => int, 'inviter_id' => int, 'date' => int]; -``` - - -Or, if you're into Lua: - -```lua -channelParticipantModerator={_='channelParticipantModerator', user_id=int, inviter_id=int, date=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelParticipantsBanned.md b/old_docs/API_docs_v44/constructors/channelParticipantsBanned.md new file mode 100644 index 00000000..60bc77c8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelParticipantsBanned.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsBanned +description: Fetch only banned participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsBanned +[Back to constructors index](index.md) + + + +Fetch only banned participants + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional filter for searching banned participants by name (otherwise empty)| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsBanned = ['_' => 'channelParticipantsBanned', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsBanned={_='channelParticipantsBanned', q='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelParticipantsContacts.md b/old_docs/API_docs_v44/constructors/channelParticipantsContacts.md new file mode 100644 index 00000000..38981ff4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelParticipantsContacts.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsContacts +description: Fetch only participants that are also contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsContacts +[Back to constructors index](index.md) + + + +Fetch only participants that are also contacts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional search query for searching contact participants by name| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsContacts = ['_' => 'channelParticipantsContacts', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsContacts={_='channelParticipantsContacts', q='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelParticipantsKicked.md b/old_docs/API_docs_v44/constructors/channelParticipantsKicked.md index f039f834..8566e1fc 100644 --- a/old_docs/API_docs_v44/constructors/channelParticipantsKicked.md +++ b/old_docs/API_docs_v44/constructors/channelParticipantsKicked.md @@ -10,6 +10,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png Fetch only kicked participants +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional filter for searching kicked participants by name (otherwise empty)| @@ -19,14 +24,14 @@ Fetch only kicked participants ### Example: ```php -$channelParticipantsKicked = ['_' => 'channelParticipantsKicked']; +$channelParticipantsKicked = ['_' => 'channelParticipantsKicked', 'q' => 'string']; ``` Or, if you're into Lua: ```lua -channelParticipantsKicked={_='channelParticipantsKicked'} +channelParticipantsKicked={_='channelParticipantsKicked', q='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/channelParticipantsSearch.md b/old_docs/API_docs_v44/constructors/channelParticipantsSearch.md new file mode 100644 index 00000000..e3649fbf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channelParticipantsSearch.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsSearch +description: Query participants by name +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsSearch +[Back to constructors index](index.md) + + + +Query participants by name + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Search query| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsSearch = ['_' => 'channelParticipantsSearch', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsSearch={_='channelParticipantsSearch', q='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channelRoleEditor.md b/old_docs/API_docs_v44/constructors/channelRoleEditor.md deleted file mode 100644 index 3ecedce3..00000000 --- a/old_docs/API_docs_v44/constructors/channelRoleEditor.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: channelRoleEditor -description: Channel role editor -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelRoleEditor -[Back to constructors index](index.md) - - - -Channel role editor - - - - -### Type: [ChannelParticipantRole](../types/ChannelParticipantRole.md) - - -### Example: - -```php -$channelRoleEditor = ['_' => 'channelRoleEditor']; -``` - - -Or, if you're into Lua: - -```lua -channelRoleEditor={_='channelRoleEditor'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelRoleEmpty.md b/old_docs/API_docs_v44/constructors/channelRoleEmpty.md deleted file mode 100644 index 9ada5c53..00000000 --- a/old_docs/API_docs_v44/constructors/channelRoleEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: channelRoleEmpty -description: Empty channel role -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelRoleEmpty -[Back to constructors index](index.md) - - - -Empty channel role - - - - -### Type: [ChannelParticipantRole](../types/ChannelParticipantRole.md) - - -### Example: - -```php -$channelRoleEmpty = ['_' => 'channelRoleEmpty']; -``` - - -Or, if you're into Lua: - -```lua -channelRoleEmpty={_='channelRoleEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channelRoleModerator.md b/old_docs/API_docs_v44/constructors/channelRoleModerator.md deleted file mode 100644 index 3e9d9aea..00000000 --- a/old_docs/API_docs_v44/constructors/channelRoleModerator.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: channelRoleModerator -description: Channel role moderator -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: channelRoleModerator -[Back to constructors index](index.md) - - - -Channel role moderator - - - - -### Type: [ChannelParticipantRole](../types/ChannelParticipantRole.md) - - -### Example: - -```php -$channelRoleModerator = ['_' => 'channelRoleModerator']; -``` - - -Or, if you're into Lua: - -```lua -channelRoleModerator={_='channelRoleModerator'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/channels.adminLogResults.md b/old_docs/API_docs_v44/constructors/channels.adminLogResults.md new file mode 100644 index 00000000..284dbbf0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channels.adminLogResults.md @@ -0,0 +1,41 @@ +--- +title: channels.adminLogResults +description: Admin log events +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_adminLogResults.html +--- +# Constructor: channels.adminLogResults +[Back to constructors index](index.md) + + + +Admin log events + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes|Admin log events| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats mentioned in events| +|users|Array of [User](../types/User.md) | Yes|Users mentioned in events| + + + +### Type: [channels.AdminLogResults](../types/channels.AdminLogResults.md) + + +### Example: + +```php +$channels.adminLogResults = ['_' => 'channels.adminLogResults', 'events' => [ChannelAdminLogEvent, ChannelAdminLogEvent], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +channels.adminLogResults={_='channels.adminLogResults', events={ChannelAdminLogEvent}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/channels.channelParticipants.md b/old_docs/API_docs_v44/constructors/channels.channelParticipants.md index 780dc002..d401bb96 100644 --- a/old_docs/API_docs_v44/constructors/channels.channelParticipants.md +++ b/old_docs/API_docs_v44/constructors/channels.channelParticipants.md @@ -17,7 +17,7 @@ Represents multiple channel participants |----------|---------------|----------|-------------| |count|[int](../types/int.md) | Yes|Total number of participants that correspond to the given query| |participants|Array of [ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participants| -|users|Array of [User](../types/User.md) | Yes|Users| +|users|Array of [User](../types/User.md) | Yes|Users mentioned in participant info| diff --git a/old_docs/API_docs_v44/constructors/channels.channelParticipantsNotModified.md b/old_docs/API_docs_v44/constructors/channels.channelParticipantsNotModified.md new file mode 100644 index 00000000..aebdbb36 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/channels.channelParticipantsNotModified.md @@ -0,0 +1,34 @@ +--- +title: channels.channelParticipantsNotModified +description: No new participant info could be found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_channelParticipantsNotModified.html +--- +# Constructor: channels.channelParticipantsNotModified +[Back to constructors index](index.md) + + + +No new participant info could be found + + + + +### Type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md) + + +### Example: + +```php +$channels.channelParticipantsNotModified = ['_' => 'channels.channelParticipantsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +channels.channelParticipantsNotModified={_='channels.channelParticipantsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/chat.md b/old_docs/API_docs_v44/constructors/chat.md index ec5a9f20..16a4e157 100644 --- a/old_docs/API_docs_v44/constructors/chat.md +++ b/old_docs/API_docs_v44/constructors/chat.md @@ -17,8 +17,6 @@ Info about a group |creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of the group| |kicked|[Bool](../types/Bool.md) | Optional|Whether the current user was kicked from the group| |left|[Bool](../types/Bool.md) | Optional|Whether the current user has left the group| -|admins\_enabled|[Bool](../types/Bool.md) | Optional|Admins enabled?| -|admin|[Bool](../types/Bool.md) | Optional|Admin?| |deactivated|[Bool](../types/Bool.md) | Optional|Whether the group was [migrated](https://core.telegram.org/api/channel)| |id|[int](../types/int.md) | Yes|ID of the group| |title|[string](../types/string.md) | Yes|Title| @@ -27,6 +25,8 @@ Info about a group |date|[int](../types/int.md) | Yes|Date of creation of the group| |version|[int](../types/int.md) | Yes|Used in basic groups to reorder updates and make sure that all of them were received.| |migrated\_to|[InputChannel](../types/InputChannel.md) | Optional|Means this chat was [upgraded](https://core.telegram.org/api/channel) to a supergroup| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|[Admin rights](https://core.telegram.org/api/rights) of the user in the group| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|[Default banned rights](https://core.telegram.org/api/rights) of all users in the group| @@ -36,14 +36,14 @@ Info about a group ### Example: ```php -$chat = ['_' => 'chat', 'creator' => Bool, 'kicked' => Bool, 'left' => Bool, 'admins_enabled' => Bool, 'admin' => Bool, 'deactivated' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto, 'participants_count' => int, 'date' => int, 'version' => int, 'migrated_to' => InputChannel]; +$chat = ['_' => 'chat', 'creator' => Bool, 'kicked' => Bool, 'left' => Bool, 'deactivated' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto, 'participants_count' => int, 'date' => int, 'version' => int, 'migrated_to' => InputChannel, 'admin_rights' => ChatAdminRights, 'default_banned_rights' => ChatBannedRights]; ``` Or, if you're into Lua: ```lua -chat={_='chat', creator=Bool, kicked=Bool, left=Bool, admins_enabled=Bool, admin=Bool, deactivated=Bool, id=int, title='string', photo=ChatPhoto, participants_count=int, date=int, version=int, migrated_to=InputChannel} +chat={_='chat', creator=Bool, kicked=Bool, left=Bool, deactivated=Bool, id=int, title='string', photo=ChatPhoto, participants_count=int, date=int, version=int, migrated_to=InputChannel, admin_rights=ChatAdminRights, default_banned_rights=ChatBannedRights} ``` diff --git a/old_docs/API_docs_v44/constructors/chatAdminRights.md b/old_docs/API_docs_v44/constructors/chatAdminRights.md new file mode 100644 index 00000000..f80ff21b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/chatAdminRights.md @@ -0,0 +1,45 @@ +--- +title: chatAdminRights +description: Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatAdminRights +[Back to constructors index](index.md) + + + +Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|change\_info|[Bool](../types/Bool.md) | Optional|If set, allows the admin to modify the description of the [channel/supergroup](https://core.telegram.org/api/channel)| +|post\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to post messages in the [channel](https://core.telegram.org/api/channel)| +|edit\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also edit messages from other admins in the [channel](https://core.telegram.org/api/channel)| +|delete\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also delete messages from other admins in the [channel](https://core.telegram.org/api/channel)| +|ban\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to ban users from the [channel/supergroup](https://core.telegram.org/api/channel)| +|invite\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to invite users in the [channel/supergroup](https://core.telegram.org/api/channel)| +|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to pin messages in the [channel/supergroup](https://core.telegram.org/api/channel)| +|add\_admins|[Bool](../types/Bool.md) | Optional|If set, allows the admin to add other admins with the same (or more limited) permissions in the [channel/supergroup](https://core.telegram.org/api/channel)| + + + +### Type: [ChatAdminRights](../types/ChatAdminRights.md) + + +### Example: + +```php +$chatAdminRights = ['_' => 'chatAdminRights', 'change_info' => Bool, 'post_messages' => Bool, 'edit_messages' => Bool, 'delete_messages' => Bool, 'ban_users' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'add_admins' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +chatAdminRights={_='chatAdminRights', change_info=Bool, post_messages=Bool, edit_messages=Bool, delete_messages=Bool, ban_users=Bool, invite_users=Bool, pin_messages=Bool, add_admins=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/chatBannedRights.md b/old_docs/API_docs_v44/constructors/chatBannedRights.md new file mode 100644 index 00000000..f53db6d3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/chatBannedRights.md @@ -0,0 +1,50 @@ +--- +title: chatBannedRights +description: Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatBannedRights +[Back to constructors index](index.md) + + + +Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|view\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to view messages in a [supergroup/channel/chat](https://core.telegram.org/api/channel)| +|send\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send messages in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_media|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send any media in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_stickers|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_gifs|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send gifs in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_games|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send games in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_inline|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to use inline bots in a [supergroup/chat](https://core.telegram.org/api/channel)| +|embed\_links|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to embed links in the messages of a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_polls|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)| +|change\_info|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to change the description of a [supergroup/chat](https://core.telegram.org/api/channel)| +|invite\_users|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to invite users in a [supergroup/chat](https://core.telegram.org/api/channel)| +|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to pin messages in a [supergroup/chat](https://core.telegram.org/api/channel)| +|until\_date|[int](../types/int.md) | Yes|Validity of said permissions (0 = forever, forever = 2^31-1 for now).| + + + +### Type: [ChatBannedRights](../types/ChatBannedRights.md) + + +### Example: + +```php +$chatBannedRights = ['_' => 'chatBannedRights', 'view_messages' => Bool, 'send_messages' => Bool, 'send_media' => Bool, 'send_stickers' => Bool, 'send_gifs' => Bool, 'send_games' => Bool, 'send_inline' => Bool, 'embed_links' => Bool, 'send_polls' => Bool, 'change_info' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'until_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatBannedRights={_='chatBannedRights', view_messages=Bool, send_messages=Bool, send_media=Bool, send_stickers=Bool, send_gifs=Bool, send_games=Bool, send_inline=Bool, embed_links=Bool, send_polls=Bool, change_info=Bool, invite_users=Bool, pin_messages=Bool, until_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/chatFull.md b/old_docs/API_docs_v44/constructors/chatFull.md index cc9c30b0..432c6e3e 100644 --- a/old_docs/API_docs_v44/constructors/chatFull.md +++ b/old_docs/API_docs_v44/constructors/chatFull.md @@ -14,12 +14,17 @@ Detailed chat info | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we change the username of this chat| +|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available| |id|[int](../types/int.md) | Yes|ID of the chat| +|about|[string](../types/string.md) | Yes|About string for this chat| |participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Participant list| |chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|Notification settings| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| |exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Chat invite| -|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes|Bot info| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Optional|Info about bots that are in this chat| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| @@ -29,14 +34,14 @@ Detailed chat info ### Example: ```php -$chatFull = ['_' => 'chatFull', 'id' => int, 'participants' => ChatParticipants, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo]]; +$chatFull = ['_' => 'chatFull', 'can_set_username' => Bool, 'has_scheduled' => Bool, 'id' => int, 'about' => 'string', 'participants' => ChatParticipants, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'pinned_msg_id' => int, 'folder_id' => int]; ``` Or, if you're into Lua: ```lua -chatFull={_='chatFull', id=int, participants=ChatParticipants, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}} +chatFull={_='chatFull', can_set_username=Bool, has_scheduled=Bool, id=int, about='string', participants=ChatParticipants, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, pinned_msg_id=int, folder_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/chatInvite.md b/old_docs/API_docs_v44/constructors/chatInvite.md index f86b9090..2afd78fc 100644 --- a/old_docs/API_docs_v44/constructors/chatInvite.md +++ b/old_docs/API_docs_v44/constructors/chatInvite.md @@ -19,6 +19,9 @@ Chat invite info |public|[Bool](../types/Bool.md) | Optional|Whether this is a public [channel/supergroup](https://core.telegram.org/api/channel)| |megagroup|[Bool](../types/Bool.md) | Optional|Whether this is a [supergroup](https://core.telegram.org/api/channel)| |title|[string](../types/string.md) | Yes|Chat/supergroup/channel title| +|photo|[Photo](../types/Photo.md) | Optional|Chat/supergroup/channel photo| +|participants\_count|[int](../types/int.md) | Yes|Participant count| +|participants|Array of [User](../types/User.md) | Optional|A few of the participants that are in the group| @@ -28,14 +31,14 @@ Chat invite info ### Example: ```php -$chatInvite = ['_' => 'chatInvite', 'channel' => Bool, 'broadcast' => Bool, 'public' => Bool, 'megagroup' => Bool, 'title' => 'string']; +$chatInvite = ['_' => 'chatInvite', 'channel' => Bool, 'broadcast' => Bool, 'public' => Bool, 'megagroup' => Bool, 'title' => 'string', 'photo' => Photo, 'participants_count' => int, 'participants' => [User, User]]; ``` Or, if you're into Lua: ```lua -chatInvite={_='chatInvite', channel=Bool, broadcast=Bool, public=Bool, megagroup=Bool, title='string'} +chatInvite={_='chatInvite', channel=Bool, broadcast=Bool, public=Bool, megagroup=Bool, title='string', photo=Photo, participants_count=int, participants={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/chatInvitePeek.md b/old_docs/API_docs_v44/constructors/chatInvitePeek.md new file mode 100644 index 00000000..2fe543de --- /dev/null +++ b/old_docs/API_docs_v44/constructors/chatInvitePeek.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/chatOnlines.md b/old_docs/API_docs_v44/constructors/chatOnlines.md new file mode 100644 index 00000000..f86f29d3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/chatOnlines.md @@ -0,0 +1,38 @@ +--- +title: chatOnlines +description: Number of online users in a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatOnlines +[Back to constructors index](index.md) + + + +Number of online users in a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|onlines|[int](../types/int.md) | Yes|Number of online users| + + + +### Type: [ChatOnlines](../types/ChatOnlines.md) + + +### Example: + +```php +$chatOnlines = ['_' => 'chatOnlines', 'onlines' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatOnlines={_='chatOnlines', onlines=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/chatParticipants.md b/old_docs/API_docs_v44/constructors/chatParticipants.md index 44c9d94e..b8a2497e 100644 --- a/old_docs/API_docs_v44/constructors/chatParticipants.md +++ b/old_docs/API_docs_v44/constructors/chatParticipants.md @@ -15,7 +15,7 @@ Group members. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[int](../types/int.md) | Yes|Group identifier| -|participants|Array of [ChatParticipant](../types/ChatParticipant.md) | Yes|Participants| +|participants|Array of [ChatParticipant](../types/ChatParticipant.md) | Yes|List of group members| |version|[int](../types/int.md) | Yes|Group version number| diff --git a/old_docs/API_docs_v44/constructors/chatPhoto.md b/old_docs/API_docs_v44/constructors/chatPhoto.md index dd55b37a..3ebb67cd 100644 --- a/old_docs/API_docs_v44/constructors/chatPhoto.md +++ b/old_docs/API_docs_v44/constructors/chatPhoto.md @@ -14,8 +14,10 @@ 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| @@ -25,14 +27,14 @@ Group profile photo. ### Example: ```php -$chatPhoto = ['_' => 'chatPhoto', 'photo_small' => FileLocation, 'photo_big' => FileLocation]; +$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} +chatPhoto={_='chatPhoto', has_video=Bool, photo_small=FileLocation, photo_big=FileLocation, dc_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/codeSettings.md b/old_docs/API_docs_v44/constructors/codeSettings.md new file mode 100644 index 00000000..b8a92d46 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/codeSettings.md @@ -0,0 +1,44 @@ +--- +title: codeSettings +description: Settings used by telegram servers for sending the confirm code. + +Example implementations: [telegram for android](https://github.com/DrKLO/Telegram/blob/master/TMessagesProj/src/main/java/org/telegram/ui/LoginActivity.java), [tdlib](https://github.com/tdlib/td/tree/master/td/telegram/SendCodeHelper.cpp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: codeSettings +[Back to constructors index](index.md) + + + +Settings used by telegram servers for sending the confirm code. + +Example implementations: [telegram for android](https://github.com/DrKLO/Telegram/blob/master/TMessagesProj/src/main/java/org/telegram/ui/LoginActivity.java), [tdlib](https://github.com/tdlib/td/tree/master/td/telegram/SendCodeHelper.cpp). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Whether to allow phone verification via [phone calls](https://core.telegram.org/api/auth).| +|current\_number|[Bool](../types/Bool.md) | Optional|Pass true if the phone number is used on the current device. Ignored if allow\_flashcall is not set.| +|allow\_app\_hash|[Bool](../types/Bool.md) | Optional|If a token that will be included in eventually sent SMSs is required: required in newer versions of android, to use the [android SMS receiver APIs](https://developers.google.com/identity/sms-retriever/overview)| + + + +### Type: [CodeSettings](../types/CodeSettings.md) + + +### Example: + +```php +$codeSettings = ['_' => 'codeSettings', 'allow_flashcall' => Bool, 'current_number' => Bool, 'allow_app_hash' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +codeSettings={_='codeSettings', allow_flashcall=Bool, current_number=Bool, allow_app_hash=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/config.md b/old_docs/API_docs_v44/constructors/config.md index 27c06241..01a2019d 100644 --- a/old_docs/API_docs_v44/constructors/config.md +++ b/old_docs/API_docs_v44/constructors/config.md @@ -14,11 +14,19 @@ Current configuration | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|phonecalls\_enabled|[Bool](../types/Bool.md) | Optional|Whether phone calls can be used| +|default\_p2p\_contacts|[Bool](../types/Bool.md) | Optional|Whether the client should use P2P by default for phone calls with contacts| +|preload\_featured\_stickers|[Bool](../types/Bool.md) | Optional|Whether the client should preload featured stickers| +|ignore\_phone\_entities|[Bool](../types/Bool.md) | Optional|Whether the client should ignore phone [entities](https://core.telegram.org/api/entities)| +|revoke\_pm\_inbox|[Bool](../types/Bool.md) | Optional|Whether incoming private messages can be deleted for both participants| +|blocked\_mode|[Bool](../types/Bool.md) | Optional|Indicates that telegram is *probably* censored by governments/ISPs in the current region| +|pfs\_enabled|[Bool](../types/Bool.md) | Optional|Whether [pfs](https://core.telegram.org/api/pfs) was used| |date|[int](../types/int.md) | Yes|Current date at the server| |expires|[int](../types/int.md) | Yes|Expiration date of this config: when it expires it'll have to be refetched using [help.getConfig](../methods/help.getConfig.md)| |test\_mode|[Bool](../types/Bool.md) | Yes|Whether we're connected to the test DCs| |this\_dc|[int](../types/int.md) | Yes|ID of the DC that returned the reply| -|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC options| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC IP list| +|dc\_txt\_domain\_name|[string](../types/string.md) | Yes|Domain name for fetching encrypted DC list from DNS TXT record| |chat\_size\_max|[int](../types/int.md) | Yes|Maximum member count for normal [groups](https://core.telegram.org/api/channel)| |megagroup\_size\_max|[int](../types/int.md) | Yes|Maximum member count for [supergroups](https://core.telegram.org/api/channel)| |forwarded\_count\_max|[int](../types/int.md) | Yes|Maximum number of messages that can be forwarded at once using [messages.forwardMessages](../methods/messages.forwardMessages.md).| @@ -28,10 +36,35 @@ Current configuration |online\_cloud\_timeout\_ms|[int](../types/int.md) | Yes|If we are offline, but were online from some other client in last `online_cloud_timeout_ms` milliseconds after we had gone offline, then delay offline notification for `notify_cloud_delay_ms` milliseconds.| |notify\_cloud\_delay\_ms|[int](../types/int.md) | Yes|If we are offline, but online from some other client then delay sending the offline notification for `notify_cloud_delay_ms` milliseconds.| |notify\_default\_delay\_ms|[int](../types/int.md) | Yes|If some other client is online, then delay notification for `notification_default_delay_ms` milliseconds| -|chat\_big\_size|[int](../types/int.md) | Yes|Chat big size| |push\_chat\_period\_ms|[int](../types/int.md) | Yes|Not for client use| |push\_chat\_limit|[int](../types/int.md) | Yes|Not for client use| -|disabled\_features|Array of [DisabledFeature](../types/DisabledFeature.md) | Yes|Disabled features| +|saved\_gifs\_limit|[int](../types/int.md) | Yes|Maximum count of saved gifs| +|edit\_time\_limit|[int](../types/int.md) | Yes|Only messages with age smaller than the one specified can be edited| +|revoke\_time\_limit|[int](../types/int.md) | Yes|Only channel/supergroup messages with age smaller than the specified can be deleted| +|revoke\_pm\_time\_limit|[int](../types/int.md) | Yes|Only private messages with age smaller than the specified can be deleted| +|rating\_e\_decay|[int](../types/int.md) | Yes|Exponential decay rate for computing [top peer rating](https://core.telegram.org/api/top-rating)| +|stickers\_recent\_limit|[int](../types/int.md) | Yes|Maximum number of recent stickers| +|stickers\_faved\_limit|[int](../types/int.md) | Yes|Maximum number of faved stickers| +|channels\_read\_media\_period|[int](../types/int.md) | Yes|Indicates that round videos (video notes) and voice messages sent in channels and older than the specified period must be marked as read| +|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions| +|pinned\_dialogs\_count\_max|[int](../types/int.md) | Yes|Maximum count of pinned dialogs| +|pinned\_infolder\_count\_max|[int](../types/int.md) | Yes|Maximum count of dialogs per folder| +|call\_receive\_timeout\_ms|[int](../types/int.md) | Yes|Maximum allowed outgoing ring time in VoIP calls: if the user we're calling doesn't reply within the specified time (in milliseconds), we should hang up the call| +|call\_ring\_timeout\_ms|[int](../types/int.md) | Yes|Maximum allowed incoming ring time in VoIP calls: if the current user doesn't reply within the specified time (in milliseconds), the call will be automatically refused| +|call\_connect\_timeout\_ms|[int](../types/int.md) | Yes|VoIP connection timeout: if the instance of libtgvoip on the other side of the call doesn't connect to our instance of libtgvoip within the specified time (in milliseconds), the call must be aborted| +|call\_packet\_timeout\_ms|[int](../types/int.md) | Yes|If during a VoIP call a packet isn't received for the specified period of time, the call must be aborted| +|me\_url\_prefix|[string](../types/string.md) | Yes|The domain to use to parse in-app links.
For example t.me indicates that t.me/username links should parsed to @username, t.me/addsticker/name should be parsed to the appropriate stickerset and so on...| +|autoupdate\_url\_prefix|[string](../types/string.md) | Optional|URL to use to auto-update the current app| +|gif\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use to search for GIFs| +|venue\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use to search for venues| +|img\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use for image search| +|static\_maps\_provider|[string](../types/string.md) | Optional|ID of the map provider to use for venues| +|caption\_length\_max|[int](../types/int.md) | Yes|Maximum length of caption (length in utf8 codepoints)| +|message\_length\_max|[int](../types/int.md) | Yes|Maximum length of messages (length in utf8 codepoints)| +|webfile\_dc\_id|[int](../types/int.md) | Yes|DC ID to use to download [webfiles](https://core.telegram.org/api/files)| +|suggested\_lang\_code|[string](../types/string.md) | Optional|Suggested language code| +|lang\_pack\_version|[int](../types/int.md) | Optional|Language pack version| +|base\_lang\_pack\_version|[int](../types/int.md) | Optional|Basic language pack version| @@ -41,14 +74,14 @@ Current configuration ### Example: ```php -$config = ['_' => 'config', 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'chat_size_max' => int, 'megagroup_size_max' => int, 'forwarded_count_max' => int, 'online_update_period_ms' => int, 'offline_blur_timeout_ms' => int, 'offline_idle_timeout_ms' => int, 'online_cloud_timeout_ms' => int, 'notify_cloud_delay_ms' => int, 'notify_default_delay_ms' => int, 'chat_big_size' => int, 'push_chat_period_ms' => int, 'push_chat_limit' => int, 'disabled_features' => [DisabledFeature, DisabledFeature]]; +$config = ['_' => 'config', 'phonecalls_enabled' => Bool, 'default_p2p_contacts' => Bool, 'preload_featured_stickers' => Bool, 'ignore_phone_entities' => Bool, 'revoke_pm_inbox' => Bool, 'blocked_mode' => Bool, 'pfs_enabled' => Bool, 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'dc_txt_domain_name' => 'string', 'chat_size_max' => int, 'megagroup_size_max' => int, 'forwarded_count_max' => int, 'online_update_period_ms' => int, 'offline_blur_timeout_ms' => int, 'offline_idle_timeout_ms' => int, 'online_cloud_timeout_ms' => int, 'notify_cloud_delay_ms' => int, 'notify_default_delay_ms' => int, 'push_chat_period_ms' => int, 'push_chat_limit' => int, 'saved_gifs_limit' => int, 'edit_time_limit' => int, 'revoke_time_limit' => int, 'revoke_pm_time_limit' => int, 'rating_e_decay' => int, 'stickers_recent_limit' => int, 'stickers_faved_limit' => int, 'channels_read_media_period' => int, 'tmp_sessions' => int, 'pinned_dialogs_count_max' => int, 'pinned_infolder_count_max' => int, 'call_receive_timeout_ms' => int, 'call_ring_timeout_ms' => int, 'call_connect_timeout_ms' => int, 'call_packet_timeout_ms' => int, 'me_url_prefix' => 'string', 'autoupdate_url_prefix' => 'string', 'gif_search_username' => 'string', 'venue_search_username' => 'string', 'img_search_username' => 'string', 'static_maps_provider' => 'string', 'caption_length_max' => int, 'message_length_max' => int, 'webfile_dc_id' => int, 'suggested_lang_code' => 'string', 'lang_pack_version' => int, 'base_lang_pack_version' => int]; ``` Or, if you're into Lua: ```lua -config={_='config', date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, chat_size_max=int, megagroup_size_max=int, forwarded_count_max=int, online_update_period_ms=int, offline_blur_timeout_ms=int, offline_idle_timeout_ms=int, online_cloud_timeout_ms=int, notify_cloud_delay_ms=int, notify_default_delay_ms=int, chat_big_size=int, push_chat_period_ms=int, push_chat_limit=int, disabled_features={DisabledFeature}} +config={_='config', phonecalls_enabled=Bool, default_p2p_contacts=Bool, preload_featured_stickers=Bool, ignore_phone_entities=Bool, revoke_pm_inbox=Bool, blocked_mode=Bool, pfs_enabled=Bool, date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, dc_txt_domain_name='string', chat_size_max=int, megagroup_size_max=int, forwarded_count_max=int, online_update_period_ms=int, offline_blur_timeout_ms=int, offline_idle_timeout_ms=int, online_cloud_timeout_ms=int, notify_cloud_delay_ms=int, notify_default_delay_ms=int, push_chat_period_ms=int, push_chat_limit=int, saved_gifs_limit=int, edit_time_limit=int, revoke_time_limit=int, revoke_pm_time_limit=int, rating_e_decay=int, stickers_recent_limit=int, stickers_faved_limit=int, channels_read_media_period=int, tmp_sessions=int, pinned_dialogs_count_max=int, pinned_infolder_count_max=int, call_receive_timeout_ms=int, call_ring_timeout_ms=int, call_connect_timeout_ms=int, call_packet_timeout_ms=int, me_url_prefix='string', autoupdate_url_prefix='string', gif_search_username='string', venue_search_username='string', img_search_username='string', static_maps_provider='string', caption_length_max=int, message_length_max=int, webfile_dc_id=int, suggested_lang_code='string', lang_pack_version=int, base_lang_pack_version=int} ``` diff --git a/old_docs/API_docs_v44/constructors/contactLinkContact.md b/old_docs/API_docs_v44/constructors/contactLinkContact.md deleted file mode 100644 index 6db4f73a..00000000 --- a/old_docs/API_docs_v44/constructors/contactLinkContact.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: contactLinkContact -description: Contact link contact -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: contactLinkContact -[Back to constructors index](index.md) - - - -Contact link contact - - - - -### Type: [ContactLink](../types/ContactLink.md) - - -### Example: - -```php -$contactLinkContact = ['_' => 'contactLinkContact']; -``` - - -Or, if you're into Lua: - -```lua -contactLinkContact={_='contactLinkContact'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contactLinkHasPhone.md b/old_docs/API_docs_v44/constructors/contactLinkHasPhone.md deleted file mode 100644 index 5a78aa08..00000000 --- a/old_docs/API_docs_v44/constructors/contactLinkHasPhone.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: contactLinkHasPhone -description: Contact link has phone -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: contactLinkHasPhone -[Back to constructors index](index.md) - - - -Contact link has phone - - - - -### Type: [ContactLink](../types/ContactLink.md) - - -### Example: - -```php -$contactLinkHasPhone = ['_' => 'contactLinkHasPhone']; -``` - - -Or, if you're into Lua: - -```lua -contactLinkHasPhone={_='contactLinkHasPhone'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contactLinkNone.md b/old_docs/API_docs_v44/constructors/contactLinkNone.md deleted file mode 100644 index d0d3caf8..00000000 --- a/old_docs/API_docs_v44/constructors/contactLinkNone.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: contactLinkNone -description: Contact link none -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: contactLinkNone -[Back to constructors index](index.md) - - - -Contact link none - - - - -### Type: [ContactLink](../types/ContactLink.md) - - -### Example: - -```php -$contactLinkNone = ['_' => 'contactLinkNone']; -``` - - -Or, if you're into Lua: - -```lua -contactLinkNone={_='contactLinkNone'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contactLinkUnknown.md b/old_docs/API_docs_v44/constructors/contactLinkUnknown.md deleted file mode 100644 index 7b704b3d..00000000 --- a/old_docs/API_docs_v44/constructors/contactLinkUnknown.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: contactLinkUnknown -description: Contact link unknown -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: contactLinkUnknown -[Back to constructors index](index.md) - - - -Contact link unknown - - - - -### Type: [ContactLink](../types/ContactLink.md) - - -### Example: - -```php -$contactLinkUnknown = ['_' => 'contactLinkUnknown']; -``` - - -Or, if you're into Lua: - -```lua -contactLinkUnknown={_='contactLinkUnknown'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contactSuggested.md b/old_docs/API_docs_v44/constructors/contactSuggested.md deleted file mode 100644 index 4a2b5d35..00000000 --- a/old_docs/API_docs_v44/constructors/contactSuggested.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: contactSuggested -description: Contact suggested -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: contactSuggested -[Back to constructors index](index.md) - - - -Contact suggested - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|mutual\_contacts|[int](../types/int.md) | Yes|Mutual contacts| - - - -### Type: [ContactSuggested](../types/ContactSuggested.md) - - -### Example: - -```php -$contactSuggested = ['_' => 'contactSuggested', 'user_id' => int, 'mutual_contacts' => int]; -``` - - -Or, if you're into Lua: - -```lua -contactSuggested={_='contactSuggested', user_id=int, mutual_contacts=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contacts.blocked.md b/old_docs/API_docs_v44/constructors/contacts.blocked.md index d1013bf1..ffb372a0 100644 --- a/old_docs/API_docs_v44/constructors/contacts.blocked.md +++ b/old_docs/API_docs_v44/constructors/contacts.blocked.md @@ -15,8 +15,8 @@ Full list of blocked users. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked| -|users|Array of [User](../types/User.md) | Yes|Users| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|List of blocked users| +|users|Array of [User](../types/User.md) | Yes|List of users| diff --git a/old_docs/API_docs_v44/constructors/contacts.blockedSlice.md b/old_docs/API_docs_v44/constructors/contacts.blockedSlice.md index 8f0031bf..53ac1194 100644 --- a/old_docs/API_docs_v44/constructors/contacts.blockedSlice.md +++ b/old_docs/API_docs_v44/constructors/contacts.blockedSlice.md @@ -16,8 +16,8 @@ Incomplete list of blocked users. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |count|[int](../types/int.md) | Yes|Total number of elements in the list| -|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked| -|users|Array of [User](../types/User.md) | Yes|Users| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|List of blocked users| +|users|Array of [User](../types/User.md) | Yes|List of users| diff --git a/old_docs/API_docs_v44/constructors/contacts.contacts.md b/old_docs/API_docs_v44/constructors/contacts.contacts.md index 6a7c30f3..9fe17c08 100644 --- a/old_docs/API_docs_v44/constructors/contacts.contacts.md +++ b/old_docs/API_docs_v44/constructors/contacts.contacts.md @@ -15,8 +15,9 @@ The current user's contact list and info on users. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|contacts|Array of [Contact](../types/Contact.md) | Yes|Contacts| -|users|Array of [User](../types/User.md) | Yes|Users| +|contacts|Array of [Contact](../types/Contact.md) | Yes|Contact list| +|saved\_count|[int](../types/int.md) | Yes|Number of contacts that were saved successfully| +|users|Array of [User](../types/User.md) | Yes|User list| @@ -26,14 +27,14 @@ The current user's contact list and info on users. ### Example: ```php -$contacts.contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'users' => [User, User]]; +$contacts.contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'saved_count' => int, 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -contacts.contacts={_='contacts.contacts', contacts={Contact}, users={User}} +contacts.contacts={_='contacts.contacts', contacts={Contact}, saved_count=int, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/contacts.found.md b/old_docs/API_docs_v44/constructors/contacts.found.md index 8f7d97e3..7d92cac8 100644 --- a/old_docs/API_docs_v44/constructors/contacts.found.md +++ b/old_docs/API_docs_v44/constructors/contacts.found.md @@ -15,9 +15,10 @@ Users found by name substring and auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|results|Array of [Peer](../types/Peer.md) | Yes|Results| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|my\_results|Array of [Peer](../types/Peer.md) | Yes|Personalized results| +|results|Array of [Peer](../types/Peer.md) | Yes|List of found user identifiers| +|chats|Array of [Chat](../types/Chat.md) | Yes|Found chats| +|users|Array of [User](../types/User.md) | Yes|List of users| @@ -27,14 +28,14 @@ Users found by name substring and auxiliary data. ### Example: ```php -$contacts.found = ['_' => 'contacts.found', 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]]; +$contacts.found = ['_' => 'contacts.found', 'my_results' => [Peer, Peer], 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -contacts.found={_='contacts.found', results={Peer}, chats={Chat}, users={User}} +contacts.found={_='contacts.found', my_results={Peer}, results={Peer}, chats={Chat}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/contacts.importedContacts.md b/old_docs/API_docs_v44/constructors/contacts.importedContacts.md index 66f35c8e..ac4419b8 100644 --- a/old_docs/API_docs_v44/constructors/contacts.importedContacts.md +++ b/old_docs/API_docs_v44/constructors/contacts.importedContacts.md @@ -15,9 +15,10 @@ Info on succesfully imported contacts. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|Imported| -|retry\_contacts|Array of [long](../types/long.md) | Yes|Retry importing contacts whose client IDs appear here| -|users|Array of [User](../types/User.md) | Yes|Users| +|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|List of succesfully imported contacts| +|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes|Popular contacts| +|retry\_contacts|Array of [long](../types/long.md) | Yes|List of contact ids that could not be imported due to system limitation and will need to be imported at a later date.
Parameter added in [Layer 13](https://core.telegram.org/api/layers#layer-13)| +|users|Array of [User](../types/User.md) | Yes|List of users| @@ -27,14 +28,14 @@ Info on succesfully imported contacts. ### Example: ```php -$contacts.importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'retry_contacts' => [long, long], 'users' => [User, User]]; +$contacts.importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'popular_invites' => [PopularContact, PopularContact], 'retry_contacts' => [long, long], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -contacts.importedContacts={_='contacts.importedContacts', imported={ImportedContact}, retry_contacts={long}, users={User}} +contacts.importedContacts={_='contacts.importedContacts', imported={ImportedContact}, popular_invites={PopularContact}, retry_contacts={long}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/contacts.link.md b/old_docs/API_docs_v44/constructors/contacts.link.md deleted file mode 100644 index 44f83d10..00000000 --- a/old_docs/API_docs_v44/constructors/contacts.link.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: contacts.link -description: Link -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/contacts_link.html ---- -# Constructor: contacts.link -[Back to constructors index](index.md) - - - -Link - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|my\_link|[ContactLink](../types/ContactLink.md) | Yes|My link| -|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes|Foreign link| -|user|[User](../types/User.md) | Optional|User| - - - -### Type: [contacts.Link](../types/contacts.Link.md) - - -### Example: - -```php -$contacts.link = ['_' => 'contacts.link', 'my_link' => ContactLink, 'foreign_link' => ContactLink, 'user' => User]; -``` - - -Or, if you're into Lua: - -```lua -contacts.link={_='contacts.link', my_link=ContactLink, foreign_link=ContactLink, user=User} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contacts.suggested.md b/old_docs/API_docs_v44/constructors/contacts.suggested.md deleted file mode 100644 index fb01c306..00000000 --- a/old_docs/API_docs_v44/constructors/contacts.suggested.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: contacts.suggested -description: Suggested -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/contacts_suggested.html ---- -# Constructor: contacts.suggested -[Back to constructors index](index.md) - - - -Suggested - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|results|Array of [ContactSuggested](../types/ContactSuggested.md) | Yes|Results| -|users|Array of [User](../types/User.md) | Yes|Users| - - - -### Type: [contacts.Suggested](../types/contacts.Suggested.md) - - -### Example: - -```php -$contacts.suggested = ['_' => 'contacts.suggested', 'results' => [ContactSuggested, ContactSuggested], 'users' => [User, User]]; -``` - - -Or, if you're into Lua: - -```lua -contacts.suggested={_='contacts.suggested', results={ContactSuggested}, users={User}} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/contacts.topPeers.md b/old_docs/API_docs_v44/constructors/contacts.topPeers.md new file mode 100644 index 00000000..77a65e77 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/contacts.topPeers.md @@ -0,0 +1,41 @@ +--- +title: contacts.topPeers +description: Top peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeers.html +--- +# Constructor: contacts.topPeers +[Back to constructors index](index.md) + + + +Top peers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes|Top peers by top peer category| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeers = ['_' => 'contacts.topPeers', 'categories' => [TopPeerCategoryPeers, TopPeerCategoryPeers], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeers={_='contacts.topPeers', categories={TopPeerCategoryPeers}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/contacts.topPeersDisabled.md b/old_docs/API_docs_v44/constructors/contacts.topPeersDisabled.md new file mode 100644 index 00000000..e699f926 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/contacts.topPeersDisabled.md @@ -0,0 +1,34 @@ +--- +title: contacts.topPeersDisabled +description: Top peers disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeersDisabled.html +--- +# Constructor: contacts.topPeersDisabled +[Back to constructors index](index.md) + + + +Top peers disabled + + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeersDisabled = ['_' => 'contacts.topPeersDisabled']; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeersDisabled={_='contacts.topPeersDisabled'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/contacts.topPeersNotModified.md b/old_docs/API_docs_v44/constructors/contacts.topPeersNotModified.md new file mode 100644 index 00000000..260e3614 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/contacts.topPeersNotModified.md @@ -0,0 +1,34 @@ +--- +title: contacts.topPeersNotModified +description: Top peer info hasn't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeersNotModified.html +--- +# Constructor: contacts.topPeersNotModified +[Back to constructors index](index.md) + + + +Top peer info hasn't changed + + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeersNotModified = ['_' => 'contacts.topPeersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeersNotModified={_='contacts.topPeersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/dataJSON.md b/old_docs/API_docs_v44/constructors/dataJSON.md new file mode 100644 index 00000000..5038e19b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/dataJSON.md @@ -0,0 +1,38 @@ +--- +title: dataJSON +description: Represents a json-encoded object +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dataJSON +[Back to constructors index](index.md) + + + +Represents a json-encoded object + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[string](../types/string.md) | Yes|JSON-encoded object| + + + +### Type: [DataJSON](../types/DataJSON.md) + + +### Example: + +```php +$dataJSON = ['_' => 'dataJSON', 'data' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +dataJSON={_='dataJSON', data='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/dcOption.md b/old_docs/API_docs_v44/constructors/dcOption.md index e506f02b..b6b7a166 100644 --- a/old_docs/API_docs_v44/constructors/dcOption.md +++ b/old_docs/API_docs_v44/constructors/dcOption.md @@ -16,9 +16,13 @@ Data centre |----------|---------------|----------|-------------| |ipv6|[Bool](../types/Bool.md) | Optional|Whether the specified IP is an IPv6 address| |media\_only|[Bool](../types/Bool.md) | Optional|Whether this DC should only be used to [download or upload files](https://core.telegram.org/api/files)| +|tcpo\_only|[Bool](../types/Bool.md) | Optional|Whether this DC only supports connection with [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)| +|cdn|[Bool](../types/Bool.md) | Optional|Whether this is a [CDN DC](https://core.telegram.org/cdn).| +|static|[Bool](../types/Bool.md) | Optional|If set, this IP should be used when connecting through a proxy| |id|[int](../types/int.md) | Yes|DC ID| |ip\_address|[string](../types/string.md) | Yes|IP address of DC| |port|[int](../types/int.md) | Yes|Port| +|secret|[bytes](../types/bytes.md) | Optional|If the `tcpo_only` flag is set, specifies the secret to use when connecting using [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)| @@ -28,14 +32,14 @@ Data centre ### Example: ```php -$dcOption = ['_' => 'dcOption', 'ipv6' => Bool, 'media_only' => Bool, 'id' => int, 'ip_address' => 'string', 'port' => int]; +$dcOption = ['_' => 'dcOption', 'ipv6' => Bool, 'media_only' => Bool, 'tcpo_only' => Bool, 'cdn' => Bool, 'static' => Bool, 'id' => int, 'ip_address' => 'string', 'port' => int, 'secret' => 'bytes']; ``` Or, if you're into Lua: ```lua -dcOption={_='dcOption', ipv6=Bool, media_only=Bool, id=int, ip_address='string', port=int} +dcOption={_='dcOption', ipv6=Bool, media_only=Bool, tcpo_only=Bool, cdn=Bool, static=Bool, id=int, ip_address='string', port=int, secret='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/dialog.md b/old_docs/API_docs_v44/constructors/dialog.md index ed585a8d..a63cc274 100644 --- a/old_docs/API_docs_v44/constructors/dialog.md +++ b/old_docs/API_docs_v44/constructors/dialog.md @@ -14,11 +14,18 @@ Chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Is the dialog pinned| +|unread\_mark|[Bool](../types/Bool.md) | Optional|Whether the chat was manually marked as unread| |peer|[Peer](../types/Peer.md) | Yes|The chat| |top\_message|[int](../types/int.md) | Yes|The latest message ID| |read\_inbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| |unread\_count|[int](../types/int.md) | Yes|Number of unread messages| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|Notification settings| +|unread\_mentions\_count|[int](../types/int.md) | Yes|Number of unread mentions| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| +|pts|[int](../types/int.md) | Optional|[PTS](https://core.telegram.org/api/updates)| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional|Message draft| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| @@ -28,14 +35,14 @@ Chat ### Example: ```php -$dialog = ['_' => 'dialog', 'peer' => Peer, 'top_message' => int, 'read_inbox_max_id' => int, 'unread_count' => int, 'notify_settings' => PeerNotifySettings]; +$dialog = ['_' => 'dialog', 'pinned' => Bool, 'unread_mark' => Bool, 'peer' => Peer, 'top_message' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'unread_mentions_count' => int, 'notify_settings' => PeerNotifySettings, 'pts' => int, 'draft' => DraftMessage, 'folder_id' => int]; ``` Or, if you're into Lua: ```lua -dialog={_='dialog', peer=Peer, top_message=int, read_inbox_max_id=int, unread_count=int, notify_settings=PeerNotifySettings} +dialog={_='dialog', pinned=Bool, unread_mark=Bool, peer=Peer, top_message=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, unread_mentions_count=int, notify_settings=PeerNotifySettings, pts=int, draft=DraftMessage, folder_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/dialogChannel.md b/old_docs/API_docs_v44/constructors/dialogChannel.md deleted file mode 100644 index ace46ff4..00000000 --- a/old_docs/API_docs_v44/constructors/dialogChannel.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: dialogChannel -description: Dialog channel -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: dialogChannel -[Back to constructors index](index.md) - - - -Dialog channel - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Peer](../types/Peer.md) | Yes|Peer| -|top\_message|[int](../types/int.md) | Yes|Top message| -|top\_important\_message|[int](../types/int.md) | Yes|Top important message| -|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Read inbox max ID| -|unread\_count|[int](../types/int.md) | Yes|Unread count| -|unread\_important\_count|[int](../types/int.md) | Yes|Unread important count| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|Notify settings| -|pts|[int](../types/int.md) | Yes|Pts| - - - -### Type: [Dialog](../types/Dialog.md) - - -### Example: - -```php -$dialogChannel = ['_' => 'dialogChannel', 'peer' => Peer, 'top_message' => int, 'top_important_message' => int, 'read_inbox_max_id' => int, 'unread_count' => int, 'unread_important_count' => int, 'notify_settings' => PeerNotifySettings, 'pts' => int]; -``` - - -Or, if you're into Lua: - -```lua -dialogChannel={_='dialogChannel', peer=Peer, top_message=int, top_important_message=int, read_inbox_max_id=int, unread_count=int, unread_important_count=int, notify_settings=PeerNotifySettings, pts=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/dialogFilter.md b/old_docs/API_docs_v44/constructors/dialogFilter.md new file mode 100644 index 00000000..ac0abe3e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/dialogFilter.md @@ -0,0 +1,51 @@ +--- +title: dialogFilter +description: Dialog filter AKA [folder](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogFilter +[Back to constructors index](index.md) + + + +Dialog filter AKA [folder](https://core.telegram.org/api/folders) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|contacts|[Bool](../types/Bool.md) | Optional|Whether to include all contacts in this [folder](https://core.telegram.org/api/folders)| +|non\_contacts|[Bool](../types/Bool.md) | Optional|Whether to include all non-contacts in this [folder](https://core.telegram.org/api/folders)| +|groups|[Bool](../types/Bool.md) | Optional|Whether to include all groups in this [folder](https://core.telegram.org/api/folders)| +|broadcasts|[Bool](../types/Bool.md) | Optional|Whether to include all channels in this [folder](https://core.telegram.org/api/folders)| +|bots|[Bool](../types/Bool.md) | Optional|Whether to include all bots in this [folder](https://core.telegram.org/api/folders)| +|exclude\_muted|[Bool](../types/Bool.md) | Optional|Whether to exclude muted chats from this [folder](https://core.telegram.org/api/folders)| +|exclude\_read|[Bool](../types/Bool.md) | Optional|Whether to exclude read chats from this [folder](https://core.telegram.org/api/folders)| +|exclude\_archived|[Bool](../types/Bool.md) | Optional|Whether to exclude archived chats from this [folder](https://core.telegram.org/api/folders)| +|id|[int](../types/int.md) | Yes|[Folder](https://core.telegram.org/api/folders) ID| +|title|[string](../types/string.md) | Yes|[Folder](https://core.telegram.org/api/folders) name| +|emoticon|[string](../types/string.md) | Optional|[Folder](https://core.telegram.org/api/folders) emoticon| +|pinned\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|Pinned chats, [folders](https://core.telegram.org/api/folders) can have unlimited pinned chats| +|include\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|Include the following chats in this [folder](https://core.telegram.org/api/folders)| +|exclude\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|Exclude the following chats from this [folder](https://core.telegram.org/api/folders)| + + + +### Type: [DialogFilter](../types/DialogFilter.md) + + +### Example: + +```php +$dialogFilter = ['_' => 'dialogFilter', 'contacts' => Bool, 'non_contacts' => Bool, 'groups' => Bool, 'broadcasts' => Bool, 'bots' => Bool, 'exclude_muted' => Bool, 'exclude_read' => Bool, 'exclude_archived' => Bool, 'id' => int, 'title' => 'string', 'emoticon' => 'string', 'pinned_peers' => [InputPeer, InputPeer], 'include_peers' => [InputPeer, InputPeer], 'exclude_peers' => [InputPeer, InputPeer]]; +``` + + +Or, if you're into Lua: + +```lua +dialogFilter={_='dialogFilter', contacts=Bool, non_contacts=Bool, groups=Bool, broadcasts=Bool, bots=Bool, exclude_muted=Bool, exclude_read=Bool, exclude_archived=Bool, id=int, title='string', emoticon='string', pinned_peers={InputPeer}, include_peers={InputPeer}, exclude_peers={InputPeer}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/dialogFilterSuggested.md b/old_docs/API_docs_v44/constructors/dialogFilterSuggested.md new file mode 100644 index 00000000..03cb146d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/dialogFilterSuggested.md @@ -0,0 +1,39 @@ +--- +title: dialogFilterSuggested +description: Suggested [folders](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogFilterSuggested +[Back to constructors index](index.md) + + + +Suggested [folders](https://core.telegram.org/api/folders) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|filter|[DialogFilter](../types/DialogFilter.md) | Yes|[Folder info](https://core.telegram.org/api/folders)| +|description|[string](../types/string.md) | Yes|[Folder](https://core.telegram.org/api/folders) description| + + + +### Type: [DialogFilterSuggested](../types/DialogFilterSuggested.md) + + +### Example: + +```php +$dialogFilterSuggested = ['_' => 'dialogFilterSuggested', 'filter' => DialogFilter, 'description' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +dialogFilterSuggested={_='dialogFilterSuggested', filter=DialogFilter, description='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/dialogFolder.md b/old_docs/API_docs_v44/constructors/dialogFolder.md new file mode 100644 index 00000000..9c8b3ac1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/dialogFolder.md @@ -0,0 +1,45 @@ +--- +title: dialogFolder +description: Dialog in folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogFolder +[Back to constructors index](index.md) + + + +Dialog in folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Is this folder pinned| +|folder|[Folder](../types/Folder.md) | Yes|The folder| +|peer|[Peer](../types/Peer.md) | Yes|Peer in folder| +|top\_message|[int](../types/int.md) | Yes|Latest message ID of dialog| +|unread\_muted\_peers\_count|[int](../types/int.md) | Yes|Number of unread muted peers in folder| +|unread\_unmuted\_peers\_count|[int](../types/int.md) | Yes|Number of unread unmuted peers in folder| +|unread\_muted\_messages\_count|[int](../types/int.md) | Yes|Number of unread messages from muted peers in folder| +|unread\_unmuted\_messages\_count|[int](../types/int.md) | Yes|Number of unread messages from unmuted peers in folder| + + + +### Type: [Dialog](../types/Dialog.md) + + +### Example: + +```php +$dialogFolder = ['_' => 'dialogFolder', 'pinned' => Bool, 'folder' => Folder, 'peer' => Peer, 'top_message' => int, 'unread_muted_peers_count' => int, 'unread_unmuted_peers_count' => int, 'unread_muted_messages_count' => int, 'unread_unmuted_messages_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +dialogFolder={_='dialogFolder', pinned=Bool, folder=Folder, peer=Peer, top_message=int, unread_muted_peers_count=int, unread_unmuted_peers_count=int, unread_muted_messages_count=int, unread_unmuted_messages_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/videoEmpty.md b/old_docs/API_docs_v44/constructors/dialogPeer.md similarity index 56% rename from old_docs/API_docs_v44/constructors/videoEmpty.md rename to old_docs/API_docs_v44/constructors/dialogPeer.md index 7f1713f2..5a2f5e8d 100644 --- a/old_docs/API_docs_v44/constructors/videoEmpty.md +++ b/old_docs/API_docs_v44/constructors/dialogPeer.md @@ -1,37 +1,37 @@ --- -title: videoEmpty -description: Empty video +title: dialogPeer +description: Peer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: videoEmpty +# Constructor: dialogPeer [Back to constructors index](index.md) -Empty video +Peer ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| +|peer|[Peer](../types/Peer.md) | Yes|Peer| -### Type: [Video](../types/Video.md) +### Type: [DialogPeer](../types/DialogPeer.md) ### Example: ```php -$videoEmpty = ['_' => 'videoEmpty', 'id' => long]; +$dialogPeer = ['_' => 'dialogPeer', 'peer' => Peer]; ``` Or, if you're into Lua: ```lua -videoEmpty={_='videoEmpty', id=long} +dialogPeer={_='dialogPeer', peer=Peer} ``` diff --git a/old_docs/API_docs_v44/constructors/dialogPeerFolder.md b/old_docs/API_docs_v44/constructors/dialogPeerFolder.md new file mode 100644 index 00000000..51f7855f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/dialogPeerFolder.md @@ -0,0 +1,38 @@ +--- +title: dialogPeerFolder +description: [Peer folder](https://core.telegram.org/api/folders#peer-folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogPeerFolder +[Back to constructors index](index.md) + + + +[Peer folder](https://core.telegram.org/api/folders#peer-folders) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| + + + +### Type: [DialogPeer](../types/DialogPeer.md) + + +### Example: + +```php +$dialogPeerFolder = ['_' => 'dialogPeerFolder', 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +dialogPeerFolder={_='dialogPeerFolder', folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/disabledFeature.md b/old_docs/API_docs_v44/constructors/disabledFeature.md deleted file mode 100644 index 8edf492a..00000000 --- a/old_docs/API_docs_v44/constructors/disabledFeature.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: disabledFeature -description: Disabled feature -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: disabledFeature -[Back to constructors index](index.md) - - - -Disabled feature - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|feature|[string](../types/string.md) | Yes|Feature| -|description|[string](../types/string.md) | Yes|Description| - - - -### Type: [DisabledFeature](../types/DisabledFeature.md) - - -### Example: - -```php -$disabledFeature = ['_' => 'disabledFeature', 'feature' => 'string', 'description' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -disabledFeature={_='disabledFeature', feature='string', description='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/document.md b/old_docs/API_docs_v44/constructors/document.md index d1368e16..c44e8d96 100644 --- a/old_docs/API_docs_v44/constructors/document.md +++ b/old_docs/API_docs_v44/constructors/document.md @@ -16,10 +16,12 @@ Document |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Document ID| |access\_hash|[long](../types/long.md) | Yes|Check sum, dependant on document ID| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| |date|[int](../types/int.md) | Yes|Creation date| |mime\_type|[string](../types/string.md) | Yes|MIME type| |size|[int](../types/int.md) | Yes|Size| -|thumb|[PhotoSize](../types/PhotoSize.md) | Optional|Thumbnail| +|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| @@ -31,14 +33,14 @@ Document ### Example: ```php -$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumb' => 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, date=int, mime_type='string', size=int, thumb=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}} ``` diff --git a/old_docs/API_docs_v44/constructors/documentAttributeAudio.md b/old_docs/API_docs_v44/constructors/documentAttributeAudio.md index 012ef905..2f38c9e0 100644 --- a/old_docs/API_docs_v44/constructors/documentAttributeAudio.md +++ b/old_docs/API_docs_v44/constructors/documentAttributeAudio.md @@ -14,9 +14,11 @@ Represents an audio file | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|voice|[Bool](../types/Bool.md) | Optional|Whether this is a voice message| |duration|[int](../types/int.md) | Optional|Duration in seconds| -|title|[string](../types/string.md) | Yes|Name of song| -|performer|[string](../types/string.md) | Yes|Performer| +|title|[string](../types/string.md) | Optional|Name of song| +|performer|[string](../types/string.md) | Optional|Performer| +|waveform|[bytes](../types/bytes.md) | Optional|Waveform| @@ -26,14 +28,14 @@ Represents an audio file ### Example: ```php -$documentAttributeAudio = ['_' => 'documentAttributeAudio', 'duration' => int, 'title' => 'string', 'performer' => 'string']; +$documentAttributeAudio = ['_' => 'documentAttributeAudio', 'voice' => Bool, 'duration' => int, 'title' => 'string', 'performer' => 'string', 'waveform' => 'bytes']; ``` Or, if you're into Lua: ```lua -documentAttributeAudio={_='documentAttributeAudio', duration=int, title='string', performer='string'} +documentAttributeAudio={_='documentAttributeAudio', voice=Bool, duration=int, title='string', performer='string', waveform='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/documentAttributeHasStickers.md b/old_docs/API_docs_v44/constructors/documentAttributeHasStickers.md new file mode 100644 index 00000000..ef501438 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/documentAttributeHasStickers.md @@ -0,0 +1,33 @@ +--- +title: documentAttributeHasStickers +description: Whether the current document has stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeHasStickers +[Back to constructors index](index.md) + + + +Whether the current document has stickers attached + + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeHasStickers = ['_' => 'documentAttributeHasStickers']; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeHasStickers={_='documentAttributeHasStickers'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/documentAttributeSticker.md b/old_docs/API_docs_v44/constructors/documentAttributeSticker.md index 094b3daa..a556b961 100644 --- a/old_docs/API_docs_v44/constructors/documentAttributeSticker.md +++ b/old_docs/API_docs_v44/constructors/documentAttributeSticker.md @@ -14,8 +14,10 @@ Defines a sticker | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|mask|[Bool](../types/Bool.md) | Optional|Whether this is a mask sticker| |alt|[string](../types/string.md) | Yes|Alternative emoji representation of sticker| |stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Associated stickerset| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional|Mask coordinates (if this is a mask sticker, attached to a photo)| @@ -25,14 +27,14 @@ Defines a sticker ### Example: ```php -$documentAttributeSticker = ['_' => 'documentAttributeSticker', 'alt' => 'string', 'stickerset' => InputStickerSet]; +$documentAttributeSticker = ['_' => 'documentAttributeSticker', 'mask' => Bool, 'alt' => 'string', 'stickerset' => InputStickerSet, 'mask_coords' => MaskCoords]; ``` Or, if you're into Lua: ```lua -documentAttributeSticker={_='documentAttributeSticker', alt='string', stickerset=InputStickerSet} +documentAttributeSticker={_='documentAttributeSticker', mask=Bool, alt='string', stickerset=InputStickerSet, mask_coords=MaskCoords} ``` diff --git a/old_docs/API_docs_v44/constructors/documentAttributeVideo.md b/old_docs/API_docs_v44/constructors/documentAttributeVideo.md index 8d57ec4f..c829c191 100644 --- a/old_docs/API_docs_v44/constructors/documentAttributeVideo.md +++ b/old_docs/API_docs_v44/constructors/documentAttributeVideo.md @@ -14,6 +14,8 @@ Defines a video | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|round\_message|[Bool](../types/Bool.md) | Optional|Whether this is a round video| +|supports\_streaming|[Bool](../types/Bool.md) | Optional|Whether the video supports streaming| |duration|[int](../types/int.md) | Optional|Duration in seconds| |w|[int](../types/int.md) | Optional|Video width| |h|[int](../types/int.md) | Optional|Video height| @@ -26,14 +28,14 @@ Defines a video ### Example: ```php -$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'duration' => int, 'w' => int, 'h' => int]; +$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'round_message' => Bool, 'supports_streaming' => Bool, 'duration' => int, 'w' => int, 'h' => int]; ``` Or, if you're into Lua: ```lua -documentAttributeVideo={_='documentAttributeVideo', duration=int, w=int, h=int} +documentAttributeVideo={_='documentAttributeVideo', round_message=Bool, supports_streaming=Bool, duration=int, w=int, h=int} ``` diff --git a/old_docs/API_docs_v44/constructors/draftMessage.md b/old_docs/API_docs_v44/constructors/draftMessage.md new file mode 100644 index 00000000..5cad61d8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/draftMessage.md @@ -0,0 +1,42 @@ +--- +title: draftMessage +description: Represents a message [draft](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessage +[Back to constructors index](index.md) + + + +Represents a message [draft](https://core.telegram.org/api/drafts). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Whether no webpage preview will be generated| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|The message this message will reply to| +|message|[string](../types/string.md) | Yes|The draft| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text.| +|date|[int](../types/int.md) | Yes|Date of last update of the draft.| + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +```php +$draftMessage = ['_' => 'draftMessage', 'no_webpage' => Bool, 'reply_to_msg_id' => int, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +draftMessage={_='draftMessage', no_webpage=Bool, reply_to_msg_id=int, message='string', entities={MessageEntity}, date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/draftMessageEmpty.md b/old_docs/API_docs_v44/constructors/draftMessageEmpty.md new file mode 100644 index 00000000..e56048e4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/draftMessageEmpty.md @@ -0,0 +1,38 @@ +--- +title: draftMessageEmpty +description: Empty draft +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessageEmpty +[Back to constructors index](index.md) + + + +Empty draft + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Optional|When was the draft last updated| + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +```php +$draftMessageEmpty = ['_' => 'draftMessageEmpty', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +draftMessageEmpty={_='draftMessageEmpty', date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/emojiKeyword.md b/old_docs/API_docs_v44/constructors/emojiKeyword.md new file mode 100644 index 00000000..10a1c616 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/emojiKeyword.md @@ -0,0 +1,39 @@ +--- +title: emojiKeyword +description: Emoji keyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeyword +[Back to constructors index](index.md) + + + +Emoji keyword + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|keyword|[string](../types/string.md) | Yes|Keyword| +|emoticons|Array of [string](../types/string.md) | Yes|Emojis associated to keyword| + + + +### Type: [EmojiKeyword](../types/EmojiKeyword.md) + + +### Example: + +```php +$emojiKeyword = ['_' => 'emojiKeyword', 'keyword' => 'string', 'emoticons' => ['string', 'string']]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeyword={_='emojiKeyword', keyword='string', emoticons={'string'}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/emojiKeywordDeleted.md b/old_docs/API_docs_v44/constructors/emojiKeywordDeleted.md new file mode 100644 index 00000000..5223282f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/emojiKeywordDeleted.md @@ -0,0 +1,39 @@ +--- +title: emojiKeywordDeleted +description: Deleted emoji keyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeywordDeleted +[Back to constructors index](index.md) + + + +Deleted emoji keyword + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|keyword|[string](../types/string.md) | Yes|Keyword| +|emoticons|Array of [string](../types/string.md) | Yes|Emojis that were associated to keyword| + + + +### Type: [EmojiKeyword](../types/EmojiKeyword.md) + + +### Example: + +```php +$emojiKeywordDeleted = ['_' => 'emojiKeywordDeleted', 'keyword' => 'string', 'emoticons' => ['string', 'string']]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeywordDeleted={_='emojiKeywordDeleted', keyword='string', emoticons={'string'}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/emojiKeywordsDifference.md b/old_docs/API_docs_v44/constructors/emojiKeywordsDifference.md new file mode 100644 index 00000000..717179d1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/emojiKeywordsDifference.md @@ -0,0 +1,41 @@ +--- +title: emojiKeywordsDifference +description: Changes to emoji keywords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeywordsDifference +[Back to constructors index](index.md) + + + +Changes to emoji keywords + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code for keywords| +|from\_version|[int](../types/int.md) | Yes|Previous emoji keyword list version| +|version|[int](../types/int.md) | Yes|Current version of emoji keyword list| +|keywords|Array of [EmojiKeyword](../types/EmojiKeyword.md) | Yes|Emojis associated to keywords| + + + +### Type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + + +### Example: + +```php +$emojiKeywordsDifference = ['_' => 'emojiKeywordsDifference', 'lang_code' => 'string', 'from_version' => int, 'version' => int, 'keywords' => [EmojiKeyword, EmojiKeyword]]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeywordsDifference={_='emojiKeywordsDifference', lang_code='string', from_version=int, version=int, keywords={EmojiKeyword}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/emojiLanguage.md b/old_docs/API_docs_v44/constructors/emojiLanguage.md new file mode 100644 index 00000000..f7cc4ddf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/emojiLanguage.md @@ -0,0 +1,38 @@ +--- +title: emojiLanguage +description: Emoji language +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiLanguage +[Back to constructors index](index.md) + + + +Emoji language + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| + + + +### Type: [EmojiLanguage](../types/EmojiLanguage.md) + + +### Example: + +```php +$emojiLanguage = ['_' => 'emojiLanguage', 'lang_code' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +emojiLanguage={_='emojiLanguage', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/emojiURL.md b/old_docs/API_docs_v44/constructors/emojiURL.md new file mode 100644 index 00000000..e4b11c6c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/emojiURL.md @@ -0,0 +1,38 @@ +--- +title: emojiURL +description: An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiURL +[Back to constructors index](index.md) + + + +An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation| + + + +### Type: [EmojiURL](../types/EmojiURL.md) + + +### Example: + +```php +$emojiURL = ['_' => 'emojiURL', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +emojiURL={_='emojiURL', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/encryptedChatRequested.md b/old_docs/API_docs_v44/constructors/encryptedChatRequested.md index 99809e9b..3f7bdfa9 100644 --- a/old_docs/API_docs_v44/constructors/encryptedChatRequested.md +++ b/old_docs/API_docs_v44/constructors/encryptedChatRequested.md @@ -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'} ``` diff --git a/old_docs/API_docs_v44/constructors/encryptedMessage.md b/old_docs/API_docs_v44/constructors/encryptedMessage.md index 42397df3..784f72f6 100644 --- a/old_docs/API_docs_v44/constructors/encryptedMessage.md +++ b/old_docs/API_docs_v44/constructors/encryptedMessage.md @@ -16,7 +16,7 @@ Encrypted message. |----------|---------------|----------|-------------| |chat\_id|[int](../types/int.md) | Yes|ID of encrypted chat| |date|[int](../types/int.md) | Yes|Date of sending| -|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|Decrypted message| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes| |file|[EncryptedFile](../types/EncryptedFile.md) | Optional|Attached encrypted file| diff --git a/old_docs/API_docs_v44/constructors/encryptedMessageService.md b/old_docs/API_docs_v44/constructors/encryptedMessageService.md index 1ce100a5..51e9de4e 100644 --- a/old_docs/API_docs_v44/constructors/encryptedMessageService.md +++ b/old_docs/API_docs_v44/constructors/encryptedMessageService.md @@ -16,7 +16,7 @@ Encrypted service message |----------|---------------|----------|-------------| |chat\_id|[int](../types/int.md) | Yes|ID of encrypted chat| |date|[int](../types/int.md) | Yes|Date of sending| -|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|Decrypted message| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes| diff --git a/old_docs/API_docs_v44/constructors/exportedMessageLink.md b/old_docs/API_docs_v44/constructors/exportedMessageLink.md new file mode 100644 index 00000000..ec35c657 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/exportedMessageLink.md @@ -0,0 +1,39 @@ +--- +title: exportedMessageLink +description: Link to a message in a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: exportedMessageLink +[Back to constructors index](index.md) + + + +Link to a message in a supergroup/channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|link|[string](../types/string.md) | Yes|URL| +|html|[string](../types/string.md) | Yes|Embed code| + + + +### Type: [ExportedMessageLink](../types/ExportedMessageLink.md) + + +### Example: + +```php +$exportedMessageLink = ['_' => 'exportedMessageLink', 'link' => 'string', 'html' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +exportedMessageLink={_='exportedMessageLink', link='string', html='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/fileHash.md b/old_docs/API_docs_v44/constructors/fileHash.md new file mode 100644 index 00000000..ab9e46e8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/fileHash.md @@ -0,0 +1,40 @@ +--- +title: fileHash +description: SHA256 Hash of an uploaded file, to be checked for validity after download +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileHash +[Back to constructors index](index.md) + + + +SHA256 Hash of an uploaded file, to be checked for validity after download + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset from where to start computing SHA-256 hash| +|limit|[int](../types/int.md) | Yes|Length| +|hash|[bytes](../types/bytes.md) | Yes|SHA-256 Hash of file chunk, to be checked for validity after download| + + + +### Type: [FileHash](../types/FileHash.md) + + +### Example: + +```php +$fileHash = ['_' => 'fileHash', 'offset' => int, 'limit' => int, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +fileHash={_='fileHash', offset=int, limit=int, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/fileLocation.md b/old_docs/API_docs_v44/constructors/fileLocationToBeDeprecated.md similarity index 53% rename from old_docs/API_docs_v44/constructors/fileLocation.md rename to old_docs/API_docs_v44/constructors/fileLocationToBeDeprecated.md index 02f96b77..715304b3 100644 --- a/old_docs/API_docs_v44/constructors/fileLocation.md +++ b/old_docs/API_docs_v44/constructors/fileLocationToBeDeprecated.md @@ -1,23 +1,21 @@ --- -title: fileLocation -description: File location +title: fileLocationToBeDeprecated +description: Indicates the location of a photo, will be deprecated soon image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: fileLocation +# Constructor: fileLocationToBeDeprecated [Back to constructors index](index.md) -File location +Indicates the location of a photo, will be deprecated soon ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|dc\_id|[int](../types/int.md) | Yes|DC ID| |volume\_id|[long](../types/long.md) | Yes|Volume ID| |local\_id|[int](../types/int.md) | Yes|Local ID| -|secret|[long](../types/long.md) | Yes|Secret| @@ -27,14 +25,14 @@ File location ### Example: ```php -$fileLocation = ['_' => 'fileLocation', 'dc_id' => int, 'volume_id' => long, 'local_id' => int, 'secret' => long]; +$fileLocationToBeDeprecated = ['_' => 'fileLocationToBeDeprecated', 'volume_id' => long, 'local_id' => int]; ``` Or, if you're into Lua: ```lua -fileLocation={_='fileLocation', dc_id=int, volume_id=long, local_id=int, secret=long} +fileLocationToBeDeprecated={_='fileLocationToBeDeprecated', volume_id=long, local_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/fileLocationUnavailable.md b/old_docs/API_docs_v44/constructors/fileLocationUnavailable.md deleted file mode 100644 index 849c9168..00000000 --- a/old_docs/API_docs_v44/constructors/fileLocationUnavailable.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: fileLocationUnavailable -description: File location unavailable -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: fileLocationUnavailable -[Back to constructors index](index.md) - - - -File location unavailable - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|volume\_id|[long](../types/long.md) | Yes|Volume ID| -|local\_id|[int](../types/int.md) | Yes|Local ID| -|secret|[long](../types/long.md) | Yes|Secret| - - - -### Type: [FileLocation](../types/FileLocation.md) - - -### Example: - -```php -$fileLocationUnavailable = ['_' => 'fileLocationUnavailable', 'volume_id' => long, 'local_id' => int, 'secret' => long]; -``` - - -Or, if you're into Lua: - -```lua -fileLocationUnavailable={_='fileLocationUnavailable', volume_id=long, local_id=int, secret=long} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/folder.md b/old_docs/API_docs_v44/constructors/folder.md new file mode 100644 index 00000000..669096a8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/folder.md @@ -0,0 +1,43 @@ +--- +title: folder +description: Folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: folder +[Back to constructors index](index.md) + + + +Folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|autofill\_new\_broadcasts|[Bool](../types/Bool.md) | Optional|Automatically add new channels to this folder| +|autofill\_public\_groups|[Bool](../types/Bool.md) | Optional|Automatically add joined new public supergroups to this folder| +|autofill\_new\_correspondents|[Bool](../types/Bool.md) | Optional|Automatically add new private chats to this folder| +|id|[int](../types/int.md) | Yes|Folder ID| +|title|[string](../types/string.md) | Yes|Folder title| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Folder picture| + + + +### Type: [Folder](../types/Folder.md) + + +### Example: + +```php +$folder = ['_' => 'folder', 'autofill_new_broadcasts' => Bool, 'autofill_public_groups' => Bool, 'autofill_new_correspondents' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto]; +``` + + +Or, if you're into Lua: + +```lua +folder={_='folder', autofill_new_broadcasts=Bool, autofill_public_groups=Bool, autofill_new_correspondents=Bool, id=int, title='string', photo=ChatPhoto} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/folderPeer.md b/old_docs/API_docs_v44/constructors/folderPeer.md new file mode 100644 index 00000000..d0e85630 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/folderPeer.md @@ -0,0 +1,39 @@ +--- +title: folderPeer +description: Peer in a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: folderPeer +[Back to constructors index](index.md) + + + +Peer in a folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Folder peer info| +|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| + + + +### Type: [FolderPeer](../types/FolderPeer.md) + + +### Example: + +```php +$folderPeer = ['_' => 'folderPeer', 'peer' => Peer, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +folderPeer={_='folderPeer', peer=Peer, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/game.md b/old_docs/API_docs_v44/constructors/game.md new file mode 100644 index 00000000..812c2707 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/game.md @@ -0,0 +1,44 @@ +--- +title: game +description: Indicates an already sent game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: game +[Back to constructors index](index.md) + + + +Indicates an already sent game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID of the game| +|access\_hash|[long](../types/long.md) | Yes|Access hash of the game| +|short\_name|[string](../types/string.md) | Yes|Short name for the game| +|title|[string](../types/string.md) | Yes|Title of the game| +|description|[string](../types/string.md) | Yes|Game description| +|photo|[Photo](../types/Photo.md) | Optional|Game preview| +|document|[Document](../types/Document.md) | Optional|Optional attached document| + + + +### Type: [Game](../types/Game.md) + + +### Example: + +```php +$game = ['_' => 'game', 'id' => long, 'access_hash' => long, 'short_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'document' => Document]; +``` + + +Or, if you're into Lua: + +```lua +game={_='game', id=long, access_hash=long, short_name='string', title='string', description='string', photo=Photo, document=Document} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/geoPoint.md b/old_docs/API_docs_v44/constructors/geoPoint.md index f59c06b0..98db4e1a 100644 --- a/old_docs/API_docs_v44/constructors/geoPoint.md +++ b/old_docs/API_docs_v44/constructors/geoPoint.md @@ -16,6 +16,7 @@ GeoPoint. |----------|---------------|----------|-------------| |long|[double](../types/double.md) | Yes|Longtitude| |lat|[double](../types/double.md) | Yes|Latitude| +|access\_hash|[long](../types/long.md) | Yes|Access hash| @@ -25,14 +26,14 @@ GeoPoint. ### Example: ```php -$geoPoint = ['_' => 'geoPoint', 'long' => double, 'lat' => double]; +$geoPoint = ['_' => 'geoPoint', 'long' => double, 'lat' => double, 'access_hash' => long]; ``` Or, if you're into Lua: ```lua -geoPoint={_='geoPoint', long=double, lat=double} +geoPoint={_='geoPoint', long=double, lat=double, access_hash=long} ``` diff --git a/old_docs/API_docs_v44/constructors/globalPrivacySettings.md b/old_docs/API_docs_v44/constructors/globalPrivacySettings.md new file mode 100644 index 00000000..bb26bd1c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/globalPrivacySettings.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.appChangelog.md b/old_docs/API_docs_v44/constructors/help.appChangelog.md deleted file mode 100644 index ac4e984c..00000000 --- a/old_docs/API_docs_v44/constructors/help.appChangelog.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: help.appChangelog -description: App changelog -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/help_appChangelog.html ---- -# Constructor: help.appChangelog -[Back to constructors index](index.md) - - - -App changelog - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|text|[string](../types/string.md) | Yes|Text| - - - -### Type: [help.AppChangelog](../types/help.AppChangelog.md) - - -### Example: - -```php -$help.appChangelog = ['_' => 'help.appChangelog', 'text' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -help.appChangelog={_='help.appChangelog', text='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/help.appChangelogEmpty.md b/old_docs/API_docs_v44/constructors/help.appChangelogEmpty.md deleted file mode 100644 index 62becd4a..00000000 --- a/old_docs/API_docs_v44/constructors/help.appChangelogEmpty.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: help.appChangelogEmpty -description: Empty app changelog -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/help_appChangelogEmpty.html ---- -# Constructor: help.appChangelogEmpty -[Back to constructors index](index.md) - - - -Empty app changelog - - - - -### Type: [help.AppChangelog](../types/help.AppChangelog.md) - - -### Example: - -```php -$help.appChangelogEmpty = ['_' => 'help.appChangelogEmpty']; -``` - - -Or, if you're into Lua: - -```lua -help.appChangelogEmpty={_='help.appChangelogEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/help.appUpdate.md b/old_docs/API_docs_v44/constructors/help.appUpdate.md index a91304c4..88ba8462 100644 --- a/old_docs/API_docs_v44/constructors/help.appUpdate.md +++ b/old_docs/API_docs_v44/constructors/help.appUpdate.md @@ -15,10 +15,13 @@ An update is available for the application. | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|can\_not\_skip|[Bool](../types/Bool.md) | Optional|Unskippable, the new info must be shown to the user (with a popup or something else)| |id|[int](../types/int.md) | Yes|Update ID| -|critical|[Bool](../types/Bool.md) | Yes|Critical?| -|url|[string](../types/string.md) | Yes|Application download URL| +|version|[string](../types/string.md) | Yes|New version name| |text|[string](../types/string.md) | Yes|Text description of the update| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|[Message entities for styled text](https://core.telegram.org/api/entities)| +|document|[Document](../types/Document.md) | Optional|Application binary| +|url|[string](../types/string.md) | Optional|Application download URL| @@ -28,14 +31,14 @@ An update is available for the application. ### Example: ```php -$help.appUpdate = ['_' => 'help.appUpdate', 'id' => int, 'critical' => Bool, 'url' => 'string', 'text' => 'string']; +$help.appUpdate = ['_' => 'help.appUpdate', 'can_not_skip' => Bool, 'id' => int, 'version' => 'string', 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'document' => Document, 'url' => 'string']; ``` Or, if you're into Lua: ```lua -help.appUpdate={_='help.appUpdate', id=int, critical=Bool, url='string', text='string'} +help.appUpdate={_='help.appUpdate', can_not_skip=Bool, id=int, version='string', text='string', entities={MessageEntity}, document=Document, url='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/help.deepLinkInfo.md b/old_docs/API_docs_v44/constructors/help.deepLinkInfo.md new file mode 100644 index 00000000..3758b43b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.deepLinkInfo.md @@ -0,0 +1,41 @@ +--- +title: help.deepLinkInfo +description: Deep linking info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_deepLinkInfo.html +--- +# Constructor: help.deepLinkInfo +[Back to constructors index](index.md) + + + +Deep linking info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|update\_app|[Bool](../types/Bool.md) | Optional|An update of the app is required to parse this link| +|message|[string](../types/string.md) | Yes|Message to show to the user| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| + + + +### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + + +### Example: + +```php +$help.deepLinkInfo = ['_' => 'help.deepLinkInfo', 'update_app' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +help.deepLinkInfo={_='help.deepLinkInfo', update_app=Bool, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.deepLinkInfoEmpty.md b/old_docs/API_docs_v44/constructors/help.deepLinkInfoEmpty.md new file mode 100644 index 00000000..016b846a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.deepLinkInfoEmpty.md @@ -0,0 +1,34 @@ +--- +title: help.deepLinkInfoEmpty +description: Deep link info empty +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_deepLinkInfoEmpty.html +--- +# Constructor: help.deepLinkInfoEmpty +[Back to constructors index](index.md) + + + +Deep link info empty + + + + +### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + + +### Example: + +```php +$help.deepLinkInfoEmpty = ['_' => 'help.deepLinkInfoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +help.deepLinkInfoEmpty={_='help.deepLinkInfoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.inviteText.md b/old_docs/API_docs_v44/constructors/help.inviteText.md index 4e220483..4baf6633 100644 --- a/old_docs/API_docs_v44/constructors/help.inviteText.md +++ b/old_docs/API_docs_v44/constructors/help.inviteText.md @@ -1,6 +1,6 @@ --- title: help.inviteText -description: Text of a text message with an invitation to install application. +description: Text of a text message with an invitation to install Telegram. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/constructors/help_inviteText.html --- @@ -9,13 +9,13 @@ redirect_from: /API_docs/constructors/help_inviteText.html -Text of a text message with an invitation to install application. +Text of a text message with an invitation to install Telegram. ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Text of a message| +|message|[string](../types/string.md) | Yes|Text of the message| diff --git a/old_docs/API_docs_v44/constructors/help.passportConfig.md b/old_docs/API_docs_v44/constructors/help.passportConfig.md new file mode 100644 index 00000000..29fadabb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.passportConfig.md @@ -0,0 +1,40 @@ +--- +title: help.passportConfig +description: Telegram [passport](https://core.telegram.org/passport) configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_passportConfig.html +--- +# Constructor: help.passportConfig +[Back to constructors index](index.md) + + + +Telegram [passport](https://core.telegram.org/passport) configuration + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|countries\_langs|[DataJSON](../types/DataJSON.md) | Yes|Localization| + + + +### Type: [help.PassportConfig](../types/help.PassportConfig.md) + + +### Example: + +```php +$help.passportConfig = ['_' => 'help.passportConfig', 'hash' => int, 'countries_langs' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +help.passportConfig={_='help.passportConfig', hash=int, countries_langs=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.passportConfigNotModified.md b/old_docs/API_docs_v44/constructors/help.passportConfigNotModified.md new file mode 100644 index 00000000..f84475c7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.passportConfigNotModified.md @@ -0,0 +1,34 @@ +--- +title: help.passportConfigNotModified +description: Password configuration not modified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_passportConfigNotModified.html +--- +# Constructor: help.passportConfigNotModified +[Back to constructors index](index.md) + + + +Password configuration not modified + + + + +### Type: [help.PassportConfig](../types/help.PassportConfig.md) + + +### Example: + +```php +$help.passportConfigNotModified = ['_' => 'help.passportConfigNotModified']; +``` + + +Or, if you're into Lua: + +```lua +help.passportConfigNotModified={_='help.passportConfigNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.promoData.md b/old_docs/API_docs_v44/constructors/help.promoData.md new file mode 100644 index 00000000..5a8fb4cc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.promoData.md @@ -0,0 +1,45 @@ +--- +title: help.promoData +description: MTProxy/Public Service Announcement information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_promoData.html +--- +# Constructor: help.promoData +[Back to constructors index](index.md) + + + +MTProxy/Public Service Announcement information + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|proxy|[Bool](../types/Bool.md) | Optional|MTProxy-related channel| +|expires|[int](../types/int.md) | Yes|Expiry of PSA/MTProxy info| +|peer|[Peer](../types/Peer.md) | Yes|MTProxy/PSA peer| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chat info| +|users|Array of [User](../types/User.md) | Yes|User info| +|psa\_type|[string](../types/string.md) | Optional|PSA type| +|psa\_message|[string](../types/string.md) | Optional|PSA message| + + + +### Type: [help.PromoData](../types/help.PromoData.md) + + +### Example: + +```php +$help.promoData = ['_' => 'help.promoData', 'proxy' => Bool, 'expires' => int, 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User], 'psa_type' => 'string', 'psa_message' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +help.promoData={_='help.promoData', proxy=Bool, expires=int, peer=Peer, chats={Chat}, users={User}, psa_type='string', psa_message='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.promoDataEmpty.md b/old_docs/API_docs_v44/constructors/help.promoDataEmpty.md new file mode 100644 index 00000000..2fe1d80c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.promoDataEmpty.md @@ -0,0 +1,39 @@ +--- +title: help.promoDataEmpty +description: No PSA/MTProxy info is available +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_promoDataEmpty.html +--- +# Constructor: help.promoDataEmpty +[Back to constructors index](index.md) + + + +No PSA/MTProxy info is available + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Re-fetch PSA/MTProxy info after the specified number of seconds| + + + +### Type: [help.PromoData](../types/help.PromoData.md) + + +### Example: + +```php +$help.promoDataEmpty = ['_' => 'help.promoDataEmpty', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.promoDataEmpty={_='help.promoDataEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.recentMeUrls.md b/old_docs/API_docs_v44/constructors/help.recentMeUrls.md new file mode 100644 index 00000000..ed957ccd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.recentMeUrls.md @@ -0,0 +1,41 @@ +--- +title: help.recentMeUrls +description: Recent t.me URLs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_recentMeUrls.html +--- +# Constructor: help.recentMeUrls +[Back to constructors index](index.md) + + + +Recent t.me URLs + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|urls|Array of [RecentMeUrl](../types/RecentMeUrl.md) | Yes|URLs| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [help.RecentMeUrls](../types/help.RecentMeUrls.md) + + +### Example: + +```php +$help.recentMeUrls = ['_' => 'help.recentMeUrls', 'urls' => [RecentMeUrl, RecentMeUrl], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +help.recentMeUrls={_='help.recentMeUrls', urls={RecentMeUrl}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.supportName.md b/old_docs/API_docs_v44/constructors/help.supportName.md new file mode 100644 index 00000000..a7b2f698 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.supportName.md @@ -0,0 +1,39 @@ +--- +title: help.supportName +description: Localized name for telegram support +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_supportName.html +--- +# Constructor: help.supportName +[Back to constructors index](index.md) + + + +Localized name for telegram support + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Localized name| + + + +### Type: [help.SupportName](../types/help.SupportName.md) + + +### Example: + +```php +$help.supportName = ['_' => 'help.supportName', 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +help.supportName={_='help.supportName', name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.termsOfService.md b/old_docs/API_docs_v44/constructors/help.termsOfService.md index 8feb566e..1d4339c5 100644 --- a/old_docs/API_docs_v44/constructors/help.termsOfService.md +++ b/old_docs/API_docs_v44/constructors/help.termsOfService.md @@ -15,7 +15,11 @@ Info about the latest telegram Terms Of Service | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|popup|[Bool](../types/Bool.md) | Optional|Whether a prompt must be showed to the user, in order to accept the new terms.| +|id|[DataJSON](../types/DataJSON.md) | Yes|ID of the new terms| |text|[string](../types/string.md) | Yes|Text of the new terms| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|[Message entities for styled text](https://core.telegram.org/api/entities)| +|min\_age\_confirm|[int](../types/int.md) | Optional|Minimum age required to sign up to telegram, the user must confirm that they is older than the minimum age.| @@ -25,14 +29,14 @@ Info about the latest telegram Terms Of Service ### Example: ```php -$help.termsOfService = ['_' => 'help.termsOfService', 'text' => 'string']; +$help.termsOfService = ['_' => 'help.termsOfService', 'popup' => Bool, 'id' => DataJSON, 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'min_age_confirm' => int]; ``` Or, if you're into Lua: ```lua -help.termsOfService={_='help.termsOfService', text='string'} +help.termsOfService={_='help.termsOfService', popup=Bool, id=DataJSON, text='string', entities={MessageEntity}, min_age_confirm=int} ``` diff --git a/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdate.md b/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdate.md new file mode 100644 index 00000000..5daa8776 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdate.md @@ -0,0 +1,40 @@ +--- +title: help.termsOfServiceUpdate +description: Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update" +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_termsOfServiceUpdate.html +--- +# Constructor: help.termsOfServiceUpdate +[Back to constructors index](index.md) + + + +Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update" + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds| +|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Yes|New terms of service| + + + +### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + + +### Example: + +```php +$help.termsOfServiceUpdate = ['_' => 'help.termsOfServiceUpdate', 'expires' => int, 'terms_of_service' => help.TermsOfService]; +``` + + +Or, if you're into Lua: + +```lua +help.termsOfServiceUpdate={_='help.termsOfServiceUpdate', expires=int, terms_of_service=help.TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdateEmpty.md b/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdateEmpty.md new file mode 100644 index 00000000..75d973a5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.termsOfServiceUpdateEmpty.md @@ -0,0 +1,39 @@ +--- +title: help.termsOfServiceUpdateEmpty +description: No changes were made to telegram's terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_termsOfServiceUpdateEmpty.html +--- +# Constructor: help.termsOfServiceUpdateEmpty +[Back to constructors index](index.md) + + + +No changes were made to telegram's terms of service + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds| + + + +### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + + +### Example: + +```php +$help.termsOfServiceUpdateEmpty = ['_' => 'help.termsOfServiceUpdateEmpty', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.termsOfServiceUpdateEmpty={_='help.termsOfServiceUpdateEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.userInfo.md b/old_docs/API_docs_v44/constructors/help.userInfo.md new file mode 100644 index 00000000..6188aa7a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.userInfo.md @@ -0,0 +1,42 @@ +--- +title: help.userInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_userInfo.html +--- +# Constructor: help.userInfo +[Back to constructors index](index.md) + + + +Internal use + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Info| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|[Message entities for styled text](https://core.telegram.org/api/entities)| +|author|[string](../types/string.md) | Yes|Author| +|date|[int](../types/int.md) | Yes|Date| + + + +### Type: [help.UserInfo](../types/help.UserInfo.md) + + +### Example: + +```php +$help.userInfo = ['_' => 'help.userInfo', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'author' => 'string', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.userInfo={_='help.userInfo', message='string', entities={MessageEntity}, author='string', date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/help.userInfoEmpty.md b/old_docs/API_docs_v44/constructors/help.userInfoEmpty.md new file mode 100644 index 00000000..3225ff3c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/help.userInfoEmpty.md @@ -0,0 +1,34 @@ +--- +title: help.userInfoEmpty +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_userInfoEmpty.html +--- +# Constructor: help.userInfoEmpty +[Back to constructors index](index.md) + + + +Internal use + + + + +### Type: [help.UserInfo](../types/help.UserInfo.md) + + +### Example: + +```php +$help.userInfoEmpty = ['_' => 'help.userInfoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +help.userInfoEmpty={_='help.userInfoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/highScore.md b/old_docs/API_docs_v44/constructors/highScore.md new file mode 100644 index 00000000..26f43d91 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/highScore.md @@ -0,0 +1,40 @@ +--- +title: highScore +description: Game highscore +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: highScore +[Back to constructors index](index.md) + + + +Game highscore + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pos|[int](../types/int.md) | Yes|Position in highscore list| +|user\_id|[int](../types/int.md) | Yes|User ID| +|score|[int](../types/int.md) | Yes|Score| + + + +### Type: [HighScore](../types/HighScore.md) + + +### Example: + +```php +$highScore = ['_' => 'highScore', 'pos' => int, 'user_id' => int, 'score' => int]; +``` + + +Or, if you're into Lua: + +```lua +highScore={_='highScore', pos=int, user_id=int, score=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inlineBotSwitchPM.md b/old_docs/API_docs_v44/constructors/inlineBotSwitchPM.md new file mode 100644 index 00000000..f4ac504a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inlineBotSwitchPM.md @@ -0,0 +1,39 @@ +--- +title: inlineBotSwitchPM +description: The bot requested the user to message him in private +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inlineBotSwitchPM +[Back to constructors index](index.md) + + + +The bot requested the user to message him in private + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Text for the button that switches the user to a private chat with the bot and sends the bot a start message with the parameter `start_parameter` (can be empty)| +|start\_param|[string](../types/string.md) | Yes|The parameter for the `/start parameter`| + + + +### Type: [InlineBotSwitchPM](../types/InlineBotSwitchPM.md) + + +### Example: + +```php +$inlineBotSwitchPM = ['_' => 'inlineBotSwitchPM', 'text' => 'string', 'start_param' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inlineBotSwitchPM={_='inlineBotSwitchPM', text='string', start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputAppEvent.md b/old_docs/API_docs_v44/constructors/inputAppEvent.md index ef60e17f..c67f92aa 100644 --- a/old_docs/API_docs_v44/constructors/inputAppEvent.md +++ b/old_docs/API_docs_v44/constructors/inputAppEvent.md @@ -17,7 +17,7 @@ Event that occured in the application. |time|[double](../types/double.md) | Yes|Client's exact timestamp for the event| |type|[string](../types/string.md) | Yes|Type of event| |peer|[long](../types/long.md) | Yes|Arbitrary numeric value for more convenient selection of certain event types, or events referring to a certain object| -|data|[string](../types/string.md) | Yes|Data| +|data|[JSONValue](../types/JSONValue.md) | Yes|Details of the event| @@ -27,14 +27,14 @@ Event that occured in the application. ### Example: ```php -$inputAppEvent = ['_' => 'inputAppEvent', 'time' => double, 'type' => 'string', 'peer' => long, 'data' => 'string']; +$inputAppEvent = ['_' => 'inputAppEvent', 'time' => double, 'type' => 'string', 'peer' => long, 'data' => JSONValue]; ``` Or, if you're into Lua: ```lua -inputAppEvent={_='inputAppEvent', time=double, type='string', peer=long, data='string'} +inputAppEvent={_='inputAppEvent', time=double, type='string', peer=long, data=JSONValue} ``` diff --git a/old_docs/API_docs_v44/constructors/inputAudioEmpty.md b/old_docs/API_docs_v44/constructors/inputAudioEmpty.md deleted file mode 100644 index 976c4c3e..00000000 --- a/old_docs/API_docs_v44/constructors/inputAudioEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputAudioEmpty -description: Empty input audio -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputAudioEmpty -[Back to constructors index](index.md) - - - -Empty input audio - - - - -### Type: [InputAudio](../types/InputAudio.md) - - -### Example: - -```php -$inputAudioEmpty = ['_' => 'inputAudioEmpty']; -``` - - -Or, if you're into Lua: - -```lua -inputAudioEmpty={_='inputAudioEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputAudioFileLocation.md b/old_docs/API_docs_v44/constructors/inputAudioFileLocation.md deleted file mode 100644 index b9104cee..00000000 --- a/old_docs/API_docs_v44/constructors/inputAudioFileLocation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: inputAudioFileLocation -description: Audio file location -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputAudioFileLocation -[Back to constructors index](index.md) - - - -Audio file location - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| -|access\_hash|[long](../types/long.md) | Yes|Access hash| - - - -### Type: [InputFileLocation](../types/InputFileLocation.md) - - -### Example: - -```php -$inputAudioFileLocation = ['_' => 'inputAudioFileLocation', 'id' => long, 'access_hash' => long]; -``` - - -Or, if you're into Lua: - -```lua -inputAudioFileLocation={_='inputAudioFileLocation', id=long, access_hash=long} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageGame.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageGame.md new file mode 100644 index 00000000..38d1df54 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageGame.md @@ -0,0 +1,44 @@ +--- +title: inputBotInlineMessageGame +description: A game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageGame +[Back to constructors index](index.md) + + + +A game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageGame = ['_' => 'inputBotInlineMessageGame', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageGame={_='inputBotInlineMessageGame', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageID.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageID.md new file mode 100644 index 00000000..e0272c70 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageID.md @@ -0,0 +1,40 @@ +--- +title: inputBotInlineMessageID +description: Represents a sent inline message from the perspective of a bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageID +[Back to constructors index](index.md) + + + +Represents a sent inline message from the perspective of a bot + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|DC ID to use when working with this inline message| +|id|[long](../types/long.md) | Yes|ID of message| +|access\_hash|[long](../types/long.md) | Yes|Access hash of message| + + + +### Type: [InputBotInlineMessageID](../types/InputBotInlineMessageID.md) + + +### Example: + +```php +$inputBotInlineMessageID = ['_' => 'inputBotInlineMessageID', 'dc_id' => int, 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageID={_='inputBotInlineMessageID', dc_id=int, id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaAuto.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaAuto.md new file mode 100644 index 00000000..b7041fd8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaAuto.md @@ -0,0 +1,46 @@ +--- +title: inputBotInlineMessageMediaAuto +description: A media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +A media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Caption| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaAuto = ['_' => 'inputBotInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageMediaAuto={_='inputBotInlineMessageMediaAuto', message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaContact.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaContact.md new file mode 100644 index 00000000..723cd7b1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaContact.md @@ -0,0 +1,48 @@ +--- +title: inputBotInlineMessageMediaContact +description: A contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaContact +[Back to constructors index](index.md) + + + +A contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|vcard|[string](../types/string.md) | Yes|VCard info| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaContact = ['_' => 'inputBotInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageMediaContact={_='inputBotInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaGeo.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaGeo.md new file mode 100644 index 00000000..e3f2f1c2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaGeo.md @@ -0,0 +1,46 @@ +--- +title: inputBotInlineMessageMediaGeo +description: Geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +Geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup for bot/inline keyboards| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaGeo = ['_' => 'inputBotInlineMessageMediaGeo', 'geo_point' => InputGeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageMediaGeo={_='inputBotInlineMessageMediaGeo', geo_point=InputGeoPoint, period=int, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaVenue.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaVenue.md new file mode 100644 index 00000000..8dfa7a54 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageMediaVenue.md @@ -0,0 +1,50 @@ +--- +title: inputBotInlineMessageMediaVenue +description: Venue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +Venue + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Address| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaVenue = ['_' => 'inputBotInlineMessageMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageMediaVenue={_='inputBotInlineMessageMediaVenue', geo_point=InputGeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineMessageText.md b/old_docs/API_docs_v44/constructors/inputBotInlineMessageText.md new file mode 100644 index 00000000..acb61c31 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineMessageText.md @@ -0,0 +1,47 @@ +--- +title: inputBotInlineMessageText +description: Simple text message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageText +[Back to constructors index](index.md) + + + +Simple text message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|message|[string](../types/string.md) | Yes|Message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageText = ['_' => 'inputBotInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageText={_='inputBotInlineMessageText', no_webpage=Bool, message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineResult.md b/old_docs/API_docs_v44/constructors/inputBotInlineResult.md new file mode 100644 index 00000000..04f2c162 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineResult.md @@ -0,0 +1,45 @@ +--- +title: inputBotInlineResult +description: An inline bot result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResult +[Back to constructors index](index.md) + + + +An inline bot result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|ID of result| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|url|[string](../types/string.md) | Optional|URL of result| +|thumb|[InputWebDocument](../types/InputWebDocument.md) | Optional|Thumbnail for result| +|content|[InputWebDocument](../types/InputWebDocument.md) | Optional|Result contents| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResult = ['_' => 'inputBotInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => InputWebDocument, 'content' => InputWebDocument, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResult={_='inputBotInlineResult', id='string', type='string', title='string', description='string', url='string', thumb=InputWebDocument, content=InputWebDocument, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineResultDocument.md b/old_docs/API_docs_v44/constructors/inputBotInlineResultDocument.md new file mode 100644 index 00000000..294bfc74 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineResultDocument.md @@ -0,0 +1,43 @@ +--- +title: inputBotInlineResultDocument +description: Document (media of any type except for photos) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultDocument +[Back to constructors index](index.md) + + + +Document (media of any type except for photos) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Document to send| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultDocument = ['_' => 'inputBotInlineResultDocument', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'document' => InputDocument, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultDocument={_='inputBotInlineResultDocument', id='string', type='string', title='string', description='string', document=InputDocument, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineResultGame.md b/old_docs/API_docs_v44/constructors/inputBotInlineResultGame.md new file mode 100644 index 00000000..3f92c03f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineResultGame.md @@ -0,0 +1,40 @@ +--- +title: inputBotInlineResultGame +description: Game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultGame +[Back to constructors index](index.md) + + + +Game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|short\_name|[string](../types/string.md) | Yes|Game short name| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultGame = ['_' => 'inputBotInlineResultGame', 'id' => 'string', 'short_name' => 'string', 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultGame={_='inputBotInlineResultGame', id='string', short_name='string', send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputBotInlineResultPhoto.md b/old_docs/API_docs_v44/constructors/inputBotInlineResultPhoto.md new file mode 100644 index 00000000..a60583cd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputBotInlineResultPhoto.md @@ -0,0 +1,41 @@ +--- +title: inputBotInlineResultPhoto +description: Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultPhoto +[Back to constructors index](index.md) + + + +Photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|photo|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Photo to send| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultPhoto = ['_' => 'inputBotInlineResultPhoto', 'id' => 'string', 'type' => 'string', 'photo' => InputPhoto, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultPhoto={_='inputBotInlineResultPhoto', id='string', type='string', photo=InputPhoto, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputChannelFromMessage.md b/old_docs/API_docs_v44/constructors/inputChannelFromMessage.md new file mode 100644 index 00000000..0fb18022 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputChannelFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputChannelFromMessage +description: Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannelFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the channel was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID in the chat where the channel was seen| +|channel\_id|[int](../types/int.md) | Yes|The channel ID| + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +```php +$inputChannelFromMessage = ['_' => 'inputChannelFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputChannelFromMessage={_='inputChannelFromMessage', peer=InputPeer, msg_id=int, channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputChatPhoto.md b/old_docs/API_docs_v44/constructors/inputChatPhoto.md index 7abcf147..ec0afc88 100644 --- a/old_docs/API_docs_v44/constructors/inputChatPhoto.md +++ b/old_docs/API_docs_v44/constructors/inputChatPhoto.md @@ -15,7 +15,6 @@ Existing photo to be set as a chat profile photo. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Existing photo| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Crop| @@ -25,14 +24,14 @@ Existing photo to be set as a chat profile photo. ### Example: ```php -$inputChatPhoto = ['_' => 'inputChatPhoto', 'id' => InputPhoto, 'crop' => InputPhotoCrop]; +$inputChatPhoto = ['_' => 'inputChatPhoto', 'id' => InputPhoto]; ``` Or, if you're into Lua: ```lua -inputChatPhoto={_='inputChatPhoto', id=InputPhoto, crop=InputPhotoCrop} +inputChatPhoto={_='inputChatPhoto', id=InputPhoto} ``` diff --git a/old_docs/API_docs_v44/constructors/inputChatUploadedPhoto.md b/old_docs/API_docs_v44/constructors/inputChatUploadedPhoto.md index d651e549..67b781cc 100644 --- a/old_docs/API_docs_v44/constructors/inputChatUploadedPhoto.md +++ b/old_docs/API_docs_v44/constructors/inputChatUploadedPhoto.md @@ -14,8 +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)| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Crop| +|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| @@ -25,14 +26,14 @@ New photo to be set as group profile photo. ### Example: ```php -$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile, 'crop' => InputPhotoCrop]; +$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile, 'video' => InputFile, 'video_start_ts' => double]; ``` Or, if you're into Lua: ```lua -inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile, crop=InputPhotoCrop} +inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile, video=InputFile, video_start_ts=double} ``` diff --git a/old_docs/API_docs_v44/constructors/inputCheckPasswordEmpty.md b/old_docs/API_docs_v44/constructors/inputCheckPasswordEmpty.md new file mode 100644 index 00000000..4811921d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputCheckPasswordEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputCheckPasswordEmpty +description: There is no password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputCheckPasswordEmpty +[Back to constructors index](index.md) + + + +There is no password + + + + +### Type: [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) + + +### Example: + +```php +$inputCheckPasswordEmpty = ['_' => 'inputCheckPasswordEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputCheckPasswordEmpty={_='inputCheckPasswordEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputCheckPasswordSRP.md b/old_docs/API_docs_v44/constructors/inputCheckPasswordSRP.md new file mode 100644 index 00000000..82db7595 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputCheckPasswordSRP.md @@ -0,0 +1,40 @@ +--- +title: inputCheckPasswordSRP +description: Constructor for checking the validity of a 2FA SRP password (see [SRP](https://core.telegram.org/api/srp)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputCheckPasswordSRP +[Back to constructors index](index.md) + + + +Constructor for checking the validity of a 2FA SRP password (see [SRP](https://core.telegram.org/api/srp)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|srp\_id|[long](../types/long.md) | Yes|[SRP ID](https://core.telegram.org/api/srp)| +|A|[bytes](../types/bytes.md) | Yes|`A` parameter (see [SRP](https://core.telegram.org/api/srp))| +|M1|[bytes](../types/bytes.md) | Yes|`M1` parameter (see [SRP](https://core.telegram.org/api/srp))| + + + +### Type: [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) + + +### Example: + +```php +$inputCheckPasswordSRP = ['_' => 'inputCheckPasswordSRP', 'srp_id' => long, 'A' => 'bytes', 'M1' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputCheckPasswordSRP={_='inputCheckPasswordSRP', srp_id=long, A='bytes', M1='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputClientProxy.md b/old_docs/API_docs_v44/constructors/inputClientProxy.md new file mode 100644 index 00000000..3a4f8a68 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputClientProxy.md @@ -0,0 +1,39 @@ +--- +title: inputClientProxy +description: Info about an [MTProxy](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation) used to connect. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputClientProxy +[Back to constructors index](index.md) + + + +Info about an [MTProxy](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation) used to connect. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|address|[string](../types/string.md) | Yes|Proxy address| +|port|[int](../types/int.md) | Yes|Proxy port| + + + +### Type: [InputClientProxy](../types/InputClientProxy.md) + + +### Example: + +```php +$inputClientProxy = ['_' => 'inputClientProxy', 'address' => 'string', 'port' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputClientProxy={_='inputClientProxy', address='string', port=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputDialogPeer.md b/old_docs/API_docs_v44/constructors/inputDialogPeer.md new file mode 100644 index 00000000..d7f2f20b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputDialogPeer.md @@ -0,0 +1,38 @@ +--- +title: inputDialogPeer +description: A peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDialogPeer +[Back to constructors index](index.md) + + + +A peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| + + + +### Type: [InputDialogPeer](../types/InputDialogPeer.md) + + +### Example: + +```php +$inputDialogPeer = ['_' => 'inputDialogPeer', 'peer' => InputPeer]; +``` + + +Or, if you're into Lua: + +```lua +inputDialogPeer={_='inputDialogPeer', peer=InputPeer} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputDialogPeerFolder.md b/old_docs/API_docs_v44/constructors/inputDialogPeerFolder.md new file mode 100644 index 00000000..a5a65d90 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputDialogPeerFolder.md @@ -0,0 +1,38 @@ +--- +title: inputDialogPeerFolder +description: All peers in a [peer folder](https://core.telegram.org/api/folders#peer-folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDialogPeerFolder +[Back to constructors index](index.md) + + + +All peers in a [peer folder](https://core.telegram.org/api/folders#peer-folders) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| + + + +### Type: [InputDialogPeer](../types/InputDialogPeer.md) + + +### Example: + +```php +$inputDialogPeerFolder = ['_' => 'inputDialogPeerFolder', 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputDialogPeerFolder={_='inputDialogPeerFolder', folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputDocument.md b/old_docs/API_docs_v44/constructors/inputDocument.md index d6594a7a..9b5d5ffb 100644 --- a/old_docs/API_docs_v44/constructors/inputDocument.md +++ b/old_docs/API_docs_v44/constructors/inputDocument.md @@ -16,6 +16,7 @@ Defines a video for subsequent interaction. |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Document ID| |access\_hash|[long](../types/long.md) | Yes|**access\_hash** parameter from the [document](../constructors/document.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| @@ -25,14 +26,14 @@ Defines a video for subsequent interaction. ### Example: ```php -$inputDocument = ['_' => 'inputDocument', 'id' => long, 'access_hash' => long]; +$inputDocument = ['_' => 'inputDocument', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes']; ``` Or, if you're into Lua: ```lua -inputDocument={_='inputDocument', id=long, access_hash=long} +inputDocument={_='inputDocument', id=long, access_hash=long, file_reference='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputDocumentFileLocation.md b/old_docs/API_docs_v44/constructors/inputDocumentFileLocation.md index 47dc535d..81405f93 100644 --- a/old_docs/API_docs_v44/constructors/inputDocumentFileLocation.md +++ b/old_docs/API_docs_v44/constructors/inputDocumentFileLocation.md @@ -16,6 +16,8 @@ Document location (video, voice, audio, basically every type except photo) |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Document ID| |access\_hash|[long](../types/long.md) | Yes|**access\_hash** parameter from the [document](../constructors/document.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| +|thumb\_size|[string](../types/string.md) | Yes|Thumbnail size to download the thumbnail| @@ -25,14 +27,14 @@ Document location (video, voice, audio, basically every type except photo) ### Example: ```php -$inputDocumentFileLocation = ['_' => 'inputDocumentFileLocation', 'id' => long, 'access_hash' => long]; +$inputDocumentFileLocation = ['_' => 'inputDocumentFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'thumb_size' => 'string']; ``` Or, if you're into Lua: ```lua -inputDocumentFileLocation={_='inputDocumentFileLocation', id=long, access_hash=long} +inputDocumentFileLocation={_='inputDocumentFileLocation', id=long, access_hash=long, file_reference='bytes', thumb_size='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputFileLocation.md b/old_docs/API_docs_v44/constructors/inputFileLocation.md index 377bc203..e53d7615 100644 --- a/old_docs/API_docs_v44/constructors/inputFileLocation.md +++ b/old_docs/API_docs_v44/constructors/inputFileLocation.md @@ -17,6 +17,7 @@ DEPRECATED location of a photo |volume\_id|[long](../types/long.md) | Yes|Server volume| |local\_id|[int](../types/int.md) | Yes|File identifier| |secret|[long](../types/long.md) | Yes|Check sum to access the file| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| @@ -26,14 +27,14 @@ DEPRECATED location of a photo ### Example: ```php -$inputFileLocation = ['_' => 'inputFileLocation', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +$inputFileLocation = ['_' => 'inputFileLocation', 'volume_id' => long, 'local_id' => int, 'secret' => long, 'file_reference' => 'bytes']; ``` Or, if you're into Lua: ```lua -inputFileLocation={_='inputFileLocation', volume_id=long, local_id=int, secret=long} +inputFileLocation={_='inputFileLocation', volume_id=long, local_id=int, secret=long, file_reference='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputFolderPeer.md b/old_docs/API_docs_v44/constructors/inputFolderPeer.md new file mode 100644 index 00000000..8bfd9b5b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputFolderPeer.md @@ -0,0 +1,39 @@ +--- +title: inputFolderPeer +description: Peer in a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFolderPeer +[Back to constructors index](index.md) + + + +Peer in a folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| +|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| + + + +### Type: [InputFolderPeer](../types/InputFolderPeer.md) + + +### Example: + +```php +$inputFolderPeer = ['_' => 'inputFolderPeer', 'peer' => InputPeer, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputFolderPeer={_='inputFolderPeer', peer=InputPeer, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputGameID.md b/old_docs/API_docs_v44/constructors/inputGameID.md new file mode 100644 index 00000000..198650e7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputGameID.md @@ -0,0 +1,39 @@ +--- +title: inputGameID +description: Indicates an already sent game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameID +[Back to constructors index](index.md) + + + +Indicates an already sent game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|game ID from [Game](../types/Game.md) constructor| +|access\_hash|[long](../types/long.md) | Yes|access hash from [Game](../types/Game.md) constructor| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +```php +$inputGameID = ['_' => 'inputGameID', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputGameID={_='inputGameID', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputGameShortName.md b/old_docs/API_docs_v44/constructors/inputGameShortName.md new file mode 100644 index 00000000..016c1105 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputGameShortName.md @@ -0,0 +1,39 @@ +--- +title: inputGameShortName +description: Game by short name +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameShortName +[Back to constructors index](index.md) + + + +Game by short name + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot that provides the game| +|short\_name|[string](../types/string.md) | Yes|The game's short name| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +```php +$inputGameShortName = ['_' => 'inputGameShortName', 'bot_id' => InputUser, 'short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputGameShortName={_='inputGameShortName', bot_id=InputUser, short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputKeyboardButtonUrlAuth.md b/old_docs/API_docs_v44/constructors/inputKeyboardButtonUrlAuth.md new file mode 100644 index 00000000..00662373 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputKeyboardButtonUrlAuth.md @@ -0,0 +1,42 @@ +--- +title: inputKeyboardButtonUrlAuth +description: Button to request a user to [authorize](../methods/messages.acceptUrlAuth.md) via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputKeyboardButtonUrlAuth +[Back to constructors index](index.md) + + + +Button to request a user to [authorize](../methods/messages.acceptUrlAuth.md) via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_write\_access|[Bool](../types/Bool.md) | Optional|Set this flag to request the permission for your bot to send messages to the user.| +|text|[string](../types/string.md) | Yes|Button text| +|fwd\_text|[string](../types/string.md) | Optional|New text of the button in forwarded messages.| +|url|[string](../types/string.md) | Yes|An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data).
NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization).| +|bot|[InputUser](../types/InputUser.md) | Optional|Username of a bot, which will be used for user authorization. See [Setting up a bot](https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details.| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$inputKeyboardButtonUrlAuth = ['_' => 'inputKeyboardButtonUrlAuth', 'request_write_access' => Bool, 'text' => 'string', 'fwd_text' => 'string', 'url' => 'string', 'bot' => InputUser]; +``` + + +Or, if you're into Lua: + +```lua +inputKeyboardButtonUrlAuth={_='inputKeyboardButtonUrlAuth', request_write_access=Bool, text='string', fwd_text='string', url='string', bot=InputUser} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaContact.md b/old_docs/API_docs_v44/constructors/inputMediaContact.md index b756bcc3..655f0d32 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaContact.md +++ b/old_docs/API_docs_v44/constructors/inputMediaContact.md @@ -17,6 +17,7 @@ Phonebook contact |phone\_number|[string](../types/string.md) | Yes|Phone number| |first\_name|[string](../types/string.md) | Yes|Contact's first name| |last\_name|[string](../types/string.md) | Yes|Contact's last name| +|vcard|[string](../types/string.md) | Yes|Contact vcard| @@ -26,14 +27,14 @@ Phonebook contact ### Example: ```php -$inputMediaContact = ['_' => 'inputMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string']; +$inputMediaContact = ['_' => 'inputMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string']; ``` Or, if you're into Lua: ```lua -inputMediaContact={_='inputMediaContact', phone_number='string', first_name='string', last_name='string'} +inputMediaContact={_='inputMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaDice.md b/old_docs/API_docs_v44/constructors/inputMediaDice.md new file mode 100644 index 00000000..6412d75e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaDice.md @@ -0,0 +1,38 @@ +--- +title: inputMediaDice +description: Send a [dice-based animated sticker](https://core.telegram.org/api/dice) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDice +[Back to constructors index](index.md) + + + +Send a [dice-based animated sticker](https://core.telegram.org/api/dice) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[string](../types/string.md) | Yes|The emoji, for now 🏀, 🎲 and 🎯 are supported| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaDice = ['_' => 'inputMediaDice', 'emoticon' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputMediaDice={_='inputMediaDice', emoticon='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaDocument.md b/old_docs/API_docs_v44/constructors/inputMediaDocument.md index 8c7422db..f4cd3916 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaDocument.md +++ b/old_docs/API_docs_v44/constructors/inputMediaDocument.md @@ -15,6 +15,7 @@ Forwarded document | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The document to be forwarded.| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live of self-destructing document| @@ -24,14 +25,14 @@ Forwarded document ### Example: ```php -$inputMediaDocument = ['_' => 'inputMediaDocument', 'id' => InputDocument]; +$inputMediaDocument = ['_' => 'inputMediaDocument', 'id' => InputDocument, 'ttl_seconds' => int]; ``` Or, if you're into Lua: ```lua -inputMediaDocument={_='inputMediaDocument', id=InputDocument} +inputMediaDocument={_='inputMediaDocument', id=InputDocument, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaDocumentExternal.md b/old_docs/API_docs_v44/constructors/inputMediaDocumentExternal.md new file mode 100644 index 00000000..caa729d2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaDocumentExternal.md @@ -0,0 +1,39 @@ +--- +title: inputMediaDocumentExternal +description: Document that will be downloaded by the telegram servers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDocumentExternal +[Back to constructors index](index.md) + + + +Document that will be downloaded by the telegram servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL of the document| +|ttl\_seconds|[int](../types/int.md) | Optional|Self-destruct time to live of document| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaDocumentExternal = ['_' => 'inputMediaDocumentExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaDocumentExternal={_='inputMediaDocumentExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaAudio.md b/old_docs/API_docs_v44/constructors/inputMediaGame.md similarity index 57% rename from old_docs/API_docs_v44/constructors/inputMediaAudio.md rename to old_docs/API_docs_v44/constructors/inputMediaGame.md index 654ddbfb..293b1d9b 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaAudio.md +++ b/old_docs/API_docs_v44/constructors/inputMediaGame.md @@ -1,20 +1,20 @@ --- -title: inputMediaAudio -description: Media audio +title: inputMediaGame +description: A game image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: inputMediaAudio +# Constructor: inputMediaGame [Back to constructors index](index.md) -Media audio +A game ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[InputAudio](../types/InputAudio.md) | Optional|ID| +|id|[InputGame](../types/InputGame.md) | Yes|The game to forward| @@ -24,14 +24,14 @@ Media audio ### Example: ```php -$inputMediaAudio = ['_' => 'inputMediaAudio', 'id' => InputAudio]; +$inputMediaGame = ['_' => 'inputMediaGame', 'id' => InputGame]; ``` Or, if you're into Lua: ```lua -inputMediaAudio={_='inputMediaAudio', id=InputAudio} +inputMediaGame={_='inputMediaGame', id=InputGame} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaGeoLive.md b/old_docs/API_docs_v44/constructors/inputMediaGeoLive.md new file mode 100644 index 00000000..0e899bb1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaGeoLive.md @@ -0,0 +1,40 @@ +--- +title: inputMediaGeoLive +description: Live geographical location +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGeoLive +[Back to constructors index](index.md) + + + +Live geographical location + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stopped|[Bool](../types/Bool.md) | Optional|Whether sending of the geolocation was stopped| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current geolocation| +|period|[int](../types/int.md) | Optional|Validity period of the current location| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaGeoLive = ['_' => 'inputMediaGeoLive', 'stopped' => Bool, 'geo_point' => InputGeoPoint, 'period' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaGeoLive={_='inputMediaGeoLive', stopped=Bool, geo_point=InputGeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaGifExternal.md b/old_docs/API_docs_v44/constructors/inputMediaGifExternal.md deleted file mode 100644 index 1b2934e7..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaGifExternal.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: inputMediaGifExternal -description: New GIF animation that will be uploaded by the server using the specified URL -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaGifExternal -[Back to constructors index](index.md) - - - -New GIF animation that will be uploaded by the server using the specified URL - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|q|[string](../types/string.md) | Yes|Query| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaGifExternal = ['_' => 'inputMediaGifExternal', 'url' => 'string', 'q' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -inputMediaGifExternal={_='inputMediaGifExternal', url='string', q='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMediaInvoice.md b/old_docs/API_docs_v44/constructors/inputMediaInvoice.md new file mode 100644 index 00000000..8de50c5e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaInvoice.md @@ -0,0 +1,45 @@ +--- +title: inputMediaInvoice +description: Generated invoice of a [bot payment](https://core.telegram.org/bots/payments) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaInvoice +[Back to constructors index](index.md) + + + +Generated invoice of a [bot payment](https://core.telegram.org/bots/payments) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Product name, 1-32 characters| +|description|[string](../types/string.md) | Yes|Product description, 1-255 characters| +|photo|[InputWebDocument](../types/InputWebDocument.md) | Optional|URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.| +|invoice|[Invoice](../types/Invoice.md) | Yes|The actual invoice| +|payload|[bytes](../types/bytes.md) | Yes|Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.| +|provider|[string](../types/string.md) | Yes|Payments provider token, obtained via [Botfather](https://t.me/botfather)| +|provider\_data|[DataJSON](../types/DataJSON.md) | Yes|JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.| +|start\_param|[string](../types/string.md) | Yes|Start parameter| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaInvoice = ['_' => 'inputMediaInvoice', 'title' => 'string', 'description' => 'string', 'photo' => InputWebDocument, 'invoice' => Invoice, 'payload' => 'bytes', 'provider' => 'string', 'provider_data' => DataJSON, 'start_param' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputMediaInvoice={_='inputMediaInvoice', title='string', description='string', photo=InputWebDocument, invoice=Invoice, payload='bytes', provider='string', provider_data=DataJSON, start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaPhoto.md b/old_docs/API_docs_v44/constructors/inputMediaPhoto.md index 8ffca42a..e42acf33 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaPhoto.md +++ b/old_docs/API_docs_v44/constructors/inputMediaPhoto.md @@ -15,7 +15,7 @@ Forwarded photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Photo to be forwarded| -|caption|[string](../types/string.md) | Yes|Caption| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| @@ -25,14 +25,14 @@ Forwarded photo ### Example: ```php -$inputMediaPhoto = ['_' => 'inputMediaPhoto', 'id' => InputPhoto, 'caption' => 'string']; +$inputMediaPhoto = ['_' => 'inputMediaPhoto', 'id' => InputPhoto, 'ttl_seconds' => int]; ``` Or, if you're into Lua: ```lua -inputMediaPhoto={_='inputMediaPhoto', id=InputPhoto, caption='string'} +inputMediaPhoto={_='inputMediaPhoto', id=InputPhoto, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaPhotoExternal.md b/old_docs/API_docs_v44/constructors/inputMediaPhotoExternal.md new file mode 100644 index 00000000..75f82119 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaPhotoExternal.md @@ -0,0 +1,39 @@ +--- +title: inputMediaPhotoExternal +description: New photo that will be uploaded by the server using the specified URL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPhotoExternal +[Back to constructors index](index.md) + + + +New photo that will be uploaded by the server using the specified URL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL of the photo| +|ttl\_seconds|[int](../types/int.md) | Optional|Self-destruct time to live of photo| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaPhotoExternal = ['_' => 'inputMediaPhotoExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaPhotoExternal={_='inputMediaPhotoExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaPoll.md b/old_docs/API_docs_v44/constructors/inputMediaPoll.md new file mode 100644 index 00000000..db80b7ad --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMediaPoll.md @@ -0,0 +1,41 @@ +--- +title: inputMediaPoll +description: A poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPoll +[Back to constructors index](index.md) + + + +A poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll|[Poll](../types/Poll.md) | Yes|The poll to send| +|correct\_answers|Array of [bytes](../types/bytes.md) | Optional|Correct answer IDs (for quiz polls)| +|solution|[string](../types/string.md) | Optional|Explanation of quiz solution| +|solution\_entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaPoll = ['_' => 'inputMediaPoll', 'poll' => Poll, 'correct_answers' => ['bytes', 'bytes'], 'solution' => 'string', 'solution_entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaPoll={_='inputMediaPoll', poll=Poll, correct_answers={'bytes'}, solution='string', solution_entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedAudio.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedAudio.md deleted file mode 100644 index 54f1d7e5..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedAudio.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: inputMediaUploadedAudio -description: Media uploaded audio -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaUploadedAudio -[Back to constructors index](index.md) - - - -Media uploaded audio - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|File| -|duration|[int](../types/int.md) | Yes|Duration| -|mime\_type|[string](../types/string.md) | Optional|Mime type| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaUploadedAudio = ['_' => 'inputMediaUploadedAudio', 'file' => InputFile, 'duration' => int, 'mime_type' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -inputMediaUploadedAudio={_='inputMediaUploadedAudio', file=InputFile, duration=int, mime_type='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedDocument.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedDocument.md index ea213bb7..dc8453de 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedDocument.md +++ b/old_docs/API_docs_v44/constructors/inputMediaUploadedDocument.md @@ -14,9 +14,14 @@ 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| -|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes that specify the type of the document (video, audio, voice, sticker, etc.)| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Attached stickers| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing document| @@ -26,14 +31,14 @@ New document ### Example: ```php -$inputMediaUploadedDocument = ['_' => 'inputMediaUploadedDocument', 'file' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +$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', file=InputFile, mime_type='string', attributes={DocumentAttribute}} +inputMediaUploadedDocument={_='inputMediaUploadedDocument', nosound_video=Bool, force_file=Bool, file=InputFile, thumb=InputFile, mime_type='string', attributes={DocumentAttribute}, stickers={InputDocument}, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedPhoto.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedPhoto.md index 257b603e..fff0dcbf 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedPhoto.md +++ b/old_docs/API_docs_v44/constructors/inputMediaUploadedPhoto.md @@ -15,7 +15,8 @@ Photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file|[File path or InputFile](../types/InputFile.md) | Yes|The [uploaded file](https://core.telegram.org/api/files)| -|caption|[string](../types/string.md) | Yes|Caption| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Attached mask stickers| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| @@ -25,14 +26,14 @@ Photo ### Example: ```php -$inputMediaUploadedPhoto = ['_' => 'inputMediaUploadedPhoto', 'file' => InputFile, 'caption' => 'string']; +$inputMediaUploadedPhoto = ['_' => 'inputMediaUploadedPhoto', 'file' => InputFile, 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int]; ``` Or, if you're into Lua: ```lua -inputMediaUploadedPhoto={_='inputMediaUploadedPhoto', file=InputFile, caption='string'} +inputMediaUploadedPhoto={_='inputMediaUploadedPhoto', file=InputFile, stickers={InputDocument}, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbDocument.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbDocument.md deleted file mode 100644 index 45a58ae9..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbDocument.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: inputMediaUploadedThumbDocument -description: Media uploaded thumb document -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaUploadedThumbDocument -[Back to constructors index](index.md) - - - -Media uploaded thumb document - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|File| -|thumb|[File path or InputFile](../types/InputFile.md) | Yes|Thumbnail| -|mime\_type|[string](../types/string.md) | Optional|Mime type| -|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaUploadedThumbDocument = ['_' => 'inputMediaUploadedThumbDocument', 'file' => InputFile, 'thumb' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; -``` - - -Or, if you're into Lua: - -```lua -inputMediaUploadedThumbDocument={_='inputMediaUploadedThumbDocument', file=InputFile, thumb=InputFile, mime_type='string', attributes={DocumentAttribute}} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbVideo.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbVideo.md deleted file mode 100644 index 242ffa1b..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedThumbVideo.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: inputMediaUploadedThumbVideo -description: Media uploaded thumb video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaUploadedThumbVideo -[Back to constructors index](index.md) - - - -Media uploaded thumb video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|File| -|thumb|[File path or InputFile](../types/InputFile.md) | Yes|Thumbnail| -|duration|[int](../types/int.md) | Yes|Duration| -|w|[int](../types/int.md) | Yes|Width| -|h|[int](../types/int.md) | Yes|Height| -|mime\_type|[string](../types/string.md) | Optional|Mime type| -|caption|[string](../types/string.md) | Yes|Caption| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaUploadedThumbVideo = ['_' => 'inputMediaUploadedThumbVideo', 'file' => InputFile, 'thumb' => InputFile, 'duration' => int, 'w' => int, 'h' => int, 'mime_type' => 'string', 'caption' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -inputMediaUploadedThumbVideo={_='inputMediaUploadedThumbVideo', file=InputFile, thumb=InputFile, duration=int, w=int, h=int, mime_type='string', caption='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMediaUploadedVideo.md b/old_docs/API_docs_v44/constructors/inputMediaUploadedVideo.md deleted file mode 100644 index 26924336..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaUploadedVideo.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: inputMediaUploadedVideo -description: Media uploaded video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaUploadedVideo -[Back to constructors index](index.md) - - - -Media uploaded video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|File| -|duration|[int](../types/int.md) | Yes|Duration| -|w|[int](../types/int.md) | Yes|Width| -|h|[int](../types/int.md) | Yes|Height| -|mime\_type|[string](../types/string.md) | Optional|Mime type| -|caption|[string](../types/string.md) | Yes|Caption| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaUploadedVideo = ['_' => 'inputMediaUploadedVideo', 'file' => InputFile, 'duration' => int, 'w' => int, 'h' => int, 'mime_type' => 'string', 'caption' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -inputMediaUploadedVideo={_='inputMediaUploadedVideo', file=InputFile, duration=int, w=int, h=int, mime_type='string', caption='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMediaVenue.md b/old_docs/API_docs_v44/constructors/inputMediaVenue.md index 021f6de5..b6361d36 100644 --- a/old_docs/API_docs_v44/constructors/inputMediaVenue.md +++ b/old_docs/API_docs_v44/constructors/inputMediaVenue.md @@ -19,6 +19,7 @@ Can be used to send a venue geolocation. |address|[string](../types/string.md) | Yes|Physical address of the venue| |provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| |venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| @@ -28,14 +29,14 @@ Can be used to send a venue geolocation. ### Example: ```php -$inputMediaVenue = ['_' => 'inputMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string']; +$inputMediaVenue = ['_' => 'inputMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; ``` Or, if you're into Lua: ```lua -inputMediaVenue={_='inputMediaVenue', geo_point=InputGeoPoint, title='string', address='string', provider='string', venue_id='string'} +inputMediaVenue={_='inputMediaVenue', geo_point=InputGeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputMediaVideo.md b/old_docs/API_docs_v44/constructors/inputMediaVideo.md deleted file mode 100644 index 41e88e4d..00000000 --- a/old_docs/API_docs_v44/constructors/inputMediaVideo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: inputMediaVideo -description: Media video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMediaVideo -[Back to constructors index](index.md) - - - -Media video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputVideo](../types/InputVideo.md) | Optional|ID| -|caption|[string](../types/string.md) | Yes|Caption| - - - -### Type: [InputMedia](../types/InputMedia.md) - - -### Example: - -```php -$inputMediaVideo = ['_' => 'inputMediaVideo', 'id' => InputVideo, 'caption' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -inputMediaVideo={_='inputMediaVideo', id=InputVideo, caption='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMessageEntityMentionName.md b/old_docs/API_docs_v44/constructors/inputMessageEntityMentionName.md new file mode 100644 index 00000000..31bee751 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessageEntityMentionName.md @@ -0,0 +1,40 @@ +--- +title: inputMessageEntityMentionName +description: Message entity that can be used to create a user [user mention](https://t.me/test): received mentions use the [messageEntityMentionName](../constructors/messageEntityMentionName.md) constructor, instead. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageEntityMentionName +[Back to constructors index](index.md) + + + +Message entity that can be used to create a user [user mention](https://t.me/test): received mentions use the [messageEntityMentionName](../constructors/messageEntityMentionName.md) constructor, instead. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|user\_id|[InputUser](../types/InputUser.md) | Optional|Identifier of the user that was mentioned| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$inputMessageEntityMentionName = ['_' => 'inputMessageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => InputUser]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageEntityMentionName={_='inputMessageEntityMentionName', offset=int, length=int, user_id=InputUser} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessageID.md b/old_docs/API_docs_v44/constructors/inputMessageID.md new file mode 100644 index 00000000..46260dcc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessageID.md @@ -0,0 +1,38 @@ +--- +title: inputMessageID +description: Message by ID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageID +[Back to constructors index](index.md) + + + +Message by ID + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Message ID| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessageID = ['_' => 'inputMessageID', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageID={_='inputMessageID', id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagePinned.md b/old_docs/API_docs_v44/constructors/inputMessagePinned.md new file mode 100644 index 00000000..db74a775 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagePinned.md @@ -0,0 +1,33 @@ +--- +title: inputMessagePinned +description: Pinned message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagePinned +[Back to constructors index](index.md) + + + +Pinned message + + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessagePinned = ['_' => 'inputMessagePinned']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagePinned={_='inputMessagePinned'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessageReplyTo.md b/old_docs/API_docs_v44/constructors/inputMessageReplyTo.md new file mode 100644 index 00000000..992ded1a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessageReplyTo.md @@ -0,0 +1,38 @@ +--- +title: inputMessageReplyTo +description: Message to which the specified message replies to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageReplyTo +[Back to constructors index](index.md) + + + +Message to which the specified message replies to + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|ID of the message that replies to the message we need| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessageReplyTo = ['_' => 'inputMessageReplyTo', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageReplyTo={_='inputMessageReplyTo', id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterAudio.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterAudio.md deleted file mode 100644 index 88b5ba8c..00000000 --- a/old_docs/API_docs_v44/constructors/inputMessagesFilterAudio.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputMessagesFilterAudio -description: Messages filter audio -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMessagesFilterAudio -[Back to constructors index](index.md) - - - -Messages filter audio - - - - -### Type: [MessagesFilter](../types/MessagesFilter.md) - - -### Example: - -```php -$inputMessagesFilterAudio = ['_' => 'inputMessagesFilterAudio']; -``` - - -Or, if you're into Lua: - -```lua -inputMessagesFilterAudio={_='inputMessagesFilterAudio'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterAudioDocuments.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterAudioDocuments.md deleted file mode 100644 index 50f065e4..00000000 --- a/old_docs/API_docs_v44/constructors/inputMessagesFilterAudioDocuments.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputMessagesFilterAudioDocuments -description: Messages filter audio documents -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMessagesFilterAudioDocuments -[Back to constructors index](index.md) - - - -Messages filter audio documents - - - - -### Type: [MessagesFilter](../types/MessagesFilter.md) - - -### Example: - -```php -$inputMessagesFilterAudioDocuments = ['_' => 'inputMessagesFilterAudioDocuments']; -``` - - -Or, if you're into Lua: - -```lua -inputMessagesFilterAudioDocuments={_='inputMessagesFilterAudioDocuments'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterChatPhotos.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterChatPhotos.md new file mode 100644 index 00000000..bbaad234 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterChatPhotos.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterChatPhotos +description: Return only chat photo changes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterChatPhotos +[Back to constructors index](index.md) + + + +Return only chat photo changes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterChatPhotos = ['_' => 'inputMessagesFilterChatPhotos']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterChatPhotos={_='inputMessagesFilterChatPhotos'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterContacts.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterContacts.md new file mode 100644 index 00000000..94994f6f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterContacts.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterContacts +description: Return only messages containing contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterContacts +[Back to constructors index](index.md) + + + +Return only messages containing contacts + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterContacts = ['_' => 'inputMessagesFilterContacts']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterContacts={_='inputMessagesFilterContacts'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterGeo.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterGeo.md new file mode 100644 index 00000000..a3e24fd0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterGeo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterGeo +description: Return only messages containing geolocations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGeo +[Back to constructors index](index.md) + + + +Return only messages containing geolocations + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterGeo = ['_' => 'inputMessagesFilterGeo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterGeo={_='inputMessagesFilterGeo'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterGif.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterGif.md new file mode 100644 index 00000000..dc9218d4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterGif.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterGif +description: Return only messages containing gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGif +[Back to constructors index](index.md) + + + +Return only messages containing gifs + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterGif = ['_' => 'inputMessagesFilterGif']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterGif={_='inputMessagesFilterGif'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterMusic.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterMusic.md new file mode 100644 index 00000000..c7159158 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterMusic.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterMusic +description: Return only messages containing audio files +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMusic +[Back to constructors index](index.md) + + + +Return only messages containing audio files + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterMusic = ['_' => 'inputMessagesFilterMusic']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterMusic={_='inputMessagesFilterMusic'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterMyMentions.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterMyMentions.md new file mode 100644 index 00000000..181f68b3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterMyMentions.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterMyMentions +description: Return only messages where the current user was mentioned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMyMentions +[Back to constructors index](index.md) + + + +Return only messages where the current user was mentioned + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterMyMentions = ['_' => 'inputMessagesFilterMyMentions']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterMyMentions={_='inputMessagesFilterMyMentions'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterPhoneCalls.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterPhoneCalls.md new file mode 100644 index 00000000..5ad65ba9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterPhoneCalls.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterPhoneCalls +description: Return only phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhoneCalls +[Back to constructors index](index.md) + + + +Return only phone calls + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|missed|[Bool](../types/Bool.md) | Optional|Return only missed phone calls| + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterPhoneCalls = ['_' => 'inputMessagesFilterPhoneCalls', 'missed' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterPhoneCalls={_='inputMessagesFilterPhoneCalls', missed=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterPhotoVideoDocuments.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterPhotoVideoDocuments.md deleted file mode 100644 index fb544841..00000000 --- a/old_docs/API_docs_v44/constructors/inputMessagesFilterPhotoVideoDocuments.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputMessagesFilterPhotoVideoDocuments -description: Messages filter photo video documents -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputMessagesFilterPhotoVideoDocuments -[Back to constructors index](index.md) - - - -Messages filter photo video documents - - - - -### Type: [MessagesFilter](../types/MessagesFilter.md) - - -### Example: - -```php -$inputMessagesFilterPhotoVideoDocuments = ['_' => 'inputMessagesFilterPhotoVideoDocuments']; -``` - - -Or, if you're into Lua: - -```lua -inputMessagesFilterPhotoVideoDocuments={_='inputMessagesFilterPhotoVideoDocuments'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVideo.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVideo.md new file mode 100644 index 00000000..d10eeba0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVideo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterRoundVideo +description: Return only round videos +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVideo +[Back to constructors index](index.md) + + + +Return only round videos + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterRoundVideo = ['_' => 'inputMessagesFilterRoundVideo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterRoundVideo={_='inputMessagesFilterRoundVideo'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVoice.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVoice.md new file mode 100644 index 00000000..db0f1f94 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterRoundVoice.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterRoundVoice +description: Return only round videos and voice notes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVoice +[Back to constructors index](index.md) + + + +Return only round videos and voice notes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterRoundVoice = ['_' => 'inputMessagesFilterRoundVoice']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterRoundVoice={_='inputMessagesFilterRoundVoice'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputMessagesFilterVoice.md b/old_docs/API_docs_v44/constructors/inputMessagesFilterVoice.md new file mode 100644 index 00000000..c997d4c3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputMessagesFilterVoice.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterVoice +description: Return only messages containing voice notes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterVoice +[Back to constructors index](index.md) + + + +Return only messages containing voice notes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterVoice = ['_' => 'inputMessagesFilterVoice']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterVoice={_='inputMessagesFilterVoice'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputNotifyAll.md b/old_docs/API_docs_v44/constructors/inputNotifyAll.md deleted file mode 100644 index 9eeea8cb..00000000 --- a/old_docs/API_docs_v44/constructors/inputNotifyAll.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputNotifyAll -description: Notify all -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputNotifyAll -[Back to constructors index](index.md) - - - -Notify all - - - - -### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) - - -### Example: - -```php -$inputNotifyAll = ['_' => 'inputNotifyAll']; -``` - - -Or, if you're into Lua: - -```lua -inputNotifyAll={_='inputNotifyAll'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputNotifyBroadcasts.md b/old_docs/API_docs_v44/constructors/inputNotifyBroadcasts.md new file mode 100644 index 00000000..175adcdf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputNotifyBroadcasts.md @@ -0,0 +1,33 @@ +--- +title: inputNotifyBroadcasts +description: All [channels](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyBroadcasts +[Back to constructors index](index.md) + + + +All [channels](https://core.telegram.org/api/channel) + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +```php +$inputNotifyBroadcasts = ['_' => 'inputNotifyBroadcasts']; +``` + + +Or, if you're into Lua: + +```lua +inputNotifyBroadcasts={_='inputNotifyBroadcasts'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPaymentCredentials.md b/old_docs/API_docs_v44/constructors/inputPaymentCredentials.md new file mode 100644 index 00000000..5ac8ce14 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPaymentCredentials.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentials +description: Payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentials +[Back to constructors index](index.md) + + + +Payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[Bool](../types/Bool.md) | Optional|Save payment credential for future use| +|data|[DataJSON](../types/DataJSON.md) | Yes|Payment credentials| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentials = ['_' => 'inputPaymentCredentials', 'save' => Bool, 'data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentials={_='inputPaymentCredentials', save=Bool, data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPaymentCredentialsAndroidPay.md b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsAndroidPay.md new file mode 100644 index 00000000..81030684 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsAndroidPay.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentialsAndroidPay +description: Android pay payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsAndroidPay +[Back to constructors index](index.md) + + + +Android pay payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|payment\_token|[DataJSON](../types/DataJSON.md) | Yes|Android pay payment token| +|google\_transaction\_id|[string](../types/string.md) | Yes|Google transaction ID| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsAndroidPay = ['_' => 'inputPaymentCredentialsAndroidPay', 'payment_token' => DataJSON, 'google_transaction_id' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsAndroidPay={_='inputPaymentCredentialsAndroidPay', payment_token=DataJSON, google_transaction_id='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPaymentCredentialsApplePay.md b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsApplePay.md new file mode 100644 index 00000000..748af34d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsApplePay.md @@ -0,0 +1,38 @@ +--- +title: inputPaymentCredentialsApplePay +description: Apple pay payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsApplePay +[Back to constructors index](index.md) + + + +Apple pay payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|payment\_data|[DataJSON](../types/DataJSON.md) | Yes|Payment data| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsApplePay = ['_' => 'inputPaymentCredentialsApplePay', 'payment_data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsApplePay={_='inputPaymentCredentialsApplePay', payment_data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPaymentCredentialsSaved.md b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsSaved.md new file mode 100644 index 00000000..27bd7f81 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPaymentCredentialsSaved.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentialsSaved +description: Saved payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsSaved +[Back to constructors index](index.md) + + + +Saved payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Credential ID| +|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsSaved = ['_' => 'inputPaymentCredentialsSaved', 'id' => 'string', 'tmp_password' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsSaved={_='inputPaymentCredentialsSaved', id='string', tmp_password='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPeerChannelFromMessage.md b/old_docs/API_docs_v44/constructors/inputPeerChannelFromMessage.md new file mode 100644 index 00000000..98f51db1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPeerChannelFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputPeerChannelFromMessage +description: Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChannelFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the channel's message was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|channel\_id|[int](../types/int.md) | Yes|The identifier of the channel that was seen| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerChannelFromMessage = ['_' => 'inputPeerChannelFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerChannelFromMessage={_='inputPeerChannelFromMessage', peer=InputPeer, msg_id=int, channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsAll.md b/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsAll.md deleted file mode 100644 index 9299f03e..00000000 --- a/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsAll.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputPeerNotifyEventsAll -description: Peer notify events all -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputPeerNotifyEventsAll -[Back to constructors index](index.md) - - - -Peer notify events all - - - - -### Type: [InputPeerNotifyEvents](../types/InputPeerNotifyEvents.md) - - -### Example: - -```php -$inputPeerNotifyEventsAll = ['_' => 'inputPeerNotifyEventsAll']; -``` - - -Or, if you're into Lua: - -```lua -inputPeerNotifyEventsAll={_='inputPeerNotifyEventsAll'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsEmpty.md b/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsEmpty.md deleted file mode 100644 index a31319e8..00000000 --- a/old_docs/API_docs_v44/constructors/inputPeerNotifyEventsEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputPeerNotifyEventsEmpty -description: Empty input peer notify events -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputPeerNotifyEventsEmpty -[Back to constructors index](index.md) - - - -Empty input peer notify events - - - - -### Type: [InputPeerNotifyEvents](../types/InputPeerNotifyEvents.md) - - -### Example: - -```php -$inputPeerNotifyEventsEmpty = ['_' => 'inputPeerNotifyEventsEmpty']; -``` - - -Or, if you're into Lua: - -```lua -inputPeerNotifyEventsEmpty={_='inputPeerNotifyEventsEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputPeerNotifySettings.md b/old_docs/API_docs_v44/constructors/inputPeerNotifySettings.md index 7ffaf826..780e7a16 100644 --- a/old_docs/API_docs_v44/constructors/inputPeerNotifySettings.md +++ b/old_docs/API_docs_v44/constructors/inputPeerNotifySettings.md @@ -14,10 +14,10 @@ Notification settings. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|mute\_until|[int](../types/int.md) | Yes|Date until which all notifications shall be switched off| -|sound|[string](../types/string.md) | Yes|Name of an audio file for notification| -|show\_previews|[Bool](../types/Bool.md) | Yes|If the text of the message shall be displayed in notification| -|events\_mask|[int](../types/int.md) | Yes|Events mask| +|show\_previews|[Bool](../types/Bool.md) | Optional|If the text of the message shall be displayed in notification| +|silent|[Bool](../types/Bool.md) | Optional|Peer was muted?| +|mute\_until|[int](../types/int.md) | Optional|Date until which all notifications shall be switched off| +|sound|[string](../types/string.md) | Optional|Name of an audio file for notification| @@ -27,14 +27,14 @@ Notification settings. ### Example: ```php -$inputPeerNotifySettings = ['_' => 'inputPeerNotifySettings', 'mute_until' => int, 'sound' => 'string', 'show_previews' => Bool, 'events_mask' => int]; +$inputPeerNotifySettings = ['_' => 'inputPeerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; ``` Or, if you're into Lua: ```lua -inputPeerNotifySettings={_='inputPeerNotifySettings', mute_until=int, sound='string', show_previews=Bool, events_mask=int} +inputPeerNotifySettings={_='inputPeerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputPeerPhotoFileLocation.md b/old_docs/API_docs_v44/constructors/inputPeerPhotoFileLocation.md new file mode 100644 index 00000000..f6816693 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPeerPhotoFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputPeerPhotoFileLocation +description: Location of profile photo of channel/group/supergroup/user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerPhotoFileLocation +[Back to constructors index](index.md) + + + +Location of profile photo of channel/group/supergroup/user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|big|[Bool](../types/Bool.md) | Optional|Whether to download the high-quality version of the picture| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer whose profile picture should be downloaded| +|volume\_id|[long](../types/long.md) | Yes|Volume ID from [FileLocation](../types/FileLocation.md) met in the profile photo container.| +|local\_id|[int](../types/int.md) | Yes|Local ID from [FileLocation](../types/FileLocation.md) met in the profile photo container.| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPeerPhotoFileLocation = ['_' => 'inputPeerPhotoFileLocation', 'big' => Bool, 'peer' => InputPeer, 'volume_id' => long, 'local_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerPhotoFileLocation={_='inputPeerPhotoFileLocation', big=Bool, peer=InputPeer, volume_id=long, local_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPeerUserFromMessage.md b/old_docs/API_docs_v44/constructors/inputPeerUserFromMessage.md new file mode 100644 index 00000000..b5d5a676 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPeerUserFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputPeerUserFromMessage +description: Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerUserFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the user was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[int](../types/int.md) | Yes|The identifier of the user that was seen| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerUserFromMessage = ['_' => 'inputPeerUserFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerUserFromMessage={_='inputPeerUserFromMessage', peer=InputPeer, msg_id=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputVideo.md b/old_docs/API_docs_v44/constructors/inputPhoneCall.md similarity index 53% rename from old_docs/API_docs_v44/constructors/inputVideo.md rename to old_docs/API_docs_v44/constructors/inputPhoneCall.md index 752f82e0..c0f2fc09 100644 --- a/old_docs/API_docs_v44/constructors/inputVideo.md +++ b/old_docs/API_docs_v44/constructors/inputPhoneCall.md @@ -1,38 +1,38 @@ --- -title: inputVideo -description: Video +title: inputPhoneCall +description: Phone call image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: inputVideo +# Constructor: inputPhoneCall [Back to constructors index](index.md) -Video +Phone call ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| +|id|[long](../types/long.md) | Yes|Call ID| |access\_hash|[long](../types/long.md) | Yes|Access hash| -### Type: [InputVideo](../types/InputVideo.md) +### Type: [InputPhoneCall](../types/InputPhoneCall.md) ### Example: ```php -$inputVideo = ['_' => 'inputVideo', 'id' => long, 'access_hash' => long]; +$inputPhoneCall = ['_' => 'inputPhoneCall', 'id' => long, 'access_hash' => long]; ``` Or, if you're into Lua: ```lua -inputVideo={_='inputVideo', id=long, access_hash=long} +inputPhoneCall={_='inputPhoneCall', id=long, access_hash=long} ``` diff --git a/old_docs/API_docs_v44/constructors/inputPhoto.md b/old_docs/API_docs_v44/constructors/inputPhoto.md index 49e4bdb9..6064993f 100644 --- a/old_docs/API_docs_v44/constructors/inputPhoto.md +++ b/old_docs/API_docs_v44/constructors/inputPhoto.md @@ -16,6 +16,7 @@ Defines a photo for further interaction. |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Photo identifier| |access\_hash|[long](../types/long.md) | Yes|**access\_hash** value from the [photo](../constructors/photo.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| @@ -25,14 +26,14 @@ Defines a photo for further interaction. ### Example: ```php -$inputPhoto = ['_' => 'inputPhoto', 'id' => long, 'access_hash' => long]; +$inputPhoto = ['_' => 'inputPhoto', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes']; ``` Or, if you're into Lua: ```lua -inputPhoto={_='inputPhoto', id=long, access_hash=long} +inputPhoto={_='inputPhoto', id=long, access_hash=long, file_reference='bytes'} ``` diff --git a/old_docs/API_docs_v44/constructors/inputPhotoCrop.md b/old_docs/API_docs_v44/constructors/inputPhotoCrop.md deleted file mode 100644 index 2c784a9b..00000000 --- a/old_docs/API_docs_v44/constructors/inputPhotoCrop.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: inputPhotoCrop -description: Photo crop -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputPhotoCrop -[Back to constructors index](index.md) - - - -Photo crop - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|crop\_left|[double](../types/double.md) | Yes|Crop left| -|crop\_top|[double](../types/double.md) | Yes|Crop top| -|crop\_width|[double](../types/double.md) | Yes|Crop width| - - - -### Type: [InputPhotoCrop](../types/InputPhotoCrop.md) - - -### Example: - -```php -$inputPhotoCrop = ['_' => 'inputPhotoCrop', 'crop_left' => double, 'crop_top' => double, 'crop_width' => double]; -``` - - -Or, if you're into Lua: - -```lua -inputPhotoCrop={_='inputPhotoCrop', crop_left=double, crop_top=double, crop_width=double} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputPhotoCropAuto.md b/old_docs/API_docs_v44/constructors/inputPhotoCropAuto.md deleted file mode 100644 index a7800631..00000000 --- a/old_docs/API_docs_v44/constructors/inputPhotoCropAuto.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputPhotoCropAuto -description: Photo crop auto -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputPhotoCropAuto -[Back to constructors index](index.md) - - - -Photo crop auto - - - - -### Type: [InputPhotoCrop](../types/InputPhotoCrop.md) - - -### Example: - -```php -$inputPhotoCropAuto = ['_' => 'inputPhotoCropAuto']; -``` - - -Or, if you're into Lua: - -```lua -inputPhotoCropAuto={_='inputPhotoCropAuto'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputPhotoFileLocation.md b/old_docs/API_docs_v44/constructors/inputPhotoFileLocation.md new file mode 100644 index 00000000..908b4abe --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPhotoFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputPhotoFileLocation +description: Use this object to download a photo with [upload.getFile](../methods/upload.getFile.md) method +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoFileLocation +[Back to constructors index](index.md) + + + +Use this object to download a photo with [upload.getFile](../methods/upload.getFile.md) method + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo ID, obtained from the [photo](../constructors/photo.md) object| +|access\_hash|[long](../types/long.md) | Yes|Photo's access hash, obtained from the [photo](../constructors/photo.md) object| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| +|thumb\_size|[string](../types/string.md) | Yes|The [PhotoSize](../types/PhotoSize.md) to download: must be set to the `type` field of the desired PhotoSize object of the [photo](../constructors/photo.md)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPhotoFileLocation = ['_' => 'inputPhotoFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'thumb_size' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoFileLocation={_='inputPhotoFileLocation', id=long, access_hash=long, file_reference='bytes', thumb_size='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPhotoLegacyFileLocation.md b/old_docs/API_docs_v44/constructors/inputPhotoLegacyFileLocation.md new file mode 100644 index 00000000..ca1553da --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPhotoLegacyFileLocation.md @@ -0,0 +1,43 @@ +--- +title: inputPhotoLegacyFileLocation +description: Legacy photo file location +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoLegacyFileLocation +[Back to constructors index](index.md) + + + +Legacy photo file location + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|file\_reference|[bytes](../types/bytes.md) | Yes|File reference| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| +|secret|[long](../types/long.md) | Yes|Secret| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPhotoLegacyFileLocation = ['_' => 'inputPhotoLegacyFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoLegacyFileLocation={_='inputPhotoLegacyFileLocation', id=long, access_hash=long, file_reference='bytes', volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyAddedByPhone.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyAddedByPhone.md new file mode 100644 index 00000000..e0ed36bb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyAddedByPhone.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyAddedByPhone +description: Whether people can add you to their contact list by your phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyAddedByPhone +[Back to constructors index](index.md) + + + +Whether people can add you to their contact list by your phone number + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyAddedByPhone = ['_' => 'inputPrivacyKeyAddedByPhone']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyAddedByPhone={_='inputPrivacyKeyAddedByPhone'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyChatInvite.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyChatInvite.md new file mode 100644 index 00000000..8540d520 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyChatInvite.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyChatInvite +description: Whether the user can be invited to chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyChatInvite +[Back to constructors index](index.md) + + + +Whether the user can be invited to chats + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyChatInvite = ['_' => 'inputPrivacyKeyChatInvite']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyChatInvite={_='inputPrivacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyForwards.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyForwards.md new file mode 100644 index 00000000..3731887a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyForwards.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyForwards +description: Whether messages forwarded from this user will be [anonymous](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyForwards +[Back to constructors index](index.md) + + + +Whether messages forwarded from this user will be [anonymous](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyForwards = ['_' => 'inputPrivacyKeyForwards']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyForwards={_='inputPrivacyKeyForwards'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneCall.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneCall.md new file mode 100644 index 00000000..65198433 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneCall.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneCall +description: Whether the user will accept phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneCall +[Back to constructors index](index.md) + + + +Whether the user will accept phone calls + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneCall = ['_' => 'inputPrivacyKeyPhoneCall']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneCall={_='inputPrivacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneNumber.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneNumber.md new file mode 100644 index 00000000..ef715dbf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneNumber.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneNumber +description: Whether people will be able to see the user's phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneNumber +[Back to constructors index](index.md) + + + +Whether people will be able to see the user's phone number + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneNumber = ['_' => 'inputPrivacyKeyPhoneNumber']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneNumber={_='inputPrivacyKeyPhoneNumber'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneP2P.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneP2P.md new file mode 100644 index 00000000..8bec8a77 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyPhoneP2P.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneP2P +description: Whether the user allows P2P communication during VoIP calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneP2P +[Back to constructors index](index.md) + + + +Whether the user allows P2P communication during VoIP calls + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneP2P = ['_' => 'inputPrivacyKeyPhoneP2P']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneP2P={_='inputPrivacyKeyPhoneP2P'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyKeyProfilePhoto.md b/old_docs/API_docs_v44/constructors/inputPrivacyKeyProfilePhoto.md new file mode 100644 index 00000000..ece82c63 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyKeyProfilePhoto.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyProfilePhoto +description: Whether people will be able to see the user's profile picture +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyProfilePhoto +[Back to constructors index](index.md) + + + +Whether people will be able to see the user's profile picture + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyProfilePhoto = ['_' => 'inputPrivacyKeyProfilePhoto']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyProfilePhoto={_='inputPrivacyKeyProfilePhoto'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowChatParticipants.md b/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowChatParticipants.md new file mode 100644 index 00000000..fa60bc0c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueAllowChatParticipants +description: Allow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowChatParticipants +[Back to constructors index](index.md) + + + +Allow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Allowed chat IDs| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueAllowChatParticipants = ['_' => 'inputPrivacyValueAllowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueAllowChatParticipants={_='inputPrivacyValueAllowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowUsers.md b/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowUsers.md index 7edf1c49..08f3bd10 100644 --- a/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowUsers.md +++ b/old_docs/API_docs_v44/constructors/inputPrivacyValueAllowUsers.md @@ -14,7 +14,7 @@ Allow only certain users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Allowed users| diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowChatParticipants.md b/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowChatParticipants.md new file mode 100644 index 00000000..a8cfe01e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueDisallowChatParticipants +description: Disallow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowChatParticipants +[Back to constructors index](index.md) + + + +Disallow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Disallowed chat IDs| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueDisallowChatParticipants = ['_' => 'inputPrivacyValueDisallowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueDisallowChatParticipants={_='inputPrivacyValueDisallowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowUsers.md b/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowUsers.md index e3015589..f9b08a53 100644 --- a/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowUsers.md +++ b/old_docs/API_docs_v44/constructors/inputPrivacyValueDisallowUsers.md @@ -14,7 +14,7 @@ Disallow only certain users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users to disallow| diff --git a/old_docs/API_docs_v44/constructors/inputReportReasonChildAbuse.md b/old_docs/API_docs_v44/constructors/inputReportReasonChildAbuse.md new file mode 100644 index 00000000..8e71704b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputReportReasonChildAbuse.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonChildAbuse +description: Report for child abuse +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonChildAbuse +[Back to constructors index](index.md) + + + +Report for child abuse + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonChildAbuse = ['_' => 'inputReportReasonChildAbuse']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonChildAbuse={_='inputReportReasonChildAbuse'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputReportReasonCopyright.md b/old_docs/API_docs_v44/constructors/inputReportReasonCopyright.md new file mode 100644 index 00000000..96575a8c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputReportReasonCopyright.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonCopyright +description: Report for copyrighted content +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonCopyright +[Back to constructors index](index.md) + + + +Report for copyrighted content + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonCopyright = ['_' => 'inputReportReasonCopyright']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonCopyright={_='inputReportReasonCopyright'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputReportReasonGeoIrrelevant.md b/old_docs/API_docs_v44/constructors/inputReportReasonGeoIrrelevant.md new file mode 100644 index 00000000..c66b64b2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputReportReasonGeoIrrelevant.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonGeoIrrelevant +description: Report an irrelevant geogroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonGeoIrrelevant +[Back to constructors index](index.md) + + + +Report an irrelevant geogroup + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonGeoIrrelevant = ['_' => 'inputReportReasonGeoIrrelevant']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonGeoIrrelevant={_='inputReportReasonGeoIrrelevant'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputSecureFile.md b/old_docs/API_docs_v44/constructors/inputSecureFile.md new file mode 100644 index 00000000..80552121 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputSecureFile.md @@ -0,0 +1,39 @@ +--- +title: inputSecureFile +description: Preuploaded [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFile +[Back to constructors index](index.md) + + + +Preuploaded [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Secure file ID| +|access\_hash|[long](../types/long.md) | Yes|Secure file access hash| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +```php +$inputSecureFile = ['_' => 'inputSecureFile', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFile={_='inputSecureFile', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputSecureFileLocation.md b/old_docs/API_docs_v44/constructors/inputSecureFileLocation.md new file mode 100644 index 00000000..7002f48d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputSecureFileLocation.md @@ -0,0 +1,39 @@ +--- +title: inputSecureFileLocation +description: Location of encrypted telegram [passport](https://core.telegram.org/passport) file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileLocation +[Back to constructors index](index.md) + + + +Location of encrypted telegram [passport](https://core.telegram.org/passport) file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|File ID, **id** parameter value from [secureFile](../constructors/secureFile.md)| +|access\_hash|[long](../types/long.md) | Yes|Checksum, **access\_hash** parameter value from [secureFile](../constructors/secureFile.md)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputSecureFileLocation = ['_' => 'inputSecureFileLocation', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFileLocation={_='inputSecureFileLocation', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputSecureFileUploaded.md b/old_docs/API_docs_v44/constructors/inputSecureFileUploaded.md new file mode 100644 index 00000000..51a9c5db --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputSecureFileUploaded.md @@ -0,0 +1,42 @@ +--- +title: inputSecureFileUploaded +description: Uploaded secure file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileUploaded +[Back to constructors index](index.md) + + + +Uploaded secure file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Secure file ID| +|parts|[int](../types/int.md) | Yes|Secure file part count| +|md5\_checksum|[string](../types/string.md) | Yes|MD5 hash of encrypted uploaded file, to be checked server-side| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +```php +$inputSecureFileUploaded = ['_' => 'inputSecureFileUploaded', 'id' => long, 'parts' => int, 'md5_checksum' => 'string', 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFileUploaded={_='inputSecureFileUploaded', id=long, parts=int, md5_checksum='string', file_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputSecureValue.md b/old_docs/API_docs_v44/constructors/inputSecureValue.md new file mode 100644 index 00000000..eb5fd660 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputSecureValue.md @@ -0,0 +1,45 @@ +--- +title: inputSecureValue +description: Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureValue +[Back to constructors index](index.md) + + + +Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure [passport](https://core.telegram.org/passport) value type| +|data|[SecureData](../types/SecureData.md) | Optional|Encrypted [Telegram Passport](https://core.telegram.org/passport) element data| +|front\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the front side of the document| +|reverse\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the reverse side of the document| +|selfie|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with a selfie of the user holding the document| +|translation|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional|Array of encrypted [passport](https://core.telegram.org/passport) files with translated versions of the provided documents| +|files|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional|Array of encrypted [passport](https://core.telegram.org/passport) files with photos the of the documents| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional|Plaintext verified [passport](https://core.telegram.org/passport) data| + + + +### Type: [InputSecureValue](../types/InputSecureValue.md) + + +### Example: + +```php +$inputSecureValue = ['_' => 'inputSecureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => InputSecureFile, 'reverse_side' => InputSecureFile, 'selfie' => InputSecureFile, 'translation' => [InputSecureFile, InputSecureFile], 'files' => [InputSecureFile, InputSecureFile], 'plain_data' => SecurePlainData]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureValue={_='inputSecureValue', type=SecureValueType, data=SecureData, front_side=InputSecureFile, reverse_side=InputSecureFile, selfie=InputSecureFile, translation={InputSecureFile}, files={InputSecureFile}, plain_data=SecurePlainData} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputSingleMedia.md b/old_docs/API_docs_v44/constructors/inputSingleMedia.md new file mode 100644 index 00000000..e730be46 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputSingleMedia.md @@ -0,0 +1,40 @@ +--- +title: inputSingleMedia +description: A single media in an album sent with [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSingleMedia +[Back to constructors index](index.md) + + + +A single media in an album sent with [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[MessageMedia, Message, Update or InputMedia](../types/InputMedia.md) | Optional|The media| +|message|[string](../types/string.md) | Yes|A caption for the media| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text| + + + +### Type: [InputSingleMedia](../types/InputSingleMedia.md) + + +### Example: + +```php +$inputSingleMedia = ['_' => 'inputSingleMedia', 'media' => InputMedia, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +inputSingleMedia={_='inputSingleMedia', media=InputMedia, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickerSetAnimatedEmoji.md b/old_docs/API_docs_v44/constructors/inputStickerSetAnimatedEmoji.md new file mode 100644 index 00000000..61e5c133 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickerSetAnimatedEmoji.md @@ -0,0 +1,33 @@ +--- +title: inputStickerSetAnimatedEmoji +description: Animated emojis stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetAnimatedEmoji +[Back to constructors index](index.md) + + + +Animated emojis stickerset + + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetAnimatedEmoji = ['_' => 'inputStickerSetAnimatedEmoji']; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetAnimatedEmoji={_='inputStickerSetAnimatedEmoji'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickerSetDice.md b/old_docs/API_docs_v44/constructors/inputStickerSetDice.md new file mode 100644 index 00000000..fcc4e388 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickerSetDice.md @@ -0,0 +1,38 @@ +--- +title: inputStickerSetDice +description: Used for fetching [animated dice stickers](https://core.telegram.org/api/dice) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetDice +[Back to constructors index](index.md) + + + +Used for fetching [animated dice stickers](https://core.telegram.org/api/dice) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[string](../types/string.md) | Yes|The emoji, for now 🏀, 🎲 and 🎯 are supported| + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetDice = ['_' => 'inputStickerSetDice', 'emoticon' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetDice={_='inputStickerSetDice', emoticon='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickerSetItem.md b/old_docs/API_docs_v44/constructors/inputStickerSetItem.md new file mode 100644 index 00000000..b20cc934 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickerSetItem.md @@ -0,0 +1,40 @@ +--- +title: inputStickerSetItem +description: Sticker in a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetItem +[Back to constructors index](index.md) + + + +Sticker in a stickerset + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|emoji|[string](../types/string.md) | Yes|Associated emoji| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional|Coordinates for mask sticker| + + + +### Type: [InputStickerSetItem](../types/InputStickerSetItem.md) + + +### Example: + +```php +$inputStickerSetItem = ['_' => 'inputStickerSetItem', 'document' => InputDocument, 'emoji' => 'string', 'mask_coords' => MaskCoords]; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetItem={_='inputStickerSetItem', document=InputDocument, emoji='string', mask_coords=MaskCoords} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickerSetThumb.md b/old_docs/API_docs_v44/constructors/inputStickerSetThumb.md new file mode 100644 index 00000000..7a7d730e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickerSetThumb.md @@ -0,0 +1,40 @@ +--- +title: inputStickerSetThumb +description: Location of stickerset thumbnail (see [files](https://core.telegram.org/api/files)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetThumb +[Back to constructors index](index.md) + + + +Location of stickerset thumbnail (see [files](https://core.telegram.org/api/files)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Sticker set| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputStickerSetThumb = ['_' => 'inputStickerSetThumb', 'stickerset' => InputStickerSet, 'volume_id' => long, 'local_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetThumb={_='inputStickerSetThumb', stickerset=InputStickerSet, volume_id=long, local_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickeredMediaDocument.md b/old_docs/API_docs_v44/constructors/inputStickeredMediaDocument.md new file mode 100644 index 00000000..a5f0aeed --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickeredMediaDocument.md @@ -0,0 +1,38 @@ +--- +title: inputStickeredMediaDocument +description: A document with stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaDocument +[Back to constructors index](index.md) + + + +A document with stickers attached + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The document| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +```php +$inputStickeredMediaDocument = ['_' => 'inputStickeredMediaDocument', 'id' => InputDocument]; +``` + + +Or, if you're into Lua: + +```lua +inputStickeredMediaDocument={_='inputStickeredMediaDocument', id=InputDocument} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputStickeredMediaPhoto.md b/old_docs/API_docs_v44/constructors/inputStickeredMediaPhoto.md new file mode 100644 index 00000000..264365cd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputStickeredMediaPhoto.md @@ -0,0 +1,38 @@ +--- +title: inputStickeredMediaPhoto +description: A photo with stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaPhoto +[Back to constructors index](index.md) + + + +A photo with stickers attached + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|The photo| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +```php +$inputStickeredMediaPhoto = ['_' => 'inputStickeredMediaPhoto', 'id' => InputPhoto]; +``` + + +Or, if you're into Lua: + +```lua +inputStickeredMediaPhoto={_='inputStickeredMediaPhoto', id=InputPhoto} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputTakeoutFileLocation.md b/old_docs/API_docs_v44/constructors/inputTakeoutFileLocation.md new file mode 100644 index 00000000..98957405 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputTakeoutFileLocation.md @@ -0,0 +1,33 @@ +--- +title: inputTakeoutFileLocation +description: Empty constructor for takeout +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputTakeoutFileLocation +[Back to constructors index](index.md) + + + +Empty constructor for takeout + + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputTakeoutFileLocation = ['_' => 'inputTakeoutFileLocation']; +``` + + +Or, if you're into Lua: + +```lua +inputTakeoutFileLocation={_='inputTakeoutFileLocation'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputAudio.md b/old_docs/API_docs_v44/constructors/inputTheme.md similarity index 64% rename from old_docs/API_docs_v44/constructors/inputAudio.md rename to old_docs/API_docs_v44/constructors/inputTheme.md index 1c121fd4..d6b8b66f 100644 --- a/old_docs/API_docs_v44/constructors/inputAudio.md +++ b/old_docs/API_docs_v44/constructors/inputTheme.md @@ -1,14 +1,14 @@ --- -title: inputAudio -description: Audio +title: inputTheme +description: Theme image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: inputAudio +# Constructor: inputTheme [Back to constructors index](index.md) -Audio +Theme ### Attributes: @@ -19,20 +19,20 @@ Audio -### Type: [InputAudio](../types/InputAudio.md) +### Type: [InputTheme](../types/InputTheme.md) ### Example: ```php -$inputAudio = ['_' => 'inputAudio', 'id' => long, 'access_hash' => long]; +$inputTheme = ['_' => 'inputTheme', 'id' => long, 'access_hash' => long]; ``` Or, if you're into Lua: ```lua -inputAudio={_='inputAudio', id=long, access_hash=long} +inputTheme={_='inputTheme', id=long, access_hash=long} ``` diff --git a/old_docs/API_docs_v44/constructors/inputThemeSettings.md b/old_docs/API_docs_v44/constructors/inputThemeSettings.md new file mode 100644 index 00000000..a841d5a8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputThemeSettings.md @@ -0,0 +1,43 @@ +--- +title: inputThemeSettings +description: Theme settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputThemeSettings +[Back to constructors index](index.md) + + + +Theme settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes|Default theme on which this theme is based| +|accent\_color|[int](../types/int.md) | Yes|Accent color, RGB24 format| +|message\_top\_color|[int](../types/int.md) | Optional|Message gradient color (top), RGB24 format| +|message\_bottom\_color|[int](../types/int.md) | Optional|Message gradient color (bottom), RGB24 format| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Optional|Wallpaper| +|wallpaper\_settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings| + + + +### Type: [InputThemeSettings](../types/InputThemeSettings.md) + + +### Example: + +```php +$inputThemeSettings = ['_' => 'inputThemeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => InputWallPaper, 'wallpaper_settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +inputThemeSettings={_='inputThemeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=InputWallPaper, wallpaper_settings=WallPaperSettings} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputThemeSlug.md b/old_docs/API_docs_v44/constructors/inputThemeSlug.md new file mode 100644 index 00000000..d7cdf470 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputThemeSlug.md @@ -0,0 +1,38 @@ +--- +title: inputThemeSlug +description: Theme by theme ID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputThemeSlug +[Back to constructors index](index.md) + + + +Theme by theme ID + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|slug|[string](../types/string.md) | Yes|Unique theme ID| + + + +### Type: [InputTheme](../types/InputTheme.md) + + +### Example: + +```php +$inputThemeSlug = ['_' => 'inputThemeSlug', 'slug' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputThemeSlug={_='inputThemeSlug', slug='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputUserFromMessage.md b/old_docs/API_docs_v44/constructors/inputUserFromMessage.md new file mode 100644 index 00000000..2e8c152e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputUserFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputUserFromMessage +description: Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the user was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[int](../types/int.md) | Yes|The identifier of the user that was seen| + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +```php +$inputUserFromMessage = ['_' => 'inputUserFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputUserFromMessage={_='inputUserFromMessage', peer=InputPeer, msg_id=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputVideoEmpty.md b/old_docs/API_docs_v44/constructors/inputVideoEmpty.md deleted file mode 100644 index 645da333..00000000 --- a/old_docs/API_docs_v44/constructors/inputVideoEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: inputVideoEmpty -description: Empty input video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputVideoEmpty -[Back to constructors index](index.md) - - - -Empty input video - - - - -### Type: [InputVideo](../types/InputVideo.md) - - -### Example: - -```php -$inputVideoEmpty = ['_' => 'inputVideoEmpty']; -``` - - -Or, if you're into Lua: - -```lua -inputVideoEmpty={_='inputVideoEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputVideoFileLocation.md b/old_docs/API_docs_v44/constructors/inputVideoFileLocation.md deleted file mode 100644 index 8c6fb54a..00000000 --- a/old_docs/API_docs_v44/constructors/inputVideoFileLocation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: inputVideoFileLocation -description: Video file location -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: inputVideoFileLocation -[Back to constructors index](index.md) - - - -Video file location - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| -|access\_hash|[long](../types/long.md) | Yes|Access hash| - - - -### Type: [InputFileLocation](../types/InputFileLocation.md) - - -### Example: - -```php -$inputVideoFileLocation = ['_' => 'inputVideoFileLocation', 'id' => long, 'access_hash' => long]; -``` - - -Or, if you're into Lua: - -```lua -inputVideoFileLocation={_='inputVideoFileLocation', id=long, access_hash=long} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/inputWallPaper.md b/old_docs/API_docs_v44/constructors/inputWallPaper.md new file mode 100644 index 00000000..b4ca01ef --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWallPaper.md @@ -0,0 +1,39 @@ +--- +title: inputWallPaper +description: Wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaper +[Back to constructors index](index.md) + + + +Wallpaper + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Wallpaper ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaper = ['_' => 'inputWallPaper', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaper={_='inputWallPaper', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputWallPaperNoFile.md b/old_docs/API_docs_v44/constructors/inputWallPaperNoFile.md new file mode 100644 index 00000000..4807523f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWallPaperNoFile.md @@ -0,0 +1,33 @@ +--- +title: inputWallPaperNoFile +description: Wallpaper with no file +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaperNoFile +[Back to constructors index](index.md) + + + +Wallpaper with no file + + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaperNoFile = ['_' => 'inputWallPaperNoFile']; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaperNoFile={_='inputWallPaperNoFile'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputWallPaperSlug.md b/old_docs/API_docs_v44/constructors/inputWallPaperSlug.md new file mode 100644 index 00000000..eb3def9f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWallPaperSlug.md @@ -0,0 +1,38 @@ +--- +title: inputWallPaperSlug +description: Wallpaper by slug (a unique ID) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaperSlug +[Back to constructors index](index.md) + + + +Wallpaper by slug (a unique ID) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|slug|[string](../types/string.md) | Yes|Unique wallpaper ID| + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaperSlug = ['_' => 'inputWallPaperSlug', 'slug' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaperSlug={_='inputWallPaperSlug', slug='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputWebDocument.md b/old_docs/API_docs_v44/constructors/inputWebDocument.md new file mode 100644 index 00000000..a94cff03 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWebDocument.md @@ -0,0 +1,41 @@ +--- +title: inputWebDocument +description: The document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebDocument +[Back to constructors index](index.md) + + + +The document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Remote document URL to be downloaded using the appropriate [method](https://core.telegram.org/api/files)| +|size|[int](../types/int.md) | Yes|Remote file size| +|mime\_type|[string](../types/string.md) | Yes|Mime type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes for media types| + + + +### Type: [InputWebDocument](../types/InputWebDocument.md) + + +### Example: + +```php +$inputWebDocument = ['_' => 'inputWebDocument', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +inputWebDocument={_='inputWebDocument', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputWebFileGeoPointLocation.md b/old_docs/API_docs_v44/constructors/inputWebFileGeoPointLocation.md new file mode 100644 index 00000000..d9a5bd50 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWebFileGeoPointLocation.md @@ -0,0 +1,43 @@ +--- +title: inputWebFileGeoPointLocation +description: Geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileGeoPointLocation +[Back to constructors index](index.md) + + + +Geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|w|[int](../types/int.md) | Yes|Map width in pixels before applying scale; 16-1024| +|h|[int](../types/int.md) | Yes|Map height in pixels before applying scale; 16-1024| +|zoom|[int](../types/int.md) | Yes|Map zoom level; 13-20| +|scale|[int](../types/int.md) | Yes|Map scale; 1-3| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +```php +$inputWebFileGeoPointLocation = ['_' => 'inputWebFileGeoPointLocation', 'geo_point' => InputGeoPoint, 'access_hash' => long, 'w' => int, 'h' => int, 'zoom' => int, 'scale' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputWebFileGeoPointLocation={_='inputWebFileGeoPointLocation', geo_point=InputGeoPoint, access_hash=long, w=int, h=int, zoom=int, scale=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/inputWebFileLocation.md b/old_docs/API_docs_v44/constructors/inputWebFileLocation.md new file mode 100644 index 00000000..23aa7632 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/inputWebFileLocation.md @@ -0,0 +1,39 @@ +--- +title: inputWebFileLocation +description: Location of a remote HTTP(s) file +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileLocation +[Back to constructors index](index.md) + + + +Location of a remote HTTP(s) file + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|HTTP URL of file| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +```php +$inputWebFileLocation = ['_' => 'inputWebFileLocation', 'url' => 'string', 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputWebFileLocation={_='inputWebFileLocation', url='string', access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/invoice.md b/old_docs/API_docs_v44/constructors/invoice.md new file mode 100644 index 00000000..ecdac5bf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/invoice.md @@ -0,0 +1,47 @@ +--- +title: invoice +description: Invoice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: invoice +[Back to constructors index](index.md) + + + +Invoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|test|[Bool](../types/Bool.md) | Optional|Test invoice| +|name\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's full name to complete the order| +|phone\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's phone number to complete the order| +|email\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's email address to complete the order| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's shipping address to complete the order| +|flexible|[Bool](../types/Bool.md) | Optional|Set this flag if the final price depends on the shipping method| +|phone\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's phone number should be sent to provider| +|email\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's email address should be sent to provider| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes|Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)| + + + +### Type: [Invoice](../types/Invoice.md) + + +### Example: + +```php +$invoice = ['_' => 'invoice', 'test' => Bool, 'name_requested' => Bool, 'phone_requested' => Bool, 'email_requested' => Bool, 'shipping_address_requested' => Bool, 'flexible' => Bool, 'phone_to_provider' => Bool, 'email_to_provider' => Bool, 'currency' => 'string', 'prices' => [LabeledPrice, LabeledPrice]]; +``` + + +Or, if you're into Lua: + +```lua +invoice={_='invoice', test=Bool, name_requested=Bool, phone_requested=Bool, email_requested=Bool, shipping_address_requested=Bool, flexible=Bool, phone_to_provider=Bool, email_to_provider=Bool, currency='string', prices={LabeledPrice}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/jsonArray.md b/old_docs/API_docs_v44/constructors/jsonArray.md new file mode 100644 index 00000000..7de21fe2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonArray.md @@ -0,0 +1,38 @@ +--- +title: jsonArray +description: JSON array +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonArray +[Back to constructors index](index.md) + + + +JSON array + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [JSONValue](../types/JSONValue.md) | Yes|JSON values| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonArray = ['_' => 'jsonArray', 'value' => [JSONValue, JSONValue]]; +``` + + +Or, if you're into Lua: + +```lua +jsonArray={_='jsonArray', value={JSONValue}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/foundGif.md b/old_docs/API_docs_v44/constructors/jsonBool.md similarity index 54% rename from old_docs/API_docs_v44/constructors/foundGif.md rename to old_docs/API_docs_v44/constructors/jsonBool.md index 91b156e5..82f8f4c3 100644 --- a/old_docs/API_docs_v44/constructors/foundGif.md +++ b/old_docs/API_docs_v44/constructors/jsonBool.md @@ -1,37 +1,37 @@ --- -title: foundGif -description: Found GIF +title: jsonBool +description: JSON boolean value image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: foundGif +# Constructor: jsonBool [Back to constructors index](index.md) -Found GIF +JSON boolean value ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|webpage|[WebPage](../types/WebPage.md) | Optional|Webpage| +|value|[Bool](../types/Bool.md) | Yes|Value| -### Type: [FoundGif](../types/FoundGif.md) +### Type: [JSONValue](../types/JSONValue.md) ### Example: ```php -$foundGif = ['_' => 'foundGif', 'webpage' => WebPage]; +$jsonBool = ['_' => 'jsonBool', 'value' => Bool]; ``` Or, if you're into Lua: ```lua -foundGif={_='foundGif', webpage=WebPage} +jsonBool={_='jsonBool', value=Bool} ``` diff --git a/old_docs/API_docs_v44/constructors/jsonNull.md b/old_docs/API_docs_v44/constructors/jsonNull.md new file mode 100644 index 00000000..54e2df01 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonNull.md @@ -0,0 +1,33 @@ +--- +title: jsonNull +description: null JSON value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonNull +[Back to constructors index](index.md) + + + +null JSON value + + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonNull = ['_' => 'jsonNull']; +``` + + +Or, if you're into Lua: + +```lua +jsonNull={_='jsonNull'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/jsonNumber.md b/old_docs/API_docs_v44/constructors/jsonNumber.md new file mode 100644 index 00000000..5af7e3b6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonNumber.md @@ -0,0 +1,38 @@ +--- +title: jsonNumber +description: JSON numeric value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonNumber +[Back to constructors index](index.md) + + + +JSON numeric value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[double](../types/double.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonNumber = ['_' => 'jsonNumber', 'value' => double]; +``` + + +Or, if you're into Lua: + +```lua +jsonNumber={_='jsonNumber', value=double} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/jsonObject.md b/old_docs/API_docs_v44/constructors/jsonObject.md new file mode 100644 index 00000000..877babdf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonObject.md @@ -0,0 +1,38 @@ +--- +title: jsonObject +description: JSON object value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonObject +[Back to constructors index](index.md) + + + +JSON object value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [JSONObjectValue](../types/JSONObjectValue.md) | Yes|Values| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonObject = ['_' => 'jsonObject', 'value' => [JSONObjectValue, JSONObjectValue]]; +``` + + +Or, if you're into Lua: + +```lua +jsonObject={_='jsonObject', value={JSONObjectValue}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/jsonObjectValue.md b/old_docs/API_docs_v44/constructors/jsonObjectValue.md new file mode 100644 index 00000000..56fa49e8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonObjectValue.md @@ -0,0 +1,39 @@ +--- +title: jsonObjectValue +description: JSON key: value pair +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonObjectValue +[Back to constructors index](index.md) + + + +JSON key: value pair + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Key| +|value|[JSONValue](../types/JSONValue.md) | Yes|Value| + + + +### Type: [JSONObjectValue](../types/JSONObjectValue.md) + + +### Example: + +```php +$jsonObjectValue = ['_' => 'jsonObjectValue', 'key' => 'string', 'value' => JSONValue]; +``` + + +Or, if you're into Lua: + +```lua +jsonObjectValue={_='jsonObjectValue', key='string', value=JSONValue} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/jsonString.md b/old_docs/API_docs_v44/constructors/jsonString.md new file mode 100644 index 00000000..a6c052fa --- /dev/null +++ b/old_docs/API_docs_v44/constructors/jsonString.md @@ -0,0 +1,38 @@ +--- +title: jsonString +description: JSON string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonString +[Back to constructors index](index.md) + + + +JSON string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[string](../types/string.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonString = ['_' => 'jsonString', 'value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +jsonString={_='jsonString', value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonBuy.md b/old_docs/API_docs_v44/constructors/keyboardButtonBuy.md new file mode 100644 index 00000000..d327d308 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonBuy.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonBuy +description: Button to buy a product +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonBuy +[Back to constructors index](index.md) + + + +Button to buy a product + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonBuy = ['_' => 'keyboardButtonBuy', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonBuy={_='keyboardButtonBuy', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonCallback.md b/old_docs/API_docs_v44/constructors/keyboardButtonCallback.md new file mode 100644 index 00000000..19251d80 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonCallback.md @@ -0,0 +1,39 @@ +--- +title: keyboardButtonCallback +description: Callback button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonCallback +[Back to constructors index](index.md) + + + +Callback button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| +|data|[bytes](../types/bytes.md) | Yes|Callback data| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonCallback = ['_' => 'keyboardButtonCallback', 'text' => 'string', 'data' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonCallback={_='keyboardButtonCallback', text='string', data='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonGame.md b/old_docs/API_docs_v44/constructors/keyboardButtonGame.md new file mode 100644 index 00000000..c9b6b121 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonGame.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonGame +description: Button to start a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonGame +[Back to constructors index](index.md) + + + +Button to start a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonGame = ['_' => 'keyboardButtonGame', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonGame={_='keyboardButtonGame', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonRequestGeoLocation.md b/old_docs/API_docs_v44/constructors/keyboardButtonRequestGeoLocation.md new file mode 100644 index 00000000..4dc969f1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonRequestGeoLocation.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonRequestGeoLocation +description: Button to request a user's geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestGeoLocation +[Back to constructors index](index.md) + + + +Button to request a user's geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestGeoLocation = ['_' => 'keyboardButtonRequestGeoLocation', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestGeoLocation={_='keyboardButtonRequestGeoLocation', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonRequestPhone.md b/old_docs/API_docs_v44/constructors/keyboardButtonRequestPhone.md new file mode 100644 index 00000000..14ec8e59 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonRequestPhone.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonRequestPhone +description: Button to request a user's phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPhone +[Back to constructors index](index.md) + + + +Button to request a user's phone number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestPhone = ['_' => 'keyboardButtonRequestPhone', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestPhone={_='keyboardButtonRequestPhone', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonRequestPoll.md b/old_docs/API_docs_v44/constructors/keyboardButtonRequestPoll.md new file mode 100644 index 00000000..79fcf944 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonRequestPoll.md @@ -0,0 +1,39 @@ +--- +title: keyboardButtonRequestPoll +description: A button that allows the user to create and send a poll when pressed; available only in private +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPoll +[Back to constructors index](index.md) + + + +A button that allows the user to create and send a poll when pressed; available only in private + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|quiz|[Bool](../types/Bool.md) | Optional|If set, only quiz polls can be sent| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestPoll = ['_' => 'keyboardButtonRequestPoll', 'quiz' => Bool, 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestPoll={_='keyboardButtonRequestPoll', quiz=Bool, text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonRow.md b/old_docs/API_docs_v44/constructors/keyboardButtonRow.md index f19537b3..cd5e3031 100644 --- a/old_docs/API_docs_v44/constructors/keyboardButtonRow.md +++ b/old_docs/API_docs_v44/constructors/keyboardButtonRow.md @@ -14,7 +14,7 @@ Inline keyboard row | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|buttons|Array of [KeyboardButton](../types/KeyboardButton.md) | Yes|Buttons| +|buttons|Array of [KeyboardButton](../types/KeyboardButton.md) | Yes|Bot or inline keyboard buttons| diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonSwitchInline.md b/old_docs/API_docs_v44/constructors/keyboardButtonSwitchInline.md new file mode 100644 index 00000000..98deb2c1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonSwitchInline.md @@ -0,0 +1,40 @@ +--- +title: keyboardButtonSwitchInline +description: Button to force a user to switch to inline mode Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonSwitchInline +[Back to constructors index](index.md) + + + +Button to force a user to switch to inline mode Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|same\_peer|[Bool](../types/Bool.md) | Optional|If set, pressing the button will insert the bot‘s username and the specified inline `query` in the current chat's input field.| +|text|[string](../types/string.md) | Yes|Button label| +|query|[string](../types/string.md) | Yes|The inline query to use| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonSwitchInline = ['_' => 'keyboardButtonSwitchInline', 'same_peer' => Bool, 'text' => 'string', 'query' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonSwitchInline={_='keyboardButtonSwitchInline', same_peer=Bool, text='string', query='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonUrl.md b/old_docs/API_docs_v44/constructors/keyboardButtonUrl.md new file mode 100644 index 00000000..39589559 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonUrl.md @@ -0,0 +1,39 @@ +--- +title: keyboardButtonUrl +description: URL button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonUrl +[Back to constructors index](index.md) + + + +URL button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button label| +|url|[string](../types/string.md) | Yes|URL| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonUrl = ['_' => 'keyboardButtonUrl', 'text' => 'string', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonUrl={_='keyboardButtonUrl', text='string', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/keyboardButtonUrlAuth.md b/old_docs/API_docs_v44/constructors/keyboardButtonUrlAuth.md new file mode 100644 index 00000000..29443267 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/keyboardButtonUrlAuth.md @@ -0,0 +1,41 @@ +--- +title: keyboardButtonUrlAuth +description: Button to request a user to authorize via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). When the user clicks on such a button, [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md) should be called, providing the `button_id` and the ID of the container message. The returned [urlAuthResultRequest](../constructors/urlAuthResultRequest.md) object will contain more details about the authorization request (`request_write_access` if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call [messages.acceptUrlAuth](../methods/messages.acceptUrlAuth.md) to get a [urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) with the URL to open instead of the `url` of this constructor, or a [urlAuthResultDefault](../constructors/urlAuthResultDefault.md), in which case the `url` of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the `url` of this constructor must be used. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonUrlAuth +[Back to constructors index](index.md) + + + +Button to request a user to authorize via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). When the user clicks on such a button, [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md) should be called, providing the `button_id` and the ID of the container message. The returned [urlAuthResultRequest](../constructors/urlAuthResultRequest.md) object will contain more details about the authorization request (`request_write_access` if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call [messages.acceptUrlAuth](../methods/messages.acceptUrlAuth.md) to get a [urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) with the URL to open instead of the `url` of this constructor, or a [urlAuthResultDefault](../constructors/urlAuthResultDefault.md), in which case the `url` of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the `url` of this constructor must be used. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button label| +|fwd\_text|[string](../types/string.md) | Optional|New text of the button in forwarded messages.| +|url|[string](../types/string.md) | Yes|An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data).
**NOTE**: Services must **always** check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization).| +|button\_id|[int](../types/int.md) | Yes|ID of the button to pass to [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md)| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonUrlAuth = ['_' => 'keyboardButtonUrlAuth', 'text' => 'string', 'fwd_text' => 'string', 'url' => 'string', 'button_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonUrlAuth={_='keyboardButtonUrlAuth', text='string', fwd_text='string', url='string', button_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/labeledPrice.md b/old_docs/API_docs_v44/constructors/labeledPrice.md new file mode 100644 index 00000000..5c33cec5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/labeledPrice.md @@ -0,0 +1,39 @@ +--- +title: labeledPrice +description: This object represents a portion of the price for goods or services. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: labeledPrice +[Back to constructors index](index.md) + + + +This object represents a portion of the price for goods or services. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|label|[string](../types/string.md) | Yes|Portion label| +|amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [LabeledPrice](../types/LabeledPrice.md) + + +### Example: + +```php +$labeledPrice = ['_' => 'labeledPrice', 'label' => 'string', 'amount' => long]; +``` + + +Or, if you're into Lua: + +```lua +labeledPrice={_='labeledPrice', label='string', amount=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/langPackDifference.md b/old_docs/API_docs_v44/constructors/langPackDifference.md new file mode 100644 index 00000000..e0f531c3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/langPackDifference.md @@ -0,0 +1,41 @@ +--- +title: langPackDifference +description: Changes to the app's localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackDifference +[Back to constructors index](index.md) + + + +Changes to the app's localization pack + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|from\_version|[int](../types/int.md) | Yes|Previous version number| +|version|[int](../types/int.md) | Yes|New version number| +|strings|Array of [LangPackString](../types/LangPackString.md) | Yes|Localized strings| + + + +### Type: [LangPackDifference](../types/LangPackDifference.md) + + +### Example: + +```php +$langPackDifference = ['_' => 'langPackDifference', 'lang_code' => 'string', 'from_version' => int, 'version' => int, 'strings' => [LangPackString, LangPackString]]; +``` + + +Or, if you're into Lua: + +```lua +langPackDifference={_='langPackDifference', lang_code='string', from_version=int, version=int, strings={LangPackString}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/langPackLanguage.md b/old_docs/API_docs_v44/constructors/langPackLanguage.md new file mode 100644 index 00000000..8824132c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/langPackLanguage.md @@ -0,0 +1,48 @@ +--- +title: langPackLanguage +description: Identifies a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackLanguage +[Back to constructors index](index.md) + + + +Identifies a localization pack + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|official|[Bool](../types/Bool.md) | Optional|Whether the language pack is official| +|rtl|[Bool](../types/Bool.md) | Optional|Is this a localization pack for an RTL language| +|beta|[Bool](../types/Bool.md) | Optional|Is this a beta localization pack?| +|name|[string](../types/string.md) | Yes|Language name| +|native\_name|[string](../types/string.md) | Yes|Language name in the language itself| +|lang\_code|[string](../types/string.md) | Yes|Language code (pack identifier)| +|base\_lang\_code|[string](../types/string.md) | Optional|Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it should be fetched from base language pack. Unsupported in custom language packs| +|plural\_code|[string](../types/string.md) | Yes|A language code to be used to apply plural forms. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info| +|strings\_count|[int](../types/int.md) | Yes|Total number of non-deleted strings from the language pack| +|translated\_count|[int](../types/int.md) | Yes|Total number of translated strings from the language pack| +|translations\_url|[string](../types/string.md) | Yes|Link to language translation interface; empty for custom local language packs| + + + +### Type: [LangPackLanguage](../types/LangPackLanguage.md) + + +### Example: + +```php +$langPackLanguage = ['_' => 'langPackLanguage', 'official' => Bool, 'rtl' => Bool, 'beta' => Bool, 'name' => 'string', 'native_name' => 'string', 'lang_code' => 'string', 'base_lang_code' => 'string', 'plural_code' => 'string', 'strings_count' => int, 'translated_count' => int, 'translations_url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackLanguage={_='langPackLanguage', official=Bool, rtl=Bool, beta=Bool, name='string', native_name='string', lang_code='string', base_lang_code='string', plural_code='string', strings_count=int, translated_count=int, translations_url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/langPackString.md b/old_docs/API_docs_v44/constructors/langPackString.md new file mode 100644 index 00000000..24e2537e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/langPackString.md @@ -0,0 +1,39 @@ +--- +title: langPackString +description: Translated localization string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackString +[Back to constructors index](index.md) + + + +Translated localization string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Language key| +|value|[string](../types/string.md) | Yes|Value| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackString = ['_' => 'langPackString', 'key' => 'string', 'value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackString={_='langPackString', key='string', value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/langPackStringDeleted.md b/old_docs/API_docs_v44/constructors/langPackStringDeleted.md new file mode 100644 index 00000000..2c8cc573 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/langPackStringDeleted.md @@ -0,0 +1,38 @@ +--- +title: langPackStringDeleted +description: Deleted localization string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringDeleted +[Back to constructors index](index.md) + + + +Deleted localization string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Localization key| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackStringDeleted = ['_' => 'langPackStringDeleted', 'key' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackStringDeleted={_='langPackStringDeleted', key='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/langPackStringPluralized.md b/old_docs/API_docs_v44/constructors/langPackStringPluralized.md new file mode 100644 index 00000000..dd0dc602 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/langPackStringPluralized.md @@ -0,0 +1,44 @@ +--- +title: langPackStringPluralized +description: A language pack string which has different forms based on the number of some object it mentions. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringPluralized +[Back to constructors index](index.md) + + + +A language pack string which has different forms based on the number of some object it mentions. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Localization key| +|zero\_value|[string](../types/string.md) | Optional|Value for zero objects| +|one\_value|[string](../types/string.md) | Optional|Value for one object| +|two\_value|[string](../types/string.md) | Optional|Value for two objects| +|few\_value|[string](../types/string.md) | Optional|Value for a few objects| +|many\_value|[string](../types/string.md) | Optional|Value for many objects| +|other\_value|[string](../types/string.md) | Yes|Default value| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackStringPluralized = ['_' => 'langPackStringPluralized', 'key' => 'string', 'zero_value' => 'string', 'one_value' => 'string', 'two_value' => 'string', 'few_value' => 'string', 'many_value' => 'string', 'other_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackStringPluralized={_='langPackStringPluralized', key='string', zero_value='string', one_value='string', two_value='string', few_value='string', many_value='string', other_value='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/maskCoords.md b/old_docs/API_docs_v44/constructors/maskCoords.md new file mode 100644 index 00000000..9e83fb87 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/maskCoords.md @@ -0,0 +1,55 @@ +--- +title: maskCoords +description: Position on a photo where a mask should be placed + +The `n` position indicates where the mask should be placed: + +- 0 => Relative to the forehead +- 1 => Relative to the eyes +- 2 => Relative to the mouth +- 3 => Relative to the chin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: maskCoords +[Back to constructors index](index.md) + + + +Position on a photo where a mask should be placed + +The `n` position indicates where the mask should be placed: + +- 0 => Relative to the forehead +- 1 => Relative to the eyes +- 2 => Relative to the mouth +- 3 => Relative to the chin + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|n|[int](../types/int.md) | Yes|Part of the face, relative to which the mask should be placed| +|x|[double](../types/double.md) | Yes|Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)| +|y|[double](../types/double.md) | Yes|Shift by Y-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)| +|zoom|[double](../types/double.md) | Yes|Mask scaling coefficient. (For example, 2.0 means a doubled size)| + + + +### Type: [MaskCoords](../types/MaskCoords.md) + + +### Example: + +```php +$maskCoords = ['_' => 'maskCoords', 'n' => int, 'x' => double, 'y' => double, 'zoom' => double]; +``` + + +Or, if you're into Lua: + +```lua +maskCoords={_='maskCoords', n=int, x=double, y=double, zoom=double} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/message.md b/old_docs/API_docs_v44/constructors/message.md index a7330ebe..9a51204b 100644 --- a/old_docs/API_docs_v44/constructors/message.md +++ b/old_docs/API_docs_v44/constructors/message.md @@ -14,22 +14,30 @@ A message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Unread?| |out|[Bool](../types/Bool.md) | Optional|Is this an outgoing message| |mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in this message| |media\_unread|[Bool](../types/Bool.md) | Optional|Whether there are unread media attachments in this message| +|silent|[Bool](../types/Bool.md) | Optional|Whether this is a silent message (no notification triggered)| +|post|[Bool](../types/Bool.md) | Optional|Whether this is a channel post| +|from\_scheduled|[Bool](../types/Bool.md) | Optional|Whether this is a scheduled post| +|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer| +|edit\_hide|[Bool](../types/Bool.md) | Optional|Whether the message should be shown as not modified to the user, even if an edit date is present| |id|[int](../types/int.md) | Yes|ID of the message| |from\_id|[int](../types/int.md) | Optional|ID of the sender of the message| |to\_id|[Peer](../types/Peer.md) | Yes|ID of the chat were the message was sent| -|fwd\_from\_id|[Peer](../types/Peer.md) | Optional|Forwarded from ID| -|fwd\_date|[int](../types/int.md) | Optional|Forwarded date| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about forwarded messages| +|via\_bot\_id|[int](../types/int.md) | Optional|ID of the inline bot that generated the message| |reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| |date|[int](../types/int.md) | Yes|Date of the message| |message|[string](../types/string.md) | Yes|The message| |media|[MessageMedia](../types/MessageMedia.md) | Optional|Media attachment| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup (bot/inline keyboards)| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text| |views|[int](../types/int.md) | Optional|View count for channel posts| +|edit\_date|[int](../types/int.md) | Optional|Last edit date of this message| +|post\_author|[string](../types/string.md) | Optional|Name of the author of this message for channel posts (with signatures enabled)| +|grouped\_id|[long](../types/long.md) | Optional|Multiple media messages sent using [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md) with the same grouped ID indicate an album| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Contains the reason why access to this message must be restricted.| @@ -39,14 +47,14 @@ A message ### Example: ```php -$message = ['_' => 'message', 'unread' => Bool, 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'fwd_from_id' => Peer, 'fwd_date' => int, 'reply_to_msg_id' => int, 'date' => int, 'message' => 'string', 'media' => MessageMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'views' => int]; +$message = ['_' => 'message', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'from_scheduled' => Bool, 'legacy' => Bool, 'edit_hide' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'date' => int, 'message' => 'string', 'media' => MessageMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'views' => int, 'edit_date' => int, 'post_author' => 'string', 'grouped_id' => long, 'restriction_reason' => [RestrictionReason, RestrictionReason]]; ``` Or, if you're into Lua: ```lua -message={_='message', unread=Bool, out=Bool, mentioned=Bool, media_unread=Bool, id=int, from_id=int, to_id=Peer, fwd_from_id=Peer, fwd_date=int, reply_to_msg_id=int, date=int, message='string', media=MessageMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, views=int} +message={_='message', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, from_scheduled=Bool, legacy=Bool, edit_hide=Bool, id=int, from_id=int, to_id=Peer, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, date=int, message='string', media=MessageMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, views=int, edit_date=int, post_author='string', grouped_id=long, restriction_reason={RestrictionReason}} ``` diff --git a/old_docs/API_docs_v44/constructors/messageActionBotAllowed.md b/old_docs/API_docs_v44/constructors/messageActionBotAllowed.md new file mode 100644 index 00000000..3b0b5119 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionBotAllowed.md @@ -0,0 +1,38 @@ +--- +title: messageActionBotAllowed +description: The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionBotAllowed +[Back to constructors index](index.md) + + + +The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user has logged in.| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionBotAllowed = ['_' => 'messageActionBotAllowed', 'domain' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionBotAllowed={_='messageActionBotAllowed', domain='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionChatAddUser.md b/old_docs/API_docs_v44/constructors/messageActionChatAddUser.md index b475a59a..1da6b7bc 100644 --- a/old_docs/API_docs_v44/constructors/messageActionChatAddUser.md +++ b/old_docs/API_docs_v44/constructors/messageActionChatAddUser.md @@ -14,7 +14,7 @@ New member in the group | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|users|Array of [int](../types/int.md) | Yes|Users| +|users|Array of [int](../types/int.md) | Yes|Users that were invited to the chat| diff --git a/old_docs/API_docs_v44/constructors/messageActionChatCreate.md b/old_docs/API_docs_v44/constructors/messageActionChatCreate.md index 4a75cfbf..4d0ba14e 100644 --- a/old_docs/API_docs_v44/constructors/messageActionChatCreate.md +++ b/old_docs/API_docs_v44/constructors/messageActionChatCreate.md @@ -15,7 +15,7 @@ Group created | Name | Type | Required | Description | |----------|---------------|----------|-------------| |title|[string](../types/string.md) | Yes|Group name| -|users|Array of [int](../types/int.md) | Yes|Users| +|users|Array of [int](../types/int.md) | Yes|List of group members| diff --git a/old_docs/API_docs_v44/constructors/messageActionContactSignUp.md b/old_docs/API_docs_v44/constructors/messageActionContactSignUp.md new file mode 100644 index 00000000..363af97a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionContactSignUp.md @@ -0,0 +1,33 @@ +--- +title: messageActionContactSignUp +description: A contact just signed up to telegram +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionContactSignUp +[Back to constructors index](index.md) + + + +A contact just signed up to telegram + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionContactSignUp = ['_' => 'messageActionContactSignUp']; +``` + + +Or, if you're into Lua: + +```lua +messageActionContactSignUp={_='messageActionContactSignUp'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionCustomAction.md b/old_docs/API_docs_v44/constructors/messageActionCustomAction.md new file mode 100644 index 00000000..f5c1c354 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionCustomAction.md @@ -0,0 +1,38 @@ +--- +title: messageActionCustomAction +description: Custom action (most likely not supported by the current layer, an upgrade might be needed) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionCustomAction +[Back to constructors index](index.md) + + + +Custom action (most likely not supported by the current layer, an upgrade might be needed) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Action message| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionCustomAction = ['_' => 'messageActionCustomAction', 'message' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionCustomAction={_='messageActionCustomAction', message='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionGameScore.md b/old_docs/API_docs_v44/constructors/messageActionGameScore.md new file mode 100644 index 00000000..aed301e2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionGameScore.md @@ -0,0 +1,39 @@ +--- +title: messageActionGameScore +description: Someone scored in a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionGameScore +[Back to constructors index](index.md) + + + +Someone scored in a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game\_id|[long](../types/long.md) | Yes|Game ID| +|score|[int](../types/int.md) | Yes|Score| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionGameScore = ['_' => 'messageActionGameScore', 'game_id' => long, 'score' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionGameScore={_='messageActionGameScore', game_id=long, score=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionHistoryClear.md b/old_docs/API_docs_v44/constructors/messageActionHistoryClear.md new file mode 100644 index 00000000..cc1560e9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionHistoryClear.md @@ -0,0 +1,33 @@ +--- +title: messageActionHistoryClear +description: Chat history was cleared +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionHistoryClear +[Back to constructors index](index.md) + + + +Chat history was cleared + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionHistoryClear = ['_' => 'messageActionHistoryClear']; +``` + + +Or, if you're into Lua: + +```lua +messageActionHistoryClear={_='messageActionHistoryClear'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionPaymentSent.md b/old_docs/API_docs_v44/constructors/messageActionPaymentSent.md new file mode 100644 index 00000000..2850e8b8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionPaymentSent.md @@ -0,0 +1,39 @@ +--- +title: messageActionPaymentSent +description: A payment was sent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSent +[Back to constructors index](index.md) + + + +A payment was sent + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPaymentSent = ['_' => 'messageActionPaymentSent', 'currency' => 'string', 'total_amount' => long]; +``` + + +Or, if you're into Lua: + +```lua +messageActionPaymentSent={_='messageActionPaymentSent', currency='string', total_amount=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionPaymentSentMe.md b/old_docs/API_docs_v44/constructors/messageActionPaymentSentMe.md new file mode 100644 index 00000000..07e7361a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionPaymentSentMe.md @@ -0,0 +1,43 @@ +--- +title: messageActionPaymentSentMe +description: A user just sent a payment to me (a bot) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSentMe +[Back to constructors index](index.md) + + + +A user just sent a payment to me (a bot) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Order info provided by the user| +|shipping\_option\_id|[string](../types/string.md) | Optional|Identifier of the shipping option chosen by the user| +|charge|[PaymentCharge](../types/PaymentCharge.md) | Yes|Provider payment identifier| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPaymentSentMe = ['_' => 'messageActionPaymentSentMe', 'currency' => 'string', 'total_amount' => long, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'charge' => PaymentCharge]; +``` + + +Or, if you're into Lua: + +```lua +messageActionPaymentSentMe={_='messageActionPaymentSentMe', currency='string', total_amount=long, payload='bytes', info=PaymentRequestedInfo, shipping_option_id='string', charge=PaymentCharge} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionPhoneCall.md b/old_docs/API_docs_v44/constructors/messageActionPhoneCall.md new file mode 100644 index 00000000..94d9b2f3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionPhoneCall.md @@ -0,0 +1,41 @@ +--- +title: messageActionPhoneCall +description: A phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPhoneCall +[Back to constructors index](index.md) + + + +A phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Is this a video call?| +|call\_id|[long](../types/long.md) | Yes|Call ID| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional|If the call has ended, the reason why it ended| +|duration|[int](../types/int.md) | Optional|Duration of the call in seconds| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPhoneCall = ['_' => 'messageActionPhoneCall', 'video' => Bool, 'call_id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionPhoneCall={_='messageActionPhoneCall', video=Bool, call_id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionPinMessage.md b/old_docs/API_docs_v44/constructors/messageActionPinMessage.md new file mode 100644 index 00000000..af8881cc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionPinMessage.md @@ -0,0 +1,33 @@ +--- +title: messageActionPinMessage +description: A message was pinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPinMessage +[Back to constructors index](index.md) + + + +A message was pinned + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPinMessage = ['_' => 'messageActionPinMessage']; +``` + + +Or, if you're into Lua: + +```lua +messageActionPinMessage={_='messageActionPinMessage'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionScreenshotTaken.md b/old_docs/API_docs_v44/constructors/messageActionScreenshotTaken.md new file mode 100644 index 00000000..6f5df8d1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionScreenshotTaken.md @@ -0,0 +1,33 @@ +--- +title: messageActionScreenshotTaken +description: A screenshot of the chat was taken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionScreenshotTaken +[Back to constructors index](index.md) + + + +A screenshot of the chat was taken + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionScreenshotTaken = ['_' => 'messageActionScreenshotTaken']; +``` + + +Or, if you're into Lua: + +```lua +messageActionScreenshotTaken={_='messageActionScreenshotTaken'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionSecureValuesSent.md b/old_docs/API_docs_v44/constructors/messageActionSecureValuesSent.md new file mode 100644 index 00000000..49998904 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionSecureValuesSent.md @@ -0,0 +1,38 @@ +--- +title: messageActionSecureValuesSent +description: Request for secure [telegram passport](https://core.telegram.org/passport) values was sent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSent +[Back to constructors index](index.md) + + + +Request for secure [telegram passport](https://core.telegram.org/passport) values was sent + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|Secure value types| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionSecureValuesSent = ['_' => 'messageActionSecureValuesSent', 'types' => [SecureValueType, SecureValueType]]; +``` + + +Or, if you're into Lua: + +```lua +messageActionSecureValuesSent={_='messageActionSecureValuesSent', types={SecureValueType}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageActionSecureValuesSentMe.md b/old_docs/API_docs_v44/constructors/messageActionSecureValuesSentMe.md new file mode 100644 index 00000000..72e6fe40 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageActionSecureValuesSentMe.md @@ -0,0 +1,39 @@ +--- +title: messageActionSecureValuesSentMe +description: Secure [telegram passport](https://core.telegram.org/passport) values were received +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSentMe +[Back to constructors index](index.md) + + + +Secure [telegram passport](https://core.telegram.org/passport) values were received + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Vector with information about documents and other Telegram Passport elements that were shared with the bot| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Yes|Encrypted credentials required to decrypt the data| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionSecureValuesSentMe = ['_' => 'messageActionSecureValuesSentMe', 'values' => [SecureValue, SecureValue], 'credentials' => SecureCredentialsEncrypted]; +``` + + +Or, if you're into Lua: + +```lua +messageActionSecureValuesSentMe={_='messageActionSecureValuesSentMe', values={SecureValue}, credentials=SecureCredentialsEncrypted} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityBankCard.md b/old_docs/API_docs_v44/constructors/messageEntityBankCard.md new file mode 100644 index 00000000..0cc76109 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityBankCard.md @@ -0,0 +1,39 @@ +--- +title: messageEntityBankCard +description: Indicates a credit card number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBankCard +[Back to constructors index](index.md) + + + +Indicates a credit card number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityBankCard = ['_' => 'messageEntityBankCard', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityBankCard={_='messageEntityBankCard', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityBlockquote.md b/old_docs/API_docs_v44/constructors/messageEntityBlockquote.md new file mode 100644 index 00000000..3fe46f32 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityBlockquote.md @@ -0,0 +1,39 @@ +--- +title: messageEntityBlockquote +description: Message entity representing a block quote. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBlockquote +[Back to constructors index](index.md) + + + +Message entity representing a block quote. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityBlockquote = ['_' => 'messageEntityBlockquote', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityBlockquote={_='messageEntityBlockquote', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityCashtag.md b/old_docs/API_docs_v44/constructors/messageEntityCashtag.md new file mode 100644 index 00000000..ba480e37 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityCashtag.md @@ -0,0 +1,39 @@ +--- +title: messageEntityCashtag +description: Message entity representing a **$cashtag**. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityCashtag +[Back to constructors index](index.md) + + + +Message entity representing a **$cashtag**. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityCashtag = ['_' => 'messageEntityCashtag', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityCashtag={_='messageEntityCashtag', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityMentionName.md b/old_docs/API_docs_v44/constructors/messageEntityMentionName.md new file mode 100644 index 00000000..76524eaf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityMentionName.md @@ -0,0 +1,40 @@ +--- +title: messageEntityMentionName +description: Message entity representing a [user mention](https://t.me/test): for *creating* a mention use [inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityMentionName +[Back to constructors index](index.md) + + + +Message entity representing a [user mention](https://t.me/test): for *creating* a mention use [inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|user\_id|[int](../types/int.md) | Yes|Identifier of the user that was mentioned| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityMentionName = ['_' => 'messageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityMentionName={_='messageEntityMentionName', offset=int, length=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityPhone.md b/old_docs/API_docs_v44/constructors/messageEntityPhone.md new file mode 100644 index 00000000..19b30658 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityPhone.md @@ -0,0 +1,39 @@ +--- +title: messageEntityPhone +description: Message entity representing a phone number. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityPhone +[Back to constructors index](index.md) + + + +Message entity representing a phone number. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityPhone = ['_' => 'messageEntityPhone', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityPhone={_='messageEntityPhone', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityStrike.md b/old_docs/API_docs_v44/constructors/messageEntityStrike.md new file mode 100644 index 00000000..32d3c490 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityStrike.md @@ -0,0 +1,39 @@ +--- +title: messageEntityStrike +description: Message entity representingstrikethroughtext. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityStrike +[Back to constructors index](index.md) + + + +Message entity representingstrikethroughtext. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityStrike = ['_' => 'messageEntityStrike', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityStrike={_='messageEntityStrike', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageEntityUnderline.md b/old_docs/API_docs_v44/constructors/messageEntityUnderline.md new file mode 100644 index 00000000..2a94a886 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageEntityUnderline.md @@ -0,0 +1,39 @@ +--- +title: messageEntityUnderline +description: Message entity representing underlined text. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUnderline +[Back to constructors index](index.md) + + + +Message entity representing underlined text. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityUnderline = ['_' => 'messageEntityUnderline', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityUnderline={_='messageEntityUnderline', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageFwdHeader.md b/old_docs/API_docs_v44/constructors/messageFwdHeader.md new file mode 100644 index 00000000..56f2bc67 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageFwdHeader.md @@ -0,0 +1,46 @@ +--- +title: messageFwdHeader +description: Info about a forwarded message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageFwdHeader +[Back to constructors index](index.md) + + + +Info about a forwarded message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|from\_id|[int](../types/int.md) | Optional|The ID of the user that originally sent the message| +|from\_name|[string](../types/string.md) | Optional|The name of the user that originally sent the message| +|date|[int](../types/int.md) | Yes|When was the message originally sent| +|channel\_id|[int](../types/int.md) | Optional|ID of the channel from which the message was forwarded| +|channel\_post|[int](../types/int.md) | Optional|ID of the channel message that was forwarded| +|post\_author|[string](../types/string.md) | Optional|For channels and if signatures are enabled, author of the channel message| +|saved\_from\_peer|[Peer](../types/Peer.md) | Optional|Only for messages forwarded to the current user (inputPeerSelf), full info about the user/channel that originally sent the message| +|saved\_from\_msg\_id|[int](../types/int.md) | Optional|Only for messages forwarded to the current user (inputPeerSelf), ID of the message that was forwarded from the original user/channel| +|psa\_type|[string](../types/string.md) | Optional|PSA type| + + + +### Type: [MessageFwdHeader](../types/MessageFwdHeader.md) + + +### Example: + +```php +$messageFwdHeader = ['_' => 'messageFwdHeader', 'from_id' => int, 'from_name' => 'string', 'date' => int, 'channel_id' => int, 'channel_post' => int, 'post_author' => 'string', 'saved_from_peer' => Peer, 'saved_from_msg_id' => int, 'psa_type' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageFwdHeader={_='messageFwdHeader', from_id=int, from_name='string', date=int, channel_id=int, channel_post=int, post_author='string', saved_from_peer=Peer, saved_from_msg_id=int, psa_type='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageGroup.md b/old_docs/API_docs_v44/constructors/messageGroup.md deleted file mode 100644 index 0b987400..00000000 --- a/old_docs/API_docs_v44/constructors/messageGroup.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: messageGroup -description: Message group -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: messageGroup -[Back to constructors index](index.md) - - - -Message group - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|min\_id|[int](../types/int.md) | Yes|Min ID| -|max\_id|[int](../types/int.md) | Yes|Max ID| -|count|[int](../types/int.md) | Yes|Count| -|date|[int](../types/int.md) | Yes|Date| - - - -### Type: [MessageGroup](../types/MessageGroup.md) - - -### Example: - -```php -$messageGroup = ['_' => 'messageGroup', 'min_id' => int, 'max_id' => int, 'count' => int, 'date' => int]; -``` - - -Or, if you're into Lua: - -```lua -messageGroup={_='messageGroup', min_id=int, max_id=int, count=int, date=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/messageInteractionCounters.md b/old_docs/API_docs_v44/constructors/messageInteractionCounters.md new file mode 100644 index 00000000..21103671 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageInteractionCounters.md @@ -0,0 +1,40 @@ +--- +title: messageInteractionCounters +description: Message interaction counters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageInteractionCounters +[Back to constructors index](index.md) + + + +Message interaction counters + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|views|[int](../types/int.md) | Yes|Views| +|forwards|[int](../types/int.md) | Yes|Number of times this message was forwarded| + + + +### Type: [MessageInteractionCounters](../types/MessageInteractionCounters.md) + + +### Example: + +```php +$messageInteractionCounters = ['_' => 'messageInteractionCounters', 'msg_id' => int, 'views' => int, 'forwards' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageInteractionCounters={_='messageInteractionCounters', msg_id=int, views=int, forwards=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageMediaContact.md b/old_docs/API_docs_v44/constructors/messageMediaContact.md index 7fde2b19..fbd3645f 100644 --- a/old_docs/API_docs_v44/constructors/messageMediaContact.md +++ b/old_docs/API_docs_v44/constructors/messageMediaContact.md @@ -17,6 +17,7 @@ Attached contact. |phone\_number|[string](../types/string.md) | Yes|Phone number| |first\_name|[string](../types/string.md) | Yes|Contact's first name| |last\_name|[string](../types/string.md) | Yes|Contact's last name| +|vcard|[string](../types/string.md) | Yes|VCARD of contact| |user\_id|[int](../types/int.md) | Yes|User identifier or `0`, if the user with the given phone number is not registered| @@ -27,14 +28,14 @@ Attached contact. ### Example: ```php -$messageMediaContact = ['_' => 'messageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'user_id' => int]; +$messageMediaContact = ['_' => 'messageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'user_id' => int]; ``` Or, if you're into Lua: ```lua -messageMediaContact={_='messageMediaContact', phone_number='string', first_name='string', last_name='string', user_id=int} +messageMediaContact={_='messageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', user_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/messageMediaDice.md b/old_docs/API_docs_v44/constructors/messageMediaDice.md new file mode 100644 index 00000000..90fb4ac1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageMediaDice.md @@ -0,0 +1,39 @@ +--- +title: messageMediaDice +description: [Dice-based animated sticker](https://core.telegram.org/api/dice) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaDice +[Back to constructors index](index.md) + + + +[Dice-based animated sticker](https://core.telegram.org/api/dice) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[int](../types/int.md) | Yes|[Dice value](https://core.telegram.org/api/dice)| +|emoticon|[string](../types/string.md) | Yes|The emoji, for now 🏀, 🎲 and 🎯 are supported| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaDice = ['_' => 'messageMediaDice', 'value' => int, 'emoticon' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageMediaDice={_='messageMediaDice', value=int, emoticon='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageMediaDocument.md b/old_docs/API_docs_v44/constructors/messageMediaDocument.md index 31a75bc0..a7f48e48 100644 --- a/old_docs/API_docs_v44/constructors/messageMediaDocument.md +++ b/old_docs/API_docs_v44/constructors/messageMediaDocument.md @@ -15,6 +15,7 @@ Document (video, audio, voice, sticker, any media type except photo) | Name | Type | Required | Description | |----------|---------------|----------|-------------| |document|[Document](../types/Document.md) | Optional|Attached document| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live of self-destructing document| @@ -24,14 +25,14 @@ Document (video, audio, voice, sticker, any media type except photo) ### Example: ```php -$messageMediaDocument = ['_' => 'messageMediaDocument', 'document' => Document]; +$messageMediaDocument = ['_' => 'messageMediaDocument', 'document' => Document, 'ttl_seconds' => int]; ``` Or, if you're into Lua: ```lua -messageMediaDocument={_='messageMediaDocument', document=Document} +messageMediaDocument={_='messageMediaDocument', document=Document, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/messageMediaAudio.md b/old_docs/API_docs_v44/constructors/messageMediaGame.md similarity index 56% rename from old_docs/API_docs_v44/constructors/messageMediaAudio.md rename to old_docs/API_docs_v44/constructors/messageMediaGame.md index 9b7c0422..d5a08477 100644 --- a/old_docs/API_docs_v44/constructors/messageMediaAudio.md +++ b/old_docs/API_docs_v44/constructors/messageMediaGame.md @@ -1,20 +1,20 @@ --- -title: messageMediaAudio -description: Message media audio +title: messageMediaGame +description: Telegram game image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: messageMediaAudio +# Constructor: messageMediaGame [Back to constructors index](index.md) -Message media audio +Telegram game ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|audio|[Audio](../types/Audio.md) | Optional|Audio| +|game|[Game](../types/Game.md) | Yes|Game| @@ -24,14 +24,14 @@ Message media audio ### Example: ```php -$messageMediaAudio = ['_' => 'messageMediaAudio', 'audio' => Audio]; +$messageMediaGame = ['_' => 'messageMediaGame', 'game' => Game]; ``` Or, if you're into Lua: ```lua -messageMediaAudio={_='messageMediaAudio', audio=Audio} +messageMediaGame={_='messageMediaGame', game=Game} ``` diff --git a/old_docs/API_docs_v44/constructors/messageMediaGeoLive.md b/old_docs/API_docs_v44/constructors/messageMediaGeoLive.md new file mode 100644 index 00000000..f31a8536 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageMediaGeoLive.md @@ -0,0 +1,39 @@ +--- +title: messageMediaGeoLive +description: Indicates a live geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGeoLive +[Back to constructors index](index.md) + + + +Indicates a live geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period of provided geolocation| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaGeoLive = ['_' => 'messageMediaGeoLive', 'geo' => GeoPoint, 'period' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaGeoLive={_='messageMediaGeoLive', geo=GeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageMediaInvoice.md b/old_docs/API_docs_v44/constructors/messageMediaInvoice.md new file mode 100644 index 00000000..33490172 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageMediaInvoice.md @@ -0,0 +1,46 @@ +--- +title: messageMediaInvoice +description: Invoice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaInvoice +[Back to constructors index](index.md) + + + +Invoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional|Whether the shipping address was requested| +|test|[Bool](../types/Bool.md) | Optional|Whether this is an example invoice| +|title|[string](../types/string.md) | Yes|Product name, 1-32 characters| +|description|[string](../types/string.md) | Yes|Product description, 1-255 characters| +|photo|[WebDocument](../types/WebDocument.md) | Optional|URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.| +|receipt\_msg\_id|[int](../types/int.md) | Optional|Message ID of receipt: if set, clients should change the text of the first [keyboardButtonBuy](../constructors/keyboardButtonBuy.md) button always attached to the [message](../constructors/message.md) to a localized version of the word `Receipt`| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total price in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|start\_param|[string](../types/string.md) | Yes|Unique bot deep-linking parameter that can be used to generate this invoice| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaInvoice = ['_' => 'messageMediaInvoice', 'shipping_address_requested' => Bool, 'test' => Bool, 'title' => 'string', 'description' => 'string', 'photo' => WebDocument, 'receipt_msg_id' => int, 'currency' => 'string', 'total_amount' => long, 'start_param' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageMediaInvoice={_='messageMediaInvoice', shipping_address_requested=Bool, test=Bool, title='string', description='string', photo=WebDocument, receipt_msg_id=int, currency='string', total_amount=long, start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageMediaPhoto.md b/old_docs/API_docs_v44/constructors/messageMediaPhoto.md index 585d0102..1ab6d134 100644 --- a/old_docs/API_docs_v44/constructors/messageMediaPhoto.md +++ b/old_docs/API_docs_v44/constructors/messageMediaPhoto.md @@ -15,7 +15,7 @@ Attached photo. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |photo|[Photo](../types/Photo.md) | Optional|Photo| -|caption|[string](../types/string.md) | Yes|Caption| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| @@ -25,14 +25,14 @@ Attached photo. ### Example: ```php -$messageMediaPhoto = ['_' => 'messageMediaPhoto', 'photo' => Photo, 'caption' => 'string']; +$messageMediaPhoto = ['_' => 'messageMediaPhoto', 'photo' => Photo, 'ttl_seconds' => int]; ``` Or, if you're into Lua: ```lua -messageMediaPhoto={_='messageMediaPhoto', photo=Photo, caption='string'} +messageMediaPhoto={_='messageMediaPhoto', photo=Photo, ttl_seconds=int} ``` diff --git a/old_docs/API_docs_v44/constructors/messageMediaPoll.md b/old_docs/API_docs_v44/constructors/messageMediaPoll.md new file mode 100644 index 00000000..4527e406 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageMediaPoll.md @@ -0,0 +1,39 @@ +--- +title: messageMediaPoll +description: Poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaPoll +[Back to constructors index](index.md) + + + +Poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll|[Poll](../types/Poll.md) | Yes|The poll| +|results|[PollResults](../types/PollResults.md) | Yes|The results of the poll| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaPoll = ['_' => 'messageMediaPoll', 'poll' => Poll, 'results' => PollResults]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaPoll={_='messageMediaPoll', poll=Poll, results=PollResults} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageMediaVenue.md b/old_docs/API_docs_v44/constructors/messageMediaVenue.md index 9d6ed418..430d2c32 100644 --- a/old_docs/API_docs_v44/constructors/messageMediaVenue.md +++ b/old_docs/API_docs_v44/constructors/messageMediaVenue.md @@ -19,6 +19,7 @@ Venue |address|[string](../types/string.md) | Yes|Address| |provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| |venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| @@ -28,14 +29,14 @@ Venue ### Example: ```php -$messageMediaVenue = ['_' => 'messageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string']; +$messageMediaVenue = ['_' => 'messageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; ``` Or, if you're into Lua: ```lua -messageMediaVenue={_='messageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string'} +messageMediaVenue={_='messageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/messageMediaVideo.md b/old_docs/API_docs_v44/constructors/messageMediaVideo.md deleted file mode 100644 index f0183143..00000000 --- a/old_docs/API_docs_v44/constructors/messageMediaVideo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: messageMediaVideo -description: Message media video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: messageMediaVideo -[Back to constructors index](index.md) - - - -Message media video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|video|[Video](../types/Video.md) | Optional|Video| -|caption|[string](../types/string.md) | Yes|Caption| - - - -### Type: [MessageMedia](../types/MessageMedia.md) - - -### Example: - -```php -$messageMediaVideo = ['_' => 'messageMediaVideo', 'video' => Video, 'caption' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -messageMediaVideo={_='messageMediaVideo', video=Video, caption='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/messageService.md b/old_docs/API_docs_v44/constructors/messageService.md index ef560731..553a4973 100644 --- a/old_docs/API_docs_v44/constructors/messageService.md +++ b/old_docs/API_docs_v44/constructors/messageService.md @@ -14,13 +14,16 @@ Indicates a service message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Unread?| |out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| |mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in the message| |media\_unread|[Bool](../types/Bool.md) | Optional|Whether the message contains unread media| +|silent|[Bool](../types/Bool.md) | Optional|Whether the message is silent| +|post|[Bool](../types/Bool.md) | Optional|Whether it's a channel post| +|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer| |id|[int](../types/int.md) | Yes|Message ID| |from\_id|[int](../types/int.md) | Optional|Id of te sender of the message| |to\_id|[Peer](../types/Peer.md) | Yes|ID of the destination of the message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| |date|[int](../types/int.md) | Yes|Message date| |action|[MessageAction](../types/MessageAction.md) | Optional|Event connected with the service message| @@ -32,14 +35,14 @@ Indicates a service message ### Example: ```php -$messageService = ['_' => 'messageService', 'unread' => Bool, 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'date' => int, 'action' => MessageAction]; +$messageService = ['_' => 'messageService', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'legacy' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'reply_to_msg_id' => int, 'date' => int, 'action' => MessageAction]; ``` Or, if you're into Lua: ```lua -messageService={_='messageService', unread=Bool, out=Bool, mentioned=Bool, media_unread=Bool, id=int, from_id=int, to_id=Peer, date=int, action=MessageAction} +messageService={_='messageService', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, legacy=Bool, id=int, from_id=int, to_id=Peer, reply_to_msg_id=int, date=int, action=MessageAction} ``` diff --git a/old_docs/API_docs_v44/constructors/messageUserVote.md b/old_docs/API_docs_v44/constructors/messageUserVote.md new file mode 100644 index 00000000..8ce8d875 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageUserVote.md @@ -0,0 +1,40 @@ +--- +title: messageUserVote +description: How a user voted in a poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVote +[Back to constructors index](index.md) + + + +How a user voted in a poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User ID| +|option|[bytes](../types/bytes.md) | Yes|The option chosen by the user| +|date|[int](../types/int.md) | Yes|When did the user cast the vote| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVote = ['_' => 'messageUserVote', 'user_id' => int, 'option' => 'bytes', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVote={_='messageUserVote', user_id=int, option='bytes', date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageUserVoteInputOption.md b/old_docs/API_docs_v44/constructors/messageUserVoteInputOption.md new file mode 100644 index 00000000..657dccfe --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageUserVoteInputOption.md @@ -0,0 +1,39 @@ +--- +title: messageUserVoteInputOption +description: How a user voted in a poll (reduced constructor, returned if an `option` was provided to [messages.getPollVotes](../methods/messages.getPollVotes.md)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteInputOption +[Back to constructors index](index.md) + + + +How a user voted in a poll (reduced constructor, returned if an `option` was provided to [messages.getPollVotes](../methods/messages.getPollVotes.md)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|The user that voted for the queried `option`| +|date|[int](../types/int.md) | Yes|When did the user cast the vote| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteInputOption = ['_' => 'messageUserVoteInputOption', 'user_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteInputOption={_='messageUserVoteInputOption', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messageUserVoteMultiple.md b/old_docs/API_docs_v44/constructors/messageUserVoteMultiple.md new file mode 100644 index 00000000..c0e67954 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messageUserVoteMultiple.md @@ -0,0 +1,40 @@ +--- +title: messageUserVoteMultiple +description: How a user voted in a multiple-choice poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteMultiple +[Back to constructors index](index.md) + + + +How a user voted in a multiple-choice poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User ID| +|options|Array of [bytes](../types/bytes.md) | Yes|Options chosen by the user| +|date|[int](../types/int.md) | Yes|When did the user cast their votes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteMultiple = ['_' => 'messageUserVoteMultiple', 'user_id' => int, 'options' => ['bytes', 'bytes'], 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteMultiple={_='messageUserVoteMultiple', user_id=int, options={'bytes'}, date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.allStickers.md b/old_docs/API_docs_v44/constructors/messages.allStickers.md index 99c19e62..df4a2cb8 100644 --- a/old_docs/API_docs_v44/constructors/messages.allStickers.md +++ b/old_docs/API_docs_v44/constructors/messages.allStickers.md @@ -15,8 +15,8 @@ Info about all installed stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| -|sets|Array of [StickerSet](../types/StickerSet.md) | Yes|Sets| +|hash|[int](../types/int.md) | Yes| +|sets|Array of [StickerSet](../types/StickerSet.md) | Yes|All stickersets| diff --git a/old_docs/API_docs_v44/constructors/messages.archivedStickers.md b/old_docs/API_docs_v44/constructors/messages.archivedStickers.md new file mode 100644 index 00000000..0f8d2c33 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.archivedStickers.md @@ -0,0 +1,40 @@ +--- +title: messages.archivedStickers +description: Archived stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_archivedStickers.html +--- +# Constructor: messages.archivedStickers +[Back to constructors index](index.md) + + + +Archived stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of archived stickers| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Archived stickersets| + + + +### Type: [messages.ArchivedStickers](../types/messages.ArchivedStickers.md) + + +### Example: + +```php +$messages.archivedStickers = ['_' => 'messages.archivedStickers', 'count' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.archivedStickers={_='messages.archivedStickers', count=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.botCallbackAnswer.md b/old_docs/API_docs_v44/constructors/messages.botCallbackAnswer.md new file mode 100644 index 00000000..31a3eb1e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.botCallbackAnswer.md @@ -0,0 +1,44 @@ +--- +title: messages.botCallbackAnswer +description: Callback answer sent by the bot in response to a button press +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_botCallbackAnswer.html +--- +# Constructor: messages.botCallbackAnswer +[Back to constructors index](index.md) + + + +Callback answer sent by the bot in response to a button press + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[Bool](../types/Bool.md) | Optional|Whether an alert should be shown to the user instead of a toast notification| +|has\_url|[Bool](../types/Bool.md) | Optional|Whether an URL is present| +|native\_ui|[Bool](../types/Bool.md) | Optional|Whether to show games in WebView or in native UI.| +|message|[string](../types/string.md) | Optional|Alert to show| +|url|[string](../types/string.md) | Optional|URL to open| +|cache\_time|[int](../types/int.md) | Yes|For how long should this answer be cached| + + + +### Type: [messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) + + +### Example: + +```php +$messages.botCallbackAnswer = ['_' => 'messages.botCallbackAnswer', 'alert' => Bool, 'has_url' => Bool, 'native_ui' => Bool, 'message' => 'string', 'url' => 'string', 'cache_time' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.botCallbackAnswer={_='messages.botCallbackAnswer', alert=Bool, has_url=Bool, native_ui=Bool, message='string', url='string', cache_time=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.botResults.md b/old_docs/API_docs_v44/constructors/messages.botResults.md new file mode 100644 index 00000000..ff2841e5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.botResults.md @@ -0,0 +1,45 @@ +--- +title: messages.botResults +description: Result of a query to an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_botResults.html +--- +# Constructor: messages.botResults +[Back to constructors index](index.md) + + + +Result of a query to an inline bot + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[Bool](../types/Bool.md) | Optional|Whether the result is a picture gallery| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|next\_offset|[string](../types/string.md) | Optional|The next offset to use when navigating through results| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Whether the bot requested the user to message him in private| +|results|Array of [BotInlineResult](../types/BotInlineResult.md) | Yes|The results| +|cache\_time|[int](../types/int.md) | Yes|Caching validity of the results| +|users|Array of [User](../types/User.md) | Yes|Users mentioned in the results| + + + +### Type: [messages.BotResults](../types/messages.BotResults.md) + + +### Example: + +```php +$messages.botResults = ['_' => 'messages.botResults', 'gallery' => Bool, 'query_id' => long, 'next_offset' => 'string', 'switch_pm' => InlineBotSwitchPM, 'results' => [BotInlineResult, BotInlineResult], 'cache_time' => int, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.botResults={_='messages.botResults', gallery=Bool, query_id=long, next_offset='string', switch_pm=InlineBotSwitchPM, results={BotInlineResult}, cache_time=int, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.channelMessages.md b/old_docs/API_docs_v44/constructors/messages.channelMessages.md index 5006b7f9..94fea1d2 100644 --- a/old_docs/API_docs_v44/constructors/messages.channelMessages.md +++ b/old_docs/API_docs_v44/constructors/messages.channelMessages.md @@ -15,10 +15,10 @@ Channel messages | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, returned results may be inexact| |pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| |count|[int](../types/int.md) | Yes|Total number of results were found server-side (may not be all included here)| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|collapsed|Array of [MessageGroup](../types/MessageGroup.md) | Optional|Collapsed| +|messages|Array of [Message](../types/Message.md) | Yes|Found messages| |chats|Array of [Chat](../types/Chat.md) | Yes|Chats| |users|Array of [User](../types/User.md) | Yes|Users| @@ -30,14 +30,14 @@ Channel messages ### Example: ```php -$messages.channelMessages = ['_' => 'messages.channelMessages', 'pts' => int, 'count' => int, 'messages' => [Message, Message], 'collapsed' => [MessageGroup, MessageGroup], 'chats' => [Chat, Chat], 'users' => [User, User]]; +$messages.channelMessages = ['_' => 'messages.channelMessages', 'inexact' => Bool, 'pts' => int, 'count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -messages.channelMessages={_='messages.channelMessages', pts=int, count=int, messages={Message}, collapsed={MessageGroup}, chats={Chat}, users={User}} +messages.channelMessages={_='messages.channelMessages', inexact=Bool, pts=int, count=int, messages={Message}, chats={Chat}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/messages.chatFull.md b/old_docs/API_docs_v44/constructors/messages.chatFull.md index ada5153a..0a2bd12f 100644 --- a/old_docs/API_docs_v44/constructors/messages.chatFull.md +++ b/old_docs/API_docs_v44/constructors/messages.chatFull.md @@ -16,8 +16,8 @@ Extended info on chat and auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |full\_chat|[ChatFull](../types/ChatFull.md) | Yes|Extended info on a chat| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|chats|Array of [Chat](../types/Chat.md) | Yes|List containing basic info on chat| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned above| diff --git a/old_docs/API_docs_v44/constructors/messages.chats.md b/old_docs/API_docs_v44/constructors/messages.chats.md index 06cd8363..abb3e6ca 100644 --- a/old_docs/API_docs_v44/constructors/messages.chats.md +++ b/old_docs/API_docs_v44/constructors/messages.chats.md @@ -15,7 +15,7 @@ List of chats with auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats| diff --git a/old_docs/API_docs_v44/constructors/messages.chatsSlice.md b/old_docs/API_docs_v44/constructors/messages.chatsSlice.md new file mode 100644 index 00000000..a40d1e20 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.chatsSlice.md @@ -0,0 +1,40 @@ +--- +title: messages.chatsSlice +description: Partial list of chats, more would have to be fetched with [pagination](https://core.telegram.org/api/offsets) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_chatsSlice.html +--- +# Constructor: messages.chatsSlice +[Back to constructors index](index.md) + + + +Partial list of chats, more would have to be fetched with [pagination](https://core.telegram.org/api/offsets) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of results that were found server-side (not all are included in `chats`)| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| + + + +### Type: [messages.Chats](../types/messages.Chats.md) + + +### Example: + +```php +$messages.chatsSlice = ['_' => 'messages.chatsSlice', 'count' => int, 'chats' => [Chat, Chat]]; +``` + + +Or, if you're into Lua: + +```lua +messages.chatsSlice={_='messages.chatsSlice', count=int, chats={Chat}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.dialogs.md b/old_docs/API_docs_v44/constructors/messages.dialogs.md index b8c4aceb..1bd07d61 100644 --- a/old_docs/API_docs_v44/constructors/messages.dialogs.md +++ b/old_docs/API_docs_v44/constructors/messages.dialogs.md @@ -15,10 +15,10 @@ Full list of chats with messages and auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialogs| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|List of chats| +|messages|Array of [Message](../types/Message.md) | Yes|List of last messages from each chat| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of groups mentioned in the chats| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in messages and groups| diff --git a/old_docs/API_docs_v44/constructors/messages.dialogsNotModified.md b/old_docs/API_docs_v44/constructors/messages.dialogsNotModified.md new file mode 100644 index 00000000..2ffc9dfa --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.dialogsNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.dialogsNotModified +description: Dialogs haven't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dialogsNotModified.html +--- +# Constructor: messages.dialogsNotModified +[Back to constructors index](index.md) + + + +Dialogs haven't changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of dialogs found server-side by the query| + + + +### Type: [messages.Dialogs](../types/messages.Dialogs.md) + + +### Example: + +```php +$messages.dialogsNotModified = ['_' => 'messages.dialogsNotModified', 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.dialogsNotModified={_='messages.dialogsNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.dialogsSlice.md b/old_docs/API_docs_v44/constructors/messages.dialogsSlice.md index 4d2c9a4a..7105ad88 100644 --- a/old_docs/API_docs_v44/constructors/messages.dialogsSlice.md +++ b/old_docs/API_docs_v44/constructors/messages.dialogsSlice.md @@ -16,10 +16,10 @@ Incomplete list of dialogs with messages and auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |count|[int](../types/int.md) | Yes|Total number of dialogs| -|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialogs| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|List of dialogs| +|messages|Array of [Message](../types/Message.md) | Yes|List of last messages from dialogs| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in dialogs| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in messages and chats| diff --git a/old_docs/API_docs_v44/constructors/messages.favedStickers.md b/old_docs/API_docs_v44/constructors/messages.favedStickers.md new file mode 100644 index 00000000..aa101ae5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.favedStickers.md @@ -0,0 +1,41 @@ +--- +title: messages.favedStickers +description: Favorited stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_favedStickers.html +--- +# Constructor: messages.favedStickers +[Back to constructors index](index.md) + + + +Favorited stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Emojis associated to stickers| +|stickers|Array of [Document](../types/Document.md) | Yes|Favorited stickers| + + + +### Type: [messages.FavedStickers](../types/messages.FavedStickers.md) + + +### Example: + +```php +$messages.favedStickers = ['_' => 'messages.favedStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.favedStickers={_='messages.favedStickers', hash=int, packs={StickerPack}, stickers={Document}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.favedStickersNotModified.md b/old_docs/API_docs_v44/constructors/messages.favedStickersNotModified.md new file mode 100644 index 00000000..9b76f9a2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.favedStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.favedStickersNotModified +description: No new favorited stickers were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_favedStickersNotModified.html +--- +# Constructor: messages.favedStickersNotModified +[Back to constructors index](index.md) + + + +No new favorited stickers were found + + + + +### Type: [messages.FavedStickers](../types/messages.FavedStickers.md) + + +### Example: + +```php +$messages.favedStickersNotModified = ['_' => 'messages.favedStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.favedStickersNotModified={_='messages.favedStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.featuredStickers.md b/old_docs/API_docs_v44/constructors/messages.featuredStickers.md new file mode 100644 index 00000000..bbaa51e7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.featuredStickers.md @@ -0,0 +1,42 @@ +--- +title: messages.featuredStickers +description: Featured stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_featuredStickers.html +--- +# Constructor: messages.featuredStickers +[Back to constructors index](index.md) + + + +Featured stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|count|[int](../types/int.md) | Yes|Total number of featured stickers| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Featured stickersets| +|unread|Array of [long](../types/long.md) | Yes|IDs of new featured stickersets| + + + +### Type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + + +### Example: + +```php +$messages.featuredStickers = ['_' => 'messages.featuredStickers', 'hash' => int, 'count' => int, 'sets' => [StickerSetCovered, StickerSetCovered], 'unread' => [long, long]]; +``` + + +Or, if you're into Lua: + +```lua +messages.featuredStickers={_='messages.featuredStickers', hash=int, count=int, sets={StickerSetCovered}, unread={long}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.featuredStickersNotModified.md b/old_docs/API_docs_v44/constructors/messages.featuredStickersNotModified.md new file mode 100644 index 00000000..89e30cd9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.featuredStickersNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.featuredStickersNotModified +description: Featured stickers haven't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_featuredStickersNotModified.html +--- +# Constructor: messages.featuredStickersNotModified +[Back to constructors index](index.md) + + + +Featured stickers haven't changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of featured stickers| + + + +### Type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + + +### Example: + +```php +$messages.featuredStickersNotModified = ['_' => 'messages.featuredStickersNotModified', 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.featuredStickersNotModified={_='messages.featuredStickersNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.foundGifs.md b/old_docs/API_docs_v44/constructors/messages.foundGifs.md deleted file mode 100644 index 6f10d2c4..00000000 --- a/old_docs/API_docs_v44/constructors/messages.foundGifs.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: messages.foundGifs -description: Found GIFs -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/messages_foundGifs.html ---- -# Constructor: messages.foundGifs -[Back to constructors index](index.md) - - - -Found GIFs - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|next\_offset|[int](../types/int.md) | Yes|Next offset to use when trying to [load more results](../methods/messages.searchGifs.md)| -|results|Array of [FoundGif](../types/FoundGif.md) | Yes|Results| - - - -### Type: [messages.FoundGifs](../types/messages.FoundGifs.md) - - -### Example: - -```php -$messages.foundGifs = ['_' => 'messages.foundGifs', 'next_offset' => int, 'results' => [FoundGif, FoundGif]]; -``` - - -Or, if you're into Lua: - -```lua -messages.foundGifs={_='messages.foundGifs', next_offset=int, results={FoundGif}} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/messages.foundStickerSets.md b/old_docs/API_docs_v44/constructors/messages.foundStickerSets.md new file mode 100644 index 00000000..0f2cae83 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.foundStickerSets.md @@ -0,0 +1,40 @@ +--- +title: messages.foundStickerSets +description: Found stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_foundStickerSets.html +--- +# Constructor: messages.foundStickerSets +[Back to constructors index](index.md) + + + +Found stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Found stickersets| + + + +### Type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + + +### Example: + +```php +$messages.foundStickerSets = ['_' => 'messages.foundStickerSets', 'hash' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.foundStickerSets={_='messages.foundStickerSets', hash=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.foundStickerSetsNotModified.md b/old_docs/API_docs_v44/constructors/messages.foundStickerSetsNotModified.md new file mode 100644 index 00000000..b989b44a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.foundStickerSetsNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.foundStickerSetsNotModified +description: No further results were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_foundStickerSetsNotModified.html +--- +# Constructor: messages.foundStickerSetsNotModified +[Back to constructors index](index.md) + + + +No further results were found + + + + +### Type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + + +### Example: + +```php +$messages.foundStickerSetsNotModified = ['_' => 'messages.foundStickerSetsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.foundStickerSetsNotModified={_='messages.foundStickerSetsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.highScores.md b/old_docs/API_docs_v44/constructors/messages.highScores.md new file mode 100644 index 00000000..00566013 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.highScores.md @@ -0,0 +1,40 @@ +--- +title: messages.highScores +description: Highscores in a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_highScores.html +--- +# Constructor: messages.highScores +[Back to constructors index](index.md) + + + +Highscores in a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|scores|Array of [HighScore](../types/HighScore.md) | Yes|Highscores| +|users|Array of [User](../types/User.md) | Yes|Users, associated to the highscores| + + + +### Type: [messages.HighScores](../types/messages.HighScores.md) + + +### Example: + +```php +$messages.highScores = ['_' => 'messages.highScores', 'scores' => [HighScore, HighScore], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.highScores={_='messages.highScores', scores={HighScore}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.inactiveChats.md b/old_docs/API_docs_v44/constructors/messages.inactiveChats.md new file mode 100644 index 00000000..851a117c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.inactiveChats.md @@ -0,0 +1,41 @@ +--- +title: messages.inactiveChats +description: Inactive chat list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_inactiveChats.html +--- +# Constructor: messages.inactiveChats +[Back to constructors index](index.md) + + + +Inactive chat list + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dates|Array of [int](../types/int.md) | Yes|When was the chat last active| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chat list| +|users|Array of [User](../types/User.md) | Yes|Users mentioned in the chat list| + + + +### Type: [messages.InactiveChats](../types/messages.InactiveChats.md) + + +### Example: + +```php +$messages.inactiveChats = ['_' => 'messages.inactiveChats', 'dates' => [int, int], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.inactiveChats={_='messages.inactiveChats', dates={int}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.messageEditData.md b/old_docs/API_docs_v44/constructors/messages.messageEditData.md new file mode 100644 index 00000000..f2288b96 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.messageEditData.md @@ -0,0 +1,39 @@ +--- +title: messages.messageEditData +description: Message edit data for media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messageEditData.html +--- +# Constructor: messages.messageEditData +[Back to constructors index](index.md) + + + +Message edit data for media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|caption|[Bool](../types/Bool.md) | Optional|Media caption, if the specified media's caption can be edited| + + + +### Type: [messages.MessageEditData](../types/messages.MessageEditData.md) + + +### Example: + +```php +$messages.messageEditData = ['_' => 'messages.messageEditData', 'caption' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +messages.messageEditData={_='messages.messageEditData', caption=Bool} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.messages.md b/old_docs/API_docs_v44/constructors/messages.messages.md index 471c4844..77209a54 100644 --- a/old_docs/API_docs_v44/constructors/messages.messages.md +++ b/old_docs/API_docs_v44/constructors/messages.messages.md @@ -15,9 +15,9 @@ Full list of messages with auxilary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|messages|Array of [Message](../types/Message.md) | Yes|List of messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in dialogs| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in messages and chats| diff --git a/old_docs/API_docs_v44/constructors/messages.messagesNotModified.md b/old_docs/API_docs_v44/constructors/messages.messagesNotModified.md new file mode 100644 index 00000000..a52e8c80 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.messagesNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.messagesNotModified +description: No new messages matching the query were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messagesNotModified.html +--- +# Constructor: messages.messagesNotModified +[Back to constructors index](index.md) + + + +No new messages matching the query were found + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of results found server-side by the given query| + + + +### Type: [messages.Messages](../types/messages.Messages.md) + + +### Example: + +```php +$messages.messagesNotModified = ['_' => 'messages.messagesNotModified', 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.messagesNotModified={_='messages.messagesNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.messagesSlice.md b/old_docs/API_docs_v44/constructors/messages.messagesSlice.md index 6a2502bd..474f2a5f 100644 --- a/old_docs/API_docs_v44/constructors/messages.messagesSlice.md +++ b/old_docs/API_docs_v44/constructors/messages.messagesSlice.md @@ -15,10 +15,12 @@ Incomplete list of messages and auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, indicates that the results may be inexact| |count|[int](../types/int.md) | Yes|Total number of messages in the list| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|next\_rate|[int](../types/int.md) | Optional|Rate to use in the `offset_rate` parameter in the next call to [messages.searchGlobal](../methods/messages.searchGlobal.md)| +|messages|Array of [Message](../types/Message.md) | Yes|List of messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in messages| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in messages and chats| @@ -28,14 +30,14 @@ Incomplete list of messages and auxiliary data. ### Example: ```php -$messages.messagesSlice = ['_' => 'messages.messagesSlice', 'count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +$messages.messagesSlice = ['_' => 'messages.messagesSlice', 'inexact' => Bool, 'count' => int, 'next_rate' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -messages.messagesSlice={_='messages.messagesSlice', count=int, messages={Message}, chats={Chat}, users={User}} +messages.messagesSlice={_='messages.messagesSlice', inexact=Bool, count=int, next_rate=int, messages={Message}, chats={Chat}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/messages.peerDialogs.md b/old_docs/API_docs_v44/constructors/messages.peerDialogs.md new file mode 100644 index 00000000..8934e94c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.peerDialogs.md @@ -0,0 +1,43 @@ +--- +title: messages.peerDialogs +description: Dialog info of multiple peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_peerDialogs.html +--- +# Constructor: messages.peerDialogs +[Back to constructors index](index.md) + + + +Dialog info of multiple peers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialog info| +|messages|Array of [Message](../types/Message.md) | Yes|Messages mentioned in dialog info| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| +|state|[updates.State](../constructors/updates.State.md) | Yes|Current [update state of dialog](https://core.telegram.org/api/updates)| + + + +### Type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + + +### Example: + +```php +$messages.peerDialogs = ['_' => 'messages.peerDialogs', 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User], 'state' => updates.State]; +``` + + +Or, if you're into Lua: + +```lua +messages.peerDialogs={_='messages.peerDialogs', dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}, state=updates.State} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.recentStickers.md b/old_docs/API_docs_v44/constructors/messages.recentStickers.md new file mode 100644 index 00000000..e3050d9c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.recentStickers.md @@ -0,0 +1,42 @@ +--- +title: messages.recentStickers +description: Recently used stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_recentStickers.html +--- +# Constructor: messages.recentStickers +[Back to constructors index](index.md) + + + +Recently used stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Emojis associated to stickers| +|stickers|Array of [Document](../types/Document.md) | Yes|Recent stickers| +|dates|Array of [int](../types/int.md) | Yes|When was each sticker last used| + + + +### Type: [messages.RecentStickers](../types/messages.RecentStickers.md) + + +### Example: + +```php +$messages.recentStickers = ['_' => 'messages.recentStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document], 'dates' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +messages.recentStickers={_='messages.recentStickers', hash=int, packs={StickerPack}, stickers={Document}, dates={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.recentStickersNotModified.md b/old_docs/API_docs_v44/constructors/messages.recentStickersNotModified.md new file mode 100644 index 00000000..ea35f802 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.recentStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.recentStickersNotModified +description: No new recent sticker was found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_recentStickersNotModified.html +--- +# Constructor: messages.recentStickersNotModified +[Back to constructors index](index.md) + + + +No new recent sticker was found + + + + +### Type: [messages.RecentStickers](../types/messages.RecentStickers.md) + + +### Example: + +```php +$messages.recentStickersNotModified = ['_' => 'messages.recentStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.recentStickersNotModified={_='messages.recentStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.savedGifs.md b/old_docs/API_docs_v44/constructors/messages.savedGifs.md new file mode 100644 index 00000000..72b33436 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.savedGifs.md @@ -0,0 +1,40 @@ +--- +title: messages.savedGifs +description: Saved gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_savedGifs.html +--- +# Constructor: messages.savedGifs +[Back to constructors index](index.md) + + + +Saved gifs + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes| +|gifs|Array of [Document](../types/Document.md) | Yes|List of saved gifs| + + + +### Type: [messages.SavedGifs](../types/messages.SavedGifs.md) + + +### Example: + +```php +$messages.savedGifs = ['_' => 'messages.savedGifs', 'hash' => int, 'gifs' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.savedGifs={_='messages.savedGifs', hash=int, gifs={Document}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.savedGifsNotModified.md b/old_docs/API_docs_v44/constructors/messages.savedGifsNotModified.md new file mode 100644 index 00000000..1a437d96 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.savedGifsNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.savedGifsNotModified +description: No new saved gifs were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_savedGifsNotModified.html +--- +# Constructor: messages.savedGifsNotModified +[Back to constructors index](index.md) + + + +No new saved gifs were found + + + + +### Type: [messages.SavedGifs](../types/messages.SavedGifs.md) + + +### Example: + +```php +$messages.savedGifsNotModified = ['_' => 'messages.savedGifsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.savedGifsNotModified={_='messages.savedGifsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.searchCounter.md b/old_docs/API_docs_v44/constructors/messages.searchCounter.md new file mode 100644 index 00000000..616eadc3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.searchCounter.md @@ -0,0 +1,41 @@ +--- +title: messages.searchCounter +description: Indicates how many results would be found by a [messages.search](../methods/messages.search.md) call with the same parameters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_searchCounter.html +--- +# Constructor: messages.searchCounter +[Back to constructors index](index.md) + + + +Indicates how many results would be found by a [messages.search](../methods/messages.search.md) call with the same parameters + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, the results may be inexact| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Provided message filter| +|count|[int](../types/int.md) | Yes|Number of results that were found server-side| + + + +### Type: [messages.SearchCounter](../types/messages.SearchCounter.md) + + +### Example: + +```php +$messages.searchCounter = ['_' => 'messages.searchCounter', 'inexact' => Bool, 'filter' => MessagesFilter, 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.searchCounter={_='messages.searchCounter', inexact=Bool, filter=MessagesFilter, count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.stickerSet.md b/old_docs/API_docs_v44/constructors/messages.stickerSet.md index 61033ea5..68d4dd78 100644 --- a/old_docs/API_docs_v44/constructors/messages.stickerSet.md +++ b/old_docs/API_docs_v44/constructors/messages.stickerSet.md @@ -16,8 +16,8 @@ Stickerset and stickers inside it | Name | Type | Required | Description | |----------|---------------|----------|-------------| |set|[StickerSet](../types/StickerSet.md) | Yes|The stickerset| -|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Packs| -|documents|Array of [Document](../types/Document.md) | Yes|Documents| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Emoji info for stickers| +|documents|Array of [Document](../types/Document.md) | Yes|Stickers in stickerset| diff --git a/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultArchive.md b/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultArchive.md new file mode 100644 index 00000000..7d97b104 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultArchive.md @@ -0,0 +1,39 @@ +--- +title: messages.stickerSetInstallResultArchive +description: The stickerset was installed, but since there are too many stickersets some were archived +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickerSetInstallResultArchive.html +--- +# Constructor: messages.stickerSetInstallResultArchive +[Back to constructors index](index.md) + + + +The stickerset was installed, but since there are too many stickersets some were archived + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Archived stickersets| + + + +### Type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + + +### Example: + +```php +$messages.stickerSetInstallResultArchive = ['_' => 'messages.stickerSetInstallResultArchive', 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.stickerSetInstallResultArchive={_='messages.stickerSetInstallResultArchive', sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultSuccess.md b/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultSuccess.md new file mode 100644 index 00000000..0e78206b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.stickerSetInstallResultSuccess.md @@ -0,0 +1,34 @@ +--- +title: messages.stickerSetInstallResultSuccess +description: The stickerset was installed successfully +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickerSetInstallResultSuccess.html +--- +# Constructor: messages.stickerSetInstallResultSuccess +[Back to constructors index](index.md) + + + +The stickerset was installed successfully + + + + +### Type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + + +### Example: + +```php +$messages.stickerSetInstallResultSuccess = ['_' => 'messages.stickerSetInstallResultSuccess']; +``` + + +Or, if you're into Lua: + +```lua +messages.stickerSetInstallResultSuccess={_='messages.stickerSetInstallResultSuccess'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/messages.stickers.md b/old_docs/API_docs_v44/constructors/messages.stickers.md index 8884804f..db9202d7 100644 --- a/old_docs/API_docs_v44/constructors/messages.stickers.md +++ b/old_docs/API_docs_v44/constructors/messages.stickers.md @@ -15,7 +15,7 @@ Found stickers | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Hash| +|hash|[int](../types/int.md) | Yes| |stickers|Array of [Document](../types/Document.md) | Yes|Stickers| @@ -26,14 +26,14 @@ Found stickers ### Example: ```php -$messages.stickers = ['_' => 'messages.stickers', 'hash' => 'string', 'stickers' => [Document, Document]]; +$messages.stickers = ['_' => 'messages.stickers', 'hash' => int, 'stickers' => [Document, Document]]; ``` Or, if you're into Lua: ```lua -messages.stickers={_='messages.stickers', hash='string', stickers={Document}} +messages.stickers={_='messages.stickers', hash=int, stickers={Document}} ``` diff --git a/old_docs/API_docs_v44/constructors/messages.votesList.md b/old_docs/API_docs_v44/constructors/messages.votesList.md new file mode 100644 index 00000000..fb6fd02b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/messages.votesList.md @@ -0,0 +1,42 @@ +--- +title: messages.votesList +description: How users voted in a poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_votesList.html +--- +# Constructor: messages.votesList +[Back to constructors index](index.md) + + + +How users voted in a poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of votes for all options (or only for the chosen `option`, if provided to [messages.getPollVotes](../methods/messages.getPollVotes.md))| +|votes|Array of [MessageUserVote](../types/MessageUserVote.md) | Yes|Vote info for each user| +|users|Array of [User](../types/User.md) | Yes|Info about users that voted in the poll| +|next\_offset|[string](../types/string.md) | Optional|Offset to use with the next [messages.getPollVotes](../methods/messages.getPollVotes.md) request, empty string if no more results are available.| + + + +### Type: [messages.VotesList](../types/messages.VotesList.md) + + +### Example: + +```php +$messages.votesList = ['_' => 'messages.votesList', 'count' => int, 'votes' => [MessageUserVote, MessageUserVote], 'users' => [User, User], 'next_offset' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messages.votesList={_='messages.votesList', count=int, votes={MessageUserVote}, users={User}, next_offset='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/notifyAll.md b/old_docs/API_docs_v44/constructors/notifyBroadcasts.md similarity index 52% rename from old_docs/API_docs_v44/constructors/notifyAll.md rename to old_docs/API_docs_v44/constructors/notifyBroadcasts.md index bb8ae438..ef5b3600 100644 --- a/old_docs/API_docs_v44/constructors/notifyAll.md +++ b/old_docs/API_docs_v44/constructors/notifyBroadcasts.md @@ -1,14 +1,14 @@ --- -title: notifyAll -description: Notify all +title: notifyBroadcasts +description: Channel notification settings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: notifyAll +# Constructor: notifyBroadcasts [Back to constructors index](index.md) -Notify all +Channel notification settings @@ -19,14 +19,14 @@ Notify all ### Example: ```php -$notifyAll = ['_' => 'notifyAll']; +$notifyBroadcasts = ['_' => 'notifyBroadcasts']; ``` Or, if you're into Lua: ```lua -notifyAll={_='notifyAll'} +notifyBroadcasts={_='notifyBroadcasts'} ``` diff --git a/old_docs/API_docs_v44/constructors/notifyPeer.md b/old_docs/API_docs_v44/constructors/notifyPeer.md index 2ac77fb4..45ba103d 100644 --- a/old_docs/API_docs_v44/constructors/notifyPeer.md +++ b/old_docs/API_docs_v44/constructors/notifyPeer.md @@ -14,7 +14,7 @@ Notifications generated by a certain user or group. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Peer](../types/Peer.md) | Yes|User or group| +|peer|[Peer](../types/Peer.md) | Yes|user or group| diff --git a/old_docs/API_docs_v44/constructors/page.md b/old_docs/API_docs_v44/constructors/page.md new file mode 100644 index 00000000..9fdefd56 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/page.md @@ -0,0 +1,45 @@ +--- +title: page +description: [Instant view](https://instantview.telegram.org) page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: page +[Back to constructors index](index.md) + + + +[Instant view](https://instantview.telegram.org) page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|part|[Bool](../types/Bool.md) | Optional|Indicates that not full page preview is available to the client and it will need to fetch full Instant View from the server using [messages.getWebPagePreview](../methods/messages.getWebPagePreview.md).| +|rtl|[Bool](../types/Bool.md) | Optional|Whether the page contains RTL text| +|v2|[Bool](../types/Bool.md) | Optional|Whether this is an [IV v2](https://instantview.telegram.org/docs#what-39s-new-in-2-0) page| +|url|[string](../types/string.md) | Yes|Original page HTTP URL| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Page elements (like with HTML elements, only as TL constructors)| +|photos|Array of [Photo](../types/Photo.md) | Yes|Photos in page| +|documents|Array of [Document](../types/Document.md) | Yes|Media in page| +|views|[int](../types/int.md) | Optional|Viewcount| + + + +### Type: [Page](../types/Page.md) + + +### Example: + +```php +$page = ['_' => 'page', 'part' => Bool, 'rtl' => Bool, 'v2' => Bool, 'url' => 'string', 'blocks' => [PageBlock, PageBlock], 'photos' => [Photo, Photo], 'documents' => [Document, Document], 'views' => int]; +``` + + +Or, if you're into Lua: + +```lua +page={_='page', part=Bool, rtl=Bool, v2=Bool, url='string', blocks={PageBlock}, photos={Photo}, documents={Document}, views=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockAnchor.md b/old_docs/API_docs_v44/constructors/pageBlockAnchor.md new file mode 100644 index 00000000..f1a6a0cf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockAnchor.md @@ -0,0 +1,38 @@ +--- +title: pageBlockAnchor +description: Link to section within the page itself (like `anchor`) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAnchor +[Back to constructors index](index.md) + + + +Link to section within the page itself (like `anchor`) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Name of target section| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAnchor = ['_' => 'pageBlockAnchor', 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAnchor={_='pageBlockAnchor', name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockAudio.md b/old_docs/API_docs_v44/constructors/pageBlockAudio.md new file mode 100644 index 00000000..640cc7e7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockAudio.md @@ -0,0 +1,39 @@ +--- +title: pageBlockAudio +description: Audio +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAudio +[Back to constructors index](index.md) + + + +Audio + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|audio\_id|[long](../types/long.md) | Yes|Audio ID (to be fetched from the container [page](../constructors/page.md) constructor| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Audio caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAudio = ['_' => 'pageBlockAudio', 'audio_id' => long, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAudio={_='pageBlockAudio', audio_id=long, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockAuthorDate.md b/old_docs/API_docs_v44/constructors/pageBlockAuthorDate.md new file mode 100644 index 00000000..2e23dac6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockAuthorDate.md @@ -0,0 +1,39 @@ +--- +title: pageBlockAuthorDate +description: Author and date of creation of article +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAuthorDate +[Back to constructors index](index.md) + + + +Author and date of creation of article + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|author|[RichText](../types/RichText.md) | Yes|Author name| +|published\_date|[int](../types/int.md) | Yes|Date of pubblication| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAuthorDate = ['_' => 'pageBlockAuthorDate', 'author' => RichText, 'published_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAuthorDate={_='pageBlockAuthorDate', author=RichText, published_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockBlockquote.md b/old_docs/API_docs_v44/constructors/pageBlockBlockquote.md new file mode 100644 index 00000000..ef0cb454 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockBlockquote.md @@ -0,0 +1,39 @@ +--- +title: pageBlockBlockquote +description: Quote (equivalent to the HTML ``) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockBlockquote +[Back to constructors index](index.md) + + + +Quote (equivalent to the HTML ``) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Quote contents| +|caption|[RichText](../types/RichText.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockBlockquote = ['_' => 'pageBlockBlockquote', 'text' => RichText, 'caption' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockBlockquote={_='pageBlockBlockquote', text=RichText, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockChannel.md b/old_docs/API_docs_v44/constructors/pageBlockChannel.md new file mode 100644 index 00000000..a77cf8d7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockChannel.md @@ -0,0 +1,38 @@ +--- +title: pageBlockChannel +description: Reference to a telegram channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockChannel +[Back to constructors index](index.md) + + + +Reference to a telegram channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Chat](../types/Chat.md) | Optional|The channel/supergroup/chat| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockChannel = ['_' => 'pageBlockChannel', 'channel' => Chat]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockChannel={_='pageBlockChannel', channel=Chat} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockCollage.md b/old_docs/API_docs_v44/constructors/pageBlockCollage.md new file mode 100644 index 00000000..28de2838 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockCollage.md @@ -0,0 +1,39 @@ +--- +title: pageBlockCollage +description: Collage of media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCollage +[Back to constructors index](index.md) + + + +Collage of media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageBlock](../types/PageBlock.md) | Yes|Media elements| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockCollage = ['_' => 'pageBlockCollage', 'items' => [PageBlock, PageBlock], 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockCollage={_='pageBlockCollage', items={PageBlock}, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockCover.md b/old_docs/API_docs_v44/constructors/pageBlockCover.md new file mode 100644 index 00000000..ce197e51 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockCover.md @@ -0,0 +1,38 @@ +--- +title: pageBlockCover +description: A page cover +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCover +[Back to constructors index](index.md) + + + +A page cover + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cover|[PageBlock](../types/PageBlock.md) | Yes|Cover| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockCover = ['_' => 'pageBlockCover', 'cover' => PageBlock]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockCover={_='pageBlockCover', cover=PageBlock} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockDetails.md b/old_docs/API_docs_v44/constructors/pageBlockDetails.md new file mode 100644 index 00000000..dba1ca9a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockDetails.md @@ -0,0 +1,40 @@ +--- +title: pageBlockDetails +description: A collapsible details block +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockDetails +[Back to constructors index](index.md) + + + +A collapsible details block + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|open|[Bool](../types/Bool.md) | Optional|Whether the block is open by default| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Block contents| +|title|[RichText](../types/RichText.md) | Yes|Always visible heading for the block| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockDetails = ['_' => 'pageBlockDetails', 'open' => Bool, 'blocks' => [PageBlock, PageBlock], 'title' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockDetails={_='pageBlockDetails', open=Bool, blocks={PageBlock}, title=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockDivider.md b/old_docs/API_docs_v44/constructors/pageBlockDivider.md new file mode 100644 index 00000000..ee75b91c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockDivider.md @@ -0,0 +1,33 @@ +--- +title: pageBlockDivider +description: An empty block separating a page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockDivider +[Back to constructors index](index.md) + + + +An empty block separating a page + + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockDivider = ['_' => 'pageBlockDivider']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockDivider={_='pageBlockDivider'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockEmbed.md b/old_docs/API_docs_v44/constructors/pageBlockEmbed.md new file mode 100644 index 00000000..f72464d8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockEmbed.md @@ -0,0 +1,45 @@ +--- +title: pageBlockEmbed +description: An embedded webpage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbed +[Back to constructors index](index.md) + + + +An embedded webpage + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|full\_width|[Bool](../types/Bool.md) | Optional|Whether the block should be full width| +|allow\_scrolling|[Bool](../types/Bool.md) | Optional|Whether scrolling should be allowed| +|url|[string](../types/string.md) | Optional|Web page URL, if available| +|html|[string](../types/string.md) | Optional|HTML-markup of the embedded page| +|poster\_photo\_id|[long](../types/long.md) | Optional|Poster photo, if available| +|w|[int](../types/int.md) | Optional|Block width, if known| +|h|[int](../types/int.md) | Optional|Block height, if known| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockEmbed = ['_' => 'pageBlockEmbed', 'full_width' => Bool, 'allow_scrolling' => Bool, 'url' => 'string', 'html' => 'string', 'poster_photo_id' => long, 'w' => int, 'h' => int, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockEmbed={_='pageBlockEmbed', full_width=Bool, allow_scrolling=Bool, url='string', html='string', poster_photo_id=long, w=int, h=int, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockEmbedPost.md b/old_docs/API_docs_v44/constructors/pageBlockEmbedPost.md new file mode 100644 index 00000000..0d359685 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockEmbedPost.md @@ -0,0 +1,44 @@ +--- +title: pageBlockEmbedPost +description: An embedded post +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbedPost +[Back to constructors index](index.md) + + + +An embedded post + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Web page URL| +|webpage\_id|[long](../types/long.md) | Yes|ID of generated webpage preview| +|author\_photo\_id|[long](../types/long.md) | Yes|ID of the author's photo| +|author|[string](../types/string.md) | Yes|Author name| +|date|[int](../types/int.md) | Yes|Creation date| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Post contents| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockEmbedPost = ['_' => 'pageBlockEmbedPost', 'url' => 'string', 'webpage_id' => long, 'author_photo_id' => long, 'author' => 'string', 'date' => int, 'blocks' => [PageBlock, PageBlock], 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockEmbedPost={_='pageBlockEmbedPost', url='string', webpage_id=long, author_photo_id=long, author='string', date=int, blocks={PageBlock}, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockFooter.md b/old_docs/API_docs_v44/constructors/pageBlockFooter.md new file mode 100644 index 00000000..af49ca1d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockFooter.md @@ -0,0 +1,38 @@ +--- +title: pageBlockFooter +description: Page footer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockFooter +[Back to constructors index](index.md) + + + +Page footer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockFooter = ['_' => 'pageBlockFooter', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockFooter={_='pageBlockFooter', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockHeader.md b/old_docs/API_docs_v44/constructors/pageBlockHeader.md new file mode 100644 index 00000000..c2049a5c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockHeader.md @@ -0,0 +1,38 @@ +--- +title: pageBlockHeader +description: Page header +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockHeader +[Back to constructors index](index.md) + + + +Page header + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockHeader = ['_' => 'pageBlockHeader', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockHeader={_='pageBlockHeader', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockKicker.md b/old_docs/API_docs_v44/constructors/pageBlockKicker.md new file mode 100644 index 00000000..0b91112e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockKicker.md @@ -0,0 +1,38 @@ +--- +title: pageBlockKicker +description: Kicker +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockKicker +[Back to constructors index](index.md) + + + +Kicker + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockKicker = ['_' => 'pageBlockKicker', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockKicker={_='pageBlockKicker', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockList.md b/old_docs/API_docs_v44/constructors/pageBlockList.md new file mode 100644 index 00000000..6eee099f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockList.md @@ -0,0 +1,38 @@ +--- +title: pageBlockList +description: Unordered list of IV blocks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockList +[Back to constructors index](index.md) + + + +Unordered list of IV blocks + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageListItem](../types/PageListItem.md) | Yes|List of blocks in an IV page| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockList = ['_' => 'pageBlockList', 'items' => [PageListItem, PageListItem]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockList={_='pageBlockList', items={PageListItem}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockMap.md b/old_docs/API_docs_v44/constructors/pageBlockMap.md new file mode 100644 index 00000000..9d68d956 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockMap.md @@ -0,0 +1,42 @@ +--- +title: pageBlockMap +description: A map +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockMap +[Back to constructors index](index.md) + + + +A map + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Location of the map center| +|zoom|[int](../types/int.md) | Yes|Map zoom level; 13-20| +|w|[int](../types/int.md) | Yes|Map width in pixels before applying scale; 16-102| +|h|[int](../types/int.md) | Yes|Map height in pixels before applying scale; 16-1024| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockMap = ['_' => 'pageBlockMap', 'geo' => GeoPoint, 'zoom' => int, 'w' => int, 'h' => int, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockMap={_='pageBlockMap', geo=GeoPoint, zoom=int, w=int, h=int, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockOrderedList.md b/old_docs/API_docs_v44/constructors/pageBlockOrderedList.md new file mode 100644 index 00000000..11f3b322 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockOrderedList.md @@ -0,0 +1,38 @@ +--- +title: pageBlockOrderedList +description: Ordered list of IV blocks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockOrderedList +[Back to constructors index](index.md) + + + +Ordered list of IV blocks + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageListOrderedItem](../types/PageListOrderedItem.md) | Yes|List items| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockOrderedList = ['_' => 'pageBlockOrderedList', 'items' => [PageListOrderedItem, PageListOrderedItem]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockOrderedList={_='pageBlockOrderedList', items={PageListOrderedItem}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockParagraph.md b/old_docs/API_docs_v44/constructors/pageBlockParagraph.md new file mode 100644 index 00000000..0c25d546 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockParagraph.md @@ -0,0 +1,38 @@ +--- +title: pageBlockParagraph +description: A paragraph +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockParagraph +[Back to constructors index](index.md) + + + +A paragraph + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockParagraph = ['_' => 'pageBlockParagraph', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockParagraph={_='pageBlockParagraph', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockPhoto.md b/old_docs/API_docs_v44/constructors/pageBlockPhoto.md new file mode 100644 index 00000000..c4c9115e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockPhoto.md @@ -0,0 +1,41 @@ +--- +title: pageBlockPhoto +description: A photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPhoto +[Back to constructors index](index.md) + + + +A photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo\_id|[long](../types/long.md) | Yes|Photo ID| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| +|url|[string](../types/string.md) | Optional|HTTP URL of page the photo leads to when clicked| +|webpage\_id|[long](../types/long.md) | Optional|ID of preview of the page the photo leads to when clicked| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockPhoto = ['_' => 'pageBlockPhoto', 'photo_id' => long, 'caption' => PageCaption, 'url' => 'string', 'webpage_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockPhoto={_='pageBlockPhoto', photo_id=long, caption=PageCaption, url='string', webpage_id=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockPreformatted.md b/old_docs/API_docs_v44/constructors/pageBlockPreformatted.md new file mode 100644 index 00000000..837c444a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockPreformatted.md @@ -0,0 +1,39 @@ +--- +title: pageBlockPreformatted +description: Preformatted (`` text) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPreformatted +[Back to constructors index](index.md) + + + +Preformatted (`` text) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|language|[string](../types/string.md) | Yes|Programming language of preformatted text| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockPreformatted = ['_' => 'pageBlockPreformatted', 'text' => RichText, 'language' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockPreformatted={_='pageBlockPreformatted', text=RichText, language='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockPullquote.md b/old_docs/API_docs_v44/constructors/pageBlockPullquote.md new file mode 100644 index 00000000..700f4fc0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockPullquote.md @@ -0,0 +1,39 @@ +--- +title: pageBlockPullquote +description: Pullquote +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPullquote +[Back to constructors index](index.md) + + + +Pullquote + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|caption|[RichText](../types/RichText.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockPullquote = ['_' => 'pageBlockPullquote', 'text' => RichText, 'caption' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockPullquote={_='pageBlockPullquote', text=RichText, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockRelatedArticles.md b/old_docs/API_docs_v44/constructors/pageBlockRelatedArticles.md new file mode 100644 index 00000000..d3af32ad --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockRelatedArticles.md @@ -0,0 +1,39 @@ +--- +title: pageBlockRelatedArticles +description: Related articles +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockRelatedArticles +[Back to constructors index](index.md) + + + +Related articles + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[RichText](../types/RichText.md) | Yes|Title| +|articles|Array of [PageRelatedArticle](../types/PageRelatedArticle.md) | Yes|Related articles| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockRelatedArticles = ['_' => 'pageBlockRelatedArticles', 'title' => RichText, 'articles' => [PageRelatedArticle, PageRelatedArticle]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockRelatedArticles={_='pageBlockRelatedArticles', title=RichText, articles={PageRelatedArticle}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockSlideshow.md b/old_docs/API_docs_v44/constructors/pageBlockSlideshow.md new file mode 100644 index 00000000..35f91d85 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockSlideshow.md @@ -0,0 +1,39 @@ +--- +title: pageBlockSlideshow +description: Slideshow +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSlideshow +[Back to constructors index](index.md) + + + +Slideshow + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageBlock](../types/PageBlock.md) | Yes|Slideshow items| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockSlideshow = ['_' => 'pageBlockSlideshow', 'items' => [PageBlock, PageBlock], 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockSlideshow={_='pageBlockSlideshow', items={PageBlock}, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockSubheader.md b/old_docs/API_docs_v44/constructors/pageBlockSubheader.md new file mode 100644 index 00000000..600ddbd1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockSubheader.md @@ -0,0 +1,38 @@ +--- +title: pageBlockSubheader +description: Subheader +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSubheader +[Back to constructors index](index.md) + + + +Subheader + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Subheader| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockSubheader = ['_' => 'pageBlockSubheader', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockSubheader={_='pageBlockSubheader', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockSubtitle.md b/old_docs/API_docs_v44/constructors/pageBlockSubtitle.md new file mode 100644 index 00000000..8164a832 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockSubtitle.md @@ -0,0 +1,38 @@ +--- +title: pageBlockSubtitle +description: Subtitle +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSubtitle +[Back to constructors index](index.md) + + + +Subtitle + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockSubtitle = ['_' => 'pageBlockSubtitle', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockSubtitle={_='pageBlockSubtitle', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockTable.md b/old_docs/API_docs_v44/constructors/pageBlockTable.md new file mode 100644 index 00000000..bd42bd76 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockTable.md @@ -0,0 +1,41 @@ +--- +title: pageBlockTable +description: Table +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockTable +[Back to constructors index](index.md) + + + +Table + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bordered|[Bool](../types/Bool.md) | Optional|Does the table have a visible border?| +|striped|[Bool](../types/Bool.md) | Optional|Is the table striped?| +|title|[RichText](../types/RichText.md) | Yes|Title| +|rows|Array of [PageTableRow](../types/PageTableRow.md) | Yes|Table rows| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockTable = ['_' => 'pageBlockTable', 'bordered' => Bool, 'striped' => Bool, 'title' => RichText, 'rows' => [PageTableRow, PageTableRow]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockTable={_='pageBlockTable', bordered=Bool, striped=Bool, title=RichText, rows={PageTableRow}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockTitle.md b/old_docs/API_docs_v44/constructors/pageBlockTitle.md new file mode 100644 index 00000000..ffe57558 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockTitle.md @@ -0,0 +1,38 @@ +--- +title: pageBlockTitle +description: Title +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockTitle +[Back to constructors index](index.md) + + + +Title + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Title| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockTitle = ['_' => 'pageBlockTitle', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockTitle={_='pageBlockTitle', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockUnsupported.md b/old_docs/API_docs_v44/constructors/pageBlockUnsupported.md new file mode 100644 index 00000000..52927ae3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockUnsupported.md @@ -0,0 +1,33 @@ +--- +title: pageBlockUnsupported +description: Unsupported IV element +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockUnsupported +[Back to constructors index](index.md) + + + +Unsupported IV element + + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockUnsupported = ['_' => 'pageBlockUnsupported']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockUnsupported={_='pageBlockUnsupported'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageBlockVideo.md b/old_docs/API_docs_v44/constructors/pageBlockVideo.md new file mode 100644 index 00000000..57a55aaa --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageBlockVideo.md @@ -0,0 +1,41 @@ +--- +title: pageBlockVideo +description: Video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockVideo +[Back to constructors index](index.md) + + + +Video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|autoplay|[Bool](../types/Bool.md) | Optional|Whether the video is set to autoplay| +|loop|[Bool](../types/Bool.md) | Optional|Whether the video is set to loop| +|video\_id|[long](../types/long.md) | Yes|Video ID| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockVideo = ['_' => 'pageBlockVideo', 'autoplay' => Bool, 'loop' => Bool, 'video_id' => long, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockVideo={_='pageBlockVideo', autoplay=Bool, loop=Bool, video_id=long, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageCaption.md b/old_docs/API_docs_v44/constructors/pageCaption.md new file mode 100644 index 00000000..323f2925 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageCaption.md @@ -0,0 +1,39 @@ +--- +title: pageCaption +description: Page caption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageCaption +[Back to constructors index](index.md) + + + +Page caption + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Caption| +|credit|[RichText](../types/RichText.md) | Yes|Credits| + + + +### Type: [PageCaption](../types/PageCaption.md) + + +### Example: + +```php +$pageCaption = ['_' => 'pageCaption', 'text' => RichText, 'credit' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageCaption={_='pageCaption', text=RichText, credit=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageListItemBlocks.md b/old_docs/API_docs_v44/constructors/pageListItemBlocks.md new file mode 100644 index 00000000..935652de --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageListItemBlocks.md @@ -0,0 +1,38 @@ +--- +title: pageListItemBlocks +description: List item +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageListItemBlocks +[Back to constructors index](index.md) + + + +List item + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks| + + + +### Type: [PageListItem](../types/PageListItem.md) + + +### Example: + +```php +$pageListItemBlocks = ['_' => 'pageListItemBlocks', 'blocks' => [PageBlock, PageBlock]]; +``` + + +Or, if you're into Lua: + +```lua +pageListItemBlocks={_='pageListItemBlocks', blocks={PageBlock}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageListItemText.md b/old_docs/API_docs_v44/constructors/pageListItemText.md new file mode 100644 index 00000000..d41f65c0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageListItemText.md @@ -0,0 +1,38 @@ +--- +title: pageListItemText +description: List item +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageListItemText +[Back to constructors index](index.md) + + + +List item + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [PageListItem](../types/PageListItem.md) + + +### Example: + +```php +$pageListItemText = ['_' => 'pageListItemText', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageListItemText={_='pageListItemText', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageListOrderedItemBlocks.md b/old_docs/API_docs_v44/constructors/pageListOrderedItemBlocks.md new file mode 100644 index 00000000..b9ee8fad --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageListOrderedItemBlocks.md @@ -0,0 +1,39 @@ +--- +title: pageListOrderedItemBlocks +description: Ordered list of [IV](https://instantview.telegram.org) blocks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageListOrderedItemBlocks +[Back to constructors index](index.md) + + + +Ordered list of [IV](https://instantview.telegram.org) blocks + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|num|[string](../types/string.md) | Yes|Number of element within ordered list| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Item contents| + + + +### Type: [PageListOrderedItem](../types/PageListOrderedItem.md) + + +### Example: + +```php +$pageListOrderedItemBlocks = ['_' => 'pageListOrderedItemBlocks', 'num' => 'string', 'blocks' => [PageBlock, PageBlock]]; +``` + + +Or, if you're into Lua: + +```lua +pageListOrderedItemBlocks={_='pageListOrderedItemBlocks', num='string', blocks={PageBlock}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageListOrderedItemText.md b/old_docs/API_docs_v44/constructors/pageListOrderedItemText.md new file mode 100644 index 00000000..de4b66dd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageListOrderedItemText.md @@ -0,0 +1,39 @@ +--- +title: pageListOrderedItemText +description: Ordered list of text items +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageListOrderedItemText +[Back to constructors index](index.md) + + + +Ordered list of text items + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|num|[string](../types/string.md) | Yes|Number of element within ordered list| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [PageListOrderedItem](../types/PageListOrderedItem.md) + + +### Example: + +```php +$pageListOrderedItemText = ['_' => 'pageListOrderedItemText', 'num' => 'string', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageListOrderedItemText={_='pageListOrderedItemText', num='string', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageRelatedArticle.md b/old_docs/API_docs_v44/constructors/pageRelatedArticle.md new file mode 100644 index 00000000..917b0ba9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageRelatedArticle.md @@ -0,0 +1,44 @@ +--- +title: pageRelatedArticle +description: Related article +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageRelatedArticle +[Back to constructors index](index.md) + + + +Related article + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL of article| +|webpage\_id|[long](../types/long.md) | Yes|Webpage ID of generated IV preview| +|title|[string](../types/string.md) | Optional|Title| +|description|[string](../types/string.md) | Optional|Description| +|photo\_id|[long](../types/long.md) | Optional|ID of preview photo| +|author|[string](../types/string.md) | Optional|Author name| +|published\_date|[int](../types/int.md) | Optional|Date of pubblication| + + + +### Type: [PageRelatedArticle](../types/PageRelatedArticle.md) + + +### Example: + +```php +$pageRelatedArticle = ['_' => 'pageRelatedArticle', 'url' => 'string', 'webpage_id' => long, 'title' => 'string', 'description' => 'string', 'photo_id' => long, 'author' => 'string', 'published_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +pageRelatedArticle={_='pageRelatedArticle', url='string', webpage_id=long, title='string', description='string', photo_id=long, author='string', published_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageTableCell.md b/old_docs/API_docs_v44/constructors/pageTableCell.md new file mode 100644 index 00000000..2249b3e4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageTableCell.md @@ -0,0 +1,45 @@ +--- +title: pageTableCell +description: Table cell +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageTableCell +[Back to constructors index](index.md) + + + +Table cell + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|header|[Bool](../types/Bool.md) | Optional|Is this element part of the column header| +|align\_center|[Bool](../types/Bool.md) | Optional|Horizontally centered block| +|align\_right|[Bool](../types/Bool.md) | Optional|Right-aligned block| +|valign\_middle|[Bool](../types/Bool.md) | Optional|Vertically centered block| +|valign\_bottom|[Bool](../types/Bool.md) | Optional|Block vertically-alligned to the bottom| +|text|[RichText](../types/RichText.md) | Optional|Content| +|colspan|[int](../types/int.md) | Optional|For how many columns should this cell extend| +|rowspan|[int](../types/int.md) | Optional|For how many rows should this cell extend| + + + +### Type: [PageTableCell](../types/PageTableCell.md) + + +### Example: + +```php +$pageTableCell = ['_' => 'pageTableCell', 'header' => Bool, 'align_center' => Bool, 'align_right' => Bool, 'valign_middle' => Bool, 'valign_bottom' => Bool, 'text' => RichText, 'colspan' => int, 'rowspan' => int]; +``` + + +Or, if you're into Lua: + +```lua +pageTableCell={_='pageTableCell', header=Bool, align_center=Bool, align_right=Bool, valign_middle=Bool, valign_bottom=Bool, text=RichText, colspan=int, rowspan=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pageTableRow.md b/old_docs/API_docs_v44/constructors/pageTableRow.md new file mode 100644 index 00000000..f746f5c5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pageTableRow.md @@ -0,0 +1,38 @@ +--- +title: pageTableRow +description: Table row +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageTableRow +[Back to constructors index](index.md) + + + +Table row + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cells|Array of [PageTableCell](../types/PageTableCell.md) | Yes|Table cells| + + + +### Type: [PageTableRow](../types/PageTableRow.md) + + +### Example: + +```php +$pageTableRow = ['_' => 'pageTableRow', 'cells' => [PageTableCell, PageTableCell]]; +``` + + +Or, if you're into Lua: + +```lua +pageTableRow={_='pageTableRow', cells={PageTableCell}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md b/old_docs/API_docs_v44/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md new file mode 100644 index 00000000..3491c657 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md @@ -0,0 +1,41 @@ +--- +title: passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow +description: This key derivation algorithm defines that [SRP 2FA login](https://core.telegram.org/api/srp) must be used +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow +[Back to constructors index](index.md) + + + +This key derivation algorithm defines that [SRP 2FA login](https://core.telegram.org/api/srp) must be used + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|salt1|[bytes](../types/bytes.md) | Yes|One of two salts used by the derivation function (see [SRP 2FA login](https://core.telegram.org/api/srp))| +|salt2|[bytes](../types/bytes.md) | Yes|One of two salts used by the derivation function (see [SRP 2FA login](https://core.telegram.org/api/srp))| +|g|[int](../types/int.md) | Yes|Base (see [SRP 2FA login](https://core.telegram.org/api/srp))| +|p|[bytes](../types/bytes.md) | Yes|2048-bit modulus (see [SRP 2FA login](https://core.telegram.org/api/srp))| + + + +### Type: [PasswordKdfAlgo](../types/PasswordKdfAlgo.md) + + +### Example: + +```php +$passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow = ['_' => 'passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow', 'salt1' => 'bytes', 'salt2' => 'bytes', 'g' => int, 'p' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow={_='passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow', salt1='bytes', salt2='bytes', g=int, p='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/passwordKdfAlgoUnknown.md b/old_docs/API_docs_v44/constructors/passwordKdfAlgoUnknown.md new file mode 100644 index 00000000..02ea7f8e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/passwordKdfAlgoUnknown.md @@ -0,0 +1,33 @@ +--- +title: passwordKdfAlgoUnknown +description: Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: passwordKdfAlgoUnknown +[Back to constructors index](index.md) + + + +Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm) + + + + +### Type: [PasswordKdfAlgo](../types/PasswordKdfAlgo.md) + + +### Example: + +```php +$passwordKdfAlgoUnknown = ['_' => 'passwordKdfAlgoUnknown']; +``` + + +Or, if you're into Lua: + +```lua +passwordKdfAlgoUnknown={_='passwordKdfAlgoUnknown'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/paymentCharge.md b/old_docs/API_docs_v44/constructors/paymentCharge.md new file mode 100644 index 00000000..ef51d80b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/paymentCharge.md @@ -0,0 +1,39 @@ +--- +title: paymentCharge +description: Payment identifier +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentCharge +[Back to constructors index](index.md) + + + +Payment identifier + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Telegram payment identifier| +|provider\_charge\_id|[string](../types/string.md) | Yes|Provider payment identifier| + + + +### Type: [PaymentCharge](../types/PaymentCharge.md) + + +### Example: + +```php +$paymentCharge = ['_' => 'paymentCharge', 'id' => 'string', 'provider_charge_id' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +paymentCharge={_='paymentCharge', id='string', provider_charge_id='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/paymentRequestedInfo.md b/old_docs/API_docs_v44/constructors/paymentRequestedInfo.md new file mode 100644 index 00000000..ec4bd7cf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/paymentRequestedInfo.md @@ -0,0 +1,41 @@ +--- +title: paymentRequestedInfo +description: Order info provided by the user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentRequestedInfo +[Back to constructors index](index.md) + + + +Order info provided by the user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Optional|User's full name| +|phone|[string](../types/string.md) | Optional|User's phone number| +|email|[string](../types/string.md) | Optional|User's email address| +|shipping\_address|[PostAddress](../types/PostAddress.md) | Optional|User's shipping address| + + + +### Type: [PaymentRequestedInfo](../types/PaymentRequestedInfo.md) + + +### Example: + +```php +$paymentRequestedInfo = ['_' => 'paymentRequestedInfo', 'name' => 'string', 'phone' => 'string', 'email' => 'string', 'shipping_address' => PostAddress]; +``` + + +Or, if you're into Lua: + +```lua +paymentRequestedInfo={_='paymentRequestedInfo', name='string', phone='string', email='string', shipping_address=PostAddress} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/paymentSavedCredentialsCard.md b/old_docs/API_docs_v44/constructors/paymentSavedCredentialsCard.md new file mode 100644 index 00000000..83f3b314 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/paymentSavedCredentialsCard.md @@ -0,0 +1,39 @@ +--- +title: paymentSavedCredentialsCard +description: Saved credit card +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentSavedCredentialsCard +[Back to constructors index](index.md) + + + +Saved credit card + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Card ID| +|title|[string](../types/string.md) | Yes|Title| + + + +### Type: [PaymentSavedCredentials](../types/PaymentSavedCredentials.md) + + +### Example: + +```php +$paymentSavedCredentialsCard = ['_' => 'paymentSavedCredentialsCard', 'id' => 'string', 'title' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +paymentSavedCredentialsCard={_='paymentSavedCredentialsCard', id='string', title='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.bankCardData.md b/old_docs/API_docs_v44/constructors/payments.bankCardData.md new file mode 100644 index 00000000..bf5f4ec0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.bankCardData.md @@ -0,0 +1,40 @@ +--- +title: payments.bankCardData +description: Credit card info, provided by the card's bank(s) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_bankCardData.html +--- +# Constructor: payments.bankCardData +[Back to constructors index](index.md) + + + +Credit card info, provided by the card's bank(s) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Credit card title| +|open\_urls|Array of [BankCardOpenUrl](../types/BankCardOpenUrl.md) | Yes|Info URL(s) provided by the card's bank(s)| + + + +### Type: [payments.BankCardData](../types/payments.BankCardData.md) + + +### Example: + +```php +$payments.bankCardData = ['_' => 'payments.bankCardData', 'title' => 'string', 'open_urls' => [BankCardOpenUrl, BankCardOpenUrl]]; +``` + + +Or, if you're into Lua: + +```lua +payments.bankCardData={_='payments.bankCardData', title='string', open_urls={BankCardOpenUrl}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.paymentForm.md b/old_docs/API_docs_v44/constructors/payments.paymentForm.md new file mode 100644 index 00000000..fda8519d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.paymentForm.md @@ -0,0 +1,49 @@ +--- +title: payments.paymentForm +description: Payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentForm.html +--- +# Constructor: payments.paymentForm +[Back to constructors index](index.md) + + + +Payment form + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_save\_credentials|[Bool](../types/Bool.md) | Optional|Whether the user can choose to save credentials.| +|password\_missing|[Bool](../types/Bool.md) | Optional|Indicates that the user can save payment credentials, but only after setting up a [2FA password](https://core.telegram.org/api/srp) (currently the account doesn't have a [2FA password](https://core.telegram.org/api/srp))| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|invoice|[Invoice](../types/Invoice.md) | Yes|Invoice| +|provider\_id|[int](../types/int.md) | Yes|Payment provider ID.| +|url|[string](../types/string.md) | Yes|Payment form URL| +|native\_provider|[string](../types/string.md) | Optional|Payment provider name.
One of the following:
\- `stripe`| +|native\_params|[DataJSON](../types/DataJSON.md) | Optional|Contains information about the payment provider, if available, to support it natively without the need for opening the URL.
A JSON object that can contain the following fields:
\- `publishable_key`: Stripe API publishable key
\- `apple_pay_merchant_id`: Apple Pay merchant ID
\- `android_pay_public_key`: Android Pay public key
\- `android_pay_bgcolor`: Android Pay form background color
\- `android_pay_inverse`: Whether to use the dark theme in the Android Pay form
\- `need_country`: True, if the user country must be provided,
\- `need_zip`: True, if the user ZIP/postal code must be provided,
\- `need_cardholder_name`: True, if the cardholder name must be provided
| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Saved server-side order information| +|saved\_credentials|[PaymentSavedCredentials](../types/PaymentSavedCredentials.md) | Optional|Contains information about saved card credentials| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [payments.PaymentForm](../types/payments.PaymentForm.md) + + +### Example: + +```php +$payments.paymentForm = ['_' => 'payments.paymentForm', 'can_save_credentials' => Bool, 'password_missing' => Bool, 'bot_id' => int, 'invoice' => Invoice, 'provider_id' => int, 'url' => 'string', 'native_provider' => 'string', 'native_params' => DataJSON, 'saved_info' => PaymentRequestedInfo, 'saved_credentials' => PaymentSavedCredentials, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentForm={_='payments.paymentForm', can_save_credentials=Bool, password_missing=Bool, bot_id=int, invoice=Invoice, provider_id=int, url='string', native_provider='string', native_params=DataJSON, saved_info=PaymentRequestedInfo, saved_credentials=PaymentSavedCredentials, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.paymentReceipt.md b/old_docs/API_docs_v44/constructors/payments.paymentReceipt.md new file mode 100644 index 00000000..0dea8fbe --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.paymentReceipt.md @@ -0,0 +1,48 @@ +--- +title: payments.paymentReceipt +description: Receipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentReceipt.html +--- +# Constructor: payments.paymentReceipt +[Back to constructors index](index.md) + + + +Receipt + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Date of generation| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|invoice|[Invoice](../types/Invoice.md) | Yes|Invoice| +|provider\_id|[int](../types/int.md) | Yes|Provider ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Info| +|shipping|[ShippingOption](../types/ShippingOption.md) | Optional|Selected shipping option| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|credentials\_title|[string](../types/string.md) | Yes|Payment credential name| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [payments.PaymentReceipt](../types/payments.PaymentReceipt.md) + + +### Example: + +```php +$payments.paymentReceipt = ['_' => 'payments.paymentReceipt', 'date' => int, 'bot_id' => int, 'invoice' => Invoice, 'provider_id' => int, 'info' => PaymentRequestedInfo, 'shipping' => ShippingOption, 'currency' => 'string', 'total_amount' => long, 'credentials_title' => 'string', 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentReceipt={_='payments.paymentReceipt', date=int, bot_id=int, invoice=Invoice, provider_id=int, info=PaymentRequestedInfo, shipping=ShippingOption, currency='string', total_amount=long, credentials_title='string', users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.paymentResult.md b/old_docs/API_docs_v44/constructors/payments.paymentResult.md new file mode 100644 index 00000000..46b129d3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.paymentResult.md @@ -0,0 +1,39 @@ +--- +title: payments.paymentResult +description: Payment result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentResult.html +--- +# Constructor: payments.paymentResult +[Back to constructors index](index.md) + + + +Payment result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|updates|[Updates](../types/Updates.md) | Yes|Info about the payment| + + + +### Type: [payments.PaymentResult](../types/payments.PaymentResult.md) + + +### Example: + +```php +$payments.paymentResult = ['_' => 'payments.paymentResult', 'updates' => Updates]; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentResult={_='payments.paymentResult', updates=Updates} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.paymentVerificationNeeded.md b/old_docs/API_docs_v44/constructors/payments.paymentVerificationNeeded.md new file mode 100644 index 00000000..a640f5b5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.paymentVerificationNeeded.md @@ -0,0 +1,39 @@ +--- +title: payments.paymentVerificationNeeded +description: Payment was not successful, additional verification is needed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentVerificationNeeded.html +--- +# Constructor: payments.paymentVerificationNeeded +[Back to constructors index](index.md) + + + +Payment was not successful, additional verification is needed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL for additional payment credentials verification| + + + +### Type: [payments.PaymentResult](../types/payments.PaymentResult.md) + + +### Example: + +```php +$payments.paymentVerificationNeeded = ['_' => 'payments.paymentVerificationNeeded', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentVerificationNeeded={_='payments.paymentVerificationNeeded', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.savedInfo.md b/old_docs/API_docs_v44/constructors/payments.savedInfo.md new file mode 100644 index 00000000..09e78c54 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.savedInfo.md @@ -0,0 +1,40 @@ +--- +title: payments.savedInfo +description: Saved server-side order information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_savedInfo.html +--- +# Constructor: payments.savedInfo +[Back to constructors index](index.md) + + + +Saved server-side order information + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|has\_saved\_credentials|[Bool](../types/Bool.md) | Optional|Whether the user has some saved payment credentials| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Saved server-side order information| + + + +### Type: [payments.SavedInfo](../types/payments.SavedInfo.md) + + +### Example: + +```php +$payments.savedInfo = ['_' => 'payments.savedInfo', 'has_saved_credentials' => Bool, 'saved_info' => PaymentRequestedInfo]; +``` + + +Or, if you're into Lua: + +```lua +payments.savedInfo={_='payments.savedInfo', has_saved_credentials=Bool, saved_info=PaymentRequestedInfo} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/payments.validatedRequestedInfo.md b/old_docs/API_docs_v44/constructors/payments.validatedRequestedInfo.md new file mode 100644 index 00000000..62130156 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/payments.validatedRequestedInfo.md @@ -0,0 +1,40 @@ +--- +title: payments.validatedRequestedInfo +description: Validated user-provided info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_validatedRequestedInfo.html +--- +# Constructor: payments.validatedRequestedInfo +[Back to constructors index](index.md) + + + +Validated user-provided info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Optional|ID| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| + + + +### Type: [payments.ValidatedRequestedInfo](../types/payments.ValidatedRequestedInfo.md) + + +### Example: + +```php +$payments.validatedRequestedInfo = ['_' => 'payments.validatedRequestedInfo', 'id' => 'string', 'shipping_options' => [ShippingOption, ShippingOption]]; +``` + + +Or, if you're into Lua: + +```lua +payments.validatedRequestedInfo={_='payments.validatedRequestedInfo', id='string', shipping_options={ShippingOption}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/peerLocated.md b/old_docs/API_docs_v44/constructors/peerLocated.md new file mode 100644 index 00000000..125dc1d9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/peerLocated.md @@ -0,0 +1,40 @@ +--- +title: peerLocated +description: Peer geolocated nearby +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerLocated +[Back to constructors index](index.md) + + + +Peer geolocated nearby + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|expires|[int](../types/int.md) | Yes|Validity period of current data| +|distance|[int](../types/int.md) | Yes|Distance from the peer in meters| + + + +### Type: [PeerLocated](../types/PeerLocated.md) + + +### Example: + +```php +$peerLocated = ['_' => 'peerLocated', 'peer' => Peer, 'expires' => int, 'distance' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerLocated={_='peerLocated', peer=Peer, expires=int, distance=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/peerNotifyEventsAll.md b/old_docs/API_docs_v44/constructors/peerNotifyEventsAll.md deleted file mode 100644 index 0b9d3a21..00000000 --- a/old_docs/API_docs_v44/constructors/peerNotifyEventsAll.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: peerNotifyEventsAll -description: Peer notify events all -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: peerNotifyEventsAll -[Back to constructors index](index.md) - - - -Peer notify events all - - - - -### Type: [PeerNotifyEvents](../types/PeerNotifyEvents.md) - - -### Example: - -```php -$peerNotifyEventsAll = ['_' => 'peerNotifyEventsAll']; -``` - - -Or, if you're into Lua: - -```lua -peerNotifyEventsAll={_='peerNotifyEventsAll'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/peerNotifyEventsEmpty.md b/old_docs/API_docs_v44/constructors/peerNotifyEventsEmpty.md deleted file mode 100644 index afbd8e5e..00000000 --- a/old_docs/API_docs_v44/constructors/peerNotifyEventsEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: peerNotifyEventsEmpty -description: Empty peer notify events -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: peerNotifyEventsEmpty -[Back to constructors index](index.md) - - - -Empty peer notify events - - - - -### Type: [PeerNotifyEvents](../types/PeerNotifyEvents.md) - - -### Example: - -```php -$peerNotifyEventsEmpty = ['_' => 'peerNotifyEventsEmpty']; -``` - - -Or, if you're into Lua: - -```lua -peerNotifyEventsEmpty={_='peerNotifyEventsEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/peerNotifySettings.md b/old_docs/API_docs_v44/constructors/peerNotifySettings.md index 250475d8..580bbfe2 100644 --- a/old_docs/API_docs_v44/constructors/peerNotifySettings.md +++ b/old_docs/API_docs_v44/constructors/peerNotifySettings.md @@ -14,10 +14,10 @@ Notification settings. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|mute\_until|[int](../types/int.md) | Yes|Mute all notifications until this date| -|sound|[string](../types/string.md) | Yes|Audio file name for notifications| -|show\_previews|[Bool](../types/Bool.md) | Yes|Display text in notifications| -|events\_mask|[int](../types/int.md) | Yes|Events mask| +|show\_previews|[Bool](../types/Bool.md) | Optional|Display text in notifications| +|silent|[Bool](../types/Bool.md) | Optional|Mute peer?| +|mute\_until|[int](../types/int.md) | Optional|Mute all notifications until this date| +|sound|[string](../types/string.md) | Optional|Audio file name for notifications| @@ -27,14 +27,14 @@ Notification settings. ### Example: ```php -$peerNotifySettings = ['_' => 'peerNotifySettings', 'mute_until' => int, 'sound' => 'string', 'show_previews' => Bool, 'events_mask' => int]; +$peerNotifySettings = ['_' => 'peerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; ``` Or, if you're into Lua: ```lua -peerNotifySettings={_='peerNotifySettings', mute_until=int, sound='string', show_previews=Bool, events_mask=int} +peerNotifySettings={_='peerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/peerNotifySettingsEmpty.md b/old_docs/API_docs_v44/constructors/peerNotifySettingsEmpty.md deleted file mode 100644 index 196bcd7b..00000000 --- a/old_docs/API_docs_v44/constructors/peerNotifySettingsEmpty.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: peerNotifySettingsEmpty -description: Empty peer notify settings -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: peerNotifySettingsEmpty -[Back to constructors index](index.md) - - - -Empty peer notify settings - - - - -### Type: [PeerNotifySettings](../types/PeerNotifySettings.md) - - -### Example: - -```php -$peerNotifySettingsEmpty = ['_' => 'peerNotifySettingsEmpty']; -``` - - -Or, if you're into Lua: - -```lua -peerNotifySettingsEmpty={_='peerNotifySettingsEmpty'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/peerSelfLocated.md b/old_docs/API_docs_v44/constructors/peerSelfLocated.md new file mode 100644 index 00000000..2f6ca19f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/peerSelfLocated.md @@ -0,0 +1,38 @@ +--- +title: peerSelfLocated +description: Current peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerSelfLocated +[Back to constructors index](index.md) + + + +Current peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Expiry of geolocation info for current peer| + + + +### Type: [PeerLocated](../types/PeerLocated.md) + + +### Example: + +```php +$peerSelfLocated = ['_' => 'peerSelfLocated', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerSelfLocated={_='peerSelfLocated', expires=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/peerSettings.md b/old_docs/API_docs_v44/constructors/peerSettings.md new file mode 100644 index 00000000..cc230e21 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/peerSettings.md @@ -0,0 +1,45 @@ +--- +title: peerSettings +description: Peer settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerSettings +[Back to constructors index](index.md) + + + +Peer settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|report\_spam|[Bool](../types/Bool.md) | Optional|Whether we can still report the user for spam| +|add\_contact|[Bool](../types/Bool.md) | Optional|Whether we can add the user as contact| +|block\_contact|[Bool](../types/Bool.md) | Optional|Whether we can block the user| +|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| + + + +### Type: [PeerSettings](../types/PeerSettings.md) + + +### Example: + +```php +$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, autoarchived=Bool, geo_distance=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phone.phoneCall.md b/old_docs/API_docs_v44/constructors/phone.phoneCall.md new file mode 100644 index 00000000..ce97cb9c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phone.phoneCall.md @@ -0,0 +1,40 @@ +--- +title: phone.phoneCall +description: A VoIP phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/phone_phoneCall.html +--- +# Constructor: phone.phoneCall +[Back to constructors index](index.md) + + + +A VoIP phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional|The VoIP phone call| +|users|Array of [User](../types/User.md) | Yes|VoIP phone call participants| + + + +### Type: [phone.PhoneCall](../types/phone.PhoneCall.md) + + +### Example: + +```php +$phone.phoneCall = ['_' => 'phone.phoneCall', 'phone_call' => PhoneCall, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +phone.phoneCall={_='phone.phoneCall', phone_call=PhoneCall, users={User}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCall.md b/old_docs/API_docs_v44/constructors/phoneCall.md new file mode 100644 index 00000000..883d375d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCall.md @@ -0,0 +1,49 @@ +--- +title: phoneCall +description: Phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCall +[Back to constructors index](index.md) + + + +Phone call + +### Attributes: + +| 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| +|admin\_id|[int](../types/int.md) | Yes|User ID of the creator of the call| +|participant\_id|[int](../types/int.md) | Yes|User ID of the other participant in the call| +|g\_a\_or\_b|[bytes](../types/bytes.md) | Yes|[Parameter for key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|key\_fingerprint|[long](../types/long.md) | Yes|[Key fingerprint](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Call protocol info to be passed to libtgvoip| +|connections|Array of [PhoneConnection](../types/PhoneConnection.md) | Yes|List of endpoints the user can connect to to exchange call data| +|start\_date|[int](../types/int.md) | Yes|When was the call actually started| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$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, 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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallAccepted.md b/old_docs/API_docs_v44/constructors/phoneCallAccepted.md new file mode 100644 index 00000000..2f7a2660 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallAccepted.md @@ -0,0 +1,45 @@ +--- +title: phoneCallAccepted +description: An accepted phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallAccepted +[Back to constructors index](index.md) + + + +An accepted phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Whether this is a video call| +|id|[long](../types/long.md) | Yes|ID of accepted phone call| +|access\_hash|[long](../types/long.md) | Yes|Access hash of phone call| +|date|[int](../types/int.md) | Yes|When was the call accepted| +|admin\_id|[int](../types/int.md) | Yes|ID of the call creator| +|participant\_id|[int](../types/int.md) | Yes|ID of the other user in the call| +|g\_b|[bytes](../types/bytes.md) | Yes|B parameter for [secure E2E phone call key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Protocol to use for phone call| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallAccepted = ['_' => 'phoneCallAccepted', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_b' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallAccepted={_='phoneCallAccepted', video=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_b='bytes', protocol=PhoneCallProtocol} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonBusy.md b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonBusy.md new file mode 100644 index 00000000..97e36a67 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonBusy.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonBusy +description: The phone call was discared because the user is busy in another call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonBusy +[Back to constructors index](index.md) + + + +The phone call was discared because the user is busy in another call + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonBusy = ['_' => 'phoneCallDiscardReasonBusy']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonBusy={_='phoneCallDiscardReasonBusy'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonDisconnect.md b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonDisconnect.md new file mode 100644 index 00000000..bc7c231d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonDisconnect.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonDisconnect +description: The phone call was disconnected +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonDisconnect +[Back to constructors index](index.md) + + + +The phone call was disconnected + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonDisconnect = ['_' => 'phoneCallDiscardReasonDisconnect']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonDisconnect={_='phoneCallDiscardReasonDisconnect'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonHangup.md b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonHangup.md new file mode 100644 index 00000000..86288ba8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonHangup.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonHangup +description: The phone call was ended normally +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonHangup +[Back to constructors index](index.md) + + + +The phone call was ended normally + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonHangup = ['_' => 'phoneCallDiscardReasonHangup']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonHangup={_='phoneCallDiscardReasonHangup'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonMissed.md b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonMissed.md new file mode 100644 index 00000000..a2505a14 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallDiscardReasonMissed.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonMissed +description: The phone call was missed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonMissed +[Back to constructors index](index.md) + + + +The phone call was missed + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonMissed = ['_' => 'phoneCallDiscardReasonMissed']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonMissed={_='phoneCallDiscardReasonMissed'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallDiscarded.md b/old_docs/API_docs_v44/constructors/phoneCallDiscarded.md new file mode 100644 index 00000000..6156f979 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallDiscarded.md @@ -0,0 +1,43 @@ +--- +title: phoneCallDiscarded +description: Indicates a discarded phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscarded +[Back to constructors index](index.md) + + + +Indicates a discarded phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|need\_rating|[Bool](../types/Bool.md) | Optional|Whether the server required the user to [rate](../methods/phone.setCallRating.md) the call| +|need\_debug|[Bool](../types/Bool.md) | Optional|Whether the server required the client to [send](../methods/phone.saveCallDebug.md) the libtgvoip call debug data| +|video|[Bool](../types/Bool.md) | Optional|Whether the call was a video call| +|id|[long](../types/long.md) | Yes|Call ID| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional|Why was the phone call discarded| +|duration|[int](../types/int.md) | Optional|Duration of the phone call in seconds| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallDiscarded = ['_' => 'phoneCallDiscarded', 'need_rating' => Bool, 'need_debug' => Bool, 'video' => Bool, 'id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscarded={_='phoneCallDiscarded', need_rating=Bool, need_debug=Bool, video=Bool, id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallEmpty.md b/old_docs/API_docs_v44/constructors/phoneCallEmpty.md new file mode 100644 index 00000000..0187014c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallEmpty.md @@ -0,0 +1,38 @@ +--- +title: phoneCallEmpty +description: Empty constructor +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallEmpty +[Back to constructors index](index.md) + + + +Empty constructor + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Call ID| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallEmpty = ['_' => 'phoneCallEmpty', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallEmpty={_='phoneCallEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallProtocol.md b/old_docs/API_docs_v44/constructors/phoneCallProtocol.md new file mode 100644 index 00000000..896a8db1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallProtocol.md @@ -0,0 +1,42 @@ +--- +title: phoneCallProtocol +description: Protocol info for libtgvoip +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallProtocol +[Back to constructors index](index.md) + + + +Protocol info for libtgvoip + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|udp\_p2p|[Bool](../types/Bool.md) | Optional|Whether to allow P2P connection to the other participant| +|udp\_reflector|[Bool](../types/Bool.md) | Optional|Whether to allow connection to the other participants through the reflector servers| +|min\_layer|[int](../types/int.md) | Yes|Minimum layer for remote libtgvoip| +|max\_layer|[int](../types/int.md) | Yes|Maximum layer for remote libtgvoip| +|library\_versions|Array of [string](../types/string.md) | Yes|When using [phone.requestCall](../methods/phone.requestCall.md) and [phone.acceptCall](../methods/phone.acceptCall.md), specify all library versions supported by the client.
The server will merge and choose the best library version supported by both peers, returning only the best value in the result of the callee's [phone.acceptCall](../methods/phone.acceptCall.md) and in the [phoneCallAccepted](../constructors/phoneCallAccepted.md) update received by the caller.| + + + +### Type: [PhoneCallProtocol](../types/PhoneCallProtocol.md) + + +### Example: + +```php +$phoneCallProtocol = ['_' => 'phoneCallProtocol', 'udp_p2p' => Bool, 'udp_reflector' => Bool, 'min_layer' => int, 'max_layer' => int, 'library_versions' => ['string', 'string']]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallProtocol={_='phoneCallProtocol', udp_p2p=Bool, udp_reflector=Bool, min_layer=int, max_layer=int, library_versions={'string'}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallRequested.md b/old_docs/API_docs_v44/constructors/phoneCallRequested.md new file mode 100644 index 00000000..cb8f40d6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallRequested.md @@ -0,0 +1,45 @@ +--- +title: phoneCallRequested +description: Requested phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallRequested +[Back to constructors index](index.md) + + + +Requested phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Whether this is a video call| +|id|[long](../types/long.md) | Yes|Phone call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|date|[int](../types/int.md) | Yes|When was the phone call created| +|admin\_id|[int](../types/int.md) | Yes|ID of the creator of the phone call| +|participant\_id|[int](../types/int.md) | Yes|ID of the other participant of the phone call| +|g\_a\_hash|[bytes](../types/bytes.md) | Yes|[Parameter for key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Call protocol info to be passed to libtgvoip| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallRequested = ['_' => 'phoneCallRequested', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_hash' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallRequested={_='phoneCallRequested', video=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_hash='bytes', protocol=PhoneCallProtocol} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneCallWaiting.md b/old_docs/API_docs_v44/constructors/phoneCallWaiting.md new file mode 100644 index 00000000..17018d14 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneCallWaiting.md @@ -0,0 +1,45 @@ +--- +title: phoneCallWaiting +description: Incoming phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallWaiting +[Back to constructors index](index.md) + + + +Incoming phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Is this a video call| +|id|[long](../types/long.md) | Yes|Call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|date|[int](../types/int.md) | Yes|Date| +|admin\_id|[int](../types/int.md) | Yes|Admin ID| +|participant\_id|[int](../types/int.md) | Yes|Participant ID| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Phone call protocol info| +|receive\_date|[int](../types/int.md) | Optional|When was the phone call received| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallWaiting = ['_' => 'phoneCallWaiting', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'protocol' => PhoneCallProtocol, 'receive_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallWaiting={_='phoneCallWaiting', video=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, protocol=PhoneCallProtocol, receive_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneConnection.md b/old_docs/API_docs_v44/constructors/phoneConnection.md new file mode 100644 index 00000000..846c5615 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneConnection.md @@ -0,0 +1,42 @@ +--- +title: phoneConnection +description: Identifies an endpoint that can be used to connect to the other user in a phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneConnection +[Back to constructors index](index.md) + + + +Identifies an endpoint that can be used to connect to the other user in a phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Endpoint ID| +|ip|[string](../types/string.md) | Yes|IP address of endpoint| +|ipv6|[string](../types/string.md) | Yes|IPv6 address of endpoint| +|port|[int](../types/int.md) | Yes|Port ID| +|peer\_tag|[bytes](../types/bytes.md) | Yes|Our peer tag| + + + +### Type: [PhoneConnection](../types/PhoneConnection.md) + + +### Example: + +```php +$phoneConnection = ['_' => 'phoneConnection', 'id' => long, 'ip' => 'string', 'ipv6' => 'string', 'port' => int, 'peer_tag' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +phoneConnection={_='phoneConnection', id=long, ip='string', ipv6='string', port=int, peer_tag='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/phoneConnectionWebrtc.md b/old_docs/API_docs_v44/constructors/phoneConnectionWebrtc.md new file mode 100644 index 00000000..70f6d1df --- /dev/null +++ b/old_docs/API_docs_v44/constructors/phoneConnectionWebrtc.md @@ -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'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/photo.md b/old_docs/API_docs_v44/constructors/photo.md index 7b30768f..5e8217e5 100644 --- a/old_docs/API_docs_v44/constructors/photo.md +++ b/old_docs/API_docs_v44/constructors/photo.md @@ -14,10 +14,14 @@ Photo | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|has\_stickers|[Bool](../types/Bool.md) | Optional|Whether the photo has mask stickers attached to it| |id|[long](../types/long.md) | Yes|ID| |access\_hash|[long](../types/long.md) | Yes|Access hash| +|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|Sizes| +|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| @@ -27,14 +31,14 @@ Photo ### Example: ```php -$photo = ['_' => 'photo', 'id' => long, 'access_hash' => long, 'date' => int, 'sizes' => [PhotoSize, PhotoSize]]; +$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', id=long, access_hash=long, date=int, sizes={PhotoSize}} +photo={_='photo', has_stickers=Bool, id=long, access_hash=long, file_reference='bytes', date=int, sizes={PhotoSize}, video_sizes={VideoSize}, dc_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/photoStrippedSize.md b/old_docs/API_docs_v44/constructors/photoStrippedSize.md new file mode 100644 index 00000000..292522d8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/photoStrippedSize.md @@ -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'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/photos.photos.md b/old_docs/API_docs_v44/constructors/photos.photos.md index 4517899a..6ba0fbf3 100644 --- a/old_docs/API_docs_v44/constructors/photos.photos.md +++ b/old_docs/API_docs_v44/constructors/photos.photos.md @@ -15,8 +15,8 @@ Full list of photos with auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|photos|Array of [Photo](../types/Photo.md) | Yes|Photos| -|users|Array of [User](../types/User.md) | Yes|Users| +|photos|Array of [Photo](../types/Photo.md) | Yes|List of photos| +|users|Array of [User](../types/User.md) | Yes|List of mentioned users| diff --git a/old_docs/API_docs_v44/constructors/photos.photosSlice.md b/old_docs/API_docs_v44/constructors/photos.photosSlice.md index 49ff4d30..00360c0f 100644 --- a/old_docs/API_docs_v44/constructors/photos.photosSlice.md +++ b/old_docs/API_docs_v44/constructors/photos.photosSlice.md @@ -16,8 +16,8 @@ Incomplete list of photos with auxiliary data. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |count|[int](../types/int.md) | Yes|Total number of photos| -|photos|Array of [Photo](../types/Photo.md) | Yes|Photos| -|users|Array of [User](../types/User.md) | Yes|Users| +|photos|Array of [Photo](../types/Photo.md) | Yes|List of photos| +|users|Array of [User](../types/User.md) | Yes|List of mentioned users| diff --git a/old_docs/API_docs_v44/constructors/poll.md b/old_docs/API_docs_v44/constructors/poll.md new file mode 100644 index 00000000..21b6804a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/poll.md @@ -0,0 +1,46 @@ +--- +title: poll +description: Poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: poll +[Back to constructors index](index.md) + + + +Poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID of the poll| +|closed|[Bool](../types/Bool.md) | Optional|Whether the poll is closed and doesn't accept any more answers| +|public\_voters|[Bool](../types/Bool.md) | Optional|Whether cast votes are publicly visible to all users (non-anonymous poll)| +|multiple\_choice|[Bool](../types/Bool.md) | Optional|Whether multiple options can be chosen as answer| +|quiz|[Bool](../types/Bool.md) | Optional|Whether this is a quiz (with wrong and correct answers, results shown in the return type)| +|question|[string](../types/string.md) | Yes|The question of the poll| +|answers|Array of [PollAnswer](../types/PollAnswer.md) | Yes|The possible answers, vote using [messages.sendVote](../methods/messages.sendVote.md).| +|close\_period|[int](../types/int.md) | Optional|Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close\_date.| +|close\_date|[int](../types/int.md) | Optional|Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future; can't be used together with open\_period.| + + + +### Type: [Poll](../types/Poll.md) + + +### Example: + +```php +$poll = ['_' => 'poll', 'id' => long, 'closed' => Bool, 'public_voters' => Bool, 'multiple_choice' => Bool, 'quiz' => Bool, 'question' => 'string', 'answers' => [PollAnswer, PollAnswer], 'close_period' => int, 'close_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +poll={_='poll', id=long, closed=Bool, public_voters=Bool, multiple_choice=Bool, quiz=Bool, question='string', answers={PollAnswer}, close_period=int, close_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pollAnswer.md b/old_docs/API_docs_v44/constructors/pollAnswer.md new file mode 100644 index 00000000..405ba73a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pollAnswer.md @@ -0,0 +1,39 @@ +--- +title: pollAnswer +description: A possible answer of a poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollAnswer +[Back to constructors index](index.md) + + + +A possible answer of a poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Textual representation of the answer| +|option|[bytes](../types/bytes.md) | Yes|The param that has to be passed to [messages.sendVote](../methods/messages.sendVote.md).| + + + +### Type: [PollAnswer](../types/PollAnswer.md) + + +### Example: + +```php +$pollAnswer = ['_' => 'pollAnswer', 'text' => 'string', 'option' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +pollAnswer={_='pollAnswer', text='string', option='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pollAnswerVoters.md b/old_docs/API_docs_v44/constructors/pollAnswerVoters.md new file mode 100644 index 00000000..0d85eb82 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pollAnswerVoters.md @@ -0,0 +1,41 @@ +--- +title: pollAnswerVoters +description: A poll answer, and how users voted on it +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollAnswerVoters +[Back to constructors index](index.md) + + + +A poll answer, and how users voted on it + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chosen|[Bool](../types/Bool.md) | Optional|Whether we have chosen this answer| +|correct|[Bool](../types/Bool.md) | Optional|For quizes, whether the option we have chosen is correct| +|option|[bytes](../types/bytes.md) | Yes|The param that has to be passed to [messages.sendVote](../methods/messages.sendVote.md).| +|voters|[int](../types/int.md) | Yes|How many users voted for this option| + + + +### Type: [PollAnswerVoters](../types/PollAnswerVoters.md) + + +### Example: + +```php +$pollAnswerVoters = ['_' => 'pollAnswerVoters', 'chosen' => Bool, 'correct' => Bool, 'option' => 'bytes', 'voters' => int]; +``` + + +Or, if you're into Lua: + +```lua +pollAnswerVoters={_='pollAnswerVoters', chosen=Bool, correct=Bool, option='bytes', voters=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/pollResults.md b/old_docs/API_docs_v44/constructors/pollResults.md new file mode 100644 index 00000000..1bb84041 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/pollResults.md @@ -0,0 +1,43 @@ +--- +title: pollResults +description: Results of poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollResults +[Back to constructors index](index.md) + + + +Results of poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|min|[Bool](../types/Bool.md) | Optional|Similar to [min](https://core.telegram.org/api/min) objects, used for poll constructors that are the same for all users so they don't have option chosen by the current user (you can use [messages.getPollResults](../methods/messages.getPollResults.md) to get the full poll results).| +|results|Array of [PollAnswerVoters](../types/PollAnswerVoters.md) | Optional|Poll results| +|total\_voters|[int](../types/int.md) | Optional|Total number of people that voted in the poll| +|recent\_voters|Array of [int](../types/int.md) | Optional|IDs of the last users that recently voted in the poll| +|solution|[string](../types/string.md) | Optional|Explanation of quiz solution| +|solution\_entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text in quiz solution](https://core.telegram.org/api/entities)| + + + +### Type: [PollResults](../types/PollResults.md) + + +### Example: + +```php +$pollResults = ['_' => 'pollResults', 'min' => Bool, 'results' => [PollAnswerVoters, PollAnswerVoters], 'total_voters' => int, 'recent_voters' => [int, int], 'solution' => 'string', 'solution_entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +pollResults={_='pollResults', min=Bool, results={PollAnswerVoters}, total_voters=int, recent_voters={int}, solution='string', solution_entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/popularContact.md b/old_docs/API_docs_v44/constructors/popularContact.md new file mode 100644 index 00000000..c0ce7513 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/popularContact.md @@ -0,0 +1,39 @@ +--- +title: popularContact +description: Popular contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: popularContact +[Back to constructors index](index.md) + + + +Popular contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|client\_id|[long](../types/long.md) | Yes|Contact identifier| +|importers|[int](../types/int.md) | Yes|How many people imported this contact| + + + +### Type: [PopularContact](../types/PopularContact.md) + + +### Example: + +```php +$popularContact = ['_' => 'popularContact', 'client_id' => long, 'importers' => int]; +``` + + +Or, if you're into Lua: + +```lua +popularContact={_='popularContact', client_id=long, importers=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/postAddress.md b/old_docs/API_docs_v44/constructors/postAddress.md new file mode 100644 index 00000000..8083f1da --- /dev/null +++ b/old_docs/API_docs_v44/constructors/postAddress.md @@ -0,0 +1,43 @@ +--- +title: postAddress +description: Shipping address +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: postAddress +[Back to constructors index](index.md) + + + +Shipping address + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|street\_line1|[string](../types/string.md) | Yes|First line for the address| +|street\_line2|[string](../types/string.md) | Yes|Second line for the address| +|city|[string](../types/string.md) | Yes|City| +|state|[string](../types/string.md) | Yes|State, if applicable (empty otherwise)| +|country\_iso2|[string](../types/string.md) | Yes|ISO 3166-1 alpha-2 country code| +|post\_code|[string](../types/string.md) | Yes|Address post code| + + + +### Type: [PostAddress](../types/PostAddress.md) + + +### Example: + +```php +$postAddress = ['_' => 'postAddress', 'street_line1' => 'string', 'street_line2' => 'string', 'city' => 'string', 'state' => 'string', 'country_iso2' => 'string', 'post_code' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +postAddress={_='postAddress', street_line1='string', street_line2='string', city='string', state='string', country_iso2='string', post_code='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyAddedByPhone.md b/old_docs/API_docs_v44/constructors/privacyKeyAddedByPhone.md new file mode 100644 index 00000000..72a2e3bd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyAddedByPhone.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyAddedByPhone +description: Whether people can add you to their contact list by your phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyAddedByPhone +[Back to constructors index](index.md) + + + +Whether people can add you to their contact list by your phone number + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyAddedByPhone = ['_' => 'privacyKeyAddedByPhone']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyAddedByPhone={_='privacyKeyAddedByPhone'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyChatInvite.md b/old_docs/API_docs_v44/constructors/privacyKeyChatInvite.md new file mode 100644 index 00000000..5acbff55 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyChatInvite.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyChatInvite +description: Whether the user can be invited to chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyChatInvite +[Back to constructors index](index.md) + + + +Whether the user can be invited to chats + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyChatInvite = ['_' => 'privacyKeyChatInvite']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyChatInvite={_='privacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyForwards.md b/old_docs/API_docs_v44/constructors/privacyKeyForwards.md new file mode 100644 index 00000000..934eaf40 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyForwards.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyForwards +description: Whether messages forwarded from the user will be [anonymously forwarded](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyForwards +[Back to constructors index](index.md) + + + +Whether messages forwarded from the user will be [anonymously forwarded](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyForwards = ['_' => 'privacyKeyForwards']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyForwards={_='privacyKeyForwards'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyPhoneCall.md b/old_docs/API_docs_v44/constructors/privacyKeyPhoneCall.md new file mode 100644 index 00000000..e8fecc92 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyPhoneCall.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneCall +description: Whether the user accepts phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneCall +[Back to constructors index](index.md) + + + +Whether the user accepts phone calls + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneCall = ['_' => 'privacyKeyPhoneCall']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneCall={_='privacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyPhoneNumber.md b/old_docs/API_docs_v44/constructors/privacyKeyPhoneNumber.md new file mode 100644 index 00000000..14338118 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyPhoneNumber.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneNumber +description: Whether the user allows us to see his phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneNumber +[Back to constructors index](index.md) + + + +Whether the user allows us to see his phone number + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneNumber = ['_' => 'privacyKeyPhoneNumber']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneNumber={_='privacyKeyPhoneNumber'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyPhoneP2P.md b/old_docs/API_docs_v44/constructors/privacyKeyPhoneP2P.md new file mode 100644 index 00000000..6b23dabb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyPhoneP2P.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneP2P +description: Whether P2P connections in phone calls are allowed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneP2P +[Back to constructors index](index.md) + + + +Whether P2P connections in phone calls are allowed + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneP2P = ['_' => 'privacyKeyPhoneP2P']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneP2P={_='privacyKeyPhoneP2P'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyKeyProfilePhoto.md b/old_docs/API_docs_v44/constructors/privacyKeyProfilePhoto.md new file mode 100644 index 00000000..7d9845be --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyKeyProfilePhoto.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyProfilePhoto +description: Whether the profile picture of the user is visible +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyProfilePhoto +[Back to constructors index](index.md) + + + +Whether the profile picture of the user is visible + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyProfilePhoto = ['_' => 'privacyKeyProfilePhoto']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyProfilePhoto={_='privacyKeyProfilePhoto'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyValueAllowChatParticipants.md b/old_docs/API_docs_v44/constructors/privacyValueAllowChatParticipants.md new file mode 100644 index 00000000..d3329f3e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyValueAllowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: privacyValueAllowChatParticipants +description: Allow all participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowChatParticipants +[Back to constructors index](index.md) + + + +Allow all participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Allowed chats| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueAllowChatParticipants = ['_' => 'privacyValueAllowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueAllowChatParticipants={_='privacyValueAllowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyValueAllowUsers.md b/old_docs/API_docs_v44/constructors/privacyValueAllowUsers.md index 937f8e4b..1e448a39 100644 --- a/old_docs/API_docs_v44/constructors/privacyValueAllowUsers.md +++ b/old_docs/API_docs_v44/constructors/privacyValueAllowUsers.md @@ -14,7 +14,7 @@ Allow only certain users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|users|Array of [int](../types/int.md) | Yes|Users| +|users|Array of [int](../types/int.md) | Yes|Allowed users| diff --git a/old_docs/API_docs_v44/constructors/privacyValueDisallowChatParticipants.md b/old_docs/API_docs_v44/constructors/privacyValueDisallowChatParticipants.md new file mode 100644 index 00000000..a4c604d0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/privacyValueDisallowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: privacyValueDisallowChatParticipants +description: Disallow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowChatParticipants +[Back to constructors index](index.md) + + + +Disallow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Disallowed chats| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueDisallowChatParticipants = ['_' => 'privacyValueDisallowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueDisallowChatParticipants={_='privacyValueDisallowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/privacyValueDisallowUsers.md b/old_docs/API_docs_v44/constructors/privacyValueDisallowUsers.md index 58aeff12..699bdca3 100644 --- a/old_docs/API_docs_v44/constructors/privacyValueDisallowUsers.md +++ b/old_docs/API_docs_v44/constructors/privacyValueDisallowUsers.md @@ -14,7 +14,7 @@ Disallow only certain users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|users|Array of [int](../types/int.md) | Yes|Users| +|users|Array of [int](../types/int.md) | Yes|Disallowed users| diff --git a/old_docs/API_docs_v44/constructors/recentMeUrlChat.md b/old_docs/API_docs_v44/constructors/recentMeUrlChat.md new file mode 100644 index 00000000..4dada02f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/recentMeUrlChat.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlChat +description: Recent t.me link to a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChat +[Back to constructors index](index.md) + + + +Recent t.me link to a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|t.me URL| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlChat = ['_' => 'recentMeUrlChat', 'url' => 'string', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlChat={_='recentMeUrlChat', url='string', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/recentMeUrlChatInvite.md b/old_docs/API_docs_v44/constructors/recentMeUrlChatInvite.md new file mode 100644 index 00000000..aa3629e7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/recentMeUrlChatInvite.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlChatInvite +description: Recent t.me invite link to a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChatInvite +[Back to constructors index](index.md) + + + +Recent t.me invite link to a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|t.me URL| +|chat\_invite|[ChatInvite](../types/ChatInvite.md) | Optional|Chat invitation| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlChatInvite = ['_' => 'recentMeUrlChatInvite', 'url' => 'string', 'chat_invite' => ChatInvite]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlChatInvite={_='recentMeUrlChatInvite', url='string', chat_invite=ChatInvite} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/recentMeUrlStickerSet.md b/old_docs/API_docs_v44/constructors/recentMeUrlStickerSet.md new file mode 100644 index 00000000..5036650a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/recentMeUrlStickerSet.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlStickerSet +description: Recent t.me stickerset installation URL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlStickerSet +[Back to constructors index](index.md) + + + +Recent t.me stickerset installation URL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|t.me URL| +|set|[StickerSetCovered](../types/StickerSetCovered.md) | Yes|Stickerset| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlStickerSet = ['_' => 'recentMeUrlStickerSet', 'url' => 'string', 'set' => StickerSetCovered]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlStickerSet={_='recentMeUrlStickerSet', url='string', set=StickerSetCovered} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/recentMeUrlUnknown.md b/old_docs/API_docs_v44/constructors/recentMeUrlUnknown.md new file mode 100644 index 00000000..d14e7671 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/recentMeUrlUnknown.md @@ -0,0 +1,38 @@ +--- +title: recentMeUrlUnknown +description: Unknown t.me url +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUnknown +[Back to constructors index](index.md) + + + +Unknown t.me url + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlUnknown = ['_' => 'recentMeUrlUnknown', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlUnknown={_='recentMeUrlUnknown', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/recentMeUrlUser.md b/old_docs/API_docs_v44/constructors/recentMeUrlUser.md new file mode 100644 index 00000000..ff80c818 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/recentMeUrlUser.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlUser +description: Recent t.me link to a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUser +[Back to constructors index](index.md) + + + +Recent t.me link to a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| +|user\_id|[int](../types/int.md) | Yes|User ID| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlUser = ['_' => 'recentMeUrlUser', 'url' => 'string', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlUser={_='recentMeUrlUser', url='string', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/replyInlineMarkup.md b/old_docs/API_docs_v44/constructors/replyInlineMarkup.md new file mode 100644 index 00000000..6c7dce65 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/replyInlineMarkup.md @@ -0,0 +1,38 @@ +--- +title: replyInlineMarkup +description: Bot or inline keyboard +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyInlineMarkup +[Back to constructors index](index.md) + + + +Bot or inline keyboard + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes|Bot or inline keyboard rows| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +```php +$replyInlineMarkup = ['_' => 'replyInlineMarkup', 'rows' => [KeyboardButtonRow, KeyboardButtonRow]]; +``` + + +Or, if you're into Lua: + +```lua +replyInlineMarkup={_='replyInlineMarkup', rows={KeyboardButtonRow}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/replyKeyboardMarkup.md b/old_docs/API_docs_v44/constructors/replyKeyboardMarkup.md index f95ea6c4..bf36451e 100644 --- a/old_docs/API_docs_v44/constructors/replyKeyboardMarkup.md +++ b/old_docs/API_docs_v44/constructors/replyKeyboardMarkup.md @@ -17,7 +17,7 @@ Bot keyboard |resize|[Bool](../types/Bool.md) | Optional|Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). If not set, the custom keyboard is always of the same height as the app's standard keyboard.| |single\_use|[Bool](../types/Bool.md) | Optional|Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again.| |selective|[Bool](../types/Bool.md) | Optional|Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply\_to\_message\_id), sender of the original message.
Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.| -|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes|Rows| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes|Button row| diff --git a/old_docs/API_docs_v44/constructors/restrictionReason.md b/old_docs/API_docs_v44/constructors/restrictionReason.md new file mode 100644 index 00000000..918027a4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/restrictionReason.md @@ -0,0 +1,44 @@ +--- +title: restrictionReason +description: Restriction reason. + +Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the `platform` field is equal to `all` or to the current platform (`ios`, `android`, `wp`, etc.). Platforms can be concatenated (`ios-android`, `ios-wp`), unknown platforms are to be ignored. The `text` is the error message that should be shown to the user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: restrictionReason +[Back to constructors index](index.md) + + + +Restriction reason. + +Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the `platform` field is equal to `all` or to the current platform (`ios`, `android`, `wp`, etc.). Platforms can be concatenated (`ios-android`, `ios-wp`), unknown platforms are to be ignored. The `text` is the error message that should be shown to the user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|platform|[string](../types/string.md) | Yes|Platform identifier (ios, android, wp, all, etc.), can be concatenated with a dash as separator (`android-ios`, `ios-wp`, etc)| +|reason|[string](../types/string.md) | Yes|Restriction reason (`porno`, `terms`, etc.)| +|text|[string](../types/string.md) | Yes|Error message to be shown to the user| + + + +### Type: [RestrictionReason](../types/RestrictionReason.md) + + +### Example: + +```php +$restrictionReason = ['_' => 'restrictionReason', 'platform' => 'string', 'reason' => 'string', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +restrictionReason={_='restrictionReason', platform='string', reason='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/savedPhoneContact.md b/old_docs/API_docs_v44/constructors/savedPhoneContact.md new file mode 100644 index 00000000..64983bb3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/savedPhoneContact.md @@ -0,0 +1,41 @@ +--- +title: savedPhoneContact +description: Saved contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: savedPhoneContact +[Back to constructors index](index.md) + + + +Saved contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|date|[int](../types/int.md) | Yes|Date added| + + + +### Type: [SavedContact](../types/SavedContact.md) + + +### Example: + +```php +$savedPhoneContact = ['_' => 'savedPhoneContact', 'phone' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +savedPhoneContact={_='savedPhoneContact', phone='string', first_name='string', last_name='string', date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureCredentialsEncrypted.md b/old_docs/API_docs_v44/constructors/secureCredentialsEncrypted.md new file mode 100644 index 00000000..c693ef97 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureCredentialsEncrypted.md @@ -0,0 +1,40 @@ +--- +title: secureCredentialsEncrypted +description: Encrypted credentials required to decrypt [telegram passport](https://core.telegram.org/passport) data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureCredentialsEncrypted +[Back to constructors index](index.md) + + + +Encrypted credentials required to decrypt [telegram passport](https://core.telegram.org/passport) data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[bytes](../types/bytes.md) | Yes|Encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication, as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| +|hash|[bytes](../types/bytes.md) | Yes|Data hash for data authentication as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| +|secret|[bytes](../types/bytes.md) | Yes|Secret, encrypted with the bot's public RSA key, required for data decryption as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| + + + +### Type: [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) + + +### Example: + +```php +$secureCredentialsEncrypted = ['_' => 'secureCredentialsEncrypted', 'data' => 'bytes', 'hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureCredentialsEncrypted={_='secureCredentialsEncrypted', data='bytes', hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureData.md b/old_docs/API_docs_v44/constructors/secureData.md new file mode 100644 index 00000000..b3d896e3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureData.md @@ -0,0 +1,40 @@ +--- +title: secureData +description: Secure [passport](https://core.telegram.org/passport) data, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#securedata) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureData +[Back to constructors index](index.md) + + + +Secure [passport](https://core.telegram.org/passport) data, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#securedata) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[bytes](../types/bytes.md) | Yes|Data| +|data\_hash|[bytes](../types/bytes.md) | Yes|Data hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [SecureData](../types/SecureData.md) + + +### Example: + +```php +$secureData = ['_' => 'secureData', 'data' => 'bytes', 'data_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureData={_='secureData', data='bytes', data_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureFile.md b/old_docs/API_docs_v44/constructors/secureFile.md new file mode 100644 index 00000000..13b462d7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureFile.md @@ -0,0 +1,44 @@ +--- +title: secureFile +description: Secure [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFile +[Back to constructors index](index.md) + + + +Secure [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|size|[int](../types/int.md) | Yes|File size| +|dc\_id|[int](../types/int.md) | Yes|DC ID| +|date|[int](../types/int.md) | Yes|Date of upload| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +```php +$secureFile = ['_' => 'secureFile', 'id' => long, 'access_hash' => long, 'size' => int, 'dc_id' => int, 'date' => int, 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureFile={_='secureFile', id=long, access_hash=long, size=int, dc_id=int, date=int, file_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureFileEmpty.md b/old_docs/API_docs_v44/constructors/secureFileEmpty.md new file mode 100644 index 00000000..be9dbffe --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureFileEmpty.md @@ -0,0 +1,33 @@ +--- +title: secureFileEmpty +description: Empty constructor +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFileEmpty +[Back to constructors index](index.md) + + + +Empty constructor + + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +```php +$secureFileEmpty = ['_' => 'secureFileEmpty']; +``` + + +Or, if you're into Lua: + +```lua +secureFileEmpty={_='secureFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md new file mode 100644 index 00000000..636dd230 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md @@ -0,0 +1,38 @@ +--- +title: securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 +description: PBKDF2 with SHA512 and 100000 iterations KDF algo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 +[Back to constructors index](index.md) + + + +PBKDF2 with SHA512 and 100000 iterations KDF algo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|salt|[bytes](../types/bytes.md) | Yes|Salt| + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 = ['_' => 'securePasswordKdfAlgoPBKDF2HMACSHA512iter100000', 'salt' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoPBKDF2HMACSHA512iter100000={_='securePasswordKdfAlgoPBKDF2HMACSHA512iter100000', salt='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoSHA512.md b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoSHA512.md new file mode 100644 index 00000000..ec40a7d8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoSHA512.md @@ -0,0 +1,38 @@ +--- +title: securePasswordKdfAlgoSHA512 +description: SHA512 KDF algo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoSHA512 +[Back to constructors index](index.md) + + + +SHA512 KDF algo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|salt|[bytes](../types/bytes.md) | Yes|Salt| + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoSHA512 = ['_' => 'securePasswordKdfAlgoSHA512', 'salt' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoSHA512={_='securePasswordKdfAlgoSHA512', salt='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoUnknown.md b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoUnknown.md new file mode 100644 index 00000000..ef53df6a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/securePasswordKdfAlgoUnknown.md @@ -0,0 +1,33 @@ +--- +title: securePasswordKdfAlgoUnknown +description: Unknown KDF algo (most likely the client has to be updated) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoUnknown +[Back to constructors index](index.md) + + + +Unknown KDF algo (most likely the client has to be updated) + + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoUnknown = ['_' => 'securePasswordKdfAlgoUnknown']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoUnknown={_='securePasswordKdfAlgoUnknown'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/securePlainEmail.md b/old_docs/API_docs_v44/constructors/securePlainEmail.md new file mode 100644 index 00000000..626e8985 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/securePlainEmail.md @@ -0,0 +1,38 @@ +--- +title: securePlainEmail +description: Email address to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainEmail +[Back to constructors index](index.md) + + + +Email address to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email|[string](../types/string.md) | Yes|Email address| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +```php +$securePlainEmail = ['_' => 'securePlainEmail', 'email' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +securePlainEmail={_='securePlainEmail', email='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/securePlainPhone.md b/old_docs/API_docs_v44/constructors/securePlainPhone.md new file mode 100644 index 00000000..7b83ef38 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/securePlainPhone.md @@ -0,0 +1,38 @@ +--- +title: securePlainPhone +description: Phone number to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainPhone +[Back to constructors index](index.md) + + + +Phone number to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone|[string](../types/string.md) | Yes|Phone number| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +```php +$securePlainPhone = ['_' => 'securePlainPhone', 'phone' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +securePlainPhone={_='securePlainPhone', phone='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureRequiredType.md b/old_docs/API_docs_v44/constructors/secureRequiredType.md new file mode 100644 index 00000000..46c8a374 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureRequiredType.md @@ -0,0 +1,41 @@ +--- +title: secureRequiredType +description: Required type +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureRequiredType +[Back to constructors index](index.md) + + + +Required type + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|native\_names|[Bool](../types/Bool.md) | Optional|Native names| +|selfie\_required|[Bool](../types/Bool.md) | Optional|Is a selfie required| +|translation\_required|[Bool](../types/Bool.md) | Optional|Is a translation required| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure value type| + + + +### Type: [SecureRequiredType](../types/SecureRequiredType.md) + + +### Example: + +```php +$secureRequiredType = ['_' => 'secureRequiredType', 'native_names' => Bool, 'selfie_required' => Bool, 'translation_required' => Bool, 'type' => SecureValueType]; +``` + + +Or, if you're into Lua: + +```lua +secureRequiredType={_='secureRequiredType', native_names=Bool, selfie_required=Bool, translation_required=Bool, type=SecureValueType} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureRequiredTypeOneOf.md b/old_docs/API_docs_v44/constructors/secureRequiredTypeOneOf.md new file mode 100644 index 00000000..41fb4443 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureRequiredTypeOneOf.md @@ -0,0 +1,38 @@ +--- +title: secureRequiredTypeOneOf +description: One of +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureRequiredTypeOneOf +[Back to constructors index](index.md) + + + +One of + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Secure required value types| + + + +### Type: [SecureRequiredType](../types/SecureRequiredType.md) + + +### Example: + +```php +$secureRequiredTypeOneOf = ['_' => 'secureRequiredTypeOneOf', 'types' => [SecureRequiredType, SecureRequiredType]]; +``` + + +Or, if you're into Lua: + +```lua +secureRequiredTypeOneOf={_='secureRequiredTypeOneOf', types={SecureRequiredType}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureSecretSettings.md b/old_docs/API_docs_v44/constructors/secureSecretSettings.md new file mode 100644 index 00000000..400dae89 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureSecretSettings.md @@ -0,0 +1,40 @@ +--- +title: secureSecretSettings +description: Secure settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureSecretSettings +[Back to constructors index](index.md) + + + +Secure settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|Secure KDF algo| +|secure\_secret|[bytes](../types/bytes.md) | Yes|Secure secret| +|secure\_secret\_id|[long](../types/long.md) | Yes|Secret ID| + + + +### Type: [SecureSecretSettings](../types/SecureSecretSettings.md) + + +### Example: + +```php +$secureSecretSettings = ['_' => 'secureSecretSettings', 'secure_algo' => SecurePasswordKdfAlgo, 'secure_secret' => 'bytes', 'secure_secret_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +secureSecretSettings={_='secureSecretSettings', secure_algo=SecurePasswordKdfAlgo, secure_secret='bytes', secure_secret_id=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValue.md b/old_docs/API_docs_v44/constructors/secureValue.md new file mode 100644 index 00000000..3d46ba32 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValue.md @@ -0,0 +1,46 @@ +--- +title: secureValue +description: Secure value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValue +[Back to constructors index](index.md) + + + +Secure value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure [passport](https://core.telegram.org/passport) value type| +|data|[SecureData](../types/SecureData.md) | Optional|Encrypted [Telegram Passport](https://core.telegram.org/passport) element data| +|front\_side|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the front side of the document| +|reverse\_side|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the reverse side of the document| +|selfie|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with a selfie of the user holding the document| +|translation|Array of [SecureFile](../types/SecureFile.md) | Optional|Array of encrypted [passport](https://core.telegram.org/passport) files with translated versions of the provided documents| +|files|Array of [SecureFile](../types/SecureFile.md) | Optional|Array of encrypted [passport](https://core.telegram.org/passport) files with photos the of the documents| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional|Plaintext verified [passport](https://core.telegram.org/passport) data| +|hash|[bytes](../types/bytes.md) | Yes|Data hash| + + + +### Type: [SecureValue](../types/SecureValue.md) + + +### Example: + +```php +$secureValue = ['_' => 'secureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => SecureFile, 'reverse_side' => SecureFile, 'selfie' => SecureFile, 'translation' => [SecureFile, SecureFile], 'files' => [SecureFile, SecureFile], 'plain_data' => SecurePlainData, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureValue={_='secureValue', type=SecureValueType, data=SecureData, front_side=SecureFile, reverse_side=SecureFile, selfie=SecureFile, translation={SecureFile}, files={SecureFile}, plain_data=SecurePlainData, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueError.md b/old_docs/API_docs_v44/constructors/secureValueError.md new file mode 100644 index 00000000..62f5f96a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueError.md @@ -0,0 +1,40 @@ +--- +title: secureValueError +description: Secure value error +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueError +[Back to constructors index](index.md) + + + +Secure value error + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Type of element which has the issue| +|hash|[bytes](../types/bytes.md) | Yes|Hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueError = ['_' => 'secureValueError', 'type' => SecureValueType, 'hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueError={_='secureValueError', type=SecureValueType, hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorData.md b/old_docs/API_docs_v44/constructors/secureValueErrorData.md new file mode 100644 index 00000000..e1f1f6ed --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorData.md @@ -0,0 +1,41 @@ +--- +title: secureValueErrorData +description: Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorData +[Back to constructors index](index.md) + + + +Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|The section of the user's Telegram Passport which has the error, one of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeAddress](../constructors/secureValueTypeAddress.md)| +|data\_hash|[bytes](../types/bytes.md) | Yes|Data hash| +|field|[string](../types/string.md) | Yes|Name of the data field which has the error| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorData = ['_' => 'secureValueErrorData', 'type' => SecureValueType, 'data_hash' => 'bytes', 'field' => 'string', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorData={_='secureValueErrorData', type=SecureValueType, data_hash='bytes', field='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorFile.md b/old_docs/API_docs_v44/constructors/secureValueErrorFile.md new file mode 100644 index 00000000..fd0b14dd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorFile.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFile +description: Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFile +[Back to constructors index](index.md) + + + +Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFile = ['_' => 'secureValueErrorFile', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFile={_='secureValueErrorFile', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorFiles.md b/old_docs/API_docs_v44/constructors/secureValueErrorFiles.md new file mode 100644 index 00000000..f74ae027 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorFiles.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFiles +description: Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFiles +[Back to constructors index](index.md) + + + +Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|Array of [bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFiles = ['_' => 'secureValueErrorFiles', 'type' => SecureValueType, 'file_hash' => ['bytes', 'bytes'], 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFiles={_='secureValueErrorFiles', type=SecureValueType, file_hash={'bytes'}, text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorFrontSide.md b/old_docs/API_docs_v44/constructors/secureValueErrorFrontSide.md new file mode 100644 index 00000000..9e6d63d9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorFrontSide.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFrontSide +description: Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFrontSide +[Back to constructors index](index.md) + + + +Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFrontSide = ['_' => 'secureValueErrorFrontSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFrontSide={_='secureValueErrorFrontSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorReverseSide.md b/old_docs/API_docs_v44/constructors/secureValueErrorReverseSide.md new file mode 100644 index 00000000..ca7acdad --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorReverseSide.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorReverseSide +description: Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorReverseSide +[Back to constructors index](index.md) + + + +Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorReverseSide = ['_' => 'secureValueErrorReverseSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorReverseSide={_='secureValueErrorReverseSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorSelfie.md b/old_docs/API_docs_v44/constructors/secureValueErrorSelfie.md new file mode 100644 index 00000000..7c69b69e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorSelfie.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorSelfie +description: Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorSelfie +[Back to constructors index](index.md) + + + +Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorSelfie = ['_' => 'secureValueErrorSelfie', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorSelfie={_='secureValueErrorSelfie', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFile.md b/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFile.md new file mode 100644 index 00000000..898ebd90 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFile.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorTranslationFile +description: Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorTranslationFile +[Back to constructors index](index.md) + + + +Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorTranslationFile = ['_' => 'secureValueErrorTranslationFile', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorTranslationFile={_='secureValueErrorTranslationFile', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFiles.md b/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFiles.md new file mode 100644 index 00000000..24de0275 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueErrorTranslationFiles.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorTranslationFiles +description: Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorTranslationFiles +[Back to constructors index](index.md) + + + +Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|Array of [bytes](../types/bytes.md) | Yes|Hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorTranslationFiles = ['_' => 'secureValueErrorTranslationFiles', 'type' => SecureValueType, 'file_hash' => ['bytes', 'bytes'], 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorTranslationFiles={_='secureValueErrorTranslationFiles', type=SecureValueType, file_hash={'bytes'}, text='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueHash.md b/old_docs/API_docs_v44/constructors/secureValueHash.md new file mode 100644 index 00000000..5035b7d0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueHash.md @@ -0,0 +1,39 @@ +--- +title: secureValueHash +description: Secure value hash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueHash +[Back to constructors index](index.md) + + + +Secure value hash + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure value type| +|hash|[bytes](../types/bytes.md) | Yes|Hash| + + + +### Type: [SecureValueHash](../types/SecureValueHash.md) + + +### Example: + +```php +$secureValueHash = ['_' => 'secureValueHash', 'type' => SecureValueType, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureValueHash={_='secureValueHash', type=SecureValueType, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeAddress.md b/old_docs/API_docs_v44/constructors/secureValueTypeAddress.md new file mode 100644 index 00000000..cb1aea2a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeAddress.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeAddress +description: Address +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeAddress +[Back to constructors index](index.md) + + + +Address + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeAddress = ['_' => 'secureValueTypeAddress']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeAddress={_='secureValueTypeAddress'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeBankStatement.md b/old_docs/API_docs_v44/constructors/secureValueTypeBankStatement.md new file mode 100644 index 00000000..acdeca36 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeBankStatement.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeBankStatement +description: Bank statement +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeBankStatement +[Back to constructors index](index.md) + + + +Bank statement + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeBankStatement = ['_' => 'secureValueTypeBankStatement']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeBankStatement={_='secureValueTypeBankStatement'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeDriverLicense.md b/old_docs/API_docs_v44/constructors/secureValueTypeDriverLicense.md new file mode 100644 index 00000000..931a4787 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeDriverLicense.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeDriverLicense +description: Driver's license +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeDriverLicense +[Back to constructors index](index.md) + + + +Driver's license + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeDriverLicense = ['_' => 'secureValueTypeDriverLicense']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeDriverLicense={_='secureValueTypeDriverLicense'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeEmail.md b/old_docs/API_docs_v44/constructors/secureValueTypeEmail.md new file mode 100644 index 00000000..6ff8f3d9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeEmail.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeEmail +description: Email +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeEmail +[Back to constructors index](index.md) + + + +Email + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeEmail = ['_' => 'secureValueTypeEmail']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeEmail={_='secureValueTypeEmail'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeIdentityCard.md b/old_docs/API_docs_v44/constructors/secureValueTypeIdentityCard.md new file mode 100644 index 00000000..5ec80560 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeIdentityCard.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeIdentityCard +description: Identity card +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeIdentityCard +[Back to constructors index](index.md) + + + +Identity card + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeIdentityCard = ['_' => 'secureValueTypeIdentityCard']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeIdentityCard={_='secureValueTypeIdentityCard'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeInternalPassport.md b/old_docs/API_docs_v44/constructors/secureValueTypeInternalPassport.md new file mode 100644 index 00000000..0cd5b18f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeInternalPassport.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeInternalPassport +description: Internal [passport](https://core.telegram.org/passport) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeInternalPassport +[Back to constructors index](index.md) + + + +Internal [passport](https://core.telegram.org/passport) + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeInternalPassport = ['_' => 'secureValueTypeInternalPassport']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeInternalPassport={_='secureValueTypeInternalPassport'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypePassport.md b/old_docs/API_docs_v44/constructors/secureValueTypePassport.md new file mode 100644 index 00000000..cb62c8bb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypePassport.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePassport +description: Passport +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassport +[Back to constructors index](index.md) + + + +Passport + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePassport = ['_' => 'secureValueTypePassport']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePassport={_='secureValueTypePassport'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypePassportRegistration.md b/old_docs/API_docs_v44/constructors/secureValueTypePassportRegistration.md new file mode 100644 index 00000000..dd1dec1f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypePassportRegistration.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePassportRegistration +description: Internal registration [passport](https://core.telegram.org/passport) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassportRegistration +[Back to constructors index](index.md) + + + +Internal registration [passport](https://core.telegram.org/passport) + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePassportRegistration = ['_' => 'secureValueTypePassportRegistration']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePassportRegistration={_='secureValueTypePassportRegistration'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypePersonalDetails.md b/old_docs/API_docs_v44/constructors/secureValueTypePersonalDetails.md new file mode 100644 index 00000000..ec3af9ab --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypePersonalDetails.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePersonalDetails +description: Personal details +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePersonalDetails +[Back to constructors index](index.md) + + + +Personal details + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePersonalDetails = ['_' => 'secureValueTypePersonalDetails']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePersonalDetails={_='secureValueTypePersonalDetails'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypePhone.md b/old_docs/API_docs_v44/constructors/secureValueTypePhone.md new file mode 100644 index 00000000..63a5e60c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypePhone.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePhone +description: Phone +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePhone +[Back to constructors index](index.md) + + + +Phone + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePhone = ['_' => 'secureValueTypePhone']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePhone={_='secureValueTypePhone'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeRentalAgreement.md b/old_docs/API_docs_v44/constructors/secureValueTypeRentalAgreement.md new file mode 100644 index 00000000..5c789815 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeRentalAgreement.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeRentalAgreement +description: Rental agreement +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeRentalAgreement +[Back to constructors index](index.md) + + + +Rental agreement + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeRentalAgreement = ['_' => 'secureValueTypeRentalAgreement']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeRentalAgreement={_='secureValueTypeRentalAgreement'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeTemporaryRegistration.md b/old_docs/API_docs_v44/constructors/secureValueTypeTemporaryRegistration.md new file mode 100644 index 00000000..fd6c6d1a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeTemporaryRegistration.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeTemporaryRegistration +description: Temporary registration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeTemporaryRegistration +[Back to constructors index](index.md) + + + +Temporary registration + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeTemporaryRegistration = ['_' => 'secureValueTypeTemporaryRegistration']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeTemporaryRegistration={_='secureValueTypeTemporaryRegistration'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/secureValueTypeUtilityBill.md b/old_docs/API_docs_v44/constructors/secureValueTypeUtilityBill.md new file mode 100644 index 00000000..8ea49b4e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/secureValueTypeUtilityBill.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeUtilityBill +description: Utility bill +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeUtilityBill +[Back to constructors index](index.md) + + + +Utility bill + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeUtilityBill = ['_' => 'secureValueTypeUtilityBill']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeUtilityBill={_='secureValueTypeUtilityBill'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/sendMessageGamePlayAction.md b/old_docs/API_docs_v44/constructors/sendMessageGamePlayAction.md new file mode 100644 index 00000000..23ed8757 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/sendMessageGamePlayAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageGamePlayAction +description: User is playing a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageGamePlayAction +[Back to constructors index](index.md) + + + +User is playing a game + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageGamePlayAction = ['_' => 'sendMessageGamePlayAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageGamePlayAction={_='sendMessageGamePlayAction'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/sendMessageRecordRoundAction.md b/old_docs/API_docs_v44/constructors/sendMessageRecordRoundAction.md new file mode 100644 index 00000000..7a7d2586 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/sendMessageRecordRoundAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageRecordRoundAction +description: User is recording a round video to share +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordRoundAction +[Back to constructors index](index.md) + + + +User is recording a round video to share + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageRecordRoundAction = ['_' => 'sendMessageRecordRoundAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageRecordRoundAction={_='sendMessageRecordRoundAction'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/sendMessageUploadRoundAction.md b/old_docs/API_docs_v44/constructors/sendMessageUploadRoundAction.md new file mode 100644 index 00000000..a52b1021 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/sendMessageUploadRoundAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadRoundAction +description: User is uploading a round video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadRoundAction +[Back to constructors index](index.md) + + + +User is uploading a round video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadRoundAction = ['_' => 'sendMessageUploadRoundAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadRoundAction={_='sendMessageUploadRoundAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/shippingOption.md b/old_docs/API_docs_v44/constructors/shippingOption.md new file mode 100644 index 00000000..2d11622e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/shippingOption.md @@ -0,0 +1,40 @@ +--- +title: shippingOption +description: Shipping option +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: shippingOption +[Back to constructors index](index.md) + + + +Shipping option + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Option ID| +|title|[string](../types/string.md) | Yes|Title| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes|List of price portions| + + + +### Type: [ShippingOption](../types/ShippingOption.md) + + +### Example: + +```php +$shippingOption = ['_' => 'shippingOption', 'id' => 'string', 'title' => 'string', 'prices' => [LabeledPrice, LabeledPrice]]; +``` + + +Or, if you're into Lua: + +```lua +shippingOption={_='shippingOption', id='string', title='string', prices={LabeledPrice}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/stats.broadcastStats.md b/old_docs/API_docs_v44/constructors/stats.broadcastStats.md new file mode 100644 index 00000000..e0447b22 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/stats.broadcastStats.md @@ -0,0 +1,53 @@ +--- +title: stats.broadcastStats +description: [Channel statistics](https://core.telegram.org/api/stats). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/stats_broadcastStats.html +--- +# Constructor: stats.broadcastStats +[Back to constructors index](index.md) + + + +[Channel statistics](https://core.telegram.org/api/stats). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|period|[StatsDateRangeDays](../types/StatsDateRangeDays.md) | Yes|Period in consideration| +|followers|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|Follower count change for period in consideration| +|views\_per\_post|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|`total_viewcount/postcount`, for posts posted during the period in consideration (`views_per_post`).
Note that in this case, `current` refers to the `period` in consideration (`min_date` till `max_date`), and `prev` refers to the previous period (`(min_date - (max_date - min_date))` till `min_date`).| +|shares\_per\_post|[StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) | Yes|`total_viewcount/postcount`, for posts posted during the period in consideration (`views_per_post`).
Note that in this case, `current` refers to the `period` in consideration (`min_date` till `max_date`), and `prev` refers to the previous period (`(min_date - (max_date - min_date))` till `min_date`)| +|enabled\_notifications|[StatsPercentValue](../types/StatsPercentValue.md) | Yes|Percentage of subscribers with enabled notifications| +|growth\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Channel growth graph (absolute subscriber count)| +|followers\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Followers growth graph (relative subscriber count)| +|mute\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Muted users graph (relative)| +|top\_hours\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Views per hour graph (absolute)| +|interactions\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Interactions graph (absolute)| +|iv\_interactions\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|IV interactions graph (absolute)| +|views\_by\_source\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Views by source graph (absolute)| +|new\_followers\_by\_source\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|New followers by source graph (absolute)| +|languages\_graph|[StatsGraph](../types/StatsGraph.md) | Yes|Subscriber language graph (piechart)| +|recent\_message\_interactions|Array of [MessageInteractionCounters](../types/MessageInteractionCounters.md) | Yes|Recent message interactions| + + + +### Type: [stats.BroadcastStats](../types/stats.BroadcastStats.md) + + +### Example: + +```php +$stats.broadcastStats = ['_' => 'stats.broadcastStats', 'period' => StatsDateRangeDays, 'followers' => StatsAbsValueAndPrev, 'views_per_post' => StatsAbsValueAndPrev, 'shares_per_post' => StatsAbsValueAndPrev, 'enabled_notifications' => StatsPercentValue, 'growth_graph' => StatsGraph, 'followers_graph' => StatsGraph, 'mute_graph' => StatsGraph, 'top_hours_graph' => StatsGraph, 'interactions_graph' => StatsGraph, 'iv_interactions_graph' => StatsGraph, 'views_by_source_graph' => StatsGraph, 'new_followers_by_source_graph' => StatsGraph, 'languages_graph' => StatsGraph, 'recent_message_interactions' => [MessageInteractionCounters, MessageInteractionCounters]]; +``` + + +Or, if you're into Lua: + +```lua +stats.broadcastStats={_='stats.broadcastStats', period=StatsDateRangeDays, followers=StatsAbsValueAndPrev, views_per_post=StatsAbsValueAndPrev, shares_per_post=StatsAbsValueAndPrev, enabled_notifications=StatsPercentValue, growth_graph=StatsGraph, followers_graph=StatsGraph, mute_graph=StatsGraph, top_hours_graph=StatsGraph, interactions_graph=StatsGraph, iv_interactions_graph=StatsGraph, views_by_source_graph=StatsGraph, new_followers_by_source_graph=StatsGraph, languages_graph=StatsGraph, recent_message_interactions={MessageInteractionCounters}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/stats.megagroupStats.md b/old_docs/API_docs_v44/constructors/stats.megagroupStats.md new file mode 100644 index 00000000..1a77cd72 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/stats.megagroupStats.md @@ -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}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsAbsValueAndPrev.md b/old_docs/API_docs_v44/constructors/statsAbsValueAndPrev.md new file mode 100644 index 00000000..f536554d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsAbsValueAndPrev.md @@ -0,0 +1,39 @@ +--- +title: statsAbsValueAndPrev +description: Statistics value couple; intial and final value for period of time currently in consideration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsAbsValueAndPrev +[Back to constructors index](index.md) + + + +Statistics value couple; intial and final value for period of time currently in consideration + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|current|[double](../types/double.md) | Yes|Current value| +|previous|[double](../types/double.md) | Yes|Previous value| + + + +### Type: [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md) + + +### Example: + +```php +$statsAbsValueAndPrev = ['_' => 'statsAbsValueAndPrev', 'current' => double, 'previous' => double]; +``` + + +Or, if you're into Lua: + +```lua +statsAbsValueAndPrev={_='statsAbsValueAndPrev', current=double, previous=double} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsDateRangeDays.md b/old_docs/API_docs_v44/constructors/statsDateRangeDays.md new file mode 100644 index 00000000..435bf694 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsDateRangeDays.md @@ -0,0 +1,39 @@ +--- +title: statsDateRangeDays +description: [Channel statistics](https://core.telegram.org/api/stats) date range +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsDateRangeDays +[Back to constructors index](index.md) + + + +[Channel statistics](https://core.telegram.org/api/stats) date range + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|min\_date|[int](../types/int.md) | Yes|Initial date| +|max\_date|[int](../types/int.md) | Yes|Final date| + + + +### Type: [StatsDateRangeDays](../types/StatsDateRangeDays.md) + + +### Example: + +```php +$statsDateRangeDays = ['_' => 'statsDateRangeDays', 'min_date' => int, 'max_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +statsDateRangeDays={_='statsDateRangeDays', min_date=int, max_date=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGraph.md b/old_docs/API_docs_v44/constructors/statsGraph.md new file mode 100644 index 00000000..88d659e3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGraph.md @@ -0,0 +1,39 @@ +--- +title: statsGraph +description: [Channel statistics graph](https://core.telegram.org/api/stats) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsGraph +[Back to constructors index](index.md) + + + +[Channel statistics graph](https://core.telegram.org/api/stats) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|json|[DataJSON](../types/DataJSON.md) | Yes|Statistics data| +|zoom\_token|[string](../types/string.md) | Optional|Zoom token| + + + +### Type: [StatsGraph](../types/StatsGraph.md) + + +### Example: + +```php +$statsGraph = ['_' => 'statsGraph', 'json' => DataJSON, 'zoom_token' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +statsGraph={_='statsGraph', json=DataJSON, zoom_token='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGraphAsync.md b/old_docs/API_docs_v44/constructors/statsGraphAsync.md new file mode 100644 index 00000000..09c42179 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGraphAsync.md @@ -0,0 +1,38 @@ +--- +title: statsGraphAsync +description: This [channel statistics graph](https://core.telegram.org/api/stats) must be generated asynchronously using [stats.loadAsyncGraph](../methods/stats.loadAsyncGraph.md) to reduce server load +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsGraphAsync +[Back to constructors index](index.md) + + + +This [channel statistics graph](https://core.telegram.org/api/stats) must be generated asynchronously using [stats.loadAsyncGraph](../methods/stats.loadAsyncGraph.md) to reduce server load + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|token|[string](../types/string.md) | Yes|Token to use for fetching the async graph| + + + +### Type: [StatsGraph](../types/StatsGraph.md) + + +### Example: + +```php +$statsGraphAsync = ['_' => 'statsGraphAsync', 'token' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +statsGraphAsync={_='statsGraphAsync', token='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGraphError.md b/old_docs/API_docs_v44/constructors/statsGraphError.md new file mode 100644 index 00000000..073d75d3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGraphError.md @@ -0,0 +1,38 @@ +--- +title: statsGraphError +description: An error occurred while generating the [statistics graph](https://core.telegram.org/api/stats) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsGraphError +[Back to constructors index](index.md) + + + +An error occurred while generating the [statistics graph](https://core.telegram.org/api/stats) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|error|[string](../types/string.md) | Yes|The error| + + + +### Type: [StatsGraph](../types/StatsGraph.md) + + +### Example: + +```php +$statsGraphError = ['_' => 'statsGraphError', 'error' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +statsGraphError={_='statsGraphError', error='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGroupTopAdmin.md b/old_docs/API_docs_v44/constructors/statsGroupTopAdmin.md new file mode 100644 index 00000000..51c10490 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGroupTopAdmin.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGroupTopInviter.md b/old_docs/API_docs_v44/constructors/statsGroupTopInviter.md new file mode 100644 index 00000000..c08111cf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGroupTopInviter.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsGroupTopPoster.md b/old_docs/API_docs_v44/constructors/statsGroupTopPoster.md new file mode 100644 index 00000000..a8f26bb1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsGroupTopPoster.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsPercentValue.md b/old_docs/API_docs_v44/constructors/statsPercentValue.md new file mode 100644 index 00000000..1f5386b8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsPercentValue.md @@ -0,0 +1,41 @@ +--- +title: statsPercentValue +description: [Channel statistics percentage](https://core.telegram.org/api/stats). +Compute the percentage simply by doing `part * total / 100` +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsPercentValue +[Back to constructors index](index.md) + + + +[Channel statistics percentage](https://core.telegram.org/api/stats). +Compute the percentage simply by doing `part * total / 100` + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|part|[double](../types/double.md) | Yes|Partial value| +|total|[double](../types/double.md) | Yes|Total value| + + + +### Type: [StatsPercentValue](../types/StatsPercentValue.md) + + +### Example: + +```php +$statsPercentValue = ['_' => 'statsPercentValue', 'part' => double, 'total' => double]; +``` + + +Or, if you're into Lua: + +```lua +statsPercentValue={_='statsPercentValue', part=double, total=double} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/statsURL.md b/old_docs/API_docs_v44/constructors/statsURL.md new file mode 100644 index 00000000..51f29f3c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/statsURL.md @@ -0,0 +1,38 @@ +--- +title: statsURL +description: URL with chat statistics +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsURL +[Back to constructors index](index.md) + + + +URL with chat statistics + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Chat statistics| + + + +### Type: [StatsURL](../types/StatsURL.md) + + +### Example: + +```php +$statsURL = ['_' => 'statsURL', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +statsURL={_='statsURL', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/stickerPack.md b/old_docs/API_docs_v44/constructors/stickerPack.md index 77591a3e..c3ef344b 100644 --- a/old_docs/API_docs_v44/constructors/stickerPack.md +++ b/old_docs/API_docs_v44/constructors/stickerPack.md @@ -17,7 +17,7 @@ It is **not** a sticker pack the way it is usually intended, you may be looking | Name | Type | Required | Description | |----------|---------------|----------|-------------| |emoticon|[string](../types/string.md) | Yes|Emoji| -|documents|Array of [long](../types/long.md) | Yes|Documents| +|documents|Array of [long](../types/long.md) | Yes|Stickers| diff --git a/old_docs/API_docs_v44/constructors/stickerSet.md b/old_docs/API_docs_v44/constructors/stickerSet.md index e0146514..6ff94aff 100644 --- a/old_docs/API_docs_v44/constructors/stickerSet.md +++ b/old_docs/API_docs_v44/constructors/stickerSet.md @@ -14,15 +14,19 @@ Represents a stickerset (stickerpack) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|installed|[Bool](../types/Bool.md) | Optional|Installed?| -|disabled|[Bool](../types/Bool.md) | Optional|Disabled?| +|archived|[Bool](../types/Bool.md) | Optional|Whether this stickerset was archived (due to too many saved stickers in the current account)| |official|[Bool](../types/Bool.md) | Optional|Is this stickerset official| +|masks|[Bool](../types/Bool.md) | Optional|Is this a mask stickerset| +|animated|[Bool](../types/Bool.md) | Optional|Is this an animated stickerpack| +|installed\_date|[int](../types/int.md) | Optional|When was this stickerset installed| |id|[long](../types/long.md) | Yes|ID of the stickerset| |access\_hash|[long](../types/long.md) | Yes|Access hash of stickerset| |title|[string](../types/string.md) | Yes|Title of stickerset| |short\_name|[string](../types/string.md) | Yes|Short name of stickerset to use in `tg://addstickers?set=short_name`| +|thumb|[PhotoSize](../types/PhotoSize.md) | Optional|Thumbnail for stickerset| +|thumb\_dc\_id|[int](../types/int.md) | Optional|DC ID of thumbnail| |count|[int](../types/int.md) | Yes|Number of stickers in pack| -|hash|[int](../types/int.md) | Yes|Hash| +|hash|[int](../types/int.md) | Yes| @@ -32,14 +36,14 @@ Represents a stickerset (stickerpack) ### Example: ```php -$stickerSet = ['_' => 'stickerSet', 'installed' => Bool, 'disabled' => Bool, 'official' => Bool, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'count' => int, 'hash' => int]; +$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'animated' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'thumb' => PhotoSize, 'thumb_dc_id' => int, 'count' => int, 'hash' => int]; ``` Or, if you're into Lua: ```lua -stickerSet={_='stickerSet', installed=Bool, disabled=Bool, official=Bool, id=long, access_hash=long, title='string', short_name='string', count=int, hash=int} +stickerSet={_='stickerSet', archived=Bool, official=Bool, masks=Bool, animated=Bool, installed_date=int, id=long, access_hash=long, title='string', short_name='string', thumb=PhotoSize, thumb_dc_id=int, count=int, hash=int} ``` diff --git a/old_docs/API_docs_v44/constructors/stickerSetCovered.md b/old_docs/API_docs_v44/constructors/stickerSetCovered.md new file mode 100644 index 00000000..dc18cf12 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/stickerSetCovered.md @@ -0,0 +1,39 @@ +--- +title: stickerSetCovered +description: Stickerset, with a specific sticker as preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetCovered +[Back to constructors index](index.md) + + + +Stickerset, with a specific sticker as preview + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|set|[StickerSet](../types/StickerSet.md) | Yes|Stickerset| +|cover|[Document](../types/Document.md) | Optional|Preview| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +```php +$stickerSetCovered = ['_' => 'stickerSetCovered', 'set' => StickerSet, 'cover' => Document]; +``` + + +Or, if you're into Lua: + +```lua +stickerSetCovered={_='stickerSetCovered', set=StickerSet, cover=Document} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/stickerSetMultiCovered.md b/old_docs/API_docs_v44/constructors/stickerSetMultiCovered.md new file mode 100644 index 00000000..f3a630d8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/stickerSetMultiCovered.md @@ -0,0 +1,39 @@ +--- +title: stickerSetMultiCovered +description: Stickerset, with a specific stickers as preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetMultiCovered +[Back to constructors index](index.md) + + + +Stickerset, with a specific stickers as preview + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|set|[StickerSet](../types/StickerSet.md) | Yes|Stickerset| +|covers|Array of [Document](../types/Document.md) | Yes|Preview stickers| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +```php +$stickerSetMultiCovered = ['_' => 'stickerSetMultiCovered', 'set' => StickerSet, 'covers' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +stickerSetMultiCovered={_='stickerSetMultiCovered', set=StickerSet, covers={Document}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textAnchor.md b/old_docs/API_docs_v44/constructors/textAnchor.md new file mode 100644 index 00000000..34d43623 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textAnchor.md @@ -0,0 +1,39 @@ +--- +title: textAnchor +description: Text linking to another section of the page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textAnchor +[Back to constructors index](index.md) + + + +Text linking to another section of the page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|name|[string](../types/string.md) | Yes|Section name| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textAnchor = ['_' => 'textAnchor', 'text' => RichText, 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textAnchor={_='textAnchor', text=RichText, name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textBold.md b/old_docs/API_docs_v44/constructors/textBold.md new file mode 100644 index 00000000..765b606d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textBold.md @@ -0,0 +1,38 @@ +--- +title: textBold +description: **Bold** text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textBold +[Back to constructors index](index.md) + + + +**Bold** text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textBold = ['_' => 'textBold', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textBold={_='textBold', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textConcat.md b/old_docs/API_docs_v44/constructors/textConcat.md new file mode 100644 index 00000000..5c67e3f5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textConcat.md @@ -0,0 +1,38 @@ +--- +title: textConcat +description: Concatenation of rich texts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textConcat +[Back to constructors index](index.md) + + + +Concatenation of rich texts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|texts|Array of [RichText](../types/RichText.md) | Yes|Concatenated rich texts| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textConcat = ['_' => 'textConcat', 'texts' => [RichText, RichText]]; +``` + + +Or, if you're into Lua: + +```lua +textConcat={_='textConcat', texts={RichText}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textEmail.md b/old_docs/API_docs_v44/constructors/textEmail.md new file mode 100644 index 00000000..cb82af7c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textEmail.md @@ -0,0 +1,39 @@ +--- +title: textEmail +description: Rich text email link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmail +[Back to constructors index](index.md) + + + +Rich text email link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Link text| +|email|[string](../types/string.md) | Yes|Email address| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textEmail = ['_' => 'textEmail', 'text' => RichText, 'email' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textEmail={_='textEmail', text=RichText, email='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textEmpty.md b/old_docs/API_docs_v44/constructors/textEmpty.md new file mode 100644 index 00000000..ff79509d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textEmpty.md @@ -0,0 +1,33 @@ +--- +title: textEmpty +description: Empty rich text element +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmpty +[Back to constructors index](index.md) + + + +Empty rich text element + + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textEmpty = ['_' => 'textEmpty']; +``` + + +Or, if you're into Lua: + +```lua +textEmpty={_='textEmpty'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textFixed.md b/old_docs/API_docs_v44/constructors/textFixed.md new file mode 100644 index 00000000..1b4dd5e2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textFixed.md @@ -0,0 +1,38 @@ +--- +title: textFixed +description: `fixed-width` rich text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textFixed +[Back to constructors index](index.md) + + + +`fixed-width` rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textFixed = ['_' => 'textFixed', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textFixed={_='textFixed', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textImage.md b/old_docs/API_docs_v44/constructors/textImage.md new file mode 100644 index 00000000..b913b2c4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textImage.md @@ -0,0 +1,40 @@ +--- +title: textImage +description: Inline image +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textImage +[Back to constructors index](index.md) + + + +Inline image + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|document\_id|[long](../types/long.md) | Yes|Document ID| +|w|[int](../types/int.md) | Yes|Width| +|h|[int](../types/int.md) | Yes|Height| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textImage = ['_' => 'textImage', 'document_id' => long, 'w' => int, 'h' => int]; +``` + + +Or, if you're into Lua: + +```lua +textImage={_='textImage', document_id=long, w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textItalic.md b/old_docs/API_docs_v44/constructors/textItalic.md new file mode 100644 index 00000000..12f99413 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textItalic.md @@ -0,0 +1,38 @@ +--- +title: textItalic +description: *Italic* text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textItalic +[Back to constructors index](index.md) + + + +*Italic* text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textItalic = ['_' => 'textItalic', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textItalic={_='textItalic', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textMarked.md b/old_docs/API_docs_v44/constructors/textMarked.md new file mode 100644 index 00000000..eca55786 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textMarked.md @@ -0,0 +1,38 @@ +--- +title: textMarked +description: Highlighted text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textMarked +[Back to constructors index](index.md) + + + +Highlighted text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textMarked = ['_' => 'textMarked', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textMarked={_='textMarked', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textPhone.md b/old_docs/API_docs_v44/constructors/textPhone.md new file mode 100644 index 00000000..f934f7d2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textPhone.md @@ -0,0 +1,39 @@ +--- +title: textPhone +description: Rich text linked to a phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textPhone +[Back to constructors index](index.md) + + + +Rich text linked to a phone number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|phone|[string](../types/string.md) | Yes|Phone number| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textPhone = ['_' => 'textPhone', 'text' => RichText, 'phone' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textPhone={_='textPhone', text=RichText, phone='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/audioEmpty.md b/old_docs/API_docs_v44/constructors/textPlain.md similarity index 54% rename from old_docs/API_docs_v44/constructors/audioEmpty.md rename to old_docs/API_docs_v44/constructors/textPlain.md index ee5596e1..d94fea42 100644 --- a/old_docs/API_docs_v44/constructors/audioEmpty.md +++ b/old_docs/API_docs_v44/constructors/textPlain.md @@ -1,37 +1,37 @@ --- -title: audioEmpty -description: Empty audio +title: textPlain +description: Plain text image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: audioEmpty +# Constructor: textPlain [Back to constructors index](index.md) -Empty audio +Plain text ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| +|text|[string](../types/string.md) | Yes|Text| -### Type: [Audio](../types/Audio.md) +### Type: [RichText](../types/RichText.md) ### Example: ```php -$audioEmpty = ['_' => 'audioEmpty', 'id' => long]; +$textPlain = ['_' => 'textPlain', 'text' => 'string']; ``` Or, if you're into Lua: ```lua -audioEmpty={_='audioEmpty', id=long} +textPlain={_='textPlain', text='string'} ``` diff --git a/old_docs/API_docs_v44/constructors/textStrike.md b/old_docs/API_docs_v44/constructors/textStrike.md new file mode 100644 index 00000000..c797a27a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textStrike.md @@ -0,0 +1,38 @@ +--- +title: textStrike +description:Strikethroughtext +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textStrike +[Back to constructors index](index.md) + + + +Strikethroughtext + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textStrike = ['_' => 'textStrike', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textStrike={_='textStrike', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textSubscript.md b/old_docs/API_docs_v44/constructors/textSubscript.md new file mode 100644 index 00000000..501bc7b6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textSubscript.md @@ -0,0 +1,38 @@ +--- +title: textSubscript +description: Subscript text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textSubscript +[Back to constructors index](index.md) + + + +Subscript text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textSubscript = ['_' => 'textSubscript', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textSubscript={_='textSubscript', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textSuperscript.md b/old_docs/API_docs_v44/constructors/textSuperscript.md new file mode 100644 index 00000000..bc1a3636 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textSuperscript.md @@ -0,0 +1,38 @@ +--- +title: textSuperscript +description: Superscript text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textSuperscript +[Back to constructors index](index.md) + + + +Superscript text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textSuperscript = ['_' => 'textSuperscript', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textSuperscript={_='textSuperscript', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textUnderline.md b/old_docs/API_docs_v44/constructors/textUnderline.md new file mode 100644 index 00000000..624e12f6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textUnderline.md @@ -0,0 +1,38 @@ +--- +title: textUnderline +description: Underlined text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUnderline +[Back to constructors index](index.md) + + + +Underlined text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textUnderline = ['_' => 'textUnderline', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textUnderline={_='textUnderline', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/textUrl.md b/old_docs/API_docs_v44/constructors/textUrl.md new file mode 100644 index 00000000..f5c05080 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/textUrl.md @@ -0,0 +1,40 @@ +--- +title: textUrl +description: Link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUrl +[Back to constructors index](index.md) + + + +Link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text of link| +|url|[string](../types/string.md) | Yes|Webpage HTTP URL| +|webpage\_id|[long](../types/long.md) | Yes|If a preview was already generated for the page, the page ID| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textUrl = ['_' => 'textUrl', 'text' => RichText, 'url' => 'string', 'webpage_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +textUrl={_='textUrl', text=RichText, url='string', webpage_id=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/theme.md b/old_docs/API_docs_v44/constructors/theme.md new file mode 100644 index 00000000..938cd259 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/theme.md @@ -0,0 +1,46 @@ +--- +title: theme +description: Theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: theme +[Back to constructors index](index.md) + + + +Theme + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of this theme| +|default|[Bool](../types/Bool.md) | Optional|Whether this is the default theme| +|id|[long](../types/long.md) | Yes|Theme ID| +|access\_hash|[long](../types/long.md) | Yes|Theme access hash| +|slug|[string](../types/string.md) | Yes|Unique theme ID| +|title|[string](../types/string.md) | Yes|Theme name| +|document|[Document](../types/Document.md) | Optional|Theme| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional|Theme settings| +|installs\_count|[int](../types/int.md) | Yes|Installation count| + + + +### Type: [Theme](../types/Theme.md) + + +### Example: + +```php +$theme = ['_' => 'theme', 'creator' => Bool, 'default' => Bool, 'id' => long, 'access_hash' => long, 'slug' => 'string', 'title' => 'string', 'document' => Document, 'settings' => ThemeSettings, 'installs_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +theme={_='theme', creator=Bool, default=Bool, id=long, access_hash=long, slug='string', title='string', document=Document, settings=ThemeSettings, installs_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/themeSettings.md b/old_docs/API_docs_v44/constructors/themeSettings.md new file mode 100644 index 00000000..a45d27af --- /dev/null +++ b/old_docs/API_docs_v44/constructors/themeSettings.md @@ -0,0 +1,42 @@ +--- +title: themeSettings +description: Theme settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: themeSettings +[Back to constructors index](index.md) + + + +Theme settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes|Base theme| +|accent\_color|[int](../types/int.md) | Yes|Accent color, RGB24 format| +|message\_top\_color|[int](../types/int.md) | Optional|Message gradient color (top), RGB24 format| +|message\_bottom\_color|[int](../types/int.md) | Optional|Message gradient color (bottom), RGB24 format| +|wallpaper|[WallPaper](../types/WallPaper.md) | Optional|Wallpaper| + + + +### Type: [ThemeSettings](../types/ThemeSettings.md) + + +### Example: + +```php +$themeSettings = ['_' => 'themeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => WallPaper]; +``` + + +Or, if you're into Lua: + +```lua +themeSettings={_='themeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=WallPaper} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeer.md b/old_docs/API_docs_v44/constructors/topPeer.md new file mode 100644 index 00000000..bd5ed0d9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeer.md @@ -0,0 +1,39 @@ +--- +title: topPeer +description: Top peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeer +[Back to constructors index](index.md) + + + +Top peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|rating|[double](../types/double.md) | Yes|Rating as computer in [top peer rating »](https://core.telegram.org/api/top-rating)| + + + +### Type: [TopPeer](../types/TopPeer.md) + + +### Example: + +```php +$topPeer = ['_' => 'topPeer', 'peer' => Peer, 'rating' => double]; +``` + + +Or, if you're into Lua: + +```lua +topPeer={_='topPeer', peer=Peer, rating=double} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryBotsInline.md b/old_docs/API_docs_v44/constructors/topPeerCategoryBotsInline.md new file mode 100644 index 00000000..91ccb6c8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryBotsInline.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryBotsInline +description: Most used inline bots +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsInline +[Back to constructors index](index.md) + + + +Most used inline bots + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryBotsInline = ['_' => 'topPeerCategoryBotsInline']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryBotsInline={_='topPeerCategoryBotsInline'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryBotsPM.md b/old_docs/API_docs_v44/constructors/topPeerCategoryBotsPM.md new file mode 100644 index 00000000..ddea5ea1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryBotsPM.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryBotsPM +description: Most used bots +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsPM +[Back to constructors index](index.md) + + + +Most used bots + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryBotsPM = ['_' => 'topPeerCategoryBotsPM']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryBotsPM={_='topPeerCategoryBotsPM'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryChannels.md b/old_docs/API_docs_v44/constructors/topPeerCategoryChannels.md new file mode 100644 index 00000000..05233319 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryChannels.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryChannels +description: Most frequently visited channels +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryChannels +[Back to constructors index](index.md) + + + +Most frequently visited channels + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryChannels = ['_' => 'topPeerCategoryChannels']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryChannels={_='topPeerCategoryChannels'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryCorrespondents.md b/old_docs/API_docs_v44/constructors/topPeerCategoryCorrespondents.md new file mode 100644 index 00000000..9f9fd2cd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryCorrespondents.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryCorrespondents +description: Users we've chatted most frequently with +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryCorrespondents +[Back to constructors index](index.md) + + + +Users we've chatted most frequently with + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryCorrespondents = ['_' => 'topPeerCategoryCorrespondents']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryCorrespondents={_='topPeerCategoryCorrespondents'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryForwardChats.md b/old_docs/API_docs_v44/constructors/topPeerCategoryForwardChats.md new file mode 100644 index 00000000..bb6ae873 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryForwardChats.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryForwardChats +description: Chats to which the users often forwards messages to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryForwardChats +[Back to constructors index](index.md) + + + +Chats to which the users often forwards messages to + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryForwardChats = ['_' => 'topPeerCategoryForwardChats']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryForwardChats={_='topPeerCategoryForwardChats'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryForwardUsers.md b/old_docs/API_docs_v44/constructors/topPeerCategoryForwardUsers.md new file mode 100644 index 00000000..12fee8ad --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryForwardUsers.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryForwardUsers +description: Users to which the users often forwards messages to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryForwardUsers +[Back to constructors index](index.md) + + + +Users to which the users often forwards messages to + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryForwardUsers = ['_' => 'topPeerCategoryForwardUsers']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryForwardUsers={_='topPeerCategoryForwardUsers'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryGroups.md b/old_docs/API_docs_v44/constructors/topPeerCategoryGroups.md new file mode 100644 index 00000000..48b57d8e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryGroups.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryGroups +description: Often-opened groups and supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryGroups +[Back to constructors index](index.md) + + + +Often-opened groups and supergroups + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryGroups = ['_' => 'topPeerCategoryGroups']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryGroups={_='topPeerCategoryGroups'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryPeers.md b/old_docs/API_docs_v44/constructors/topPeerCategoryPeers.md new file mode 100644 index 00000000..563329b4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryPeers.md @@ -0,0 +1,40 @@ +--- +title: topPeerCategoryPeers +description: Top peer category +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPeers +[Back to constructors index](index.md) + + + +Top peer category + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|Top peer category of peers| +|count|[int](../types/int.md) | Yes|Count of peers| +|peers|Array of [TopPeer](../types/TopPeer.md) | Yes|Peers| + + + +### Type: [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) + + +### Example: + +```php +$topPeerCategoryPeers = ['_' => 'topPeerCategoryPeers', 'category' => TopPeerCategory, 'count' => int, 'peers' => [TopPeer, TopPeer]]; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryPeers={_='topPeerCategoryPeers', category=TopPeerCategory, count=int, peers={TopPeer}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/topPeerCategoryPhoneCalls.md b/old_docs/API_docs_v44/constructors/topPeerCategoryPhoneCalls.md new file mode 100644 index 00000000..31550c88 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/topPeerCategoryPhoneCalls.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryPhoneCalls +description: Most frequently called users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPhoneCalls +[Back to constructors index](index.md) + + + +Most frequently called users + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryPhoneCalls = ['_' => 'topPeerCategoryPhoneCalls']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryPhoneCalls={_='topPeerCategoryPhoneCalls'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotCallbackQuery.md b/old_docs/API_docs_v44/constructors/updateBotCallbackQuery.md new file mode 100644 index 00000000..b04d5b78 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotCallbackQuery.md @@ -0,0 +1,44 @@ +--- +title: updateBotCallbackQuery +description: A callback button was pressed, and the button data was sent to the bot that created the button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotCallbackQuery +[Back to constructors index](index.md) + + + +A callback button was pressed, and the button data was sent to the bot that created the button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|ID of the user that pressed the button| +|peer|[Peer](../types/Peer.md) | Yes|Chat where the inline keyboard was sent| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|chat\_instance|[long](../types/long.md) | Yes|Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.| +|data|[bytes](../types/bytes.md) | Optional|Callback data| +|game\_short\_name|[string](../types/string.md) | Optional|Short name of a Game to be returned, serves as the unique identifier for the game| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotCallbackQuery = ['_' => 'updateBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'peer' => Peer, 'msg_id' => int, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateBotCallbackQuery={_='updateBotCallbackQuery', query_id=long, user_id=int, peer=Peer, msg_id=int, chat_instance=long, data='bytes', game_short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotInlineQuery.md b/old_docs/API_docs_v44/constructors/updateBotInlineQuery.md new file mode 100644 index 00000000..992d4ac2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotInlineQuery.md @@ -0,0 +1,42 @@ +--- +title: updateBotInlineQuery +description: An incoming inline query +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineQuery +[Back to constructors index](index.md) + + + +An incoming inline query + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|User that sent the query| +|query|[string](../types/string.md) | Yes|Text of query| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Attached geolocation| +|offset|[string](../types/string.md) | Yes|Offset to navigate through results| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotInlineQuery = ['_' => 'updateBotInlineQuery', 'query_id' => long, 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'offset' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateBotInlineQuery={_='updateBotInlineQuery', query_id=long, user_id=int, query='string', geo=GeoPoint, offset='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotInlineSend.md b/old_docs/API_docs_v44/constructors/updateBotInlineSend.md new file mode 100644 index 00000000..7820faac --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotInlineSend.md @@ -0,0 +1,42 @@ +--- +title: updateBotInlineSend +description: The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the [feedback collecting](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineSend +[Back to constructors index](index.md) + + + +The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the [feedback collecting](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|The user that chose the result| +|query|[string](../types/string.md) | Yes|The query that was used to obtain the result| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Optional. Sender location, only for bots that require user location| +|id|[string](../types/string.md) | Yes|The unique identifier for the result that was chosen| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Optional|Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotInlineSend = ['_' => 'updateBotInlineSend', 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'id' => 'string', 'msg_id' => InputBotInlineMessageID]; +``` + + +Or, if you're into Lua: + +```lua +updateBotInlineSend={_='updateBotInlineSend', user_id=int, query='string', geo=GeoPoint, id='string', msg_id=InputBotInlineMessageID} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotPrecheckoutQuery.md b/old_docs/API_docs_v44/constructors/updateBotPrecheckoutQuery.md new file mode 100644 index 00000000..b9383cfb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotPrecheckoutQuery.md @@ -0,0 +1,44 @@ +--- +title: updateBotPrecheckoutQuery +description: This object contains information about an incoming pre-checkout query. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotPrecheckoutQuery +[Back to constructors index](index.md) + + + +This object contains information about an incoming pre-checkout query. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Unique query identifier| +|user\_id|[int](../types/int.md) | Yes|User who sent the query| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Order info provided by the user| +|shipping\_option\_id|[string](../types/string.md) | Optional|Identifier of the shipping option chosen by the user| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotPrecheckoutQuery = ['_' => 'updateBotPrecheckoutQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'currency' => 'string', 'total_amount' => long]; +``` + + +Or, if you're into Lua: + +```lua +updateBotPrecheckoutQuery={_='updateBotPrecheckoutQuery', query_id=long, user_id=int, payload='bytes', info=PaymentRequestedInfo, shipping_option_id='string', currency='string', total_amount=long} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotShippingQuery.md b/old_docs/API_docs_v44/constructors/updateBotShippingQuery.md new file mode 100644 index 00000000..0f0135cb --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotShippingQuery.md @@ -0,0 +1,41 @@ +--- +title: updateBotShippingQuery +description: This object contains information about an incoming shipping query. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotShippingQuery +[Back to constructors index](index.md) + + + +This object contains information about an incoming shipping query. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Unique query identifier| +|user\_id|[int](../types/int.md) | Yes|User who sent the query| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|shipping\_address|[PostAddress](../types/PostAddress.md) | Yes|User specified shipping address| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotShippingQuery = ['_' => 'updateBotShippingQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'shipping_address' => PostAddress]; +``` + + +Or, if you're into Lua: + +```lua +updateBotShippingQuery={_='updateBotShippingQuery', query_id=long, user_id=int, payload='bytes', shipping_address=PostAddress} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotWebhookJSON.md b/old_docs/API_docs_v44/constructors/updateBotWebhookJSON.md new file mode 100644 index 00000000..c15930a4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotWebhookJSON.md @@ -0,0 +1,38 @@ +--- +title: updateBotWebhookJSON +description: A new incoming event; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSON +[Back to constructors index](index.md) + + + +A new incoming event; for bots only + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[DataJSON](../types/DataJSON.md) | Yes|The event| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotWebhookJSON = ['_' => 'updateBotWebhookJSON', 'data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +updateBotWebhookJSON={_='updateBotWebhookJSON', data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateBotWebhookJSONQuery.md b/old_docs/API_docs_v44/constructors/updateBotWebhookJSONQuery.md new file mode 100644 index 00000000..21c527c1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateBotWebhookJSONQuery.md @@ -0,0 +1,40 @@ +--- +title: updateBotWebhookJSONQuery +description: A new incoming query; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSONQuery +[Back to constructors index](index.md) + + + +A new incoming query; for bots only + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query identifier| +|data|[DataJSON](../types/DataJSON.md) | Yes|Query data| +|timeout|[int](../types/int.md) | Yes|Query timeout| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotWebhookJSONQuery = ['_' => 'updateBotWebhookJSONQuery', 'query_id' => long, 'data' => DataJSON, 'timeout' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateBotWebhookJSONQuery={_='updateBotWebhookJSONQuery', query_id=long, data=DataJSON, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChannelAvailableMessages.md b/old_docs/API_docs_v44/constructors/updateChannelAvailableMessages.md new file mode 100644 index 00000000..734afc76 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChannelAvailableMessages.md @@ -0,0 +1,39 @@ +--- +title: updateChannelAvailableMessages +description: The history of a [channel/supergroup](https://core.telegram.org/api/channel) was hidden. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelAvailableMessages +[Back to constructors index](index.md) + + + +The history of a [channel/supergroup](https://core.telegram.org/api/channel) was hidden. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|available\_min\_id|[int](../types/int.md) | Yes|Identifier of a maximum unavailable message in a channel due to hidden history.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelAvailableMessages = ['_' => 'updateChannelAvailableMessages', 'channel_id' => int, 'available_min_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelAvailableMessages={_='updateChannelAvailableMessages', channel_id=int, available_min_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChannelGroup.md b/old_docs/API_docs_v44/constructors/updateChannelGroup.md deleted file mode 100644 index b721cb97..00000000 --- a/old_docs/API_docs_v44/constructors/updateChannelGroup.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: updateChannelGroup -description: Update channel group -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateChannelGroup -[Back to constructors index](index.md) - - - -Update channel group - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Channel ID| -|group|[MessageGroup](../types/MessageGroup.md) | Yes|Group| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateChannelGroup = ['_' => 'updateChannelGroup', 'channel_id' => int, 'group' => MessageGroup]; -``` - - -Or, if you're into Lua: - -```lua -updateChannelGroup={_='updateChannelGroup', channel_id=int, group=MessageGroup} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/updateChannelParticipant.md b/old_docs/API_docs_v44/constructors/updateChannelParticipant.md new file mode 100644 index 00000000..166de8a8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChannelParticipant.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChannelPinnedMessage.md b/old_docs/API_docs_v44/constructors/updateChannelPinnedMessage.md new file mode 100644 index 00000000..51ec6752 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChannelPinnedMessage.md @@ -0,0 +1,39 @@ +--- +title: updateChannelPinnedMessage +description: A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|id|[int](../types/int.md) | Yes|ID of pinned message| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelPinnedMessage = ['_' => 'updateChannelPinnedMessage', 'channel_id' => int, 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelPinnedMessage={_='updateChannelPinnedMessage', channel_id=int, id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChannelReadMessagesContents.md b/old_docs/API_docs_v44/constructors/updateChannelReadMessagesContents.md new file mode 100644 index 00000000..18213f1f --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChannelReadMessagesContents.md @@ -0,0 +1,39 @@ +--- +title: updateChannelReadMessagesContents +description: The specified [channel/supergroup](https://core.telegram.org/api/channel) messages were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelReadMessagesContents +[Back to constructors index](index.md) + + + +The specified [channel/supergroup](https://core.telegram.org/api/channel) messages were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|[Channel/supergroup](https://core.telegram.org/api/channel) ID| +|messages|Array of [int](../types/int.md) | Yes|IDs of messages that were read| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelReadMessagesContents = ['_' => 'updateChannelReadMessagesContents', 'channel_id' => int, 'messages' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelReadMessagesContents={_='updateChannelReadMessagesContents', channel_id=int, messages={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChannelTooLong.md b/old_docs/API_docs_v44/constructors/updateChannelTooLong.md index cee734e7..97bd3ff5 100644 --- a/old_docs/API_docs_v44/constructors/updateChannelTooLong.md +++ b/old_docs/API_docs_v44/constructors/updateChannelTooLong.md @@ -15,6 +15,7 @@ There are new updates in the specified channel, the client must fetch them, even | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel\_id|[int](../types/int.md) | Yes|The channel| +|pts|[int](../types/int.md) | Optional|The [PTS](https://core.telegram.org/api/updates).| @@ -24,14 +25,14 @@ There are new updates in the specified channel, the client must fetch them, even ### Example: ```php -$updateChannelTooLong = ['_' => 'updateChannelTooLong', 'channel_id' => int]; +$updateChannelTooLong = ['_' => 'updateChannelTooLong', 'channel_id' => int, 'pts' => int]; ``` Or, if you're into Lua: ```lua -updateChannelTooLong={_='updateChannelTooLong', channel_id=int} +updateChannelTooLong={_='updateChannelTooLong', channel_id=int, pts=int} ``` diff --git a/old_docs/API_docs_v44/constructors/updateChannelWebPage.md b/old_docs/API_docs_v44/constructors/updateChannelWebPage.md new file mode 100644 index 00000000..85c3e8a1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChannelWebPage.md @@ -0,0 +1,41 @@ +--- +title: updateChannelWebPage +description: A webpage preview of a link in a [channel/supergroup](https://core.telegram.org/api/channel) message was generated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelWebPage +[Back to constructors index](index.md) + + + +A webpage preview of a link in a [channel/supergroup](https://core.telegram.org/api/channel) message was generated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|[Channel/supergroup](https://core.telegram.org/api/channel) ID| +|webpage|[WebPage](../types/WebPage.md) | Optional|Generated webpage preview| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelWebPage = ['_' => 'updateChannelWebPage', 'channel_id' => int, 'webpage' => WebPage, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelWebPage={_='updateChannelWebPage', channel_id=int, webpage=WebPage, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChatAdmins.md b/old_docs/API_docs_v44/constructors/updateChatAdmins.md deleted file mode 100644 index 5a899725..00000000 --- a/old_docs/API_docs_v44/constructors/updateChatAdmins.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: updateChatAdmins -description: Update chat admins -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateChatAdmins -[Back to constructors index](index.md) - - - -Update chat admins - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int](../types/int.md) | Yes|Chat ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enabled?| -|version|[int](../types/int.md) | Yes|Version| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateChatAdmins = ['_' => 'updateChatAdmins', 'chat_id' => int, 'enabled' => Bool, 'version' => int]; -``` - - -Or, if you're into Lua: - -```lua -updateChatAdmins={_='updateChatAdmins', chat_id=int, enabled=Bool, version=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/updateChatDefaultBannedRights.md b/old_docs/API_docs_v44/constructors/updateChatDefaultBannedRights.md new file mode 100644 index 00000000..8db59e41 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChatDefaultBannedRights.md @@ -0,0 +1,40 @@ +--- +title: updateChatDefaultBannedRights +description: Default banned rights in a [normal chat](https://core.telegram.org/api/channel) were updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatDefaultBannedRights +[Back to constructors index](index.md) + + + +Default banned rights in a [normal chat](https://core.telegram.org/api/channel) were updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The chat| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New default banned rights| +|version|[int](../types/int.md) | Yes|Version| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatDefaultBannedRights = ['_' => 'updateChatDefaultBannedRights', 'peer' => Peer, 'default_banned_rights' => ChatBannedRights, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatDefaultBannedRights={_='updateChatDefaultBannedRights', peer=Peer, default_banned_rights=ChatBannedRights, version=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateChatPinnedMessage.md b/old_docs/API_docs_v44/constructors/updateChatPinnedMessage.md new file mode 100644 index 00000000..1f3c75c5 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateChatPinnedMessage.md @@ -0,0 +1,40 @@ +--- +title: updateChatPinnedMessage +description: A message was pinned in a [legacy group](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a [legacy group](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|[Legacy group](https://core.telegram.org/api/channel) ID| +|id|[int](../types/int.md) | Yes|ID of pinned message| +|version|[int](../types/int.md) | Yes|Used to reorder updates in legacy groups| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatPinnedMessage = ['_' => 'updateChatPinnedMessage', 'chat_id' => int, 'id' => int, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatPinnedMessage={_='updateChatPinnedMessage', chat_id=int, id=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateConfig.md b/old_docs/API_docs_v44/constructors/updateConfig.md new file mode 100644 index 00000000..6eb898ce --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateConfig.md @@ -0,0 +1,33 @@ +--- +title: updateConfig +description: The server-side configuration has changed; the client should re-fetch the config using [help.getConfig](../methods/help.getConfig.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateConfig +[Back to constructors index](index.md) + + + +The server-side configuration has changed; the client should re-fetch the config using [help.getConfig](../methods/help.getConfig.md) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateConfig = ['_' => 'updateConfig']; +``` + + +Or, if you're into Lua: + +```lua +updateConfig={_='updateConfig'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateContactLink.md b/old_docs/API_docs_v44/constructors/updateContactLink.md deleted file mode 100644 index abf1b1ae..00000000 --- a/old_docs/API_docs_v44/constructors/updateContactLink.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: updateContactLink -description: Update contact link -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateContactLink -[Back to constructors index](index.md) - - - -Update contact link - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|my\_link|[ContactLink](../types/ContactLink.md) | Yes|My link| -|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes|Foreign link| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateContactLink = ['_' => 'updateContactLink', 'user_id' => int, 'my_link' => ContactLink, 'foreign_link' => ContactLink]; -``` - - -Or, if you're into Lua: - -```lua -updateContactLink={_='updateContactLink', user_id=int, my_link=ContactLink, foreign_link=ContactLink} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/updateContactRegistered.md b/old_docs/API_docs_v44/constructors/updateContactRegistered.md deleted file mode 100644 index 7219058a..00000000 --- a/old_docs/API_docs_v44/constructors/updateContactRegistered.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: updateContactRegistered -description: Update contact registered -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateContactRegistered -[Back to constructors index](index.md) - - - -Update contact registered - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User ID| -|date|[int](../types/int.md) | Yes|Date| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateContactRegistered = ['_' => 'updateContactRegistered', 'user_id' => int, 'date' => int]; -``` - - -Or, if you're into Lua: - -```lua -updateContactRegistered={_='updateContactRegistered', user_id=int, date=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/updateContactsReset.md b/old_docs/API_docs_v44/constructors/updateContactsReset.md new file mode 100644 index 00000000..85725d76 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateContactsReset.md @@ -0,0 +1,33 @@ +--- +title: updateContactsReset +description: All contacts were deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateContactsReset +[Back to constructors index](index.md) + + + +All contacts were deleted + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateContactsReset = ['_' => 'updateContactsReset']; +``` + + +Or, if you're into Lua: + +```lua +updateContactsReset={_='updateContactsReset'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDcOptions.md b/old_docs/API_docs_v44/constructors/updateDcOptions.md index 9b674835..7d1ae8fb 100644 --- a/old_docs/API_docs_v44/constructors/updateDcOptions.md +++ b/old_docs/API_docs_v44/constructors/updateDcOptions.md @@ -14,7 +14,7 @@ Changes in the data center configuration options. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC options| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|New connection options| diff --git a/old_docs/API_docs_v44/constructors/updateDeleteChannelMessages.md b/old_docs/API_docs_v44/constructors/updateDeleteChannelMessages.md index 67f6e710..eb48f685 100644 --- a/old_docs/API_docs_v44/constructors/updateDeleteChannelMessages.md +++ b/old_docs/API_docs_v44/constructors/updateDeleteChannelMessages.md @@ -15,7 +15,7 @@ Some messages in a [supergroup/channel](https://core.telegram.org/api/channel) w | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel\_id|[int](../types/int.md) | Yes|Channel ID| -|messages|Array of [int](../types/int.md) | Yes|Messages| +|messages|Array of [int](../types/int.md) | Yes|IDs of messages that were deleted| |pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| diff --git a/old_docs/API_docs_v44/constructors/updateDeleteMessages.md b/old_docs/API_docs_v44/constructors/updateDeleteMessages.md index 85228d30..897b4f0a 100644 --- a/old_docs/API_docs_v44/constructors/updateDeleteMessages.md +++ b/old_docs/API_docs_v44/constructors/updateDeleteMessages.md @@ -14,7 +14,7 @@ Messages were deleted. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|messages|Array of [int](../types/int.md) | Yes|Messages| +|messages|Array of [int](../types/int.md) | Yes|List of identifiers of deleted messages| |pts|[int](../types/int.md) | Yes|New quality of actions in a message box| |pts\_count|[int](../types/int.md) | Yes|Number of generated [events](https://core.telegram.org/api/updates)| diff --git a/old_docs/API_docs_v44/constructors/updateDeleteScheduledMessages.md b/old_docs/API_docs_v44/constructors/updateDeleteScheduledMessages.md new file mode 100644 index 00000000..2c19410a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDeleteScheduledMessages.md @@ -0,0 +1,39 @@ +--- +title: updateDeleteScheduledMessages +description: Some scheduled messages were deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteScheduledMessages +[Back to constructors index](index.md) + + + +Some scheduled messages were deleted + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|messages|Array of [int](../types/int.md) | Yes|Deleted scheduled messages| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDeleteScheduledMessages = ['_' => 'updateDeleteScheduledMessages', 'peer' => Peer, 'messages' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +updateDeleteScheduledMessages={_='updateDeleteScheduledMessages', peer=Peer, messages={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDialogFilter.md b/old_docs/API_docs_v44/constructors/updateDialogFilter.md new file mode 100644 index 00000000..975d61e6 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDialogFilter.md @@ -0,0 +1,39 @@ +--- +title: updateDialogFilter +description: A new [folder](https://core.telegram.org/api/folders) was added +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogFilter +[Back to constructors index](index.md) + + + +A new [folder](https://core.telegram.org/api/folders) was added + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|[Folder](https://core.telegram.org/api/folders) ID| +|filter|[DialogFilter](../types/DialogFilter.md) | Optional|[Folder](https://core.telegram.org/api/folders) info| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogFilter = ['_' => 'updateDialogFilter', 'id' => int, 'filter' => DialogFilter]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogFilter={_='updateDialogFilter', id=int, filter=DialogFilter} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDialogFilterOrder.md b/old_docs/API_docs_v44/constructors/updateDialogFilterOrder.md new file mode 100644 index 00000000..634f3f16 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDialogFilterOrder.md @@ -0,0 +1,38 @@ +--- +title: updateDialogFilterOrder +description: New [folder](https://core.telegram.org/api/folders) order +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogFilterOrder +[Back to constructors index](index.md) + + + +New [folder](https://core.telegram.org/api/folders) order + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [int](../types/int.md) | Yes|Ordered [folder IDs](https://core.telegram.org/api/folders)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogFilterOrder = ['_' => 'updateDialogFilterOrder', 'order' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogFilterOrder={_='updateDialogFilterOrder', order={int}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDialogFilters.md b/old_docs/API_docs_v44/constructors/updateDialogFilters.md new file mode 100644 index 00000000..8c473e30 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDialogFilters.md @@ -0,0 +1,33 @@ +--- +title: updateDialogFilters +description: Clients should update [folder](https://core.telegram.org/api/folders) info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogFilters +[Back to constructors index](index.md) + + + +Clients should update [folder](https://core.telegram.org/api/folders) info + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogFilters = ['_' => 'updateDialogFilters']; +``` + + +Or, if you're into Lua: + +```lua +updateDialogFilters={_='updateDialogFilters'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDialogPinned.md b/old_docs/API_docs_v44/constructors/updateDialogPinned.md new file mode 100644 index 00000000..571efc95 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDialogPinned.md @@ -0,0 +1,40 @@ +--- +title: updateDialogPinned +description: A dialog was pinned/unpinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogPinned +[Back to constructors index](index.md) + + + +A dialog was pinned/unpinned + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Whether the dialog was pinned| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes|The dialog| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogPinned = ['_' => 'updateDialogPinned', 'pinned' => Bool, 'folder_id' => int, 'peer' => DialogPeer]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogPinned={_='updateDialogPinned', pinned=Bool, folder_id=int, peer=DialogPeer} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDialogUnreadMark.md b/old_docs/API_docs_v44/constructors/updateDialogUnreadMark.md new file mode 100644 index 00000000..49d853a9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDialogUnreadMark.md @@ -0,0 +1,39 @@ +--- +title: updateDialogUnreadMark +description: The manual unread mark of a chat was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogUnreadMark +[Back to constructors index](index.md) + + + +The manual unread mark of a chat was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|unread|[Bool](../types/Bool.md) | Optional|Was the chat marked or unmarked as read| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes|The dialog| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogUnreadMark = ['_' => 'updateDialogUnreadMark', 'unread' => Bool, 'peer' => DialogPeer]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogUnreadMark={_='updateDialogUnreadMark', unread=Bool, peer=DialogPeer} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateDraftMessage.md b/old_docs/API_docs_v44/constructors/updateDraftMessage.md new file mode 100644 index 00000000..634308e0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateDraftMessage.md @@ -0,0 +1,39 @@ +--- +title: updateDraftMessage +description: Notifies a change of a message [draft](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDraftMessage +[Back to constructors index](index.md) + + + +Notifies a change of a message [draft](https://core.telegram.org/api/drafts). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The peer to which the draft is associated| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional|The draft| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDraftMessage = ['_' => 'updateDraftMessage', 'peer' => Peer, 'draft' => DraftMessage]; +``` + + +Or, if you're into Lua: + +```lua +updateDraftMessage={_='updateDraftMessage', peer=Peer, draft=DraftMessage} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateEditChannelMessage.md b/old_docs/API_docs_v44/constructors/updateEditChannelMessage.md new file mode 100644 index 00000000..7ac46407 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateEditChannelMessage.md @@ -0,0 +1,40 @@ +--- +title: updateEditChannelMessage +description: A message was edited in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditChannelMessage +[Back to constructors index](index.md) + + + +A message was edited in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The new message| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEditChannelMessage = ['_' => 'updateEditChannelMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEditChannelMessage={_='updateEditChannelMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateEditMessage.md b/old_docs/API_docs_v44/constructors/updateEditMessage.md new file mode 100644 index 00000000..927cb798 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateEditMessage.md @@ -0,0 +1,40 @@ +--- +title: updateEditMessage +description: A message was edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditMessage +[Back to constructors index](index.md) + + + +A message was edited + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The new edited message| +|pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEditMessage = ['_' => 'updateEditMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEditMessage={_='updateEditMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateFavedStickers.md b/old_docs/API_docs_v44/constructors/updateFavedStickers.md new file mode 100644 index 00000000..27b1ca7e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateFavedStickers.md @@ -0,0 +1,33 @@ +--- +title: updateFavedStickers +description: The list of favorited stickers was changed, the client should call [messages.getFavedStickers](../methods/messages.getFavedStickers.md) to refetch the new list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateFavedStickers +[Back to constructors index](index.md) + + + +The list of favorited stickers was changed, the client should call [messages.getFavedStickers](../methods/messages.getFavedStickers.md) to refetch the new list + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateFavedStickers = ['_' => 'updateFavedStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateFavedStickers={_='updateFavedStickers'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateFolderPeers.md b/old_docs/API_docs_v44/constructors/updateFolderPeers.md new file mode 100644 index 00000000..cb9c36af --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateFolderPeers.md @@ -0,0 +1,40 @@ +--- +title: updateFolderPeers +description: The peer list of a [peer folder](https://core.telegram.org/api/folders#peer-folders) was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateFolderPeers +[Back to constructors index](index.md) + + + +The peer list of a [peer folder](https://core.telegram.org/api/folders#peer-folders) was updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_peers|Array of [FolderPeer](../types/FolderPeer.md) | Yes|New peer list| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateFolderPeers = ['_' => 'updateFolderPeers', 'folder_peers' => [FolderPeer, FolderPeer], 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateFolderPeers={_='updateFolderPeers', folder_peers={FolderPeer}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateGeoLiveViewed.md b/old_docs/API_docs_v44/constructors/updateGeoLiveViewed.md new file mode 100644 index 00000000..a070f428 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateGeoLiveViewed.md @@ -0,0 +1,39 @@ +--- +title: updateGeoLiveViewed +description: Live geoposition message was viewed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateGeoLiveViewed +[Back to constructors index](index.md) + + + +Live geoposition message was viewed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The user that viewed the live geoposition| +|msg\_id|[int](../types/int.md) | Yes|Message ID of geoposition message| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateGeoLiveViewed = ['_' => 'updateGeoLiveViewed', 'peer' => Peer, 'msg_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateGeoLiveViewed={_='updateGeoLiveViewed', peer=Peer, msg_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateInlineBotCallbackQuery.md b/old_docs/API_docs_v44/constructors/updateInlineBotCallbackQuery.md new file mode 100644 index 00000000..29393715 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateInlineBotCallbackQuery.md @@ -0,0 +1,43 @@ +--- +title: updateInlineBotCallbackQuery +description: This notification is received by bots when a button is pressed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateInlineBotCallbackQuery +[Back to constructors index](index.md) + + + +This notification is received by bots when a button is pressed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|ID of the user that pressed the button| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|ID of the inline message with the button| +|chat\_instance|[long](../types/long.md) | Yes|Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.| +|data|[bytes](../types/bytes.md) | Optional|Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.| +|game\_short\_name|[string](../types/string.md) | Optional|Short name of a Game to be returned, serves as the unique identifier for the game| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateInlineBotCallbackQuery = ['_' => 'updateInlineBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'msg_id' => InputBotInlineMessageID, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateInlineBotCallbackQuery={_='updateInlineBotCallbackQuery', query_id=long, user_id=int, msg_id=InputBotInlineMessageID, chat_instance=long, data='bytes', game_short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateLangPack.md b/old_docs/API_docs_v44/constructors/updateLangPack.md new file mode 100644 index 00000000..7d49b1c7 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateLangPack.md @@ -0,0 +1,38 @@ +--- +title: updateLangPack +description: Language pack updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPack +[Back to constructors index](index.md) + + + +Language pack updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|difference|[LangPackDifference](../types/LangPackDifference.md) | Yes|Changed strings| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLangPack = ['_' => 'updateLangPack', 'difference' => LangPackDifference]; +``` + + +Or, if you're into Lua: + +```lua +updateLangPack={_='updateLangPack', difference=LangPackDifference} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateLangPackTooLong.md b/old_docs/API_docs_v44/constructors/updateLangPackTooLong.md new file mode 100644 index 00000000..89888256 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateLangPackTooLong.md @@ -0,0 +1,38 @@ +--- +title: updateLangPackTooLong +description: A language pack has changed, the client should manually fetch the changed strings using [langpack.getDifference](../methods/langpack.getDifference.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPackTooLong +[Back to constructors index](index.md) + + + +A language pack has changed, the client should manually fetch the changed strings using [langpack.getDifference](../methods/langpack.getDifference.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLangPackTooLong = ['_' => 'updateLangPackTooLong', 'lang_code' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateLangPackTooLong={_='updateLangPackTooLong', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateLoginToken.md b/old_docs/API_docs_v44/constructors/updateLoginToken.md new file mode 100644 index 00000000..0baaac74 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateLoginToken.md @@ -0,0 +1,33 @@ +--- +title: updateLoginToken +description: A login token (for login via QR code) was accepted. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLoginToken +[Back to constructors index](index.md) + + + +A login token (for login via QR code) was accepted. + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLoginToken = ['_' => 'updateLoginToken']; +``` + + +Or, if you're into Lua: + +```lua +updateLoginToken={_='updateLoginToken'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateMessagePoll.md b/old_docs/API_docs_v44/constructors/updateMessagePoll.md new file mode 100644 index 00000000..747ad548 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateMessagePoll.md @@ -0,0 +1,40 @@ +--- +title: updateMessagePoll +description: The results of a poll have changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessagePoll +[Back to constructors index](index.md) + + + +The results of a poll have changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll\_id|[long](../types/long.md) | Yes|Poll ID| +|poll|[Poll](../types/Poll.md) | Optional|If the server knows the client hasn't cached this poll yet, the poll itself| +|results|[PollResults](../types/PollResults.md) | Yes|New poll results| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessagePoll = ['_' => 'updateMessagePoll', 'poll_id' => long, 'poll' => Poll, 'results' => PollResults]; +``` + + +Or, if you're into Lua: + +```lua +updateMessagePoll={_='updateMessagePoll', poll_id=long, poll=Poll, results=PollResults} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateMessagePollVote.md b/old_docs/API_docs_v44/constructors/updateMessagePollVote.md new file mode 100644 index 00000000..6853d241 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateMessagePollVote.md @@ -0,0 +1,40 @@ +--- +title: updateMessagePollVote +description: A specific user has voted in a poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessagePollVote +[Back to constructors index](index.md) + + + +A specific user has voted in a poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll\_id|[long](../types/long.md) | Yes|Poll ID| +|user\_id|[int](../types/int.md) | Yes|User ID| +|options|Array of [bytes](../types/bytes.md) | Yes|Chosen option(s)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessagePollVote = ['_' => 'updateMessagePollVote', 'poll_id' => long, 'user_id' => int, 'options' => ['bytes', 'bytes']]; +``` + + +Or, if you're into Lua: + +```lua +updateMessagePollVote={_='updateMessagePollVote', poll_id=long, user_id=int, options={'bytes'}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateNewAuthorization.md b/old_docs/API_docs_v44/constructors/updateNewAuthorization.md deleted file mode 100644 index 1370b025..00000000 --- a/old_docs/API_docs_v44/constructors/updateNewAuthorization.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: updateNewAuthorization -description: Update new authorization -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: updateNewAuthorization -[Back to constructors index](index.md) - - - -Update new authorization - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|auth\_key\_id|[long](../types/long.md) | Yes|Auth key ID| -|date|[int](../types/int.md) | Yes|Date| -|device|[string](../types/string.md) | Yes|Device| -|location|[string](../types/string.md) | Yes|Location| - - - -### Type: [Update](../types/Update.md) - - -### Example: - -```php -$updateNewAuthorization = ['_' => 'updateNewAuthorization', 'auth_key_id' => long, 'date' => int, 'device' => 'string', 'location' => 'string']; -``` - - -Or, if you're into Lua: - -```lua -updateNewAuthorization={_='updateNewAuthorization', auth_key_id=long, date=int, device='string', location='string'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/updateNewScheduledMessage.md b/old_docs/API_docs_v44/constructors/updateNewScheduledMessage.md new file mode 100644 index 00000000..feecd600 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateNewScheduledMessage.md @@ -0,0 +1,38 @@ +--- +title: updateNewScheduledMessage +description: New incoming scheduled message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewScheduledMessage +[Back to constructors index](index.md) + + + +New incoming scheduled message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|Message| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewScheduledMessage = ['_' => 'updateNewScheduledMessage', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +updateNewScheduledMessage={_='updateNewScheduledMessage', message=Message} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateNotifySettings.md b/old_docs/API_docs_v44/constructors/updateNotifySettings.md index 1a4a7223..b28cc1c4 100644 --- a/old_docs/API_docs_v44/constructors/updateNotifySettings.md +++ b/old_docs/API_docs_v44/constructors/updateNotifySettings.md @@ -15,7 +15,7 @@ Changes in notification settings. | Name | Type | Required | Description | |----------|---------------|----------|-------------| |peer|[NotifyPeer](../types/NotifyPeer.md) | Yes|Nofication source| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|New notification settings| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|New notification settings| diff --git a/old_docs/API_docs_v44/constructors/updatePeerLocated.md b/old_docs/API_docs_v44/constructors/updatePeerLocated.md new file mode 100644 index 00000000..d4d3b9b9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePeerLocated.md @@ -0,0 +1,38 @@ +--- +title: updatePeerLocated +description: List of peers near you was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePeerLocated +[Back to constructors index](index.md) + + + +List of peers near you was updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [PeerLocated](../types/PeerLocated.md) | Yes|Geolocated peer list update| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePeerLocated = ['_' => 'updatePeerLocated', 'peers' => [PeerLocated, PeerLocated]]; +``` + + +Or, if you're into Lua: + +```lua +updatePeerLocated={_='updatePeerLocated', peers={PeerLocated}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updatePeerSettings.md b/old_docs/API_docs_v44/constructors/updatePeerSettings.md new file mode 100644 index 00000000..ce0641f1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePeerSettings.md @@ -0,0 +1,39 @@ +--- +title: updatePeerSettings +description: Settings of a certain peer have changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePeerSettings +[Back to constructors index](index.md) + + + +Settings of a certain peer have changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The peer| +|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Associated peer settings| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePeerSettings = ['_' => 'updatePeerSettings', 'peer' => Peer, 'settings' => PeerSettings]; +``` + + +Or, if you're into Lua: + +```lua +updatePeerSettings={_='updatePeerSettings', peer=Peer, settings=PeerSettings} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updatePhoneCall.md b/old_docs/API_docs_v44/constructors/updatePhoneCall.md new file mode 100644 index 00000000..af896d0d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePhoneCall.md @@ -0,0 +1,38 @@ +--- +title: updatePhoneCall +description: An incoming phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePhoneCall +[Back to constructors index](index.md) + + + +An incoming phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional|Phone call| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePhoneCall = ['_' => 'updatePhoneCall', 'phone_call' => PhoneCall]; +``` + + +Or, if you're into Lua: + +```lua +updatePhoneCall={_='updatePhoneCall', phone_call=PhoneCall} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updatePhoneCallSignalingData.md b/old_docs/API_docs_v44/constructors/updatePhoneCallSignalingData.md new file mode 100644 index 00000000..7e4bd94b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePhoneCallSignalingData.md @@ -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'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updatePinnedDialogs.md b/old_docs/API_docs_v44/constructors/updatePinnedDialogs.md new file mode 100644 index 00000000..eb5f78f2 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePinnedDialogs.md @@ -0,0 +1,39 @@ +--- +title: updatePinnedDialogs +description: Pinned dialogs were updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePinnedDialogs +[Back to constructors index](index.md) + + + +Pinned dialogs were updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| +|order|Array of [DialogPeer](../types/DialogPeer.md) | Optional|New order of pinned dialogs| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePinnedDialogs = ['_' => 'updatePinnedDialogs', 'folder_id' => int, 'order' => [DialogPeer, DialogPeer]]; +``` + + +Or, if you're into Lua: + +```lua +updatePinnedDialogs={_='updatePinnedDialogs', folder_id=int, order={DialogPeer}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updatePrivacy.md b/old_docs/API_docs_v44/constructors/updatePrivacy.md index 521b9735..3d32ca56 100644 --- a/old_docs/API_docs_v44/constructors/updatePrivacy.md +++ b/old_docs/API_docs_v44/constructors/updatePrivacy.md @@ -15,7 +15,7 @@ Privacy rules were changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| |key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Peers to which the privacy rules apply| -|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|New privacy rules| diff --git a/old_docs/API_docs_v44/constructors/updatePtsChanged.md b/old_docs/API_docs_v44/constructors/updatePtsChanged.md new file mode 100644 index 00000000..a240eb83 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updatePtsChanged.md @@ -0,0 +1,33 @@ +--- +title: updatePtsChanged +description: [Common message box sequence PTS](https://core.telegram.org/api/updates) has changed, [state has to be refetched using updates.getState](https://core.telegram.org/api/updates#fetching-state) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePtsChanged +[Back to constructors index](index.md) + + + +[Common message box sequence PTS](https://core.telegram.org/api/updates) has changed, [state has to be refetched using updates.getState](https://core.telegram.org/api/updates#fetching-state) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePtsChanged = ['_' => 'updatePtsChanged']; +``` + + +Or, if you're into Lua: + +```lua +updatePtsChanged={_='updatePtsChanged'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateReadChannelInbox.md b/old_docs/API_docs_v44/constructors/updateReadChannelInbox.md index c7a56d58..343349ab 100644 --- a/old_docs/API_docs_v44/constructors/updateReadChannelInbox.md +++ b/old_docs/API_docs_v44/constructors/updateReadChannelInbox.md @@ -14,8 +14,11 @@ Incoming messages in a [channel/supergroup](https://core.telegram.org/api/channe | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| |channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| |max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|still\_unread\_count|[int](../types/int.md) | Yes|Count of messages weren't read yet| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| @@ -25,14 +28,14 @@ Incoming messages in a [channel/supergroup](https://core.telegram.org/api/channe ### Example: ```php -$updateReadChannelInbox = ['_' => 'updateReadChannelInbox', 'channel_id' => int, 'max_id' => int]; +$updateReadChannelInbox = ['_' => 'updateReadChannelInbox', 'folder_id' => int, 'channel_id' => int, 'max_id' => int, 'still_unread_count' => int, 'pts' => int]; ``` Or, if you're into Lua: ```lua -updateReadChannelInbox={_='updateReadChannelInbox', channel_id=int, max_id=int} +updateReadChannelInbox={_='updateReadChannelInbox', folder_id=int, channel_id=int, max_id=int, still_unread_count=int, pts=int} ``` diff --git a/old_docs/API_docs_v44/constructors/updateReadChannelOutbox.md b/old_docs/API_docs_v44/constructors/updateReadChannelOutbox.md new file mode 100644 index 00000000..7272c0e4 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateReadChannelOutbox.md @@ -0,0 +1,39 @@ +--- +title: updateReadChannelOutbox +description: Outgoing messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelOutbox +[Back to constructors index](index.md) + + + +Outgoing messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadChannelOutbox = ['_' => 'updateReadChannelOutbox', 'channel_id' => int, 'max_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadChannelOutbox={_='updateReadChannelOutbox', channel_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateReadFeaturedStickers.md b/old_docs/API_docs_v44/constructors/updateReadFeaturedStickers.md new file mode 100644 index 00000000..f95a3f8c --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateReadFeaturedStickers.md @@ -0,0 +1,33 @@ +--- +title: updateReadFeaturedStickers +description: Some featured stickers were marked as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadFeaturedStickers +[Back to constructors index](index.md) + + + +Some featured stickers were marked as read + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadFeaturedStickers = ['_' => 'updateReadFeaturedStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateReadFeaturedStickers={_='updateReadFeaturedStickers'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateReadHistoryInbox.md b/old_docs/API_docs_v44/constructors/updateReadHistoryInbox.md index 8c12699d..4e231c31 100644 --- a/old_docs/API_docs_v44/constructors/updateReadHistoryInbox.md +++ b/old_docs/API_docs_v44/constructors/updateReadHistoryInbox.md @@ -14,8 +14,10 @@ Incoming messages were read | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| |peer|[Peer](../types/Peer.md) | Yes|Peer| |max\_id|[int](../types/int.md) | Yes|Maximum ID of messages read| +|still\_unread\_count|[int](../types/int.md) | Yes|Number of messages that are still unread| |pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| @@ -27,14 +29,14 @@ Incoming messages were read ### Example: ```php -$updateReadHistoryInbox = ['_' => 'updateReadHistoryInbox', 'peer' => Peer, 'max_id' => int, 'pts' => int, 'pts_count' => int]; +$updateReadHistoryInbox = ['_' => 'updateReadHistoryInbox', 'folder_id' => int, 'peer' => Peer, 'max_id' => int, 'still_unread_count' => int, 'pts' => int, 'pts_count' => int]; ``` Or, if you're into Lua: ```lua -updateReadHistoryInbox={_='updateReadHistoryInbox', peer=Peer, max_id=int, pts=int, pts_count=int} +updateReadHistoryInbox={_='updateReadHistoryInbox', folder_id=int, peer=Peer, max_id=int, still_unread_count=int, pts=int, pts_count=int} ``` diff --git a/old_docs/API_docs_v44/constructors/updateReadMessagesContents.md b/old_docs/API_docs_v44/constructors/updateReadMessagesContents.md index 42d2691d..3203780f 100644 --- a/old_docs/API_docs_v44/constructors/updateReadMessagesContents.md +++ b/old_docs/API_docs_v44/constructors/updateReadMessagesContents.md @@ -14,7 +14,7 @@ Contents of messages in the common [message box](https://core.telegram.org/api/u | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|messages|Array of [int](../types/int.md) | Yes|Messages| +|messages|Array of [int](../types/int.md) | Yes|IDs of read messages| |pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| diff --git a/old_docs/API_docs_v44/constructors/updateRecentStickers.md b/old_docs/API_docs_v44/constructors/updateRecentStickers.md new file mode 100644 index 00000000..d588d7e3 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateRecentStickers.md @@ -0,0 +1,33 @@ +--- +title: updateRecentStickers +description: The recent sticker list was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateRecentStickers +[Back to constructors index](index.md) + + + +The recent sticker list was updated + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateRecentStickers = ['_' => 'updateRecentStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateRecentStickers={_='updateRecentStickers'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateSavedGifs.md b/old_docs/API_docs_v44/constructors/updateSavedGifs.md new file mode 100644 index 00000000..4187c414 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateSavedGifs.md @@ -0,0 +1,33 @@ +--- +title: updateSavedGifs +description: The saved gif list has changed, the client should refetch it using [messages.getSavedGifs](https://core.telegram.org/method/messages.getSavedGifs) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateSavedGifs +[Back to constructors index](index.md) + + + +The saved gif list has changed, the client should refetch it using [messages.getSavedGifs](https://core.telegram.org/method/messages.getSavedGifs) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateSavedGifs = ['_' => 'updateSavedGifs']; +``` + + +Or, if you're into Lua: + +```lua +updateSavedGifs={_='updateSavedGifs'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateServiceNotification.md b/old_docs/API_docs_v44/constructors/updateServiceNotification.md index 16ac43c4..5e16ab4f 100644 --- a/old_docs/API_docs_v44/constructors/updateServiceNotification.md +++ b/old_docs/API_docs_v44/constructors/updateServiceNotification.md @@ -18,10 +18,12 @@ The app must show the message to the user upon receiving this update. In case th | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|popup|[Bool](../types/Bool.md) | Optional|(boolTrue) if the message must be displayed in a popup.| +|inbox\_date|[int](../types/int.md) | Optional|When was the notification received
The message must also be stored locally as part of the message history with the user id `777000` (Telegram Notifications).| |type|[string](../types/string.md) | Yes|String, identical in format and contents to the [**type**](https://core.telegram.org/api/errors#error-type) field in API errors. Describes type of service message. It is acceptable to ignore repeated messages of the same **type** within a short period of time (15 minutes).| |message|[string](../types/string.md) | Yes|Message text| |media|[MessageMedia](../types/MessageMedia.md) | Optional|Media content (optional)| -|popup|[Bool](../types/Bool.md) | Yes|Popup?| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|[Message entities for styled text](https://core.telegram.org/api/entities)| @@ -31,14 +33,14 @@ The app must show the message to the user upon receiving this update. In case th ### Example: ```php -$updateServiceNotification = ['_' => 'updateServiceNotification', 'type' => 'string', 'message' => 'string', 'media' => MessageMedia, 'popup' => Bool]; +$updateServiceNotification = ['_' => 'updateServiceNotification', 'popup' => Bool, 'inbox_date' => int, 'type' => 'string', 'message' => 'string', 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateServiceNotification={_='updateServiceNotification', type='string', message='string', media=MessageMedia, popup=Bool} +updateServiceNotification={_='updateServiceNotification', popup=Bool, inbox_date=int, type='string', message='string', media=MessageMedia, entities={MessageEntity}} ``` diff --git a/old_docs/API_docs_v44/constructors/updateShortChatMessage.md b/old_docs/API_docs_v44/constructors/updateShortChatMessage.md index b57547cc..81ee36e7 100644 --- a/old_docs/API_docs_v44/constructors/updateShortChatMessage.md +++ b/old_docs/API_docs_v44/constructors/updateShortChatMessage.md @@ -14,10 +14,10 @@ Shortened constructor containing info on one new incoming text message from a ch | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Unread?| |out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| |mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in this message| |media\_unread|[Bool](../types/Bool.md) | Optional|Whether the message contains some **unread** mentions| +|silent|[Bool](../types/Bool.md) | Optional|If true, the message is a silent message, no notifications should be triggered| |id|[int](../types/int.md) | Yes|ID of the message| |from\_id|[int](../types/int.md) | Yes|ID of the sender of the message| |chat\_id|[int](../types/int.md) | Yes|ID of the chat where the message was sent| @@ -25,10 +25,10 @@ Shortened constructor containing info on one new incoming text message from a ch |pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| |date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| -|fwd\_from\_id|[Peer](../types/Peer.md) | Optional|Fwd from ID| -|fwd\_date|[int](../types/int.md) | Optional|Fwd date| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| +|via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| |reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Entities](https://core.telegram.org/api/entities) for styled text| @@ -38,14 +38,14 @@ Shortened constructor containing info on one new incoming text message from a ch ### Example: ```php -$updateShortChatMessage = ['_' => 'updateShortChatMessage', 'unread' => Bool, 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'id' => int, 'from_id' => int, 'chat_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from_id' => Peer, 'fwd_date' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +$updateShortChatMessage = ['_' => 'updateShortChatMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'from_id' => int, 'chat_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateShortChatMessage={_='updateShortChatMessage', unread=Bool, out=Bool, mentioned=Bool, media_unread=Bool, id=int, from_id=int, chat_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from_id=Peer, fwd_date=int, reply_to_msg_id=int, entities={MessageEntity}} +updateShortChatMessage={_='updateShortChatMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, from_id=int, chat_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} ``` diff --git a/old_docs/API_docs_v44/constructors/updateShortMessage.md b/old_docs/API_docs_v44/constructors/updateShortMessage.md index f5b883ac..29cfb3c4 100644 --- a/old_docs/API_docs_v44/constructors/updateShortMessage.md +++ b/old_docs/API_docs_v44/constructors/updateShortMessage.md @@ -14,20 +14,20 @@ Info about a message sent to (received from) another user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Unread?| |out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| |mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in the message| |media\_unread|[Bool](../types/Bool.md) | Optional|Whether there are some **unread** mentions in this message| +|silent|[Bool](../types/Bool.md) | Optional|If true, the message is a silent message, no notifications should be triggered| |id|[int](../types/int.md) | Yes|The message ID| |user\_id|[int](../types/int.md) | Yes|The ID of the sender (if `outgoing` will be the ID of the destination) of the message| |message|[string](../types/string.md) | Yes|The message| |pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| |date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| -|fwd\_from\_id|[Peer](../types/Peer.md) | Optional|Fwd from ID| -|fwd\_date|[int](../types/int.md) | Optional|Fwd date| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| +|via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| |reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Entities](https://core.telegram.org/api/entities) for styled text| @@ -37,14 +37,14 @@ Info about a message sent to (received from) another user ### Example: ```php -$updateShortMessage = ['_' => 'updateShortMessage', 'unread' => Bool, 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'id' => int, 'user_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from_id' => Peer, 'fwd_date' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +$updateShortMessage = ['_' => 'updateShortMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'user_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateShortMessage={_='updateShortMessage', unread=Bool, out=Bool, mentioned=Bool, media_unread=Bool, id=int, user_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from_id=Peer, fwd_date=int, reply_to_msg_id=int, entities={MessageEntity}} +updateShortMessage={_='updateShortMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, user_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} ``` diff --git a/old_docs/API_docs_v44/constructors/updateShortSentMessage.md b/old_docs/API_docs_v44/constructors/updateShortSentMessage.md index ca9a59eb..9404d568 100644 --- a/old_docs/API_docs_v44/constructors/updateShortSentMessage.md +++ b/old_docs/API_docs_v44/constructors/updateShortSentMessage.md @@ -14,14 +14,13 @@ Shortened constructor containing info on one outgoing message to a contact (the | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Unread?| |out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| |id|[int](../types/int.md) | Yes|ID of the sent message| |pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| |pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| |date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| |media|[MessageMedia](../types/MessageMedia.md) | Optional|Attached media| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Entities](https://core.telegram.org/api/entities) for styled text| @@ -31,14 +30,14 @@ Shortened constructor containing info on one outgoing message to a contact (the ### Example: ```php -$updateShortSentMessage = ['_' => 'updateShortSentMessage', 'unread' => Bool, 'out' => Bool, 'id' => int, 'pts' => int, 'pts_count' => int, 'date' => int, 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; +$updateShortSentMessage = ['_' => 'updateShortSentMessage', 'out' => Bool, 'id' => int, 'pts' => int, 'pts_count' => int, 'date' => int, 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; ``` Or, if you're into Lua: ```lua -updateShortSentMessage={_='updateShortSentMessage', unread=Bool, out=Bool, id=int, pts=int, pts_count=int, date=int, media=MessageMedia, entities={MessageEntity}} +updateShortSentMessage={_='updateShortSentMessage', out=Bool, id=int, pts=int, pts_count=int, date=int, media=MessageMedia, entities={MessageEntity}} ``` diff --git a/old_docs/API_docs_v44/constructors/updateStickerSetsOrder.md b/old_docs/API_docs_v44/constructors/updateStickerSetsOrder.md index f6192a77..9d5064ef 100644 --- a/old_docs/API_docs_v44/constructors/updateStickerSetsOrder.md +++ b/old_docs/API_docs_v44/constructors/updateStickerSetsOrder.md @@ -14,7 +14,8 @@ The order of stickersets was changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|Order| +|masks|[Bool](../types/Bool.md) | Optional|Whether the updated stickers are mask stickers| +|order|Array of [long](../types/long.md) | Yes|New sticker order by sticker ID| @@ -24,14 +25,14 @@ The order of stickersets was changed ### Example: ```php -$updateStickerSetsOrder = ['_' => 'updateStickerSetsOrder', 'order' => [long, long]]; +$updateStickerSetsOrder = ['_' => 'updateStickerSetsOrder', 'masks' => Bool, 'order' => [long, long]]; ``` Or, if you're into Lua: ```lua -updateStickerSetsOrder={_='updateStickerSetsOrder', order={long}} +updateStickerSetsOrder={_='updateStickerSetsOrder', masks=Bool, order={long}} ``` diff --git a/old_docs/API_docs_v44/constructors/updateTheme.md b/old_docs/API_docs_v44/constructors/updateTheme.md new file mode 100644 index 00000000..c638e434 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateTheme.md @@ -0,0 +1,38 @@ +--- +title: updateTheme +description: A cloud theme was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateTheme +[Back to constructors index](index.md) + + + +A cloud theme was updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|theme|[Theme](../types/Theme.md) | Yes|Theme| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateTheme = ['_' => 'updateTheme', 'theme' => Theme]; +``` + + +Or, if you're into Lua: + +```lua +updateTheme={_='updateTheme', theme=Theme} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updateUserPinnedMessage.md b/old_docs/API_docs_v44/constructors/updateUserPinnedMessage.md new file mode 100644 index 00000000..2187c87a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updateUserPinnedMessage.md @@ -0,0 +1,39 @@ +--- +title: updateUserPinnedMessage +description: A message was pinned in a private chat with a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a private chat with a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User that pinned the message| +|id|[int](../types/int.md) | Yes|Message ID that was pinned| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserPinnedMessage = ['_' => 'updateUserPinnedMessage', 'user_id' => int, 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateUserPinnedMessage={_='updateUserPinnedMessage', user_id=int, id=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updates.channelDifferenceTooLong.md b/old_docs/API_docs_v44/constructors/updates.channelDifferenceTooLong.md index 1e267644..21b49a24 100644 --- a/old_docs/API_docs_v44/constructors/updates.channelDifferenceTooLong.md +++ b/old_docs/API_docs_v44/constructors/updates.channelDifferenceTooLong.md @@ -26,16 +26,11 @@ The provided `pts + limit < remote pts`. Simply, there are too many updates to b | Name | Type | Required | Description | |----------|---------------|----------|-------------| |final|[Bool](../types/Bool.md) | Optional|Whether there are more updates that must be fetched (always false)| -|pts|[int](../types/int.md) | Yes|Pts| |timeout|[int](../types/int.md) | Optional|Clients are supposed to refetch the channel difference after timeout seconds have elapsed| -|top\_message|[int](../types/int.md) | Yes|Top message| -|top\_important\_message|[int](../types/int.md) | Yes|Top important message| -|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Read inbox max ID| -|unread\_count|[int](../types/int.md) | Yes|Unread count| -|unread\_important\_count|[int](../types/int.md) | Yes|Unread important count| -|messages|Array of [Message](../types/Message.md) | Yes|Messages| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|dialog|[Dialog](../types/Dialog.md) | Yes|Dialog containing the latest [PTS](https://core.telegram.org/api/updates) that can be used to reset the channel state| +|messages|Array of [Message](../types/Message.md) | Yes|The latest messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats from messages| +|users|Array of [User](../types/User.md) | Yes|Users from messages| @@ -45,14 +40,14 @@ The provided `pts + limit < remote pts`. Simply, there are too many updates to b ### Example: ```php -$updates.channelDifferenceTooLong = ['_' => 'updates.channelDifferenceTooLong', 'final' => Bool, 'pts' => int, 'timeout' => int, 'top_message' => int, 'top_important_message' => int, 'read_inbox_max_id' => int, 'unread_count' => int, 'unread_important_count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +$updates.channelDifferenceTooLong = ['_' => 'updates.channelDifferenceTooLong', 'final' => Bool, 'timeout' => int, 'dialog' => Dialog, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; ``` Or, if you're into Lua: ```lua -updates.channelDifferenceTooLong={_='updates.channelDifferenceTooLong', final=Bool, pts=int, timeout=int, top_message=int, top_important_message=int, read_inbox_max_id=int, unread_count=int, unread_important_count=int, messages={Message}, chats={Chat}, users={User}} +updates.channelDifferenceTooLong={_='updates.channelDifferenceTooLong', final=Bool, timeout=int, dialog=Dialog, messages={Message}, chats={Chat}, users={User}} ``` diff --git a/old_docs/API_docs_v44/constructors/updates.difference.md b/old_docs/API_docs_v44/constructors/updates.difference.md index 2533ef1c..f055264d 100644 --- a/old_docs/API_docs_v44/constructors/updates.difference.md +++ b/old_docs/API_docs_v44/constructors/updates.difference.md @@ -15,11 +15,11 @@ Full list of occurred events. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|new\_messages|Array of [Message](../types/Message.md) | Yes|New messages| -|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|New encrypted messages| -|other\_updates|Array of [Update](../types/Update.md) | Yes|Other updates| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|new\_messages|Array of [Message](../types/Message.md) | Yes|List of new messages| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|List of new encrypted secret chat messages| +|other\_updates|Array of [Update](../types/Update.md) | Yes|List of updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in events| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in events| |state|[updates.State](../constructors/updates.State.md) | Yes|Current state| diff --git a/old_docs/API_docs_v44/constructors/updates.differenceSlice.md b/old_docs/API_docs_v44/constructors/updates.differenceSlice.md index 22644341..3c0aa023 100644 --- a/old_docs/API_docs_v44/constructors/updates.differenceSlice.md +++ b/old_docs/API_docs_v44/constructors/updates.differenceSlice.md @@ -15,11 +15,11 @@ Incomplete list of occurred events. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|new\_messages|Array of [Message](../types/Message.md) | Yes|New messages| -|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|New encrypted messages| -|other\_updates|Array of [Update](../types/Update.md) | Yes|Other updates| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| -|users|Array of [User](../types/User.md) | Yes|Users| +|new\_messages|Array of [Message](../types/Message.md) | Yes|List of new messgaes| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|New messages from the [encrypted event sequence](https://core.telegram.org/api/updates)| +|other\_updates|Array of [Update](../types/Update.md) | Yes|List of updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in events| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in events| |intermediate\_state|[updates.State](../constructors/updates.State.md) | Yes|Intermediary state| diff --git a/old_docs/API_docs_v44/constructors/updates.differenceTooLong.md b/old_docs/API_docs_v44/constructors/updates.differenceTooLong.md new file mode 100644 index 00000000..5bb17a0e --- /dev/null +++ b/old_docs/API_docs_v44/constructors/updates.differenceTooLong.md @@ -0,0 +1,39 @@ +--- +title: updates.differenceTooLong +description: The difference is [too long](https://core.telegram.org/api/updates#recovering-gaps), and the specified state must be used to refetch updates. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_differenceTooLong.html +--- +# Constructor: updates.differenceTooLong +[Back to constructors index](index.md) + + + +The difference is [too long](https://core.telegram.org/api/updates#recovering-gaps), and the specified state must be used to refetch updates. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pts|[int](../types/int.md) | Yes|The new state to use.| + + + +### Type: [updates.Difference](../types/updates.Difference.md) + + +### Example: + +```php +$updates.differenceTooLong = ['_' => 'updates.differenceTooLong', 'pts' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates.differenceTooLong={_='updates.differenceTooLong', pts=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/updates.md b/old_docs/API_docs_v44/constructors/updates.md index b09d8a07..14fb038c 100644 --- a/old_docs/API_docs_v44/constructors/updates.md +++ b/old_docs/API_docs_v44/constructors/updates.md @@ -14,9 +14,9 @@ Full constructor of updates | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|updates|Array of [Update](../types/Update.md) | Yes|Updates| -|users|Array of [User](../types/User.md) | Yes|Users| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|updates|Array of [Update](../types/Update.md) | Yes|List of updates| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in updates| |date|[int](../types/int.md) | Yes|Current date| |seq|[int](../types/int.md) | Yes|Total number of sent updates| diff --git a/old_docs/API_docs_v44/constructors/updatesCombined.md b/old_docs/API_docs_v44/constructors/updatesCombined.md index b4056d77..83141652 100644 --- a/old_docs/API_docs_v44/constructors/updatesCombined.md +++ b/old_docs/API_docs_v44/constructors/updatesCombined.md @@ -14,9 +14,9 @@ Constructor for a group of updates. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|updates|Array of [Update](../types/Update.md) | Yes|Updates| -|users|Array of [User](../types/User.md) | Yes|Users| -|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|updates|Array of [Update](../types/Update.md) | Yes|List of updates| +|users|Array of [User](../types/User.md) | Yes|List of users mentioned in updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|List of chats mentioned in updates| |date|[int](../types/int.md) | Yes|Current date| |seq\_start|[int](../types/int.md) | Yes|Value **seq** for the earliest update in a group| |seq|[int](../types/int.md) | Yes|Value **seq** for the latest update in a group| diff --git a/old_docs/API_docs_v44/constructors/upload.cdnFile.md b/old_docs/API_docs_v44/constructors/upload.cdnFile.md new file mode 100644 index 00000000..e600415b --- /dev/null +++ b/old_docs/API_docs_v44/constructors/upload.cdnFile.md @@ -0,0 +1,39 @@ +--- +title: upload.cdnFile +description: Represent a chunk of a [CDN](https://core.telegram.org/cdn) file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_cdnFile.html +--- +# Constructor: upload.cdnFile +[Back to constructors index](index.md) + + + +Represent a chunk of a [CDN](https://core.telegram.org/cdn) file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bytes|[bytes](../types/bytes.md) | Yes|The data| + + + +### Type: [upload.CdnFile](../types/upload.CdnFile.md) + + +### Example: + +```php +$upload.cdnFile = ['_' => 'upload.cdnFile', 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.cdnFile={_='upload.cdnFile', bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/upload.cdnFileReuploadNeeded.md b/old_docs/API_docs_v44/constructors/upload.cdnFileReuploadNeeded.md new file mode 100644 index 00000000..a9fa41c9 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/upload.cdnFileReuploadNeeded.md @@ -0,0 +1,39 @@ +--- +title: upload.cdnFileReuploadNeeded +description: The file was cleared from the temporary RAM cache of the [CDN](https://core.telegram.org/cdn) and has to be reuploaded. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_cdnFileReuploadNeeded.html +--- +# Constructor: upload.cdnFileReuploadNeeded +[Back to constructors index](index.md) + + + +The file was cleared from the temporary RAM cache of the [CDN](https://core.telegram.org/cdn) and has to be reuploaded. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_token|[bytes](../types/bytes.md) | Yes|Request token (see [CDN](https://core.telegram.org/cdn))| + + + +### Type: [upload.CdnFile](../types/upload.CdnFile.md) + + +### Example: + +```php +$upload.cdnFileReuploadNeeded = ['_' => 'upload.cdnFileReuploadNeeded', 'request_token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.cdnFileReuploadNeeded={_='upload.cdnFileReuploadNeeded', request_token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/upload.fileCdnRedirect.md b/old_docs/API_docs_v44/constructors/upload.fileCdnRedirect.md new file mode 100644 index 00000000..904d13e1 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/upload.fileCdnRedirect.md @@ -0,0 +1,43 @@ +--- +title: upload.fileCdnRedirect +description: The file must be downloaded from a [CDN DC](https://core.telegram.org/cdn). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_fileCdnRedirect.html +--- +# Constructor: upload.fileCdnRedirect +[Back to constructors index](index.md) + + + +The file must be downloaded from a [CDN DC](https://core.telegram.org/cdn). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|[CDN DC](https://core.telegram.org/cdn) ID| +|file\_token|[bytes](../types/bytes.md) | Yes|File token (see [CDN files](https://core.telegram.org/cdn))| +|encryption\_key|[bytes](../types/bytes.md) | Yes|Encryption key (see [CDN files](https://core.telegram.org/cdn))| +|encryption\_iv|[bytes](../types/bytes.md) | Yes|Encryption IV (see [CDN files](https://core.telegram.org/cdn))| +|file\_hashes|Array of [FileHash](../types/FileHash.md) | Yes|File hashes (see [CDN files](https://core.telegram.org/cdn))| + + + +### Type: [upload.File](../types/upload.File.md) + + +### Example: + +```php +$upload.fileCdnRedirect = ['_' => 'upload.fileCdnRedirect', 'dc_id' => int, 'file_token' => 'bytes', 'encryption_key' => 'bytes', 'encryption_iv' => 'bytes', 'file_hashes' => [FileHash, FileHash]]; +``` + + +Or, if you're into Lua: + +```lua +upload.fileCdnRedirect={_='upload.fileCdnRedirect', dc_id=int, file_token='bytes', encryption_key='bytes', encryption_iv='bytes', file_hashes={FileHash}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/upload.webFile.md b/old_docs/API_docs_v44/constructors/upload.webFile.md new file mode 100644 index 00000000..1b7f90ca --- /dev/null +++ b/old_docs/API_docs_v44/constructors/upload.webFile.md @@ -0,0 +1,43 @@ +--- +title: upload.webFile +description: Represents a chunk of an [HTTP webfile](https://core.telegram.org/api/files) downloaded through telegram's secure MTProto servers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_webFile.html +--- +# Constructor: upload.webFile +[Back to constructors index](index.md) + + + +Represents a chunk of an [HTTP webfile](https://core.telegram.org/api/files) downloaded through telegram's secure MTProto servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|Mime type| +|file\_type|[storage.FileType](../constructors/storage.FileType.md) | Yes|File type| +|mtime|[int](../types/int.md) | Yes|Modified time| +|bytes|[bytes](../types/bytes.md) | Yes|Data| + + + +### Type: [upload.WebFile](../types/upload.WebFile.md) + + +### Example: + +```php +$upload.webFile = ['_' => 'upload.webFile', 'size' => int, 'mime_type' => 'string', 'file_type' => storage.FileType, 'mtime' => int, 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.webFile={_='upload.webFile', size=int, mime_type='string', file_type=storage.FileType, mtime=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/urlAuthResultAccepted.md b/old_docs/API_docs_v44/constructors/urlAuthResultAccepted.md new file mode 100644 index 00000000..a634343a --- /dev/null +++ b/old_docs/API_docs_v44/constructors/urlAuthResultAccepted.md @@ -0,0 +1,38 @@ +--- +title: urlAuthResultAccepted +description: Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultAccepted +[Back to constructors index](index.md) + + + +Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|The URL name of the website on which the user has logged in.| + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultAccepted = ['_' => 'urlAuthResultAccepted', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultAccepted={_='urlAuthResultAccepted', url='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/urlAuthResultDefault.md b/old_docs/API_docs_v44/constructors/urlAuthResultDefault.md new file mode 100644 index 00000000..976d2da0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/urlAuthResultDefault.md @@ -0,0 +1,33 @@ +--- +title: urlAuthResultDefault +description: Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultDefault +[Back to constructors index](index.md) + + + +Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultDefault = ['_' => 'urlAuthResultDefault']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultDefault={_='urlAuthResultDefault'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/urlAuthResultRequest.md b/old_docs/API_docs_v44/constructors/urlAuthResultRequest.md new file mode 100644 index 00000000..b14730da --- /dev/null +++ b/old_docs/API_docs_v44/constructors/urlAuthResultRequest.md @@ -0,0 +1,40 @@ +--- +title: urlAuthResultRequest +description: Details about the authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultRequest +[Back to constructors index](index.md) + + + +Details about the authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_write\_access|[Bool](../types/Bool.md) | Optional|Whether the bot would like to send messages to the user| +|bot|[User](../types/User.md) | Optional|Username of a bot, which will be used for user authorization. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details.| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user will log in.| + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultRequest = ['_' => 'urlAuthResultRequest', 'request_write_access' => Bool, 'bot' => User, 'domain' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultRequest={_='urlAuthResultRequest', request_write_access=Bool, bot=User, domain='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/user.md b/old_docs/API_docs_v44/constructors/user.md index 276dbaca..ca3c124c 100644 --- a/old_docs/API_docs_v44/constructors/user.md +++ b/old_docs/API_docs_v44/constructors/user.md @@ -23,6 +23,11 @@ Indicates info about a certain user |bot\_nochats|[Bool](../types/Bool.md) | Optional|Can the bot be added to groups?| |verified|[Bool](../types/Bool.md) | Optional|Whether this user is verified| |restricted|[Bool](../types/Bool.md) | Optional|Access to this user must be restricted for the reason specified in `restriction_reason`| +|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)| +|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional|Whether the bot can request our geolocation in inline mode| +|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| @@ -32,7 +37,9 @@ Indicates info about a certain user |photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional|Profile picture of user| |status|[UserStatus](../types/UserStatus.md) | Optional|Online status of user| |bot\_info\_version|[int](../types/int.md) | Optional|Version of the [bot\_info field in userFull](../constructors/userFull.md), incremented every time it changes| -|restiction\_reason|[string](../types/string.md) | Optional|Restiction reason| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Contains the reason why access to this user must be restricted.| +|bot\_inline\_placeholder|[string](../types/string.md) | Optional|Inline placeholder for this inline bot| +|lang\_code|[string](../types/string.md) | Optional|Language code of the user| @@ -42,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, 'id' => int, 'access_hash' => long, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string', 'phone' => 'string', 'photo' => UserProfilePhoto, 'status' => UserStatus, 'bot_info_version' => int, 'restiction_reason' => '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, id=int, access_hash=long, first_name='string', last_name='string', username='string', phone='string', photo=UserProfilePhoto, status=UserStatus, bot_info_version=int, restiction_reason='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'} ``` diff --git a/old_docs/API_docs_v44/constructors/userFull.md b/old_docs/API_docs_v44/constructors/userFull.md index 129a02d0..675a671c 100644 --- a/old_docs/API_docs_v44/constructors/userFull.md +++ b/old_docs/API_docs_v44/constructors/userFull.md @@ -14,12 +14,21 @@ Extended user info | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|blocked|[Bool](../types/Bool.md) | Optional|Whether you have blocked this user| +|phone\_calls\_available|[Bool](../types/Bool.md) | Optional|Whether this user can make VoIP calls| +|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| -|link|[contacts.Link](../constructors/contacts.Link.md) | Yes|Link| +|about|[string](../types/string.md) | Optional|Bio of the user| +|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Peer settings| |profile\_photo|[Photo](../types/Photo.md) | Optional|Profile photo| -|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Optional|Notification settings| -|blocked|[Bool](../types/Bool.md) | Yes|Blocked?| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| |bot\_info|[BotInfo](../types/BotInfo.md) | Optional|For bots, info about the bot (bot commands, etc)| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Pinned message ID, you can only pin messages in a chat with yourself| +|common\_chats\_count|[int](../types/int.md) | Yes|Chats in common with this user| +|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)| @@ -29,14 +38,14 @@ Extended user info ### Example: ```php -$userFull = ['_' => 'userFull', 'user' => User, 'link' => contacts.Link, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'blocked' => Bool, 'bot_info' => BotInfo]; +$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', user=User, link=contacts.Link, profile_photo=Photo, notify_settings=PeerNotifySettings, blocked=Bool, bot_info=BotInfo} +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} ``` diff --git a/old_docs/API_docs_v44/constructors/userProfilePhoto.md b/old_docs/API_docs_v44/constructors/userProfilePhoto.md index 208e68a7..ee6b1c43 100644 --- a/old_docs/API_docs_v44/constructors/userProfilePhoto.md +++ b/old_docs/API_docs_v44/constructors/userProfilePhoto.md @@ -14,9 +14,11 @@ 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
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| +|dc\_id|[int](../types/int.md) | Yes|DC ID where the photo is stored| @@ -26,14 +28,14 @@ User profile photo. ### Example: ```php -$userProfilePhoto = ['_' => 'userProfilePhoto', 'photo_id' => long, 'photo_small' => FileLocation, 'photo_big' => FileLocation]; +$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} +userProfilePhoto={_='userProfilePhoto', has_video=Bool, photo_id=long, photo_small=FileLocation, photo_big=FileLocation, dc_id=int} ``` diff --git a/old_docs/API_docs_v44/constructors/vector.md b/old_docs/API_docs_v44/constructors/vector.md deleted file mode 100644 index 63a9d26b..00000000 --- a/old_docs/API_docs_v44/constructors/vector.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: vector -description: A universal vector constructor. -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: vector -[Back to constructors index](index.md) - - - -A universal vector constructor. - - - - -### Type: [Vector t](../types/Vector t.md) - - -### Example: - -```php -$vector = ['_' => 'vector']; -``` - - -Or, if you're into Lua: - -```lua -vector={_='vector'} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/video.md b/old_docs/API_docs_v44/constructors/video.md deleted file mode 100644 index 8303c957..00000000 --- a/old_docs/API_docs_v44/constructors/video.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: video -description: Video -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: video -[Back to constructors index](index.md) - - - -Video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|ID| -|access\_hash|[long](../types/long.md) | Yes|Access hash| -|date|[int](../types/int.md) | Yes|Date| -|duration|[int](../types/int.md) | Yes|Duration| -|mime\_type|[string](../types/string.md) | Yes|Mime type| -|size|[int](../types/int.md) | Yes|Size| -|thumb|[PhotoSize](../types/PhotoSize.md) | Optional|Thumbnail| -|dc\_id|[int](../types/int.md) | Yes|DC ID| -|w|[int](../types/int.md) | Yes|Width| -|h|[int](../types/int.md) | Yes|Height| - - - -### Type: [Video](../types/Video.md) - - -### Example: - -```php -$video = ['_' => 'video', 'id' => long, 'access_hash' => long, 'date' => int, 'duration' => int, 'mime_type' => 'string', 'size' => int, 'thumb' => PhotoSize, 'dc_id' => int, 'w' => int, 'h' => int]; -``` - - -Or, if you're into Lua: - -```lua -video={_='video', id=long, access_hash=long, date=int, duration=int, mime_type='string', size=int, thumb=PhotoSize, dc_id=int, w=int, h=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/videoSize.md b/old_docs/API_docs_v44/constructors/videoSize.md new file mode 100644 index 00000000..efe5bcbf --- /dev/null +++ b/old_docs/API_docs_v44/constructors/videoSize.md @@ -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} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/wallPaper.md b/old_docs/API_docs_v44/constructors/wallPaper.md index 4140447f..ae8adbb9 100644 --- a/old_docs/API_docs_v44/constructors/wallPaper.md +++ b/old_docs/API_docs_v44/constructors/wallPaper.md @@ -14,10 +14,15 @@ Wallpaper settings. | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[int](../types/int.md) | Yes|ID| -|title|[string](../types/string.md) | Yes|Title| -|sizes|Array of [PhotoSize](../types/PhotoSize.md) | Yes|Sizes| -|color|[int](../types/int.md) | Yes|Color| +|id|[long](../types/long.md) | Yes|Identifier| +|creator|[Bool](../types/Bool.md) | Optional|Creator of the wallpaper| +|default|[Bool](../types/Bool.md) | Optional|Whether this is the default wallpaper| +|pattern|[Bool](../types/Bool.md) | Optional|Pattern| +|dark|[Bool](../types/Bool.md) | Optional|Dark mode| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|slug|[string](../types/string.md) | Yes|Unique wallpaper ID| +|document|[Document](../types/Document.md) | Optional|The actual wallpaper| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings| @@ -27,14 +32,14 @@ Wallpaper settings. ### Example: ```php -$wallPaper = ['_' => 'wallPaper', 'id' => int, 'title' => 'string', 'sizes' => [PhotoSize, PhotoSize], 'color' => int]; +$wallPaper = ['_' => 'wallPaper', 'id' => long, 'creator' => Bool, 'default' => Bool, 'pattern' => Bool, 'dark' => Bool, 'access_hash' => long, 'slug' => 'string', 'document' => Document, 'settings' => WallPaperSettings]; ``` Or, if you're into Lua: ```lua -wallPaper={_='wallPaper', id=int, title='string', sizes={PhotoSize}, color=int} +wallPaper={_='wallPaper', id=long, creator=Bool, default=Bool, pattern=Bool, dark=Bool, access_hash=long, slug='string', document=Document, settings=WallPaperSettings} ``` diff --git a/old_docs/API_docs_v44/constructors/wallPaperNoFile.md b/old_docs/API_docs_v44/constructors/wallPaperNoFile.md new file mode 100644 index 00000000..305eb540 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/wallPaperNoFile.md @@ -0,0 +1,40 @@ +--- +title: wallPaperNoFile +description: No file wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperNoFile +[Back to constructors index](index.md) + + + +No file wallpaper + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|default|[Bool](../types/Bool.md) | Optional|Whether this is the default wallpaper| +|dark|[Bool](../types/Bool.md) | Optional|Dark mode| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +```php +$wallPaperNoFile = ['_' => 'wallPaperNoFile', 'default' => Bool, 'dark' => Bool, 'settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +wallPaperNoFile={_='wallPaperNoFile', default=Bool, dark=Bool, settings=WallPaperSettings} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/wallPaperSettings.md b/old_docs/API_docs_v44/constructors/wallPaperSettings.md new file mode 100644 index 00000000..92e365b8 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/wallPaperSettings.md @@ -0,0 +1,43 @@ +--- +title: wallPaperSettings +description: Wallpaper settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperSettings +[Back to constructors index](index.md) + + + +Wallpaper settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blur|[Bool](../types/Bool.md) | Optional|If set, the wallpaper must be downscaled to fit in 450x450 square and then box-blurred with radius 12| +|motion|[Bool](../types/Bool.md) | Optional|If set, the background needs to be slightly moved when device is rotated| +|background\_color|[int](../types/int.md) | Optional|If set, a PNG pattern is to be combined with the `color` chosen by the user: the main color of the background in RGB24 format| +|second\_background\_color|[int](../types/int.md) | Optional|If set, a PNG pattern is to be combined with the first and second background colors (RGB24 format) in a top-bottom gradient| +|intensity|[int](../types/int.md) | Optional|Intensity of the pattern when it is shown above the main background color, 0-100| +|rotation|[int](../types/int.md) | Optional|Clockwise rotation angle of the gradient, in degrees; 0-359. Should be always divisible by 45| + + + +### Type: [WallPaperSettings](../types/WallPaperSettings.md) + + +### Example: + +```php +$wallPaperSettings = ['_' => 'wallPaperSettings', 'blur' => Bool, 'motion' => Bool, 'background_color' => int, 'second_background_color' => int, 'intensity' => int, 'rotation' => int]; +``` + + +Or, if you're into Lua: + +```lua +wallPaperSettings={_='wallPaperSettings', blur=Bool, motion=Bool, background_color=int, second_background_color=int, intensity=int, rotation=int} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/wallPaperSolid.md b/old_docs/API_docs_v44/constructors/wallPaperSolid.md deleted file mode 100644 index 68e72445..00000000 --- a/old_docs/API_docs_v44/constructors/wallPaperSolid.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: wallPaperSolid -description: Wall paper solid -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: wallPaperSolid -[Back to constructors index](index.md) - - - -Wall paper solid - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[int](../types/int.md) | Yes|ID| -|title|[string](../types/string.md) | Yes|Title| -|bg\_color|[int](../types/int.md) | Yes|Bg color| -|color|[int](../types/int.md) | Yes|Color| - - - -### Type: [WallPaper](../types/WallPaper.md) - - -### Example: - -```php -$wallPaperSolid = ['_' => 'wallPaperSolid', 'id' => int, 'title' => 'string', 'bg_color' => int, 'color' => int]; -``` - - -Or, if you're into Lua: - -```lua -wallPaperSolid={_='wallPaperSolid', id=int, title='string', bg_color=int, color=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/webAuthorization.md b/old_docs/API_docs_v44/constructors/webAuthorization.md new file mode 100644 index 00000000..107b1fcd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/webAuthorization.md @@ -0,0 +1,46 @@ +--- +title: webAuthorization +description: Represents a bot logged in using the [Telegram login widget](https://core.telegram.org/widgets/login) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webAuthorization +[Back to constructors index](index.md) + + + +Represents a bot logged in using the [Telegram login widget](https://core.telegram.org/widgets/login) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[long](../types/long.md) | Yes|Authorization hash| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user has logged in.| +|browser|[string](../types/string.md) | Yes|Browser user-agent| +|platform|[string](../types/string.md) | Yes|Platform| +|date\_created|[int](../types/int.md) | Yes|When was the web session created| +|date\_active|[int](../types/int.md) | Yes|When was the web session last active| +|ip|[string](../types/string.md) | Yes|IP address| +|region|[string](../types/string.md) | Yes|Region, determined from IP address| + + + +### Type: [WebAuthorization](../types/WebAuthorization.md) + + +### Example: + +```php +$webAuthorization = ['_' => 'webAuthorization', 'hash' => long, 'bot_id' => int, 'domain' => 'string', 'browser' => 'string', 'platform' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'region' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +webAuthorization={_='webAuthorization', hash=long, bot_id=int, domain='string', browser='string', platform='string', date_created=int, date_active=int, ip='string', region='string'} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/webDocument.md b/old_docs/API_docs_v44/constructors/webDocument.md new file mode 100644 index 00000000..d5f552a0 --- /dev/null +++ b/old_docs/API_docs_v44/constructors/webDocument.md @@ -0,0 +1,42 @@ +--- +title: webDocument +description: Remote document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocument +[Back to constructors index](index.md) + + + +Remote document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Document URL| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|MIME type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes for media types| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +```php +$webDocument = ['_' => 'webDocument', 'url' => 'string', 'access_hash' => long, 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +webDocument={_='webDocument', url='string', access_hash=long, size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/webDocumentNoProxy.md b/old_docs/API_docs_v44/constructors/webDocumentNoProxy.md new file mode 100644 index 00000000..50e8e6cc --- /dev/null +++ b/old_docs/API_docs_v44/constructors/webDocumentNoProxy.md @@ -0,0 +1,41 @@ +--- +title: webDocumentNoProxy +description: Remote document that can be downloaded without [proxying through telegram](https://core.telegram.org/api/files) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocumentNoProxy +[Back to constructors index](index.md) + + + +Remote document that can be downloaded without [proxying through telegram](https://core.telegram.org/api/files) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Document URL| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|MIME type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes for media types| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +```php +$webDocumentNoProxy = ['_' => 'webDocumentNoProxy', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +webDocumentNoProxy={_='webDocumentNoProxy', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/webPage.md b/old_docs/API_docs_v44/constructors/webPage.md index 3fa9a2c3..92ab3b0e 100644 --- a/old_docs/API_docs_v44/constructors/webPage.md +++ b/old_docs/API_docs_v44/constructors/webPage.md @@ -17,6 +17,7 @@ Webpage preview |id|[long](../types/long.md) | Yes|Preview ID| |url|[string](../types/string.md) | Yes|URL of previewed webpage| |display\_url|[string](../types/string.md) | Yes|Webpage URL to be displayed to the user| +|hash|[int](../types/int.md) | Yes| |type|[string](../types/string.md) | Optional|Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else| |site\_name|[string](../types/string.md) | Optional|Short name of the site (e.g., Google Docs, App Store)| |title|[string](../types/string.md) | Optional|Title of the content| @@ -29,6 +30,8 @@ Webpage preview |duration|[int](../types/int.md) | Optional|Duration of the content, in seconds| |author|[string](../types/string.md) | Optional|Author of the content| |document|[Document](../types/Document.md) | Optional|Preview of the content as a media file| +|cached\_page|[Page](../types/Page.md) | Optional|Page contents in [instant view](https://instantview.telegram.org) format| +|attributes|Array of [WebPageAttribute](../types/WebPageAttribute.md) | Optional|Webpage attributes| @@ -38,14 +41,14 @@ Webpage preview ### Example: ```php -$webPage = ['_' => 'webPage', 'id' => long, 'url' => 'string', 'display_url' => 'string', 'type' => 'string', 'site_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'embed_url' => 'string', 'embed_type' => 'string', 'embed_width' => int, 'embed_height' => int, 'duration' => int, 'author' => 'string', 'document' => Document]; +$webPage = ['_' => 'webPage', 'id' => long, 'url' => 'string', 'display_url' => 'string', 'hash' => int, 'type' => 'string', 'site_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'embed_url' => 'string', 'embed_type' => 'string', 'embed_width' => int, 'embed_height' => int, 'duration' => int, 'author' => 'string', 'document' => Document, 'cached_page' => Page, 'attributes' => [WebPageAttribute, WebPageAttribute]]; ``` Or, if you're into Lua: ```lua -webPage={_='webPage', id=long, url='string', display_url='string', type='string', site_name='string', title='string', description='string', photo=Photo, embed_url='string', embed_type='string', embed_width=int, embed_height=int, duration=int, author='string', document=Document} +webPage={_='webPage', id=long, url='string', display_url='string', hash=int, type='string', site_name='string', title='string', description='string', photo=Photo, embed_url='string', embed_type='string', embed_width=int, embed_height=int, duration=int, author='string', document=Document, cached_page=Page, attributes={WebPageAttribute}} ``` diff --git a/old_docs/API_docs_v44/constructors/webPageAttributeTheme.md b/old_docs/API_docs_v44/constructors/webPageAttributeTheme.md new file mode 100644 index 00000000..9d9fb4fd --- /dev/null +++ b/old_docs/API_docs_v44/constructors/webPageAttributeTheme.md @@ -0,0 +1,39 @@ +--- +title: webPageAttributeTheme +description: Page theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageAttributeTheme +[Back to constructors index](index.md) + + + +Page theme + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|documents|Array of [Document](../types/Document.md) | Optional|Theme files| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional|Theme settings| + + + +### Type: [WebPageAttribute](../types/WebPageAttribute.md) + + +### Example: + +```php +$webPageAttributeTheme = ['_' => 'webPageAttributeTheme', 'documents' => [Document, Document], 'settings' => ThemeSettings]; +``` + + +Or, if you're into Lua: + +```lua +webPageAttributeTheme={_='webPageAttributeTheme', documents={Document}, settings=ThemeSettings} + +``` + + diff --git a/old_docs/API_docs_v44/constructors/webPageExternal.md b/old_docs/API_docs_v44/constructors/webPageExternal.md deleted file mode 100644 index b8f2dbd6..00000000 --- a/old_docs/API_docs_v44/constructors/webPageExternal.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: webPageExternal -description: Web page external -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: webPageExternal -[Back to constructors index](index.md) - - - -Web page external - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|display\_url|[string](../types/string.md) | Yes|Display URL| -|type|[string](../types/string.md) | Optional|Type| -|title|[string](../types/string.md) | Optional|Title| -|description|[string](../types/string.md) | Optional|Description| -|thumb\_url|[string](../types/string.md) | Optional|Thumbnail URL| -|content\_url|[string](../types/string.md) | Optional|Content URL| -|w|[int](../types/int.md) | Optional|Width| -|h|[int](../types/int.md) | Optional|Height| -|duration|[int](../types/int.md) | Optional|Duration| - - - -### Type: [WebPage](../types/WebPage.md) - - -### Example: - -```php -$webPageExternal = ['_' => 'webPageExternal', 'url' => 'string', 'display_url' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'thumb_url' => 'string', 'content_url' => 'string', 'w' => int, 'h' => int, 'duration' => int]; -``` - - -Or, if you're into Lua: - -```lua -webPageExternal={_='webPageExternal', url='string', display_url='string', type='string', title='string', description='string', thumb_url='string', content_url='string', w=int, h=int, duration=int} - -``` - - diff --git a/old_docs/API_docs_v44/constructors/webPageNotModified.md b/old_docs/API_docs_v44/constructors/webPageNotModified.md new file mode 100644 index 00000000..2942ee9d --- /dev/null +++ b/old_docs/API_docs_v44/constructors/webPageNotModified.md @@ -0,0 +1,38 @@ +--- +title: webPageNotModified +description: The preview of the webpage hasn't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageNotModified +[Back to constructors index](index.md) + + + +The preview of the webpage hasn't changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cached\_page\_views|[int](../types/int.md) | Optional|Page view count| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +```php +$webPageNotModified = ['_' => 'webPageNotModified', 'cached_page_views' => int]; +``` + + +Or, if you're into Lua: + +```lua +webPageNotModified={_='webPageNotModified', cached_page_views=int} + +``` + + diff --git a/old_docs/API_docs_v44/methods/README.md b/old_docs/API_docs_v44/methods/README.md index f3154899..2c3acd97 100644 --- a/old_docs/API_docs_v44/methods/README.md +++ b/old_docs/API_docs_v44/methods/README.md @@ -30,12 +30,48 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) +* Accept QR code login token, logging in the app that generated it: auth.acceptLoginToken + +* Accept incoming call: phone.acceptCall + +* Accept the new terms of service: help.acceptTermsOfService + +* Add GIF to saved gifs list: messages.saveGif + +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet + +* Add an existing telegram user as contact: contacts.addContact + +* Add/remove sticker from recent stickers list: messages.saveRecentSticker + * Adds a user to a chat and sends a service message on it: messages.addChatUser * Adds the user to the blacklist: contacts.block +* Answer an inline query, for bots only: messages.setInlineBotResults + +* Answers a custom query; for bots only: bots.answerWebhookJSONQuery + +* Apply changes to multiple stickersets: messages.toggleStickerSets + +* Associate a group to a channel as discussion group for that channel: channels.setDiscussionGroup + +* Associate a stickerset to the supergroup: channels.setStickers + +* Ban/unban/kick a user in a supergroup/channel: channels.editBanned + +* Binds a temporary authorization key temp_auth_key_id to the permanent authorization key perm_auth_key_id. Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one: auth.bindTempAuthKey + +* Cancel the code that was sent to verify an email to use as 2FA recovery method: account.cancelPasswordEmail + +* Cancel the login verification code: auth.cancelCode + +* Cancels a request for creation and/or delete info on secret chat: messages.discardEncryption + * Chanages chat name and sends a service message on it: messages.editChatTitle +* Change media autodownload settings: account.saveAutoDownloadSettings + * Change privacy settings of current account: account.setPrivacy * Change the phone number of the current account: account.changePhone @@ -46,28 +82,60 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto +* Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition + * Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername -* Check if this phone number is registered on telegram: auth.checkPhone - * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite +* Clear all drafts: messages.clearAllDrafts + +* Clear recent stickers: messages.clearRecentStickers + +* Clear saved payment information: payments.clearSavedInfo + +* Confirm a phone number to cancel account deletion, for more info click here »: account.confirmPhone + +* Confirms creation of a secret chat: messages.acceptEncryption + * Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages +* Confirms receipt of messages in a secret chat by client, cancels push notifications: messages.receivedQueue + * Create a supergroup/channel: channels.createChannel +* Create a stickerset, bots only: stickers.createStickerSet + +* Create a theme: account.createTheme + +* Create and upload a new wallpaper: account.uploadWallPaper + * Creates a new chat: messages.createChat * Delete a channel/supergroup: channels.deleteChannel -* Delete a contact: contacts.deleteContact +* Delete a peer folder: folders.deleteFolder * Delete all messages sent by a certain user in a supergroup: channels.deleteUserHistory +* Delete all temporary authorization keys except for the ones specified: auth.dropTempAuthKeys + +* Delete contacts by phone number: contacts.deleteByPhones + +* Delete installed wallpapers: account.resetWallPapers + * Delete messages in a channel/supergroup: channels.deleteMessages +* Delete saved contacts: contacts.resetSaved + +* Delete scheduled messages: messages.deleteScheduledMessages + +* Delete stored Telegram Passport documents, for more info see the passport docs »: account.deleteSecureValue + +* Delete the history of a supergroup: channels.deleteHistory + * Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the 2FA password and no recovery method is configured: account.deleteAccount * Deletes a device by its token, stops sending PUSH-notifications to it: account.unregisterDevice @@ -84,148 +152,414 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Deletes the user from the blacklist: contacts.unblock -* Edit the about text of a channel/supergroup: channels.editAbout +* Download a CDN file: upload.getCdnFile + +* Edit an inline bot message: messages.editInlineBotMessage + +* Edit location of geogroup: channels.editLocation + +* Edit message: messages.editMessage + +* Edit peers in peer folder: folders.editPeerFolders + +* Edit the default banned rights of a channel/supergroup/group: messages.editChatDefaultBannedRights + +* Edit the description of a group/supergroup/channel: messages.editChatAbout * Edit the name of a channel/supergroup: channels.editTitle * Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings -* Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins +* Enable/disable top peers: contacts.toggleTopPeers -* Enable channel comments: channels.toggleComments +* Enable/disable message signatures in channels: channels.toggleSignatures * Export an invite link for a chat: messages.exportChatInvite -* Export contact as card: contacts.exportCard +* Find out if a media message's caption can be edited: messages.getMessageEditData -* Export the invite link of a channel: channels.exportInvite - -* Forward message: messages.forwardMessage +* Finish account takeout session: account.finishTakeoutSession * Forwards messages by their IDs: messages.forwardMessages +* Generate a login token, for login via QR code. : auth.exportLoginToken + +* Get MTProxy/Public Service Announcement information: help.getPromoData + +* Get SHA256 hashes for verifying downloaded CDN files: upload.getCdnFileHashes + +* Get SHA256 hashes for verifying downloaded files: upload.getFileHashes + +* Get channel statistics: stats.getBroadcastStats + * Get channel/supergroup messages: channels.getMessages +* Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels + +* Get folders: messages.getDialogFilters + +* Get instant view page: messages.getWebPage + +* Get passport configuration: help.getPassportConfig + +* Get suggested folders: messages.getSuggestedDialogFilters + * Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash +* Get a list of channels/supergroups we left: channels.getLeftChannels + +* Get a payment form: payments.getPaymentForm + +* Get all archived stickers: messages.getArchivedStickers + +* Get all chats, channels and supergroups: messages.getAllChats + +* Get all contacts: contacts.getSaved + +* Get all groups that can be used as discussion groups: channels.getGroupsForDiscussion + * Get all installed stickers: messages.getAllStickers +* Get all saved Telegram Passport documents, for more info see the passport docs »: account.getAllSecureValues + * Get and increase the view counter of a message sent or forwarded from a channel: messages.getMessagesViews -* Get changelog of current app: help.getAppChangelog +* Get app-specific configuration, see client configuration for more info on the result: help.getAppConfig -* Get channel dialogs: channels.getDialogs +* Get changed emoji keywords: messages.getEmojiKeywordsDifference + +* Get changelog of current app. : help.getAppChangelog + +* Get chats in common with a user: messages.getCommonChats + +* Get configuration for CDN file downloads: help.getCdnConfig + +* Get contact by telegram IDs: contacts.getContactIDs + +* Get contacts near you: contacts.getLocated + +* Get count of online users in a chat: messages.getOnlines * Get days to live of account: account.getAccountTTL -* Get important channel/supergroup history: channels.getImportantHistory +* Get dialog info of specified peers: messages.getPeerDialogs + +* Get dialogs manually marked as unread: messages.getDialogUnreadMarks + +* Get faved stickers: messages.getFavedStickers + +* Get featured stickers: messages.getFeaturedStickers + +* Get full info about a channel: channels.getFullChannel + +* Get highscores of a game sent using an inline bot: messages.getInlineGameHighScores + +* Get highscores of a game: messages.getGameHighScores + +* Get inactive channels and supergroups: channels.getInactiveChannels * Get info about channels/supergroups: channels.getChannels * Get info about a channel/supergroup participant: channels.getParticipant +* Get info about a t.me link: help.getDeepLinkInfo + +* Get info about a certain wallpaper: account.getWallPaper + +* Get info about a credit card: payments.getBankCardData + * Get info about a stickerset: messages.getStickerSet +* Get info about an emoji keyword localization: messages.getEmojiKeywordsLanguages + +* Get info about multiple wallpapers: account.getMultiWallPapers + +* Get information about a language in a localization pack: langpack.getLanguage + +* Get information about all languages in a localization pack: langpack.getLanguages + +* Get installed mask stickers: messages.getMaskStickers + +* Get installed themes: account.getThemes + +* Get link and embed info of a message in a channel/supergroup: channels.exportMessageLink + +* Get live location history of a certain user: messages.getRecentLocations + +* Get localization pack strings: langpack.getLangPack + +* Get localized emoji keywords: messages.getEmojiKeywords + +* Get localized name of the telegram support user: help.getSupportName + * Get logged-in sessions: account.getAuthorizations +* Get media autodownload settings: account.getAutoDownloadSettings + +* Get message ranges for saving the user's chat history: messages.getSplitRanges + +* Get more info about a Seamless Telegram Login authorization request, for more info click here »: messages.requestUrlAuth + +* Get most used peers: contacts.getTopPeers + +* Get new updates: updates.getDifference + +* Get new strings in languagepack: langpack.getDifference + +* Get payment receipt: payments.getPaymentReceipt + +* Get peer settings: messages.getPeerSettings + +* Get phone call configuration to be passed to libtgvoip's shared config: phone.getCallConfig + +* Get pinned dialogs: messages.getPinnedDialogs + +* Get poll results for non-anonymous polls: messages.getPollVotes + +* Get poll results: messages.getPollResults + * Get preview of webpage: messages.getWebPagePreview * Get privacy settings of current account: account.getPrivacy +* Get private info associated to the password info (recovery email, telegram passport info & so on): account.getPasswordSettings + +* Get recent stickers: messages.getRecentStickers + +* Get recently used t.me links: help.getRecentMeUrls + +* Get saved GIFs: messages.getSavedGifs + +* Get saved Telegram Passport document, for more info see the passport docs »: account.getSecureValue + +* Get saved payment information: payments.getSavedInfo + +* Get scheduled messages: messages.getScheduledHistory + +* Get scheduled messages: messages.getScheduledMessages + +* Get sensitive content settings: account.getContentSettings + +* Get stickers attached to a photo or video: messages.getAttachedStickers + * Get stickers by emoji: messages.getStickers -* Get suggested contacts: contacts.getSuggested +* Get strings from a language pack: langpack.getStrings -* Get terms of service: help.getTermsOfService +* Get temporary payment password: account.getTmpPassword + +* Get the admin log of a channel/supergroup: channels.getAdminLog + +* Get the number of results that would be found by a messages.search call with the same parameters: messages.getSearchCounters * Get the participants of a channel: channels.getParticipants +* Get theme information: account.getTheme + +* Get unread messages where we were mentioned: messages.getUnreadMentions + +* Get web login widget authorizations: account.getWebAuthorizations + * Gets back found messages: messages.search * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory * Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings +* Hide MTProxy/Public Service Announcement information: help.hidePromoData + +* Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden + +* If the peer settings of a new user allow us to add him as contact, add that user as contact: contacts.acceptContact + +* If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries: messages.setBotShippingResults + * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* Import card as contact: contacts.importCard - * Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info: contacts.importContacts +* Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus + * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet +* Install a theme: account.installTheme + +* Install wallpaper: account.installWallPaper + +* Install/uninstall wallpaper: account.saveWallPaper + * Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto -* Invite friends to telegram!: auth.sendInvites +* Internal use: help.editUserInfo + +* Internal use: help.getUserInfo + +* Intialize account takeout session: account.initTakeoutSession * Invite users to a channel/supergroup: channels.inviteToChannel +* Invoke a method within a takeout session: invokeWithTakeout + * Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries): invokeWithoutUpdates * Invoke the specified query using the specified API layer: invokeWithLayer +* Invoke with the given message range: invokeWithMessagesRange + * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs * Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel -* Kick user from channel: channels.kickFromChannel - * Leave a channel/supergroup: channels.leaveChannel +* Load channel statistics graph asynchronously: stats.loadAsyncGraph + * Log out an active authorized session by its hash: account.resetAuthorization +* Log out an active web telegram login session: account.resetWebAuthorization + +* Login as a bot: auth.importBotAuthorization + +* Login using a redirected login token, generated in case of DC mismatch during QR code login: auth.importLoginToken + +* Logs in a user using a key transmitted from his native data-centre: auth.importAuthorization + +* Logs out the user: auth.logOut + +* Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate + * Make a user admin in a legacy group: messages.editChatAdmin +* Manually mark dialog as unread: messages.markDialogUnread + * Mark channel/supergroup history as read: channels.readHistory +* Mark channel/supergroup message contents as read: channels.readMessageContents + +* Mark a sticker as favorite: messages.faveSticker + +* Mark mentions as read: messages.readMentions + +* Mark new featured stickers as read: messages.readFeaturedStickers + * Marks message history as read: messages.readHistory * Marks message history within a secret chat as read: messages.readEncryptedHistory +* Method for fetching previously featured stickers: messages.getOldFeaturedStickers + * Modify the admin rights of a user in a supergroup/channel: channels.editAdmin * Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents +* Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification + +* Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change): users.setSecureValueErrors + * Obtain configuration for two-factor authorization with password: account.getPassword +* Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update. : messages.setBotPrecheckoutResults + +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall + +* Pin a message: messages.updatePinnedMessage + +* Pin/unpin a dialog: messages.toggleDialogPin + +* Press an inline callback button and get a callback answer from the bot: messages.getBotCallbackAnswer + +* Query an inline bot: messages.getInlineBotResults + +* Rate a call: phone.setCallRating + +* Refuse or end running call: phone.discardCall + * Register device to receive PUSH notifications: account.registerDevice +* Registers a validated phone number in the system: auth.signUp + +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet + +* Reorder folders: messages.updateDialogFiltersOrder + * Reorder installed stickersets: messages.reorderStickerSets +* Reorder pinned dialogs: messages.reorderPinnedDialogs + +* Report a message in a chat for violation of telegram's Terms of Service: messages.report + * Report a new incoming chat for spam, if the peer settings of the chat allow us to do that: messages.reportSpam * Report a peer for violation of telegram's Terms of Service: account.reportPeer +* Report a secret chat for spam: messages.reportEncryptedSpam + * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam +* Request a reupload of a certain file to a CDN DC: upload.reuploadCdnFile + * Request recovery code of a 2FA password, only for accounts with a recovery email configured: auth.requestPasswordRecovery +* Resend the code to verify an email to use as 2FA recovery method: account.resendPasswordEmail + +* Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info: auth.resendCode + +* Reset rating of top peer: contacts.resetTopPeerRating + +* Reset all active web telegram login sessions: account.resetWebAuthorizations + * Reset the 2FA password using the recovery code sent using auth.requestPasswordRecovery: auth.recoverPassword * Resets all notification settings from users and groups: account.resetNotifySettings +* Resolve a @username to get peer info: contacts.resolveUsername + +* Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL + +* Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm + +* Returns a current state of updates: updates.getState + * Returns a list of available wallpapers: account.getWallPapers +* Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL + * Returns basic user info according to their identifiers: users.getUsers * Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration: help.getConfig +* Returns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length: messages.getDhConfig + +* Returns content of a whole file or its part: upload.getFile + +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile + +* Returns current configuration, including data center configuration: help.getConfig + +* Returns data for copying authorization to another data-centre: auth.exportAuthorization + +* Returns extended user info by ID: users.getFullUser + +* Returns full chat info according to its ID: messages.getFullChat * Returns info on data centre nearest to the user: help.getNearestDc * Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation: help.getInviteText +* Returns list of chats with non-default notification settings: account.getNotifyExceptions + +* Returns localized text of a text message with an invitation: help.getInviteText * Returns the current user dialog list: messages.getDialogs * Returns the current user's contact list: contacts.getContacts +* Returns the difference between the current state of updates of a certain channel and transmitted: updates.getChannelDifference + * Returns the list of blocked users: contacts.getBlocked * Returns the list of contact statuses: contacts.getStatuses @@ -238,103 +572,136 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Returns users found by username substring: contacts.search -* Saves logs of application on the server: help.saveAppLog +* Save a message draft associated to a chat: messages.saveDraft -* Search for GIFs: messages.searchGifs +* Save a theme: account.saveTheme + +* Save get all message drafts: messages.getAllDrafts + +* Saves a part of a large file (over 10Mb in size) to be later passed to one of the methods: upload.saveBigFilePart + +* Saves a part of file for futher sending to one of the methods: upload.saveFilePart + +* Saves logs of application on the server: help.saveAppLog * Search for messages and peers globally: messages.searchGlobal -* Send SMS verification code: auth.sendSms +* Search for stickersets: messages.searchStickerSets + +* Securely save Telegram Passport document, for more info see the passport docs »: account.saveSecureValue * Send a media: messages.sendMedia -* Send a message to all users in the chat list: messages.sendBroadcast +* Send a result obtained using messages.getInlineBotResults: messages.sendInlineBotResult + +* Send an album of media: messages.sendMultiMedia + +* Send compiled payment form: payments.sendPaymentForm + +* Send confirmation code to cancel account deletion, for more info click here »: account.sendConfirmPhoneCode + +* Send phone call debug data to server: phone.saveCallDebug + +* Send scheduled messages right away: messages.sendScheduledMessages + +* Send the verification code for login: auth.sendCode + +* Send the verification email code for telegram passport: account.sendVerifyEmailCode + +* Send the verification phone code for telegram passport: account.sendVerifyPhoneCode * Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Send verification phone call: auth.sendCall +* Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization * Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group: messages.setTyping +* Sends a custom request; for bots only: bots.sendCustomRequest + * Sends a message to a chat: messages.sendMessage * Sends a message with a file attachment to a secret chat: messages.sendEncryptedFile +* Sends a request to start a secret chat to the user: messages.requestEncryption + * Sends a service message to a secret chat: messages.sendEncryptedService * Sends a text message to a secret chat: messages.sendEncrypted +* Set a new 2FA password: account.updatePasswordSettings + * Set account self-destruction period: account.setAccountTTL +* Set bot command list: bots.setBotCommands + +* Set sensitive content settings (for viewing or hiding NSFW content): account.setContentSettings + +* Set stickerset thumbnail: stickers.setStickerSetThumb + +* Set the callback answer to a user button press (bots only): messages.setBotCallbackAnswer + +* Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the peer's settings: messages.hidePeerSettingsBar + +* Signs in a user with a validated phone number: auth.signIn + * Start a conversation with a bot using a deep linking parameter: messages.startBot +* Start a telegram phone call: phone.requestCall + +* Submit requested order information for validation: payments.validateRequestedInfo + * Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations +* Toggle contact sign up notifications: account.setContactSignUpNotification + +* Toggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds: channels.toggleSlowMode + +* Transfer channel ownership: channels.editCreator + +* Try logging to an account protected by a 2FA password: auth.checkPassword + * Turn a legacy group into a supergroup: messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet +* Update folder: messages.updateDialogFilter + +* Update theme: account.updateTheme + * Updates current user profile photo: photos.uploadProfilePhoto * Updates online user status: account.updateStatus * Updates user profile: account.updateProfile +* Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia + +* Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile + +* Upload theme: account.uploadTheme + +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore + +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore + +* Use this to accept a Seamless Telegram Login authorization request, for more info click here »: messages.acceptUrlAuth + * Validates a username and checks availability: account.checkUsername * Verify a new phone number to associate to the current account: account.sendChangePhoneCode +* Verify a phone number for telegram passport: account.verifyPhone + +* Verify an email address for telegram passport: account.verifyEmail + +* Verify an email to use as 2FA recovery method: account.confirmPasswordEmail + +* Vote in a poll: messages.sendVote + * When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications: account.updateDeviceLocked -* You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info: auth.bindTempAuthKey +* Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification -* You cannot use this method directly, instead use $MadelineProto->getDhConfig();: messages.getDhConfig +* Complete phone call E2E encryption key exchange »: phone.confirmCall -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.acceptEncryption - -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.discardEncryption - -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.requestEncryption - -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getChannelDifference - -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getDifference - -* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getState - -* You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.exportAuthorization - -* You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.importAuthorization - -* You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info): auth.importBotAuthorization - -* You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info): auth.checkPassword - -* You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.signIn - -* You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info): auth.signUp - -* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): channels.getFullChannel - -* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): messages.getFullChat - -* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): users.getFullUser - -* You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info): auth.logOut - -* You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.sendCode - -* You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): contacts.resolveUsername - -* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getFile - -* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveBigFilePart - -* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveFilePart - -* You cannot use this method directly: messages.receivedQueue - -* You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info): account.getPasswordSettings - -* You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info): account.updatePasswordSettings diff --git a/old_docs/API_docs_v44/methods/account.acceptAuthorization.md b/old_docs/API_docs_v44/methods/account.acceptAuthorization.md new file mode 100644 index 00000000..55729227 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.acceptAuthorization.md @@ -0,0 +1,50 @@ +--- +title: account.acceptAuthorization +description: Sends a Telegram Passport authorization form, effectively sharing data with the service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_acceptAuthorization.html +--- +# Method: account.acceptAuthorization +[Back to methods index](index.md) + + + +Sends a Telegram Passport authorization form, effectively sharing data with the service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_id|[int](../types/int.md) | Bot ID | Yes| +|scope|[string](../types/string.md) | Telegram Passport element types requested by the service | Yes| +|public\_key|[string](../types/string.md) | Service's public key | Yes| +|value\_hashes|Array of [SecureValueHash](../types/SecureValueHash.md) | Types of values sent and their hashes | Yes| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Encrypted values | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->acceptAuthorization(['bot_id' => int, 'scope' => 'string', 'public_key' => 'string', 'value_hashes' => [SecureValueHash, SecureValueHash], 'credentials' => SecureCredentialsEncrypted, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.acceptAuthorization({bot_id=int, scope='string', public_key='string', value_hashes={SecureValueHash}, credentials=SecureCredentialsEncrypted, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.cancelPasswordEmail.md b/old_docs/API_docs_v44/methods/account.cancelPasswordEmail.md new file mode 100644 index 00000000..58675222 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.cancelPasswordEmail.md @@ -0,0 +1,41 @@ +--- +title: account.cancelPasswordEmail +description: Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_cancelPasswordEmail.html +--- +# Method: account.cancelPasswordEmail +[Back to methods index](index.md) + + + +Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->cancelPasswordEmail(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.cancelPasswordEmail({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.changePhone.md b/old_docs/API_docs_v44/methods/account.changePhone.md index 873af1aa..53bb5467 100644 --- a/old_docs/API_docs_v44/methods/account.changePhone.md +++ b/old_docs/API_docs_v44/methods/account.changePhone.md @@ -4,10 +4,11 @@ description: Change the phone number of the current account image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_changePhone.html --- -# Method: account.changePhone +# Method: account.changePhone [Back to methods index](index.md) + Change the phone number of the current account ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.checkUsername.md b/old_docs/API_docs_v44/methods/account.checkUsername.md index 47f949af..2e9c27f7 100644 --- a/old_docs/API_docs_v44/methods/account.checkUsername.md +++ b/old_docs/API_docs_v44/methods/account.checkUsername.md @@ -4,17 +4,18 @@ description: Validates a username and checks availability. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_checkUsername.html --- -# Method: account.checkUsername +# Method: account.checkUsername [Back to methods index](index.md) + Validates a username and checks availability. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|username|[string](../types/string.md) | Username
Accepted characters: A-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| +|username|[string](../types/string.md) | username
Accepted characters: A-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| ### Return type: [Bool](../types/Bool.md) @@ -49,5 +50,6 @@ Bool = account.checkUsername({username='string', }) |------|----------|---------------| |400|USERNAME_INVALID|The provided username is not valid| |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| diff --git a/old_docs/API_docs_v44/methods/account.confirmPasswordEmail.md b/old_docs/API_docs_v44/methods/account.confirmPasswordEmail.md new file mode 100644 index 00000000..7ca73c89 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.confirmPasswordEmail.md @@ -0,0 +1,54 @@ +--- +title: account.confirmPasswordEmail +description: Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_confirmPasswordEmail.html +--- +# Method: account.confirmPasswordEmail +[Back to methods index](index.md) + + + +Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|code|[string](../types/string.md) | The phone code that was received after [setting a recovery email](https://core.telegram.org/api/srp#email-verification) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->confirmPasswordEmail(['code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.confirmPasswordEmail({code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CODE_INVALID|Code invalid| +|400|EMAIL_HASH_EXPIRED|Email hash expired| + + diff --git a/old_docs/API_docs_v44/methods/account.confirmPhone.md b/old_docs/API_docs_v44/methods/account.confirmPhone.md new file mode 100644 index 00000000..e994165a --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.confirmPhone.md @@ -0,0 +1,55 @@ +--- +title: account.confirmPhone +description: Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_confirmPhone.html +--- +# Method: account.confirmPhone +[Back to methods index](index.md) + + + +Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| +|phone\_code|[string](../types/string.md) | SMS code, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->confirmPhone(['phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CODE_HASH_INVALID|Code hash invalid| +|400|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v44/methods/account.createTheme.md b/old_docs/API_docs_v44/methods/account.createTheme.md new file mode 100644 index 00000000..9c6adc9a --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.createTheme.md @@ -0,0 +1,49 @@ +--- +title: account.createTheme +description: Create a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_createTheme.html +--- +# Method: account.createTheme +[Back to methods index](index.md) + + + +Create a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|slug|[string](../types/string.md) | Unique theme ID | Yes| +|title|[string](../types/string.md) | Theme name | Yes| +|document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | Theme settings | Optional| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Theme = $MadelineProto->account->createTheme(['slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Theme = account.createTheme({slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.deleteAccount.md b/old_docs/API_docs_v44/methods/account.deleteAccount.md index b432ea75..97cbd20b 100644 --- a/old_docs/API_docs_v44/methods/account.deleteAccount.md +++ b/old_docs/API_docs_v44/methods/account.deleteAccount.md @@ -4,10 +4,11 @@ description: Delete the user's account from the telegram servers. Can be used, f image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_deleteAccount.html --- -# Method: account.deleteAccount +# Method: account.deleteAccount [Back to methods index](index.md) + Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the [2FA password and no recovery method is configured](https://core.telegram.org/api/srp). ### Parameters: @@ -43,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.| + + diff --git a/old_docs/API_docs_v44/methods/account.deleteSecureValue.md b/old_docs/API_docs_v44/methods/account.deleteSecureValue.md new file mode 100644 index 00000000..49e41999 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.deleteSecureValue.md @@ -0,0 +1,46 @@ +--- +title: account.deleteSecureValue +description: Delete stored [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_deleteSecureValue.html +--- +# Method: account.deleteSecureValue +[Back to methods index](index.md) + + + +Delete stored [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Document types to delete | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->deleteSecureValue(['types' => [SecureValueType, SecureValueType], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.deleteSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.deleteContact.md b/old_docs/API_docs_v44/methods/account.finishTakeoutSession.md similarity index 55% rename from old_docs/API_docs_v44/methods/contacts.deleteContact.md rename to old_docs/API_docs_v44/methods/account.finishTakeoutSession.md index 22e8c808..0f4a1d04 100644 --- a/old_docs/API_docs_v44/methods/contacts.deleteContact.md +++ b/old_docs/API_docs_v44/methods/account.finishTakeoutSession.md @@ -1,25 +1,26 @@ --- -title: contacts.deleteContact -description: Delete a contact +title: account.finishTakeoutSession +description: Finish account takeout session image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/contacts_deleteContact.html +redirect_from: /API_docs/methods/account_finishTakeoutSession.html --- -# Method: contacts.deleteContact +# Method: account.finishTakeoutSession [Back to methods index](index.md) -Delete a contact + +Finish account takeout session ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contact to delete | Optional| +|success|[Bool](../types/Bool.md) | Data exported successfully | Optional| -### Return type: [contacts.Link](../types/contacts.Link.md) +### Return type: [Bool](../types/Bool.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -34,19 +35,19 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$contacts.Link = $MadelineProto->contacts->deleteContact(['id' => InputUser, ]); +$Bool = $MadelineProto->account->finishTakeoutSession(['success' => Bool, ]); ``` Or, if you're into Lua: ```lua -contacts.Link = contacts.deleteContact({id=InputUser, }) +Bool = account.finishTakeoutSession({success=Bool, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| -|400|CONTACT_ID_INVALID|The provided contact ID is invalid| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| diff --git a/old_docs/API_docs_v44/methods/account.getAccountTTL.md b/old_docs/API_docs_v44/methods/account.getAccountTTL.md index 17d9a386..017ed8ad 100644 --- a/old_docs/API_docs_v44/methods/account.getAccountTTL.md +++ b/old_docs/API_docs_v44/methods/account.getAccountTTL.md @@ -4,10 +4,11 @@ description: Get days to live of account image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getAccountTTL.html --- -# Method: account.getAccountTTL +# Method: account.getAccountTTL [Back to methods index](index.md) + Get days to live of account diff --git a/old_docs/API_docs_v44/methods/account.getAllSecureValues.md b/old_docs/API_docs_v44/methods/account.getAllSecureValues.md new file mode 100644 index 00000000..ca98aab5 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getAllSecureValues.md @@ -0,0 +1,41 @@ +--- +title: account.getAllSecureValues +description: Get all saved [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAllSecureValues.html +--- +# Method: account.getAllSecureValues +[Back to methods index](index.md) + + + +Get all saved [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_SecureValue = $MadelineProto->account->getAllSecureValues(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SecureValue = account.getAllSecureValues({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getAuthorizationForm.md b/old_docs/API_docs_v44/methods/account.getAuthorizationForm.md new file mode 100644 index 00000000..8b570376 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getAuthorizationForm.md @@ -0,0 +1,48 @@ +--- +title: account.getAuthorizationForm +description: Returns a Telegram Passport authorization form for sharing data with a service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAuthorizationForm.html +--- +# Method: account.getAuthorizationForm +[Back to methods index](index.md) + + + +Returns a Telegram Passport authorization form for sharing data with a service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_id|[int](../types/int.md) | User identifier of the service's bot | Yes| +|scope|[string](../types/string.md) | Telegram Passport element types requested by the service | Yes| +|public\_key|[string](../types/string.md) | Service's public key | Yes| + + +### Return type: [account.AuthorizationForm](../types/account.AuthorizationForm.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.AuthorizationForm = $MadelineProto->account->getAuthorizationForm(['bot_id' => int, 'scope' => 'string', 'public_key' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +account.AuthorizationForm = account.getAuthorizationForm({bot_id=int, scope='string', public_key='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getAuthorizations.md b/old_docs/API_docs_v44/methods/account.getAuthorizations.md index e54e2f6b..cc8dfd48 100644 --- a/old_docs/API_docs_v44/methods/account.getAuthorizations.md +++ b/old_docs/API_docs_v44/methods/account.getAuthorizations.md @@ -4,10 +4,11 @@ description: Get logged-in sessions image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getAuthorizations.html --- -# Method: account.getAuthorizations +# Method: account.getAuthorizations [Back to methods index](index.md) + Get logged-in sessions diff --git a/old_docs/API_docs_v44/methods/account.getAutoDownloadSettings.md b/old_docs/API_docs_v44/methods/account.getAutoDownloadSettings.md new file mode 100644 index 00000000..9bc097d1 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getAutoDownloadSettings.md @@ -0,0 +1,41 @@ +--- +title: account.getAutoDownloadSettings +description: Get media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAutoDownloadSettings.html +--- +# Method: account.getAutoDownloadSettings +[Back to methods index](index.md) + + + +Get media autodownload settings + + + +### Return type: [account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.AutoDownloadSettings = $MadelineProto->account->getAutoDownloadSettings(); +``` + +Or, if you're into Lua: + +```lua +account.AutoDownloadSettings = account.getAutoDownloadSettings({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getContactSignUpNotification.md b/old_docs/API_docs_v44/methods/account.getContactSignUpNotification.md new file mode 100644 index 00000000..0d122b85 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getContactSignUpNotification.md @@ -0,0 +1,41 @@ +--- +title: account.getContactSignUpNotification +description: Whether the user will receive notifications when contacts sign up +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getContactSignUpNotification.html +--- +# Method: account.getContactSignUpNotification +[Back to methods index](index.md) + + + +Whether the user will receive notifications when contacts sign up + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->getContactSignUpNotification(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.getContactSignUpNotification({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getContentSettings.md b/old_docs/API_docs_v44/methods/account.getContentSettings.md new file mode 100644 index 00000000..2f34b1b2 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getContentSettings.md @@ -0,0 +1,41 @@ +--- +title: account.getContentSettings +description: Get sensitive content settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getContentSettings.html +--- +# Method: account.getContentSettings +[Back to methods index](index.md) + + + +Get sensitive content settings + + + +### Return type: [account.ContentSettings](../types/account.ContentSettings.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.ContentSettings = $MadelineProto->account->getContentSettings(); +``` + +Or, if you're into Lua: + +```lua +account.ContentSettings = account.getContentSettings({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getGlobalPrivacySettings.md b/old_docs/API_docs_v44/methods/account.getGlobalPrivacySettings.md new file mode 100644 index 00000000..92f95152 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getGlobalPrivacySettings.md @@ -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({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getMultiWallPapers.md b/old_docs/API_docs_v44/methods/account.getMultiWallPapers.md new file mode 100644 index 00000000..bc3627a9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getMultiWallPapers.md @@ -0,0 +1,46 @@ +--- +title: account.getMultiWallPapers +description: Get info about multiple wallpapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getMultiWallPapers.html +--- +# Method: account.getMultiWallPapers +[Back to methods index](index.md) + + + +Get info about multiple wallpapers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpapers|Array of [InputWallPaper](../types/InputWallPaper.md) | Wallpapers to fetch info about | Yes| + + +### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_WallPaper = $MadelineProto->account->getMultiWallPapers(['wallpapers' => [InputWallPaper, InputWallPaper], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_WallPaper = account.getMultiWallPapers({wallpapers={InputWallPaper}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getNotifyExceptions.md b/old_docs/API_docs_v44/methods/account.getNotifyExceptions.md new file mode 100644 index 00000000..bf2847a7 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getNotifyExceptions.md @@ -0,0 +1,47 @@ +--- +title: account.getNotifyExceptions +description: Returns list of chats with non-default notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getNotifyExceptions.html +--- +# Method: account.getNotifyExceptions +[Back to methods index](index.md) + + + +Returns list of chats with non-default notification settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|compare\_sound|[Bool](../types/Bool.md) | If true, chats with non-default sound will also be returned | Optional| +|peer|[Username, chat ID, Update, Message or InputNotifyPeer](../types/InputNotifyPeer.md) | If specified, only chats of the specified category will be returned | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->account->getNotifyExceptions(['compare_sound' => Bool, 'peer' => InputNotifyPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = account.getNotifyExceptions({compare_sound=Bool, peer=InputNotifyPeer, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getNotifySettings.md b/old_docs/API_docs_v44/methods/account.getNotifySettings.md index ea9b4b26..88f72bf2 100644 --- a/old_docs/API_docs_v44/methods/account.getNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account.getNotifySettings.md @@ -4,10 +4,11 @@ description: Gets current notification settings for a given user/group, from all image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getNotifySettings.html --- -# Method: account.getNotifySettings +# Method: account.getNotifySettings [Back to methods index](index.md) + Gets current notification settings for a given user/group, from all users/all groups. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.getPassword.md b/old_docs/API_docs_v44/methods/account.getPassword.md index 15624078..c73f4481 100644 --- a/old_docs/API_docs_v44/methods/account.getPassword.md +++ b/old_docs/API_docs_v44/methods/account.getPassword.md @@ -4,10 +4,11 @@ description: Obtain configuration for two-factor authorization with password image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getPassword.html --- -# Method: account.getPassword +# Method: account.getPassword [Back to methods index](index.md) + Obtain configuration for two-factor authorization with password diff --git a/old_docs/API_docs_v44/methods/account.getPasswordSettings.md b/old_docs/API_docs_v44/methods/account.getPasswordSettings.md index 4005d9f3..de4c95c9 100644 --- a/old_docs/API_docs_v44/methods/account.getPasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account.getPasswordSettings.md @@ -1,20 +1,21 @@ --- title: account.getPasswordSettings -description: You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) +description: Get private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getPasswordSettings.html --- -# Method: account.getPasswordSettings +# Method: account.getPasswordSettings [Back to methods index](index.md) -You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) + +Get private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|current\_password\_hash|[bytes](../types/bytes.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | The password (see [SRP](https://core.telegram.org/api/srp)) | Yes| ### Return type: [account.PasswordSettings](../types/account.PasswordSettings.md) @@ -34,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$account.PasswordSettings = $MadelineProto->account->getPasswordSettings(['current_password_hash' => 'bytes', ]); +$account.PasswordSettings = $MadelineProto->account->getPasswordSettings(['password' => InputCheckPasswordSRP, ]); ``` Or, if you're into Lua: ```lua -account.PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) +account.PasswordSettings = account.getPasswordSettings({password=InputCheckPasswordSRP, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/account.getPrivacy.md b/old_docs/API_docs_v44/methods/account.getPrivacy.md index dad3bf20..8fbc7737 100644 --- a/old_docs/API_docs_v44/methods/account.getPrivacy.md +++ b/old_docs/API_docs_v44/methods/account.getPrivacy.md @@ -4,10 +4,11 @@ description: Get privacy settings of current account image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getPrivacy.html --- -# Method: account.getPrivacy +# Method: account.getPrivacy [Back to methods index](index.md) + Get privacy settings of current account ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.getSecureValue.md b/old_docs/API_docs_v44/methods/account.getSecureValue.md new file mode 100644 index 00000000..e86643b4 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getSecureValue.md @@ -0,0 +1,46 @@ +--- +title: account.getSecureValue +description: Get saved [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getSecureValue.html +--- +# Method: account.getSecureValue +[Back to methods index](index.md) + + + +Get saved [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Requested value types | Yes| + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_SecureValue = $MadelineProto->account->getSecureValue(['types' => [SecureValueType, SecureValueType], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SecureValue = account.getSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getTheme.md b/old_docs/API_docs_v44/methods/account.getTheme.md new file mode 100644 index 00000000..fca2cdea --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getTheme.md @@ -0,0 +1,56 @@ +--- +title: account.getTheme +description: Get theme information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getTheme.html +--- +# Method: account.getTheme +[Back to methods index](index.md) + + + +Get theme information + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|theme|[InputTheme](../types/InputTheme.md) | Theme | Yes| +|document\_id|[long](../types/long.md) | Document ID | Yes| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Theme = $MadelineProto->account->getTheme(['format' => 'string', 'theme' => InputTheme, 'document_id' => long, ]); +``` + +Or, if you're into Lua: + +```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| + + diff --git a/old_docs/API_docs_v44/methods/account.getThemes.md b/old_docs/API_docs_v44/methods/account.getThemes.md new file mode 100644 index 00000000..e54bfb30 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getThemes.md @@ -0,0 +1,47 @@ +--- +title: account.getThemes +description: Get installed themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getThemes.html +--- +# Method: account.getThemes +[Back to methods index](index.md) + + + +Get installed themes + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [account.Themes](../types/account.Themes.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.Themes = $MadelineProto->account->getThemes(['format' => 'string', 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +account.Themes = account.getThemes({format='string', hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.getTmpPassword.md b/old_docs/API_docs_v44/methods/account.getTmpPassword.md new file mode 100644 index 00000000..660a1169 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getTmpPassword.md @@ -0,0 +1,55 @@ +--- +title: account.getTmpPassword +description: Get temporary payment password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getTmpPassword.html +--- +# Method: account.getTmpPassword +[Back to methods index](index.md) + + + +Get temporary payment password + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | SRP password parameters | Yes| +|period|[int](../types/int.md) | Time during which the temporary password will be valid, in seconds; should be between 60 and 86400 | Yes| + + +### Return type: [account.TmpPassword](../types/account.TmpPassword.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.TmpPassword = $MadelineProto->account->getTmpPassword(['password' => InputCheckPasswordSRP, 'period' => int, ]); +``` + +Or, if you're into Lua: + +```lua +account.TmpPassword = account.getTmpPassword({password=InputCheckPasswordSRP, period=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v44/methods/channels.getDialogs.md b/old_docs/API_docs_v44/methods/account.getWallPaper.md similarity index 54% rename from old_docs/API_docs_v44/methods/channels.getDialogs.md rename to old_docs/API_docs_v44/methods/account.getWallPaper.md index eedefd52..172fc946 100644 --- a/old_docs/API_docs_v44/methods/channels.getDialogs.md +++ b/old_docs/API_docs_v44/methods/account.getWallPaper.md @@ -1,26 +1,26 @@ --- -title: channels.getDialogs -description: Get channel dialogs +title: account.getWallPaper +description: Get info about a certain wallpaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_getDialogs.html +redirect_from: /API_docs/methods/account_getWallPaper.html --- -# Method: channels.getDialogs +# Method: account.getWallPaper [Back to methods index](index.md) -Get channel dialogs + +Get info about a certain wallpaper ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|offset|[int](../types/int.md) | Offset | Yes| -|limit|[int](../types/int.md) | Number of results to return | Yes| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | The wallpaper to get info about | Yes| -### Return type: [messages.Dialogs](../types/messages.Dialogs.md) +### Return type: [WallPaper](../types/WallPaper.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -35,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Dialogs = $MadelineProto->channels->getDialogs(['offset' => int, 'limit' => int, ]); +$WallPaper = $MadelineProto->account->getWallPaper(['wallpaper' => InputWallPaper, ]); ``` Or, if you're into Lua: ```lua -messages.Dialogs = channels.getDialogs({offset=int, limit=int, }) +WallPaper = account.getWallPaper({wallpaper=InputWallPaper, }) ``` diff --git a/old_docs/API_docs_v44/methods/account.getWallPapers.md b/old_docs/API_docs_v44/methods/account.getWallPapers.md index bdc53f34..46c3e49a 100644 --- a/old_docs/API_docs_v44/methods/account.getWallPapers.md +++ b/old_docs/API_docs_v44/methods/account.getWallPapers.md @@ -4,15 +4,21 @@ description: Returns a list of available wallpapers. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_getWallPapers.html --- -# Method: account.getWallPapers +# Method: account.getWallPapers [Back to methods index](index.md) + Returns a list of available wallpapers. +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| -### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md) +### Return type: [account.WallPapers](../types/account.WallPapers.md) ### Can bots use this method: **NO** @@ -29,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Vector_of_WallPaper = $MadelineProto->account->getWallPapers(); +$account.WallPapers = $MadelineProto->account->getWallPapers(['hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -Vector_of_WallPaper = account.getWallPapers({}) +account.WallPapers = account.getWallPapers({hash={int}, }) ``` diff --git a/old_docs/API_docs_v44/methods/account.getWebAuthorizations.md b/old_docs/API_docs_v44/methods/account.getWebAuthorizations.md new file mode 100644 index 00000000..7a84a892 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.getWebAuthorizations.md @@ -0,0 +1,41 @@ +--- +title: account.getWebAuthorizations +description: Get web [login widget](https://core.telegram.org/widgets/login) authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getWebAuthorizations.html +--- +# Method: account.getWebAuthorizations +[Back to methods index](index.md) + + + +Get web [login widget](https://core.telegram.org/widgets/login) authorizations + + + +### Return type: [account.WebAuthorizations](../types/account.WebAuthorizations.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.WebAuthorizations = $MadelineProto->account->getWebAuthorizations(); +``` + +Or, if you're into Lua: + +```lua +account.WebAuthorizations = account.getWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.initTakeoutSession.md b/old_docs/API_docs_v44/methods/account.initTakeoutSession.md new file mode 100644 index 00000000..73eae2fd --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.initTakeoutSession.md @@ -0,0 +1,59 @@ +--- +title: account.initTakeoutSession +description: Intialize account takeout session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_initTakeoutSession.html +--- +# Method: account.initTakeoutSession +[Back to methods index](index.md) + + + +Intialize account takeout session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|[Bool](../types/Bool.md) | Whether to export contacts | Optional| +|message\_users|[Bool](../types/Bool.md) | Whether to export messages in private chats | Optional| +|message\_chats|[Bool](../types/Bool.md) | Whether to export messages in [legacy groups](https://core.telegram.org/api/channel) | Optional| +|message\_megagroups|[Bool](../types/Bool.md) | Whether to export messages in [supergroups](https://core.telegram.org/api/channel) | Optional| +|message\_channels|[Bool](../types/Bool.md) | Whether to export messages in [channels](https://core.telegram.org/api/channel) | Optional| +|files|[Bool](../types/Bool.md) | Whether to export files | Optional| +|file\_max\_size|[int](../types/int.md) | Maximum size of files to export | Optional| + + +### Return type: [account.Takeout](../types/account.Takeout.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.Takeout = $MadelineProto->account->initTakeoutSession(['contacts' => Bool, 'message_users' => Bool, 'message_chats' => Bool, 'message_megagroups' => Bool, 'message_channels' => Bool, 'files' => Bool, 'file_max_size' => int, ]); +``` + +Or, if you're into Lua: + +```lua +account.Takeout = account.initTakeoutSession({contacts=Bool, message_users=Bool, message_chats=Bool, message_megagroups=Bool, message_channels=Bool, files=Bool, file_max_size=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|420|TAKEOUT_INIT_DELAY_X|Wait X seconds before initing takeout| + + diff --git a/old_docs/API_docs_v44/methods/account.installTheme.md b/old_docs/API_docs_v44/methods/account.installTheme.md new file mode 100644 index 00000000..648b7372 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.installTheme.md @@ -0,0 +1,48 @@ +--- +title: account.installTheme +description: Install a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_installTheme.html +--- +# Method: account.installTheme +[Back to methods index](index.md) + + + +Install a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dark|[Bool](../types/Bool.md) | Whether to install the dark version | Optional| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Optional| +|theme|[InputTheme](../types/InputTheme.md) | Theme to install | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->installTheme(['dark' => Bool, 'format' => 'string', 'theme' => InputTheme, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.installTheme({dark=Bool, format='string', theme=InputTheme, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.installWallPaper.md b/old_docs/API_docs_v44/methods/account.installWallPaper.md new file mode 100644 index 00000000..64962cdd --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.installWallPaper.md @@ -0,0 +1,47 @@ +--- +title: account.installWallPaper +description: Install wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_installWallPaper.html +--- +# Method: account.installWallPaper +[Back to methods index](index.md) + + + +Install wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper to install | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->installWallPaper(['wallpaper' => InputWallPaper, 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.installWallPaper({wallpaper=InputWallPaper, settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.registerDevice.md b/old_docs/API_docs_v44/methods/account.registerDevice.md index 217db010..e08867f3 100644 --- a/old_docs/API_docs_v44/methods/account.registerDevice.md +++ b/old_docs/API_docs_v44/methods/account.registerDevice.md @@ -4,23 +4,23 @@ description: Register device to receive [PUSH notifications](https://core.telegr image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_registerDevice.html --- -# Method: account.registerDevice +# Method: account.registerDevice [Back to methods index](index.md) + Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates) ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|no\_muted|[Bool](../types/Bool.md) | Avoid receiving (silent and invisible background) notifications. Useful to save battery. | Optional| |token\_type|[int](../types/int.md) | Device token type.
**Possible values**:
`1` \- APNS (device token for apple push)
`2` \- FCM (firebase token for google firebase)
`3` \- MPNS (channel URI for microsoft push)
`4` \- Simple push (endpoint for firefox's simple push API)
`5` \- Ubuntu phone (token for ubuntu push)
`6` \- Blackberry (token for blackberry push)
`7` \- Unused
`8` \- WNS (windows push)
`9` \- APNS VoIP (token for apple push VoIP)
`10` \- Web push (web push, see below)
`11` \- MPNS VoIP (token for microsoft push VoIP)
`12` \- Tizen (token for tizen push)
For `10` web push, the token must be a JSON-encoded object containing the keys described in [PUSH updates](https://core.telegram.org/api/push-updates) | Yes| |token|[string](../types/string.md) | Device token | Yes| -|device\_model|[string](../types/string.md) | Device model | Yes| -|system\_version|[string](../types/string.md) | System version | Yes| -|app\_version|[string](../types/string.md) | App version | Yes| |app\_sandbox|[Bool](../types/Bool.md) | If [(boolTrue)](../constructors/boolTrue.md) is transmitted, a sandbox-certificate will be used during transmission. | Yes| -|lang\_code|[string](../types/string.md) | Language code | Yes| +|secret|[bytes](../types/bytes.md) | For FCM and APNS VoIP, optional encryption key used to encrypt push notifications | Yes| +|other\_uids|Array of [int](../types/int.md) | List of user identifiers of other users currently using the client | Yes| ### Return type: [Bool](../types/Bool.md) @@ -40,13 +40,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->account->registerDevice(['token_type' => int, 'token' => 'string', 'device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'app_sandbox' => Bool, 'lang_code' => 'string', ]); +$Bool = $MadelineProto->account->registerDevice(['no_muted' => Bool, 'token_type' => int, 'token' => 'string', 'app_sandbox' => Bool, 'secret' => 'bytes', 'other_uids' => [int, int], ]); ``` Or, if you're into Lua: ```lua -Bool = account.registerDevice({token_type=int, token='string', device_model='string', system_version='string', app_version='string', app_sandbox=Bool, lang_code='string', }) +Bool = account.registerDevice({no_muted=Bool, token_type=int, token='string', app_sandbox=Bool, secret='bytes', other_uids={int}, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/account.reportPeer.md b/old_docs/API_docs_v44/methods/account.reportPeer.md index 20218120..40ec8f91 100644 --- a/old_docs/API_docs_v44/methods/account.reportPeer.md +++ b/old_docs/API_docs_v44/methods/account.reportPeer.md @@ -4,10 +4,11 @@ description: Report a peer for violation of telegram's Terms of Service image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_reportPeer.html --- -# Method: account.reportPeer +# Method: account.reportPeer [Back to methods index](index.md) + Report a peer for violation of telegram's Terms of Service ### Parameters: @@ -48,6 +49,7 @@ Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) | Code | Type | Description | |------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| |400|PEER_ID_INVALID|The provided peer id is invalid| diff --git a/old_docs/API_docs_v44/methods/account.resendPasswordEmail.md b/old_docs/API_docs_v44/methods/account.resendPasswordEmail.md new file mode 100644 index 00000000..bc328f31 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.resendPasswordEmail.md @@ -0,0 +1,41 @@ +--- +title: account.resendPasswordEmail +description: Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resendPasswordEmail.html +--- +# Method: account.resendPasswordEmail +[Back to methods index](index.md) + + + +Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->resendPasswordEmail(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resendPasswordEmail({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.resetAuthorization.md b/old_docs/API_docs_v44/methods/account.resetAuthorization.md index a036e867..73e1e0c9 100644 --- a/old_docs/API_docs_v44/methods/account.resetAuthorization.md +++ b/old_docs/API_docs_v44/methods/account.resetAuthorization.md @@ -4,10 +4,11 @@ description: Log out an active [authorized session](https://core.telegram.org/ap image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_resetAuthorization.html --- -# Method: account.resetAuthorization +# Method: account.resetAuthorization [Back to methods index](index.md) + Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.resetNotifySettings.md b/old_docs/API_docs_v44/methods/account.resetNotifySettings.md index c1988409..38b2aa32 100644 --- a/old_docs/API_docs_v44/methods/account.resetNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account.resetNotifySettings.md @@ -4,10 +4,11 @@ description: Resets all notification settings from users and groups. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_resetNotifySettings.html --- -# Method: account.resetNotifySettings +# Method: account.resetNotifySettings [Back to methods index](index.md) + Resets all notification settings from users and groups. diff --git a/old_docs/API_docs_v44/methods/account.resetWallPapers.md b/old_docs/API_docs_v44/methods/account.resetWallPapers.md new file mode 100644 index 00000000..72ced453 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.resetWallPapers.md @@ -0,0 +1,41 @@ +--- +title: account.resetWallPapers +description: Delete installed wallpapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWallPapers.html +--- +# Method: account.resetWallPapers +[Back to methods index](index.md) + + + +Delete installed wallpapers + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->resetWallPapers(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWallPapers({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.resetWebAuthorization.md b/old_docs/API_docs_v44/methods/account.resetWebAuthorization.md new file mode 100644 index 00000000..1848302f --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.resetWebAuthorization.md @@ -0,0 +1,46 @@ +--- +title: account.resetWebAuthorization +description: Log out an active web [telegram login](https://core.telegram.org/widgets/login) session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWebAuthorization.html +--- +# Method: account.resetWebAuthorization +[Back to methods index](index.md) + + + +Log out an active web [telegram login](https://core.telegram.org/widgets/login) session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[long](../types/long.md) | [Session](../constructors/webAuthorization.md) hash | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->resetWebAuthorization(['hash' => long, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWebAuthorization({hash=long, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.resetWebAuthorizations.md b/old_docs/API_docs_v44/methods/account.resetWebAuthorizations.md new file mode 100644 index 00000000..e97f0d1c --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.resetWebAuthorizations.md @@ -0,0 +1,41 @@ +--- +title: account.resetWebAuthorizations +description: Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWebAuthorizations.html +--- +# Method: account.resetWebAuthorizations +[Back to methods index](index.md) + + + +Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->resetWebAuthorizations(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v44/methods/account.saveAutoDownloadSettings.md b/old_docs/API_docs_v44/methods/account.saveAutoDownloadSettings.md new file mode 100644 index 00000000..3ed617d7 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.saveAutoDownloadSettings.md @@ -0,0 +1,48 @@ +--- +title: account.saveAutoDownloadSettings +description: Change media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveAutoDownloadSettings.html +--- +# Method: account.saveAutoDownloadSettings +[Back to methods index](index.md) + + + +Change media autodownload settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|low|[Bool](../types/Bool.md) | Whether to save settings in the low data usage preset | Optional| +|high|[Bool](../types/Bool.md) | Whether to save settings in the high data usage preset | Optional| +|settings|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Media autodownload settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->saveAutoDownloadSettings(['low' => Bool, 'high' => Bool, 'settings' => AutoDownloadSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveAutoDownloadSettings({low=Bool, high=Bool, settings=AutoDownloadSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.saveSecureValue.md b/old_docs/API_docs_v44/methods/account.saveSecureValue.md new file mode 100644 index 00000000..fb38f867 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.saveSecureValue.md @@ -0,0 +1,47 @@ +--- +title: account.saveSecureValue +description: Securely save [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveSecureValue.html +--- +# Method: account.saveSecureValue +[Back to methods index](index.md) + + + +Securely save [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|value|[InputSecureValue](../types/InputSecureValue.md) | Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) | Yes| +|secure\_secret\_id|[long](../types/long.md) | Passport secret hash, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) | Yes| + + +### Return type: [SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### 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(); + +$SecureValue = $MadelineProto->account->saveSecureValue(['value' => InputSecureValue, 'secure_secret_id' => long, ]); +``` + +Or, if you're into Lua: + +```lua +SecureValue = account.saveSecureValue({value=InputSecureValue, secure_secret_id=long, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.saveTheme.md b/old_docs/API_docs_v44/methods/account.saveTheme.md new file mode 100644 index 00000000..ff63529a --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.saveTheme.md @@ -0,0 +1,47 @@ +--- +title: account.saveTheme +description: Save a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveTheme.html +--- +# Method: account.saveTheme +[Back to methods index](index.md) + + + +Save a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|theme|[InputTheme](../types/InputTheme.md) | Theme to save | Yes| +|unsave|[Bool](../types/Bool.md) | Unsave | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->saveTheme(['theme' => InputTheme, 'unsave' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveTheme({theme=InputTheme, unsave=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.saveWallPaper.md b/old_docs/API_docs_v44/methods/account.saveWallPaper.md new file mode 100644 index 00000000..c94ad842 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.saveWallPaper.md @@ -0,0 +1,48 @@ +--- +title: account.saveWallPaper +description: Install/uninstall wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveWallPaper.html +--- +# Method: account.saveWallPaper +[Back to methods index](index.md) + + + +Install/uninstall wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper to save | Yes| +|unsave|[Bool](../types/Bool.md) | Uninstall wallpaper? | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->saveWallPaper(['wallpaper' => InputWallPaper, 'unsave' => Bool, 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveWallPaper({wallpaper=InputWallPaper, unsave=Bool, settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.sendChangePhoneCode.md b/old_docs/API_docs_v44/methods/account.sendChangePhoneCode.md index eefa63ed..b61d4275 100644 --- a/old_docs/API_docs_v44/methods/account.sendChangePhoneCode.md +++ b/old_docs/API_docs_v44/methods/account.sendChangePhoneCode.md @@ -4,10 +4,11 @@ description: Verify a new phone number to associate to the current account image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_sendChangePhoneCode.html --- -# Method: account.sendChangePhoneCode +# Method: account.sendChangePhoneCode [Back to methods index](index.md) + Verify a new phone number to associate to the current account ### Parameters: @@ -15,9 +16,10 @@ Verify a new phone number to associate to the current account | Name | Type | Description | Required | |----------|---------------|-------------|----------| |phone\_number|[string](../types/string.md) | New phone number | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| -### Return type: [account.SentChangePhoneCode](../types/account.SentChangePhoneCode.md) +### Return type: [auth.SentCode](../types/auth.SentCode.md) ### Can bots use this method: **NO** @@ -34,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$account.SentChangePhoneCode = $MadelineProto->account->sendChangePhoneCode(['phone_number' => 'string', ]); +$auth.SentCode = $MadelineProto->account->sendChangePhoneCode(['phone_number' => 'string', 'settings' => CodeSettings, ]); ``` Or, if you're into Lua: ```lua -account.SentChangePhoneCode = account.sendChangePhoneCode({phone_number='string', }) +auth.SentCode = account.sendChangePhoneCode({phone_number='string', settings=CodeSettings, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/account.sendConfirmPhoneCode.md b/old_docs/API_docs_v44/methods/account.sendConfirmPhoneCode.md new file mode 100644 index 00000000..04c48ef5 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.sendConfirmPhoneCode.md @@ -0,0 +1,54 @@ +--- +title: account.sendConfirmPhoneCode +description: Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendConfirmPhoneCode.html +--- +# Method: account.sendConfirmPhoneCode +[Back to methods index](index.md) + + + +Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The hash from the service notification, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### 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(); + +$auth.SentCode = $MadelineProto->account->sendConfirmPhoneCode(['hash' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = account.sendConfirmPhoneCode({hash='string', settings=CodeSettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v44/methods/account.sendVerifyEmailCode.md b/old_docs/API_docs_v44/methods/account.sendVerifyEmailCode.md new file mode 100644 index 00000000..586e5b9b --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.sendVerifyEmailCode.md @@ -0,0 +1,46 @@ +--- +title: account.sendVerifyEmailCode +description: Send the verification email code for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendVerifyEmailCode.html +--- +# Method: account.sendVerifyEmailCode +[Back to methods index](index.md) + + + +Send the verification email code for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|email|[string](../types/string.md) | The email where to send the code | Yes| + + +### Return type: [account.SentEmailCode](../types/account.SentEmailCode.md) + +### Can bots use this method: **NO** + + +### 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(); + +$account.SentEmailCode = $MadelineProto->account->sendVerifyEmailCode(['email' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +account.SentEmailCode = account.sendVerifyEmailCode({email='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.sendVerifyPhoneCode.md b/old_docs/API_docs_v44/methods/account.sendVerifyPhoneCode.md new file mode 100644 index 00000000..653e6fe9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.sendVerifyPhoneCode.md @@ -0,0 +1,47 @@ +--- +title: account.sendVerifyPhoneCode +description: Send the verification phone code for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendVerifyPhoneCode.html +--- +# Method: account.sendVerifyPhoneCode +[Back to methods index](index.md) + + + +Send the verification phone code for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to verify | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### 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(); + +$auth.SentCode = $MadelineProto->account->sendVerifyPhoneCode(['phone_number' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = account.sendVerifyPhoneCode({phone_number='string', settings=CodeSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.setAccountTTL.md b/old_docs/API_docs_v44/methods/account.setAccountTTL.md index de4221a5..998e5025 100644 --- a/old_docs/API_docs_v44/methods/account.setAccountTTL.md +++ b/old_docs/API_docs_v44/methods/account.setAccountTTL.md @@ -4,10 +4,11 @@ description: Set account self-destruction period image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_setAccountTTL.html --- -# Method: account.setAccountTTL +# Method: account.setAccountTTL [Back to methods index](index.md) + Set account self-destruction period ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.setContactSignUpNotification.md b/old_docs/API_docs_v44/methods/account.setContactSignUpNotification.md new file mode 100644 index 00000000..b2a5f885 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.setContactSignUpNotification.md @@ -0,0 +1,46 @@ +--- +title: account.setContactSignUpNotification +description: Toggle contact sign up notifications +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setContactSignUpNotification.html +--- +# Method: account.setContactSignUpNotification +[Back to methods index](index.md) + + + +Toggle contact sign up notifications + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to disable contact sign up notifications | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->setContactSignUpNotification(['silent' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setContactSignUpNotification({silent=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.setContentSettings.md b/old_docs/API_docs_v44/methods/account.setContentSettings.md new file mode 100644 index 00000000..d277be60 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.setContentSettings.md @@ -0,0 +1,46 @@ +--- +title: account.setContentSettings +description: Set sensitive content settings (for viewing or hiding NSFW content) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setContentSettings.html +--- +# Method: account.setContentSettings +[Back to methods index](index.md) + + + +Set sensitive content settings (for viewing or hiding NSFW content) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Enable NSFW content | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->setContentSettings(['sensitive_enabled' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setContentSettings({sensitive_enabled=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.setGlobalPrivacySettings.md b/old_docs/API_docs_v44/methods/account.setGlobalPrivacySettings.md new file mode 100644 index 00000000..ed29175a --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.setGlobalPrivacySettings.md @@ -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, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.setPrivacy.md b/old_docs/API_docs_v44/methods/account.setPrivacy.md index b53cc7c6..d24fd8da 100644 --- a/old_docs/API_docs_v44/methods/account.setPrivacy.md +++ b/old_docs/API_docs_v44/methods/account.setPrivacy.md @@ -4,10 +4,11 @@ description: Change privacy settings of current account image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_setPrivacy.html --- -# Method: account.setPrivacy +# Method: account.setPrivacy [Back to methods index](index.md) + Change privacy settings of current account ### Parameters: @@ -15,7 +16,7 @@ Change privacy settings of current account | Name | Type | Description | Required | |----------|---------------|-------------|----------| |key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Peers to which the privacy rules apply | Yes| -|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Privacy settings | Yes| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | New privacy rules | Yes| ### Return type: [account.PrivacyRules](../types/account.PrivacyRules.md) @@ -49,5 +50,6 @@ account.PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPriv | Code | Type | Description | |------|----------|---------------| |400|PRIVACY_KEY_INVALID|The privacy key is invalid| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| diff --git a/old_docs/API_docs_v44/methods/account.unregisterDevice.md b/old_docs/API_docs_v44/methods/account.unregisterDevice.md index f79bdf38..69fa0e8d 100644 --- a/old_docs/API_docs_v44/methods/account.unregisterDevice.md +++ b/old_docs/API_docs_v44/methods/account.unregisterDevice.md @@ -4,10 +4,11 @@ description: Deletes a device by its token, stops sending PUSH-notifications to image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_unregisterDevice.html --- -# Method: account.unregisterDevice +# Method: account.unregisterDevice [Back to methods index](index.md) + Deletes a device by its token, stops sending PUSH-notifications to it. ### Parameters: @@ -16,6 +17,7 @@ Deletes a device by its token, stops sending PUSH-notifications to it. |----------|---------------|-------------|----------| |token\_type|[int](../types/int.md) | Device token type.
**Possible values**:
`1` \- APNS (device token for apple push)
`2` \- FCM (firebase token for google firebase)
`3` \- MPNS (channel URI for microsoft push)
`4` \- Simple push (endpoint for firefox's simple push API)
`5` \- Ubuntu phone (token for ubuntu push)
`6` \- Blackberry (token for blackberry push)
`7` \- Unused
`8` \- WNS (windows push)
`9` \- APNS VoIP (token for apple push VoIP)
`10` \- Web push (web push, see below)
`11` \- MPNS VoIP (token for microsoft push VoIP)
`12` \- Tizen (token for tizen push)
For `10` web push, the token must be a JSON-encoded object containing the keys described in [PUSH updates](https://core.telegram.org/api/push-updates) | Yes| |token|[string](../types/string.md) | Device token | Yes| +|other\_uids|Array of [int](../types/int.md) | List of user identifiers of other users currently using the client | Yes| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->account->unregisterDevice(['token_type' => int, 'token' => 'string', ]); +$Bool = $MadelineProto->account->unregisterDevice(['token_type' => int, 'token' => 'string', 'other_uids' => [int, int], ]); ``` Or, if you're into Lua: ```lua -Bool = account.unregisterDevice({token_type=int, token='string', }) +Bool = account.unregisterDevice({token_type=int, token='string', other_uids={int}, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/account.updateDeviceLocked.md b/old_docs/API_docs_v44/methods/account.updateDeviceLocked.md index 944e62db..c0e7a6cf 100644 --- a/old_docs/API_docs_v44/methods/account.updateDeviceLocked.md +++ b/old_docs/API_docs_v44/methods/account.updateDeviceLocked.md @@ -4,10 +4,11 @@ description: When client-side passcode lock feature is enabled, will not show me image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updateDeviceLocked.html --- -# Method: account.updateDeviceLocked +# Method: account.updateDeviceLocked [Back to methods index](index.md) + When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates). ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.updateNotifySettings.md b/old_docs/API_docs_v44/methods/account.updateNotifySettings.md index 9e22703e..7b2b80a5 100644 --- a/old_docs/API_docs_v44/methods/account.updateNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account.updateNotifySettings.md @@ -4,10 +4,11 @@ description: Edits notification settings from a given user/group, from all users image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updateNotifySettings.html --- -# Method: account.updateNotifySettings +# Method: account.updateNotifySettings [Back to methods index](index.md) + Edits notification settings from a given user/group, from all users/all groups. ### Parameters: @@ -49,6 +50,7 @@ Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNot | Code | Type | Description | |------|----------|---------------| |400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| |400|PEER_ID_INVALID|The provided peer id is invalid| |400|SETTINGS_INVALID|Invalid settings were provided| diff --git a/old_docs/API_docs_v44/methods/account.updatePasswordSettings.md b/old_docs/API_docs_v44/methods/account.updatePasswordSettings.md index 0ae95300..68adba1f 100644 --- a/old_docs/API_docs_v44/methods/account.updatePasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account.updatePasswordSettings.md @@ -1,21 +1,22 @@ --- title: account.updatePasswordSettings -description: You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) +description: Set a new 2FA password image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updatePasswordSettings.html --- -# Method: account.updatePasswordSettings +# Method: account.updatePasswordSettings [Back to methods index](index.md) -You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) + +Set a new 2FA password ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|current\_password\_hash|[bytes](../types/bytes.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| -|new\_settings|[account.PasswordInputSettings](../types/account.PasswordInputSettings.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | The old password (see [SRP](https://core.telegram.org/api/srp)) | Yes| +|new\_settings|[account.PasswordInputSettings](../types/account.PasswordInputSettings.md) | The new password (see [SRP](https://core.telegram.org/api/srp)) | Yes| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->account->updatePasswordSettings(['current_password_hash' => 'bytes', 'new_settings' => account.PasswordInputSettings, ]); +$Bool = $MadelineProto->account->updatePasswordSettings(['password' => InputCheckPasswordSRP, 'new_settings' => account.PasswordInputSettings, ]); ``` Or, if you're into Lua: ```lua -Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account.PasswordInputSettings, }) +Bool = account.updatePasswordSettings({password=InputCheckPasswordSRP, new_settings=account.PasswordInputSettings, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/account.updateProfile.md b/old_docs/API_docs_v44/methods/account.updateProfile.md index 8768e993..45749478 100644 --- a/old_docs/API_docs_v44/methods/account.updateProfile.md +++ b/old_docs/API_docs_v44/methods/account.updateProfile.md @@ -4,18 +4,20 @@ description: Updates user profile. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updateProfile.html --- -# Method: account.updateProfile +# Method: account.updateProfile [Back to methods index](index.md) + Updates user profile. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|first\_name|[string](../types/string.md) | New user first name | Yes| -|last\_name|[string](../types/string.md) | New user last name | Yes| +|first\_name|[string](../types/string.md) | New user first name | Optional| +|last\_name|[string](../types/string.md) | New user last name | Optional| +|about|[string](../types/string.md) | New bio | Optional| ### Return type: [User](../types/User.md) @@ -35,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$User = $MadelineProto->account->updateProfile(['first_name' => 'string', 'last_name' => 'string', ]); +$User = $MadelineProto->account->updateProfile(['first_name' => 'string', 'last_name' => 'string', 'about' => 'string', ]); ``` Or, if you're into Lua: ```lua -User = account.updateProfile({first_name='string', last_name='string', }) +User = account.updateProfile({first_name='string', last_name='string', about='string', }) ``` ### Errors @@ -51,6 +53,7 @@ User = account.updateProfile({first_name='string', last_name='string', }) |400|ABOUT_TOO_LONG|About string too long| |400|FIRSTNAME_INVALID|The first name 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| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/account.updateStatus.md b/old_docs/API_docs_v44/methods/account.updateStatus.md index 7c090256..42e62d23 100644 --- a/old_docs/API_docs_v44/methods/account.updateStatus.md +++ b/old_docs/API_docs_v44/methods/account.updateStatus.md @@ -4,10 +4,11 @@ description: Updates online user status. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updateStatus.html --- -# Method: account.updateStatus +# Method: account.updateStatus [Back to methods index](index.md) + Updates online user status. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/account.updateTheme.md b/old_docs/API_docs_v44/methods/account.updateTheme.md new file mode 100644 index 00000000..ed480a8b --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.updateTheme.md @@ -0,0 +1,51 @@ +--- +title: account.updateTheme +description: Update theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateTheme.html +--- +# Method: account.updateTheme +[Back to methods index](index.md) + + + +Update theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|theme|[InputTheme](../types/InputTheme.md) | Theme to update | Yes| +|slug|[string](../types/string.md) | Unique theme ID | Optional| +|title|[string](../types/string.md) | Theme name | Optional| +|document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | Theme settings | Optional| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Theme = $MadelineProto->account->updateTheme(['format' => 'string', 'theme' => InputTheme, 'slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Theme = account.updateTheme({format='string', theme=InputTheme, slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.updateUsername.md b/old_docs/API_docs_v44/methods/account.updateUsername.md index 198cf4da..4eee9112 100644 --- a/old_docs/API_docs_v44/methods/account.updateUsername.md +++ b/old_docs/API_docs_v44/methods/account.updateUsername.md @@ -4,17 +4,18 @@ description: Changes username for the current user. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/account_updateUsername.html --- -# Method: account.updateUsername +# Method: account.updateUsername [Back to methods index](index.md) + Changes username for the current user. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|username|[string](../types/string.md) | Username or empty string if username is to be removed
Accepted characters: a-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| +|username|[string](../types/string.md) | username or empty string if username is to be removed
Accepted characters: a-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| ### Return type: [User](../types/User.md) @@ -50,6 +51,7 @@ User = account.updateUsername({username='string', }) |400|USERNAME_INVALID|The provided username is not valid| |400|USERNAME_NOT_MODIFIED|The username was not modified| |400|USERNAME_OCCUPIED|The provided username is already occupied| +|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| diff --git a/old_docs/API_docs_v44/methods/account.uploadTheme.md b/old_docs/API_docs_v44/methods/account.uploadTheme.md new file mode 100644 index 00000000..999f6521 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.uploadTheme.md @@ -0,0 +1,56 @@ +--- +title: account.uploadTheme +description: Upload theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_uploadTheme.html +--- +# Method: account.uploadTheme +[Back to methods index](index.md) + + + +Upload theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | Theme file uploaded as described in [files »](https://core.telegram.org/api/files) | Yes| +|thumb|[File path or InputFile](../types/InputFile.md) | Thumbnail | Optional| +|file\_name|[string](../types/string.md) | File name | Yes| +|mime\_type|[string](../types/string.md) | MIME type, must be `application/x-tgtheme-{format}`, where `format` depends on the client | Yes| + + +### Return type: [Document](../types/Document.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Document = $MadelineProto->account->uploadTheme(['file' => InputFile, 'thumb' => InputFile, 'file_name' => 'string', 'mime_type' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Document = account.uploadTheme({file=InputFile, thumb=InputFile, file_name='string', mime_type='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|THEME_FILE_INVALID|Invalid theme file provided| + + diff --git a/old_docs/API_docs_v44/methods/account.uploadWallPaper.md b/old_docs/API_docs_v44/methods/account.uploadWallPaper.md new file mode 100644 index 00000000..77540335 --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.uploadWallPaper.md @@ -0,0 +1,48 @@ +--- +title: account.uploadWallPaper +description: Create and upload a new wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_uploadWallPaper.html +--- +# Method: account.uploadWallPaper +[Back to methods index](index.md) + + + +Create and upload a new wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The JPG/PNG wallpaper | Yes| +|mime\_type|[string](../types/string.md) | MIME type of uploaded wallpaper | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [WallPaper](../types/WallPaper.md) + +### Can bots use this method: **NO** + + +### 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(); + +$WallPaper = $MadelineProto->account->uploadWallPaper(['file' => InputFile, 'mime_type' => 'string', 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +WallPaper = account.uploadWallPaper({file=InputFile, mime_type='string', settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v44/methods/account.verifyEmail.md b/old_docs/API_docs_v44/methods/account.verifyEmail.md new file mode 100644 index 00000000..9ca060ee --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.verifyEmail.md @@ -0,0 +1,54 @@ +--- +title: account.verifyEmail +description: Verify an email address for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_verifyEmail.html +--- +# Method: account.verifyEmail +[Back to methods index](index.md) + + + +Verify an email address for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|email|[string](../types/string.md) | The email to verify | Yes| +|code|[string](../types/string.md) | The verification code that was received | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->verifyEmail(['email' => 'string', 'code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.verifyEmail({email='string', code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|EMAIL_VERIFY_EXPIRED|The verification email has expired| + + diff --git a/old_docs/API_docs_v44/methods/account.verifyPhone.md b/old_docs/API_docs_v44/methods/account.verifyPhone.md new file mode 100644 index 00000000..2b4e724f --- /dev/null +++ b/old_docs/API_docs_v44/methods/account.verifyPhone.md @@ -0,0 +1,55 @@ +--- +title: account.verifyPhone +description: Verify a phone number for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_verifyPhone.html +--- +# Method: account.verifyPhone +[Back to methods index](index.md) + + + +Verify a phone number for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash received from the call to [account.sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) | Yes| +|phone\_code|[string](../types/string.md) | Code received after the call to [account.sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->account->verifyPhone(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.verifyPhone({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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)| + + diff --git a/old_docs/API_docs_v44/methods/api_README.md b/old_docs/API_docs_v44/methods/api_README.md index a1a5c20b..38a6259c 100644 --- a/old_docs/API_docs_v44/methods/api_README.md +++ b/old_docs/API_docs_v44/methods/api_README.md @@ -34,6 +34,14 @@ $MadelineProto->[requestCall](https://docs.madelineproto.xyz/requestCall.html)($ $MadelineProto->[requestSecretChat](https://docs.madelineproto.xyz/requestSecretChat.html)($id); +*** +
+$MadelineProto->[account->acceptAuthorization](account.acceptAuthorization.md)(\['bot_id' => [int](../types/int.md), 'scope' => [string](../types/string.md), 'public_key' => [string](../types/string.md), 'value_hashes' => \[[SecureValueHash](../types/SecureValueHash.md)\], 'credentials' => [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->cancelPasswordEmail](account.cancelPasswordEmail.md)(\[\]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[account->changePhone](account.changePhone.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$User](../types/User.md) @@ -42,18 +50,70 @@ $MadelineProto->[account->changePhone](account.changePhone.md)(\['phone_number'
$MadelineProto->[account->checkUsername](account.checkUsername.md)(\['username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[account->confirmPasswordEmail](account.confirmPasswordEmail.md)(\['code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->confirmPhone](account.confirmPhone.md)(\['phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->createTheme](account.createTheme.md)(\['slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.md) + ***
$MadelineProto->[account->deleteAccount](account.deleteAccount.md)(\['reason' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[account->deleteSecureValue](account.deleteSecureValue.md)(\['types' => \[[SecureValueType](../types/SecureValueType.md)\], \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->finishTakeoutSession](account.finishTakeoutSession.md)(\['success' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[account->getAccountTTL](account.getAccountTTL.md)(\[\]) === [$AccountDaysTTL](../types/AccountDaysTTL.md) +*** +
+$MadelineProto->[account->getAllSecureValues](account.getAllSecureValues.md)(\[\]) === [$Vector\_of\_SecureValue](../types/SecureValue.md) + +*** +
+$MadelineProto->[account->getAuthorizationForm](account.getAuthorizationForm.md)(\['bot_id' => [int](../types/int.md), 'scope' => [string](../types/string.md), 'public_key' => [string](../types/string.md), \]) === [$account.AuthorizationForm](../types/account.AuthorizationForm.md) + ***
$MadelineProto->[account->getAuthorizations](account.getAuthorizations.md)(\[\]) === [$account.Authorizations](../types/account.Authorizations.md) +*** +
+$MadelineProto->[account->getAutoDownloadSettings](account.getAutoDownloadSettings.md)(\[\]) === [$account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + +*** +
+$MadelineProto->[account->getContactSignUpNotification](account.getContactSignUpNotification.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->getContentSettings](account.getContentSettings.md)(\[\]) === [$account.ContentSettings](../types/account.ContentSettings.md) + +*** +
+$MadelineProto->[account->getGlobalPrivacySettings](account.getGlobalPrivacySettings.md)(\[\]) === [$GlobalPrivacySettings](../types/GlobalPrivacySettings.md) + +*** +
+$MadelineProto->[account->getMultiWallPapers](account.getMultiWallPapers.md)(\['wallpapers' => \[[InputWallPaper](../types/InputWallPaper.md)\], \]) === [$Vector\_of\_WallPaper](../types/WallPaper.md) + +*** +
+$MadelineProto->[account->getNotifyExceptions](account.getNotifyExceptions.md)(\['compare_sound' => [Bool](../types/Bool.md), 'peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), \]) === [$Updates](../types/Updates.md) + ***
$MadelineProto->[account->getNotifySettings](account.getNotifySettings.md)(\['peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), \]) === [$PeerNotifySettings](../types/PeerNotifySettings.md) @@ -64,7 +124,7 @@ $MadelineProto->[account->getPassword](account.getPassword.md)(\[\]) === [$accou ***
-$MadelineProto->[account->getPasswordSettings](account.getPasswordSettings.md)(\['current_password_hash' => [bytes](../types/bytes.md), \]) === [$account.PasswordSettings](../types/account.PasswordSettings.md) +$MadelineProto->[account->getPasswordSettings](account.getPasswordSettings.md)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$account.PasswordSettings](../types/account.PasswordSettings.md) ***
@@ -72,16 +132,56 @@ $MadelineProto->[account->getPrivacy](account.getPrivacy.md)(\['key' => [InputPr ***
-$MadelineProto->[account->getWallPapers](account.getWallPapers.md)(\[\]) === [$Vector\_of\_WallPaper](../types/WallPaper.md) +$MadelineProto->[account->getSecureValue](account.getSecureValue.md)(\['types' => \[[SecureValueType](../types/SecureValueType.md)\], \]) === [$Vector\_of\_SecureValue](../types/SecureValue.md) ***
-$MadelineProto->[account->registerDevice](account.registerDevice.md)(\['token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), 'device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'app_sandbox' => [Bool](../types/Bool.md), 'lang_code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[account->getTheme](account.getTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'document_id' => [long](../types/long.md), \]) === [$Theme](../types/Theme.md) + +*** +
+$MadelineProto->[account->getThemes](account.getThemes.md)(\['format' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$account.Themes](../types/account.Themes.md) + +*** +
+$MadelineProto->[account->getTmpPassword](account.getTmpPassword.md)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), 'period' => [int](../types/int.md), \]) === [$account.TmpPassword](../types/account.TmpPassword.md) + +*** +
+$MadelineProto->[account->getWallPaper](account.getWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), \]) === [$WallPaper](../types/WallPaper.md) + +*** +
+$MadelineProto->[account->getWallPapers](account.getWallPapers.md)(\['hash' => [int](../types/int.md), \]) === [$account.WallPapers](../types/account.WallPapers.md) + +*** +
+$MadelineProto->[account->getWebAuthorizations](account.getWebAuthorizations.md)(\[\]) === [$account.WebAuthorizations](../types/account.WebAuthorizations.md) + +*** +
+$MadelineProto->[account->initTakeoutSession](account.initTakeoutSession.md)(\['contacts' => [Bool](../types/Bool.md), 'message_users' => [Bool](../types/Bool.md), 'message_chats' => [Bool](../types/Bool.md), 'message_megagroups' => [Bool](../types/Bool.md), 'message_channels' => [Bool](../types/Bool.md), 'files' => [Bool](../types/Bool.md), 'file_max_size' => [int](../types/int.md), \]) === [$account.Takeout](../types/account.Takeout.md) + +*** +
+$MadelineProto->[account->installTheme](account.installTheme.md)(\['dark' => [Bool](../types/Bool.md), 'format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->installWallPaper](account.installWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->registerDevice](account.registerDevice.md)(\['no_muted' => [Bool](../types/Bool.md), 'token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), 'app_sandbox' => [Bool](../types/Bool.md), 'secret' => [bytes](../types/bytes.md), 'other_uids' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) ***
$MadelineProto->[account->reportPeer](account.reportPeer.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'reason' => [ReportReason](../types/ReportReason.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[account->resendPasswordEmail](account.resendPasswordEmail.md)(\[\]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[account->resetAuthorization](account.resetAuthorization.md)(\['hash' => [long](../types/long.md), \]) === [$Bool](../types/Bool.md) @@ -92,19 +192,71 @@ $MadelineProto->[account->resetNotifySettings](account.resetNotifySettings.md)(\ ***
-$MadelineProto->[account->sendChangePhoneCode](account.sendChangePhoneCode.md)(\['phone_number' => [string](../types/string.md), \]) === [$account.SentChangePhoneCode](../types/account.SentChangePhoneCode.md) +$MadelineProto->[account->resetWallPapers](account.resetWallPapers.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->resetWebAuthorization](account.resetWebAuthorization.md)(\['hash' => [long](../types/long.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->resetWebAuthorizations](account.resetWebAuthorizations.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->saveAutoDownloadSettings](account.saveAutoDownloadSettings.md)(\['low' => [Bool](../types/Bool.md), 'high' => [Bool](../types/Bool.md), 'settings' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->saveSecureValue](account.saveSecureValue.md)(\['value' => [InputSecureValue](../types/InputSecureValue.md), 'secure_secret_id' => [long](../types/long.md), \]) === [$SecureValue](../types/SecureValue.md) + +*** +
+$MadelineProto->[account->saveTheme](account.saveTheme.md)(\['theme' => [InputTheme](../types/InputTheme.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->saveWallPaper](account.saveWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'unsave' => [Bool](../types/Bool.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->sendChangePhoneCode](account.sendChangePhoneCode.md)(\['phone_number' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) + +*** +
+$MadelineProto->[account->sendConfirmPhoneCode](account.sendConfirmPhoneCode.md)(\['hash' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) + +*** +
+$MadelineProto->[account->sendVerifyEmailCode](account.sendVerifyEmailCode.md)(\['email' => [string](../types/string.md), \]) === [$account.SentEmailCode](../types/account.SentEmailCode.md) + +*** +
+$MadelineProto->[account->sendVerifyPhoneCode](account.sendVerifyPhoneCode.md)(\['phone_number' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) ***
$MadelineProto->[account->setAccountTTL](account.setAccountTTL.md)(\['ttl' => [AccountDaysTTL](../types/AccountDaysTTL.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[account->setContactSignUpNotification](account.setContactSignUpNotification.md)(\['silent' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->setContentSettings](account.setContentSettings.md)(\['sensitive_enabled' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->setGlobalPrivacySettings](account.setGlobalPrivacySettings.md)(\['settings' => [GlobalPrivacySettings](../types/GlobalPrivacySettings.md), \]) === [$GlobalPrivacySettings](../types/GlobalPrivacySettings.md) + ***
$MadelineProto->[account->setPrivacy](account.setPrivacy.md)(\['key' => [InputPrivacyKey](../types/InputPrivacyKey.md), 'rules' => \[[InputPrivacyRule](../types/InputPrivacyRule.md)\], \]) === [$account.PrivacyRules](../types/account.PrivacyRules.md) ***
-$MadelineProto->[account->unregisterDevice](account.unregisterDevice.md)(\['token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[account->unregisterDevice](account.unregisterDevice.md)(\['token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), 'other_uids' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) ***
@@ -116,36 +268,68 @@ $MadelineProto->[account->updateNotifySettings](account.updateNotifySettings.md) ***
-$MadelineProto->[account->updatePasswordSettings](account.updatePasswordSettings.md)(\['current_password_hash' => [bytes](../types/bytes.md), 'new_settings' => [account.PasswordInputSettings](../types/account.PasswordInputSettings.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[account->updatePasswordSettings](account.updatePasswordSettings.md)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), 'new_settings' => [account.PasswordInputSettings](../types/account.PasswordInputSettings.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[account->updateProfile](account.updateProfile.md)(\['first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]) === [$User](../types/User.md) +$MadelineProto->[account->updateProfile](account.updateProfile.md)(\['first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'about' => [string](../types/string.md), \]) === [$User](../types/User.md) ***
$MadelineProto->[account->updateStatus](account.updateStatus.md)(\['offline' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[account->updateTheme](account.updateTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.md) + ***
$MadelineProto->[account->updateUsername](account.updateUsername.md)(\['username' => [string](../types/string.md), \]) === [$User](../types/User.md) +*** +
+$MadelineProto->[account->uploadTheme](account.uploadTheme.md)(\['file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), \]) === [$Document](../types/Document.md) + +*** +
+$MadelineProto->[account->uploadWallPaper](account.uploadWallPaper.md)(\['file' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$WallPaper](../types/WallPaper.md) + +*** +
+$MadelineProto->[account->verifyEmail](account.verifyEmail.md)(\['email' => [string](../types/string.md), 'code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[account->verifyPhone](account.verifyPhone.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[auth->acceptLoginToken](auth.acceptLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$Authorization](../types/Authorization.md) + ***
$MadelineProto->[auth->bindTempAuthKey](auth.bindTempAuthKey.md)(\['perm_auth_key_id' => [long](../types/long.md), 'nonce' => [long](../types/long.md), 'expires_at' => [int](../types/int.md), 'encrypted_message' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[auth->checkPassword](auth.checkPassword.md)(\['password_hash' => [bytes](../types/bytes.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) +$MadelineProto->[auth->cancelCode](auth.cancelCode.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[auth->checkPhone](auth.checkPhone.md)(\['phone_number' => [string](../types/string.md), \]) === [$auth.CheckedPhone](../types/auth.CheckedPhone.md) +$MadelineProto->[auth->checkPassword](auth.checkPassword.md)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) + +*** +
+$MadelineProto->[auth->dropTempAuthKeys](auth.dropTempAuthKeys.md)(\['except_auth_keys' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) ***
$MadelineProto->[auth->exportAuthorization](auth.exportAuthorization.md)(\['dc_id' => [int](../types/int.md), \]) === [$auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md) +*** +
+$MadelineProto->[auth->exportLoginToken](auth.exportLoginToken.md)(\['api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'except_ids' => \[[int](../types/int.md)\], \]) === [$auth.LoginToken](../types/auth.LoginToken.md) + ***
$MadelineProto->[auth->importAuthorization](auth.importAuthorization.md)(\['id' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) @@ -154,6 +338,10 @@ $MadelineProto->[auth->importAuthorization](auth.importAuthorization.md)(\['id'
$MadelineProto->[auth->importBotAuthorization](auth.importBotAuthorization.md)(\['api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'bot_auth_token' => [string](../types/string.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) +*** +
+$MadelineProto->[auth->importLoginToken](auth.importLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$auth.LoginToken](../types/auth.LoginToken.md) + ***
$MadelineProto->[auth->logOut](auth.logOut.md)(\[\]) === [$Bool](../types/Bool.md) @@ -166,25 +354,17 @@ $MadelineProto->[auth->recoverPassword](auth.recoverPassword.md)(\['code' => [st
$MadelineProto->[auth->requestPasswordRecovery](auth.requestPasswordRecovery.md)(\[\]) === [$auth.PasswordRecovery](../types/auth.PasswordRecovery.md) +*** +
+$MadelineProto->[auth->resendCode](auth.resendCode.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) + ***
$MadelineProto->[auth->resetAuthorizations](auth.resetAuthorizations.md)(\[\]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[auth->sendCall](auth.sendCall.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) - -*** -
-$MadelineProto->[auth->sendCode](auth.sendCode.md)(\['phone_number' => [string](../types/string.md), 'sms_type' => [int](../types/int.md), 'api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) - -*** -
-$MadelineProto->[auth->sendInvites](auth.sendInvites.md)(\['phone_numbers' => \[[string](../types/string.md)\], 'message' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) - -*** -
-$MadelineProto->[auth->sendSms](auth.sendSms.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[auth->sendCode](auth.sendCode.md)(\['phone_number' => [string](../types/string.md), 'api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) ***
@@ -192,7 +372,19 @@ $MadelineProto->[auth->signIn](auth.signIn.md)(\['phone_number' => [string](../t ***
-$MadelineProto->[auth->signUp](auth.signUp.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) +$MadelineProto->[auth->signUp](auth.signUp.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) + +*** +
+$MadelineProto->[bots->answerWebhookJSONQuery](bots.answerWebhookJSONQuery.md)(\['query_id' => [long](../types/long.md), 'data' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[bots->sendCustomRequest](bots.sendCustomRequest.md)(\['custom_method' => [string](../types/string.md), 'params' => [DataJSON](../types/DataJSON.md), \]) === [$DataJSON](../types/DataJSON.md) + +*** +
+$MadelineProto->[bots->setBotCommands](bots.setBotCommands.md)(\['commands' => \[[BotCommand](../types/BotCommand.md)\], \]) === [$Bool](../types/Bool.md) ***
@@ -200,12 +392,16 @@ $MadelineProto->[channels->checkUsername](channels.checkUsername.md)(\['channel' ***
-$MadelineProto->[channels->createChannel](channels.createChannel.md)(\['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'about' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[channels->createChannel](channels.createChannel.md)(\['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'about' => [string](../types/string.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) ***
$MadelineProto->[channels->deleteChannel](channels.deleteChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) +*** +
+$MadelineProto->[channels->deleteHistory](channels.deleteHistory.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'max_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[channels->deleteMessages](channels.deleteMessages.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages.AffectedMessages](../types/messages.AffectedMessages.md) @@ -216,11 +412,19 @@ $MadelineProto->[channels->deleteUserHistory](channels.deleteUserHistory.md)(\[' ***
-$MadelineProto->[channels->editAbout](channels.editAbout.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'about' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[channels->editAdmin](channels.editAdmin.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'rank' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) ***
-$MadelineProto->[channels->editAdmin](channels.editAdmin.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'role' => [ChannelParticipantRole](../types/ChannelParticipantRole.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[channels->editBanned](channels.editBanned.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[channels->editCreator](channels.editCreator.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[channels->editLocation](channels.editLocation.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) ***
@@ -232,27 +436,39 @@ $MadelineProto->[channels->editTitle](channels.editTitle.md)(\['channel' => [Inp ***
-$MadelineProto->[channels->exportInvite](channels.exportInvite.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$ExportedChatInvite](../types/ExportedChatInvite.md) +$MadelineProto->[channels->exportMessageLink](channels.exportMessageLink.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => [int](../types/int.md), 'grouped' => [Bool](../types/Bool.md), \]) === [$ExportedMessageLink](../types/ExportedMessageLink.md) + +*** +
+$MadelineProto->[channels->getAdminLog](channels.getAdminLog.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'q' => [string](../types/string.md), 'events_filter' => [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md), 'admins' => \[[InputUser](../types/InputUser.md)\], 'max_id' => [long](../types/long.md), 'min_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$channels.AdminLogResults](../types/channels.AdminLogResults.md) + +*** +
+$MadelineProto->[channels->getAdminedPublicChannels](channels.getAdminedPublicChannels.md)(\['by_location' => [Bool](../types/Bool.md), 'check_limit' => [Bool](../types/Bool.md), \]) === [$messages.Chats](../types/messages.Chats.md) ***
$MadelineProto->[channels->getChannels](channels.getChannels.md)(\['id' => \[[InputChannel](../types/InputChannel.md)\], \]) === [$messages.Chats](../types/messages.Chats.md) -*** -
-$MadelineProto->[channels->getDialogs](channels.getDialogs.md)(\['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages.Dialogs](../types/messages.Dialogs.md) - ***
$MadelineProto->[channels->getFullChannel](channels.getFullChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$messages.ChatFull](../types/messages.ChatFull.md) ***
-$MadelineProto->[channels->getImportantHistory](channels.getImportantHistory.md)(\['channel' => [InputChannel](../types/InputChannel.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), \]) === [$messages.Messages](../types/messages.Messages.md) +$MadelineProto->[channels->getGroupsForDiscussion](channels.getGroupsForDiscussion.md)(\[\]) === [$messages.Chats](../types/messages.Chats.md) ***
-$MadelineProto->[channels->getMessages](channels.getMessages.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) +$MadelineProto->[channels->getInactiveChannels](channels.getInactiveChannels.md)(\[\]) === [$messages.InactiveChats](../types/messages.InactiveChats.md) + +*** +
+$MadelineProto->[channels->getLeftChannels](channels.getLeftChannels.md)(\['offset' => [int](../types/int.md), \]) === [$messages.Chats](../types/messages.Chats.md) + +*** +
+$MadelineProto->[channels->getMessages](channels.getMessages.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[InputMessage](../types/InputMessage.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) ***
@@ -260,7 +476,7 @@ $MadelineProto->[channels->getParticipant](channels.getParticipant.md)(\['channe ***
-$MadelineProto->[channels->getParticipants](channels.getParticipants.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$channels.ChannelParticipants](../types/channels.ChannelParticipants.md) +$MadelineProto->[channels->getParticipants](channels.getParticipants.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$channels.ChannelParticipants](../types/channels.ChannelParticipants.md) ***
@@ -270,10 +486,6 @@ $MadelineProto->[channels->inviteToChannel](channels.inviteToChannel.md)(\['chan
$MadelineProto->[channels->joinChannel](channels.joinChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) -*** -
-$MadelineProto->[channels->kickFromChannel](channels.kickFromChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'kicked' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) - ***
$MadelineProto->[channels->leaveChannel](channels.leaveChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) @@ -282,33 +494,57 @@ $MadelineProto->[channels->leaveChannel](channels.leaveChannel.md)(\['channel' =
$MadelineProto->[channels->readHistory](channels.readHistory.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'max_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[channels->readMessageContents](channels.readMessageContents.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[channels->reportSpam](channels.reportSpam.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'id' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[channels->toggleComments](channels.toggleComments.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[channels->setDiscussionGroup](channels.setDiscussionGroup.md)(\['broadcast' => [InputChannel](../types/InputChannel.md), 'group' => [InputChannel](../types/InputChannel.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[channels->setStickers](channels.setStickers.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[channels->togglePreHistoryHidden](channels.togglePreHistoryHidden.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[channels->toggleSignatures](channels.toggleSignatures.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[channels->toggleSlowMode](channels.toggleSlowMode.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'seconds' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
$MadelineProto->[channels->updateUsername](channels.updateUsername.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[contacts->acceptContact](contacts.acceptContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[contacts->addContact](contacts.addContact.md)(\['add_phone_privacy_exception' => [Bool](../types/Bool.md), 'id' => [InputUser](../types/InputUser.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'phone' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + ***
$MadelineProto->[contacts->block](contacts.block.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[contacts->deleteContact](contacts.deleteContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$contacts.Link](../types/contacts.Link.md) +$MadelineProto->[contacts->deleteByPhones](contacts.deleteByPhones.md)(\['phones' => \[[string](../types/string.md)\], \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[contacts->deleteContacts](contacts.deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Bool](../types/Bool.md) - -*** -
-$MadelineProto->[contacts->exportCard](contacts.exportCard.md)(\[\]) === [$Vector\_of\_int](../types/int.md) +$MadelineProto->[contacts->deleteContacts](contacts.deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Updates](../types/Updates.md) ***
@@ -316,7 +552,19 @@ $MadelineProto->[contacts->getBlocked](contacts.getBlocked.md)(\['offset' => [in ***
-$MadelineProto->[contacts->getContacts](contacts.getContacts.md)(\['hash' => [string](../types/string.md), \]) === [$contacts.Contacts](../types/contacts.Contacts.md) +$MadelineProto->[contacts->getContactIDs](contacts.getContactIDs.md)(\['hash' => [int](../types/int.md), \]) === [$Vector\_of\_int](../types/int.md) + +*** +
+$MadelineProto->[contacts->getContacts](contacts.getContacts.md)(\['hash' => [int](../types/int.md), \]) === [$contacts.Contacts](../types/contacts.Contacts.md) + +*** +
+$MadelineProto->[contacts->getLocated](contacts.getLocated.md)(\['background' => [Bool](../types/Bool.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'self_expires' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[contacts->getSaved](contacts.getSaved.md)(\[\]) === [$Vector\_of\_SavedContact](../types/SavedContact.md) ***
@@ -324,15 +572,19 @@ $MadelineProto->[contacts->getStatuses](contacts.getStatuses.md)(\[\]) === [$Vec ***
-$MadelineProto->[contacts->getSuggested](contacts.getSuggested.md)(\['limit' => [int](../types/int.md), \]) === [$contacts.Suggested](../types/contacts.Suggested.md) +$MadelineProto->[contacts->getTopPeers](contacts.getTopPeers.md)(\['correspondents' => [Bool](../types/Bool.md), 'bots_pm' => [Bool](../types/Bool.md), 'bots_inline' => [Bool](../types/Bool.md), 'phone_calls' => [Bool](../types/Bool.md), 'forward_users' => [Bool](../types/Bool.md), 'forward_chats' => [Bool](../types/Bool.md), 'groups' => [Bool](../types/Bool.md), 'channels' => [Bool](../types/Bool.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$contacts.TopPeers](../types/contacts.TopPeers.md) ***
-$MadelineProto->[contacts->importCard](contacts.importCard.md)(\['export_card' => \[[int](../types/int.md)\], \]) === [$User](../types/User.md) +$MadelineProto->[contacts->importContacts](contacts.importContacts.md)(\['contacts' => \[[InputContact](../types/InputContact.md)\], \]) === [$contacts.ImportedContacts](../types/contacts.ImportedContacts.md) ***
-$MadelineProto->[contacts->importContacts](contacts.importContacts.md)(\['contacts' => \[[InputContact](../types/InputContact.md)\], 'replace' => [Bool](../types/Bool.md), \]) === [$contacts.ImportedContacts](../types/contacts.ImportedContacts.md) +$MadelineProto->[contacts->resetSaved](contacts.resetSaved.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[contacts->resetTopPeerRating](contacts.resetTopPeerRating.md)(\['category' => [TopPeerCategory](../types/TopPeerCategory.md), 'peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) ***
@@ -342,17 +594,49 @@ $MadelineProto->[contacts->resolveUsername](contacts.resolveUsername.md)(\['user
$MadelineProto->[contacts->search](contacts.search.md)(\['q' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$contacts.Found](../types/contacts.Found.md) +*** +
+$MadelineProto->[contacts->toggleTopPeers](contacts.toggleTopPeers.md)(\['enabled' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[contacts->unblock](contacts.unblock.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[help->getAppChangelog](help.getAppChangelog.md)(\['device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$help.AppChangelog](../types/help.AppChangelog.md) +$MadelineProto->[folders->deleteFolder](folders.deleteFolder.md)(\['folder_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
-$MadelineProto->[help->getAppUpdate](help.getAppUpdate.md)(\['device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$help.AppUpdate](../types/help.AppUpdate.md) +$MadelineProto->[folders->editPeerFolders](folders.editPeerFolders.md)(\['folder_peers' => \[[InputFolderPeer](../types/InputFolderPeer.md)\], \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[help->acceptTermsOfService](help.acceptTermsOfService.md)(\['id' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[help->dismissSuggestion](help.dismissSuggestion.md)(\['suggestion' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$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) + +*** +
+$MadelineProto->[help->getAppChangelog](help.getAppChangelog.md)(\['prev_app_version' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[help->getAppConfig](help.getAppConfig.md)(\[\]) === [$JSONValue](../types/JSONValue.md) + +*** +
+$MadelineProto->[help->getAppUpdate](help.getAppUpdate.md)(\['source' => [string](../types/string.md), \]) === [$help.AppUpdate](../types/help.AppUpdate.md) + +*** +
+$MadelineProto->[help->getCdnConfig](help.getCdnConfig.md)(\[\]) === [$CdnConfig](../types/CdnConfig.md) ***
@@ -360,19 +644,47 @@ $MadelineProto->[help->getConfig](help.getConfig.md)(\[\]) === [$Config](../type ***
-$MadelineProto->[help->getInviteText](help.getInviteText.md)(\['lang_code' => [string](../types/string.md), \]) === [$help.InviteText](../types/help.InviteText.md) +$MadelineProto->[help->getDeepLinkInfo](help.getDeepLinkInfo.md)(\['path' => [string](../types/string.md), \]) === [$help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + +*** +
+$MadelineProto->[help->getInviteText](help.getInviteText.md)(\[\]) === [$help.InviteText](../types/help.InviteText.md) ***
$MadelineProto->[help->getNearestDc](help.getNearestDc.md)(\[\]) === [$NearestDc](../types/NearestDc.md) +*** +
+$MadelineProto->[help->getPassportConfig](help.getPassportConfig.md)(\['hash' => [int](../types/int.md), \]) === [$help.PassportConfig](../types/help.PassportConfig.md) + +*** +
+$MadelineProto->[help->getPromoData](help.getPromoData.md)(\[\]) === [$help.PromoData](../types/help.PromoData.md) + +*** +
+$MadelineProto->[help->getRecentMeUrls](help.getRecentMeUrls.md)(\['referer' => [string](../types/string.md), \]) === [$help.RecentMeUrls](../types/help.RecentMeUrls.md) + ***
$MadelineProto->[help->getSupport](help.getSupport.md)(\[\]) === [$help.Support](../types/help.Support.md) ***
-$MadelineProto->[help->getTermsOfService](help.getTermsOfService.md)(\['lang_code' => [string](../types/string.md), \]) === [$help.TermsOfService](../types/help.TermsOfService.md) +$MadelineProto->[help->getSupportName](help.getSupportName.md)(\[\]) === [$help.SupportName](../types/help.SupportName.md) + +*** +
+$MadelineProto->[help->getTermsOfServiceUpdate](help.getTermsOfServiceUpdate.md)(\[\]) === [$help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + +*** +
+$MadelineProto->[help->getUserInfo](help.getUserInfo.md)(\['user_id' => [InputUser](../types/InputUser.md), \]) === [$help.UserInfo](../types/help.UserInfo.md) + +*** +
+$MadelineProto->[help->hidePromoData](help.hidePromoData.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) ***
@@ -380,7 +692,11 @@ $MadelineProto->[help->saveAppLog](help.saveAppLog.md)(\['events' => \[[InputApp ***
-$MadelineProto->[initConnection](initConnection.md)(\['api_id' => [int](../types/int.md), 'device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) +$MadelineProto->[help->setBotUpdatesStatus](help.setBotUpdatesStatus.md)(\['pending_updates_count' => [int](../types/int.md), 'message' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[initConnection](initConnection.md)(\['api_id' => [int](../types/int.md), 'device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'system_lang_code' => [string](../types/string.md), 'lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'proxy' => [InputClientProxy](../types/InputClientProxy.md), 'params' => [JSONValue](../types/JSONValue.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) ***
@@ -394,14 +710,46 @@ $MadelineProto->[invokeAfterMsgs](invokeAfterMsgs.md)(\['msg_ids' => \[[long](..
$MadelineProto->[invokeWithLayer](invokeWithLayer.md)(\['layer' => [int](../types/int.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) +*** +
+$MadelineProto->[invokeWithMessagesRange](invokeWithMessagesRange.md)(\['range' => [MessageRange](../types/MessageRange.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +
+$MadelineProto->[invokeWithTakeout](invokeWithTakeout.md)(\['takeout_id' => [long](../types/long.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + ***
$MadelineProto->[invokeWithoutUpdates](invokeWithoutUpdates.md)(\['query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) +*** +
+$MadelineProto->[langpack->getDifference](langpack.getDifference.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +*** +
+$MadelineProto->[langpack->getLangPack](langpack.getLangPack.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +*** +
+$MadelineProto->[langpack->getLanguage](langpack.getLanguage.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$LangPackLanguage](../types/LangPackLanguage.md) + +*** +
+$MadelineProto->[langpack->getLanguages](langpack.getLanguages.md)(\['lang_pack' => [string](../types/string.md), \]) === [$Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +*** +
+$MadelineProto->[langpack->getStrings](langpack.getStrings.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'keys' => \[[string](../types/string.md)\], \]) === [$Vector\_of\_LangPackString](../types/LangPackString.md) + ***
$MadelineProto->[messages->acceptEncryption](messages.acceptEncryption.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'g_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), \]) === [$EncryptedChat](../types/EncryptedChat.md) +*** +
+$MadelineProto->[messages->acceptUrlAuth](messages.acceptUrlAuth.md)(\['write_allowed' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'button_id' => [int](../types/int.md), \]) === [$UrlAuthResult](../types/UrlAuthResult.md) + ***
$MadelineProto->[messages->addChatUser](messages.addChatUser.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [InputUser](../types/InputUser.md), 'fwd_limit' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) @@ -410,6 +758,14 @@ $MadelineProto->[messages->addChatUser](messages.addChatUser.md)(\['chat_id' =>
$MadelineProto->[messages->checkChatInvite](messages.checkChatInvite.md)(\['hash' => [string](../types/string.md), \]) === [$ChatInvite](../types/ChatInvite.md) +*** +
+$MadelineProto->[messages->clearAllDrafts](messages.clearAllDrafts.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->clearRecentStickers](messages.clearRecentStickers.md)(\['attached' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[messages->createChat](messages.createChat.md)(\['users' => \[[InputUser](../types/InputUser.md)\], 'title' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) @@ -420,20 +776,32 @@ $MadelineProto->[messages->deleteChatUser](messages.deleteChatUser.md)(\['chat_i ***
-$MadelineProto->[messages->deleteHistory](messages.deleteHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'max_id' => [int](../types/int.md), \]) === [$messages.AffectedHistory](../types/messages.AffectedHistory.md) +$MadelineProto->[messages->deleteHistory](messages.deleteHistory.md)(\['just_clear' => [Bool](../types/Bool.md), 'revoke' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'max_id' => [int](../types/int.md), \]) === [$messages.AffectedHistory](../types/messages.AffectedHistory.md) ***
-$MadelineProto->[messages->deleteMessages](messages.deleteMessages.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages.AffectedMessages](../types/messages.AffectedMessages.md) +$MadelineProto->[messages->deleteMessages](messages.deleteMessages.md)(\['revoke' => [Bool](../types/Bool.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages.AffectedMessages](../types/messages.AffectedMessages.md) + +*** +
+$MadelineProto->[messages->deleteScheduledMessages](messages.deleteScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], \]) === [$Updates](../types/Updates.md) ***
$MadelineProto->[messages->discardEncryption](messages.discardEncryption.md)(\['chat_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[messages->editChatAbout](messages.editChatAbout.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'about' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[messages->editChatAdmin](messages.editChatAdmin.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [InputUser](../types/InputUser.md), 'is_admin' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[messages->editChatDefaultBannedRights](messages.editChatDefaultBannedRights.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]) === [$Updates](../types/Updates.md) + ***
$MadelineProto->[messages->editChatPhoto](messages.editChatPhoto.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'photo' => [InputChatPhoto](../types/InputChatPhoto.md), \]) === [$Updates](../types/Updates.md) @@ -444,63 +812,223 @@ $MadelineProto->[messages->editChatTitle](messages.editChatTitle.md)(\['chat_id' ***
-$MadelineProto->[messages->exportChatInvite](messages.exportChatInvite.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$ExportedChatInvite](../types/ExportedChatInvite.md) +$MadelineProto->[messages->editInlineBotMessage](messages.editInlineBotMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'message' => [string](../types/string.md), 'media' => [InputMedia](../types/InputMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[messages->forwardMessage](messages.forwardMessage.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->editMessage](messages.editMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [InputMedia](../types/InputMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
-$MadelineProto->[messages->forwardMessages](messages.forwardMessages.md)(\['broadcast' => [Bool](../types/Bool.md), 'from_peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'to_peer' => [InputPeer](../types/InputPeer.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->exportChatInvite](messages.exportChatInvite.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$ExportedChatInvite](../types/ExportedChatInvite.md) + +*** +
+$MadelineProto->[messages->faveSticker](messages.faveSticker.md)(\['id' => [InputDocument](../types/InputDocument.md), 'unfave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->forwardMessages](messages.forwardMessages.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'with_my_score' => [Bool](../types/Bool.md), 'grouped' => [Bool](../types/Bool.md), 'from_peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'to_peer' => [InputPeer](../types/InputPeer.md), 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->getAllChats](messages.getAllChats.md)(\['except_ids' => \[[int](../types/int.md)\], \]) === [$messages.Chats](../types/messages.Chats.md) + +*** +
+$MadelineProto->[messages->getAllDrafts](messages.getAllDrafts.md)(\[\]) === [$Updates](../types/Updates.md) ***
$MadelineProto->[messages->getAllStickers](messages.getAllStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages.AllStickers](../types/messages.AllStickers.md) +*** +
+$MadelineProto->[messages->getArchivedStickers](messages.getArchivedStickers.md)(\['masks' => [Bool](../types/Bool.md), 'offset_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$messages.ArchivedStickers](../types/messages.ArchivedStickers.md) + +*** +
+$MadelineProto->[messages->getAttachedStickers](messages.getAttachedStickers.md)(\['media' => [InputStickeredMedia](../types/InputStickeredMedia.md), \]) === [$Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) + +*** +
+$MadelineProto->[messages->getBotCallbackAnswer](messages.getBotCallbackAnswer.md)(\['game' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'data' => [bytes](../types/bytes.md), \]) === [$messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) + ***
$MadelineProto->[messages->getChats](messages.getChats.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages.Chats](../types/messages.Chats.md) +*** +
+$MadelineProto->[messages->getCommonChats](messages.getCommonChats.md)(\['user_id' => [InputUser](../types/InputUser.md), 'max_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages.Chats](../types/messages.Chats.md) + ***
$MadelineProto->[messages->getDhConfig](messages.getDhConfig.md)(\['version' => [int](../types/int.md), 'random_length' => [int](../types/int.md), \]) === [$messages.DhConfig](../types/messages.DhConfig.md) ***
-$MadelineProto->[messages->getDialogs](messages.getDialogs.md)(\['offset_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), \]) === [$messages.Dialogs](../types/messages.Dialogs.md) +$MadelineProto->[messages->getDialogFilters](messages.getDialogFilters.md)(\[\]) === [$Vector\_of\_DialogFilter](../types/DialogFilter.md) + +*** +
+$MadelineProto->[messages->getDialogUnreadMarks](messages.getDialogUnreadMarks.md)(\[\]) === [$Vector\_of\_DialogPeer](../types/DialogPeer.md) + +*** +
+$MadelineProto->[messages->getDialogs](messages.getDialogs.md)(\['exclude_pinned' => [Bool](../types/Bool.md), 'folder_id' => [int](../types/int.md), 'offset_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages.Dialogs](../types/messages.Dialogs.md) ***
$MadelineProto->[messages->getDocumentByHash](messages.getDocumentByHash.md)(\['sha256' => [bytes](../types/bytes.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), \]) === [$Document](../types/Document.md) +*** +
+$MadelineProto->[messages->getEmojiKeywords](messages.getEmojiKeywords.md)(\['lang_code' => [string](../types/string.md), \]) === [$EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +*** +
+$MadelineProto->[messages->getEmojiKeywordsDifference](messages.getEmojiKeywordsDifference.md)(\['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), \]) === [$EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +*** +
+$MadelineProto->[messages->getEmojiKeywordsLanguages](messages.getEmojiKeywordsLanguages.md)(\['lang_codes' => \[[string](../types/string.md)\], \]) === [$Vector\_of\_EmojiLanguage](../types/EmojiLanguage.md) + +*** +
+$MadelineProto->[messages->getEmojiURL](messages.getEmojiURL.md)(\['lang_code' => [string](../types/string.md), \]) === [$EmojiURL](../types/EmojiURL.md) + +*** +
+$MadelineProto->[messages->getFavedStickers](messages.getFavedStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages.FavedStickers](../types/messages.FavedStickers.md) + +*** +
+$MadelineProto->[messages->getFeaturedStickers](messages.getFeaturedStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + ***
$MadelineProto->[messages->getFullChat](messages.getFullChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$messages.ChatFull](../types/messages.ChatFull.md) ***
-$MadelineProto->[messages->getHistory](messages.getHistory.md)(\['peer' => [InputPeer](../types/InputPeer.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), \]) === [$messages.Messages](../types/messages.Messages.md) +$MadelineProto->[messages->getGameHighScores](messages.getGameHighScores.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$messages.HighScores](../types/messages.HighScores.md) ***
-$MadelineProto->[messages->getMessages](messages.getMessages.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) +$MadelineProto->[messages->getHistory](messages.getHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'offset_date' => [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) + +*** +
+$MadelineProto->[messages->getInlineBotResults](messages.getInlineBotResults.md)(\['bot' => [InputUser](../types/InputUser.md), 'peer' => [InputPeer](../types/InputPeer.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'query' => [string](../types/string.md), 'offset' => [string](../types/string.md), \]) === [$messages.BotResults](../types/messages.BotResults.md) + +*** +
+$MadelineProto->[messages->getInlineGameHighScores](messages.getInlineGameHighScores.md)(\['id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$messages.HighScores](../types/messages.HighScores.md) + +*** +
+$MadelineProto->[messages->getMaskStickers](messages.getMaskStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages.AllStickers](../types/messages.AllStickers.md) + +*** +
+$MadelineProto->[messages->getMessageEditData](messages.getMessageEditData.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), \]) === [$messages.MessageEditData](../types/messages.MessageEditData.md) + +*** +
+$MadelineProto->[messages->getMessages](messages.getMessages.md)(\['id' => \[[InputMessage](../types/InputMessage.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) ***
$MadelineProto->[messages->getMessagesViews](messages.getMessagesViews.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'increment' => [Bool](../types/Bool.md), \]) === [$Vector\_of\_int](../types/int.md) +*** +
+$MadelineProto->[messages->getOldFeaturedStickers](messages.getOldFeaturedStickers.md)(\['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + +*** +
+$MadelineProto->[messages->getOnlines](messages.getOnlines.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$ChatOnlines](../types/ChatOnlines.md) + +*** +
+$MadelineProto->[messages->getPeerDialogs](messages.getPeerDialogs.md)(\['peers' => \[[InputDialogPeer](../types/InputDialogPeer.md)\], \]) === [$messages.PeerDialogs](../types/messages.PeerDialogs.md) + +*** +
+$MadelineProto->[messages->getPeerSettings](messages.getPeerSettings.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$PeerSettings](../types/PeerSettings.md) + +*** +
+$MadelineProto->[messages->getPinnedDialogs](messages.getPinnedDialogs.md)(\['folder_id' => [int](../types/int.md), \]) === [$messages.PeerDialogs](../types/messages.PeerDialogs.md) + +*** +
+$MadelineProto->[messages->getPollResults](messages.getPollResults.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->getPollVotes](messages.getPollVotes.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'option' => [bytes](../types/bytes.md), 'offset' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$messages.VotesList](../types/messages.VotesList.md) + +*** +
+$MadelineProto->[messages->getRecentLocations](messages.getRecentLocations.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +
+$MadelineProto->[messages->getRecentStickers](messages.getRecentStickers.md)(\['attached' => [Bool](../types/Bool.md), 'hash' => [int](../types/int.md), \]) === [$messages.RecentStickers](../types/messages.RecentStickers.md) + +*** +
+$MadelineProto->[messages->getSavedGifs](messages.getSavedGifs.md)(\['hash' => [int](../types/int.md), \]) === [$messages.SavedGifs](../types/messages.SavedGifs.md) + +*** +
+$MadelineProto->[messages->getScheduledHistory](messages.getScheduledHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'hash' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +
+$MadelineProto->[messages->getScheduledMessages](messages.getScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +
+$MadelineProto->[messages->getSearchCounters](messages.getSearchCounters.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'filters' => \[[MessagesFilter](../types/MessagesFilter.md)\], \]) === [$Vector\_of\_messages.SearchCounter](../types/messages.SearchCounter.md) + +*** +
+$MadelineProto->[messages->getSplitRanges](messages.getSplitRanges.md)(\[\]) === [$Vector\_of\_MessageRange](../types/MessageRange.md) + +*** +
+$MadelineProto->[messages->getStatsURL](messages.getStatsURL.md)(\['dark' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'params' => [string](../types/string.md), \]) === [$StatsURL](../types/StatsURL.md) + ***
$MadelineProto->[messages->getStickerSet](messages.getStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$messages.StickerSet](../types/messages.StickerSet.md) ***
-$MadelineProto->[messages->getStickers](messages.getStickers.md)(\['emoticon' => [string](../types/string.md), 'hash' => [string](../types/string.md), \]) === [$messages.Stickers](../types/messages.Stickers.md) +$MadelineProto->[messages->getStickers](messages.getStickers.md)(\['emoticon' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$messages.Stickers](../types/messages.Stickers.md) ***
-$MadelineProto->[messages->getWebPagePreview](messages.getWebPagePreview.md)(\['message' => [string](../types/string.md), \]) === [$MessageMedia](../types/MessageMedia.md) +$MadelineProto->[messages->getSuggestedDialogFilters](messages.getSuggestedDialogFilters.md)(\[\]) === [$Vector\_of\_DialogFilterSuggested](../types/DialogFilterSuggested.md) + +*** +
+$MadelineProto->[messages->getUnreadMentions](messages.getUnreadMentions.md)(\['peer' => [InputPeer](../types/InputPeer.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), \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +
+$MadelineProto->[messages->getWebPage](messages.getWebPage.md)(\['url' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$WebPage](../types/WebPage.md) + +*** +
+$MadelineProto->[messages->getWebPagePreview](messages.getWebPagePreview.md)(\['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$MessageMedia](../types/MessageMedia.md) + +*** +
+$MadelineProto->[messages->hidePeerSettingsBar](messages.hidePeerSettingsBar.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) ***
@@ -508,7 +1036,11 @@ $MadelineProto->[messages->importChatInvite](messages.importChatInvite.md)(\['ha ***
-$MadelineProto->[messages->installStickerSet](messages.installStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'disabled' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) +$MadelineProto->[messages->installStickerSet](messages.installStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'archived' => [Bool](../types/Bool.md), \]) === [$messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + +*** +
+$MadelineProto->[messages->markDialogUnread](messages.markDialogUnread.md)(\['unread' => [Bool](../types/Bool.md), 'peer' => [InputDialogPeer](../types/InputDialogPeer.md), \]) === [$Bool](../types/Bool.md) ***
@@ -518,10 +1050,18 @@ $MadelineProto->[messages->migrateChat](messages.migrateChat.md)(\['chat_id' =>
$MadelineProto->[messages->readEncryptedHistory](messages.readEncryptedHistory.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'max_date' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[messages->readFeaturedStickers](messages.readFeaturedStickers.md)(\['id' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[messages->readHistory](messages.readHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'max_id' => [int](../types/int.md), \]) === [$messages.AffectedMessages](../types/messages.AffectedMessages.md) +*** +
+$MadelineProto->[messages->readMentions](messages.readMentions.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$messages.AffectedHistory](../types/messages.AffectedHistory.md) + ***
$MadelineProto->[messages->readMessageContents](messages.readMessageContents.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages.AffectedMessages](../types/messages.AffectedMessages.md) @@ -536,7 +1076,19 @@ $MadelineProto->[messages->receivedQueue](messages.receivedQueue.md)(\['max_qts' ***
-$MadelineProto->[messages->reorderStickerSets](messages.reorderStickerSets.md)(\['order' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) +$MadelineProto->[messages->reorderPinnedDialogs](messages.reorderPinnedDialogs.md)(\['force' => [Bool](../types/Bool.md), 'folder_id' => [int](../types/int.md), 'order' => \[[InputDialogPeer](../types/InputDialogPeer.md)\], \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->reorderStickerSets](messages.reorderStickerSets.md)(\['masks' => [Bool](../types/Bool.md), 'order' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->report](messages.report.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'reason' => [ReportReason](../types/ReportReason.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->reportEncryptedSpam](messages.reportEncryptedSpam.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), \]) === [$Bool](../types/Bool.md) ***
@@ -548,19 +1100,31 @@ $MadelineProto->[messages->requestEncryption](messages.requestEncryption.md)(\[' ***
-$MadelineProto->[messages->search](messages.search.md)(\['important_only' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'q' => [string](../types/string.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'min_date' => [int](../types/int.md), 'max_date' => [int](../types/int.md), 'offset' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md) +$MadelineProto->[messages->requestUrlAuth](messages.requestUrlAuth.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'button_id' => [int](../types/int.md), \]) === [$UrlAuthResult](../types/UrlAuthResult.md) ***
-$MadelineProto->[messages->searchGifs](messages.searchGifs.md)(\['q' => [string](../types/string.md), 'offset' => [int](../types/int.md), \]) === [$messages.FoundGifs](../types/messages.FoundGifs.md) +$MadelineProto->[messages->saveDraft](messages.saveDraft.md)(\['no_webpage' => [Bool](../types/Bool.md), 'reply_to_msg_id' => [int](../types/int.md), 'peer' => [InputPeer](../types/InputPeer.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[messages->searchGlobal](messages.searchGlobal.md)(\['q' => [string](../types/string.md), 'offset_date' => [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) +$MadelineProto->[messages->saveGif](messages.saveGif.md)(\['id' => [InputDocument](../types/InputDocument.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) ***
-$MadelineProto->[messages->sendBroadcast](messages.sendBroadcast.md)(\['contacts' => \[[InputUser](../types/InputUser.md)\], 'message' => [string](../types/string.md), 'media' => [InputMedia](../types/InputMedia.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->saveRecentSticker](messages.saveRecentSticker.md)(\['attached' => [Bool](../types/Bool.md), 'id' => [InputDocument](../types/InputDocument.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$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) + +*** +
+$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) + +*** +
+$MadelineProto->[messages->searchStickerSets](messages.searchStickerSets.md)(\['exclude_featured' => [Bool](../types/Bool.md), 'q' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$messages.FoundStickerSets](../types/messages.FoundStickerSets.md) ***
@@ -576,16 +1140,60 @@ $MadelineProto->[messages->sendEncryptedService](messages.sendEncryptedService.m ***
-$MadelineProto->[messages->sendMedia](messages.sendMedia.md)(\['broadcast' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'media' => [InputMedia](../types/InputMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->sendInlineBotResult](messages.sendInlineBotResult.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'hide_via' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'query_id' => [long](../types/long.md), 'id' => [string](../types/string.md), 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) ***
-$MadelineProto->[messages->sendMessage](messages.sendMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->sendMedia](messages.sendMedia.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'media' => [InputMedia](../types/InputMedia.md), 'message' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->sendMessage](messages.sendMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->sendMultiMedia](messages.sendMultiMedia.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'multi_media' => \[[InputSingleMedia](../types/InputSingleMedia.md)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->sendScheduledMessages](messages.sendScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->sendScreenshotNotification](messages.sendScreenshotNotification.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->sendVote](messages.sendVote.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->setBotCallbackAnswer](messages.setBotCallbackAnswer.md)(\['alert' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'message' => [string](../types/string.md), 'url' => [string](../types/string.md), 'cache_time' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->setBotPrecheckoutResults](messages.setBotPrecheckoutResults.md)(\['success' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'error' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->setBotShippingResults](messages.setBotShippingResults.md)(\['query_id' => [long](../types/long.md), 'error' => [string](../types/string.md), 'shipping_options' => \[[ShippingOption](../types/ShippingOption.md)\], \]) === [$Bool](../types/Bool.md) ***
$MadelineProto->[messages->setEncryptedTyping](messages.setEncryptedTyping.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'typing' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[messages->setGameScore](messages.setGameScore.md)(\['edit_message' => [Bool](../types/Bool.md), 'force' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'user_id' => [InputUser](../types/InputUser.md), 'score' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->setInlineBotResults](messages.setInlineBotResults.md)(\['gallery' => [Bool](../types/Bool.md), 'private' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'results' => \[[InputBotInlineResult](../types/InputBotInlineResult.md)\], 'cache_time' => [int](../types/int.md), 'next_offset' => [string](../types/string.md), 'switch_pm' => [InlineBotSwitchPM](../types/InlineBotSwitchPM.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->setInlineGameScore](messages.setInlineGameScore.md)(\['edit_message' => [Bool](../types/Bool.md), 'force' => [Bool](../types/Bool.md), 'id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'user_id' => [InputUser](../types/InputUser.md), 'score' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + ***
$MadelineProto->[messages->setTyping](messages.setTyping.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]) === [$Bool](../types/Bool.md) @@ -596,12 +1204,100 @@ $MadelineProto->[messages->startBot](messages.startBot.md)(\['bot' => [InputUser ***
-$MadelineProto->[messages->toggleChatAdmins](messages.toggleChatAdmins.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) +$MadelineProto->[messages->toggleDialogPin](messages.toggleDialogPin.md)(\['pinned' => [Bool](../types/Bool.md), 'peer' => [InputDialogPeer](../types/InputDialogPeer.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->toggleStickerSets](messages.toggleStickerSets.md)(\['uninstall' => [Bool](../types/Bool.md), 'archive' => [Bool](../types/Bool.md), 'unarchive' => [Bool](../types/Bool.md), 'stickersets' => \[[InputStickerSet](../types/InputStickerSet.md)\], \]) === [$Bool](../types/Bool.md) ***
$MadelineProto->[messages->uninstallStickerSet](messages.uninstallStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$Bool](../types/Bool.md) +*** +
+$MadelineProto->[messages->updateDialogFilter](messages.updateDialogFilter.md)(\['id' => [int](../types/int.md), 'filter' => [DialogFilter](../types/DialogFilter.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->updateDialogFiltersOrder](messages.updateDialogFiltersOrder.md)(\['order' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[messages->updatePinnedMessage](messages.updatePinnedMessage.md)(\['silent' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[messages->uploadEncryptedFile](messages.uploadEncryptedFile.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$EncryptedFile](../types/EncryptedFile.md) + +*** +
+$MadelineProto->[messages->uploadMedia](messages.uploadMedia.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'media' => [InputMedia](../types/InputMedia.md), \]) === [$MessageMedia](../types/MessageMedia.md) + +*** +
+$MadelineProto->[payments->clearSavedInfo](payments.clearSavedInfo.md)(\['credentials' => [Bool](../types/Bool.md), 'info' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[payments->getBankCardData](payments.getBankCardData.md)(\['number' => [string](../types/string.md), \]) === [$payments.BankCardData](../types/payments.BankCardData.md) + +*** +
+$MadelineProto->[payments->getPaymentForm](payments.getPaymentForm.md)(\['msg_id' => [int](../types/int.md), \]) === [$payments.PaymentForm](../types/payments.PaymentForm.md) + +*** +
+$MadelineProto->[payments->getPaymentReceipt](payments.getPaymentReceipt.md)(\['msg_id' => [int](../types/int.md), \]) === [$payments.PaymentReceipt](../types/payments.PaymentReceipt.md) + +*** +
+$MadelineProto->[payments->getSavedInfo](payments.getSavedInfo.md)(\[\]) === [$payments.SavedInfo](../types/payments.SavedInfo.md) + +*** +
+$MadelineProto->[payments->sendPaymentForm](payments.sendPaymentForm.md)(\['msg_id' => [int](../types/int.md), 'requested_info_id' => [string](../types/string.md), 'shipping_option_id' => [string](../types/string.md), 'credentials' => [InputPaymentCredentials](../types/InputPaymentCredentials.md), \]) === [$payments.PaymentResult](../types/payments.PaymentResult.md) + +*** +
+$MadelineProto->[payments->validateRequestedInfo](payments.validateRequestedInfo.md)(\['save' => [Bool](../types/Bool.md), 'msg_id' => [int](../types/int.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), \]) === [$payments.ValidatedRequestedInfo](../types/payments.ValidatedRequestedInfo.md) + +*** +
+$MadelineProto->[phone->acceptCall](phone.acceptCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'g_b' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone.PhoneCall](../types/phone.PhoneCall.md) + +*** +
+$MadelineProto->[phone->confirmCall](phone.confirmCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'g_a' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone.PhoneCall](../types/phone.PhoneCall.md) + +*** +
+$MadelineProto->[phone->discardCall](phone.discardCall.md)(\['video' => [Bool](../types/Bool.md), 'peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'duration' => [int](../types/int.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'connection_id' => [long](../types/long.md), \]) === [$Updates](../types/Updates.md) + +*** +
+$MadelineProto->[phone->getCallConfig](phone.getCallConfig.md)(\[\]) === [$DataJSON](../types/DataJSON.md) + +*** +
+$MadelineProto->[phone->receivedCall](phone.receivedCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[phone->requestCall](phone.requestCall.md)(\['video' => [Bool](../types/Bool.md), 'user_id' => [InputUser](../types/InputUser.md), 'g_a_hash' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone.PhoneCall](../types/phone.PhoneCall.md) + +*** +
+$MadelineProto->[phone->saveCallDebug](phone.saveCallDebug.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'debug' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$MadelineProto->[phone->sendSignalingData](phone.sendSignalingData.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'data' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md) + +*** +
+$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) + ***
$MadelineProto->[photos->deletePhotos](photos.deletePhotos.md)(\['id' => \[[InputPhoto](../types/InputPhoto.md)\], \]) === [$Vector\_of\_long](../types/long.md) @@ -612,19 +1308,51 @@ $MadelineProto->[photos->getUserPhotos](photos.getUserPhotos.md)(\['user_id' => ***
-$MadelineProto->[photos->updateProfilePhoto](photos.updateProfilePhoto.md)(\['id' => [InputPhoto](../types/InputPhoto.md), 'crop' => [InputPhotoCrop](../types/InputPhotoCrop.md), \]) === [$UserProfilePhoto](../types/UserProfilePhoto.md) +$MadelineProto->[photos->updateProfilePhoto](photos.updateProfilePhoto.md)(\['id' => [InputPhoto](../types/InputPhoto.md), \]) === [$photos.Photo](../types/photos.Photo.md) ***
-$MadelineProto->[photos->uploadProfilePhoto](photos.uploadProfilePhoto.md)(\['file' => [InputFile](../types/InputFile.md), 'caption' => [string](../types/string.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'crop' => [InputPhotoCrop](../types/InputPhotoCrop.md), \]) === [$photos.Photo](../types/photos.Photo.md) +$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) ***
-$MadelineProto->[updates->getChannelDifference](updates.getChannelDifference.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelMessagesFilter](../types/ChannelMessagesFilter.md), 'pts' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$updates.ChannelDifference](../types/updates.ChannelDifference.md) +$MadelineProto->[stats->getBroadcastStats](stats.getBroadcastStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), \]) === [$stats.BroadcastStats](../types/stats.BroadcastStats.md) ***
-$MadelineProto->[updates->getDifference](updates.getDifference.md)(\['pts' => [int](../types/int.md), 'date' => [int](../types/int.md), 'qts' => [int](../types/int.md), \]) === [$updates.Difference](../types/updates.Difference.md) +$MadelineProto->[stats->getMegagroupStats](stats.getMegagroupStats.md)(\['dark' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), \]) === [$stats.MegagroupStats](../types/stats.MegagroupStats.md) + +*** +
+$MadelineProto->[stats->loadAsyncGraph](stats.loadAsyncGraph.md)(\['token' => [string](../types/string.md), 'x' => [long](../types/long.md), \]) === [$StatsGraph](../types/StatsGraph.md) + +*** +
+$MadelineProto->[stickers->addStickerToSet](stickers.addStickerToSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'sticker' => [InputStickerSetItem](../types/InputStickerSetItem.md), \]) === [$messages.StickerSet](../types/messages.StickerSet.md) + +*** +
+$MadelineProto->[stickers->changeStickerPosition](stickers.changeStickerPosition.md)(\['sticker' => [InputDocument](../types/InputDocument.md), 'position' => [int](../types/int.md), \]) === [$messages.StickerSet](../types/messages.StickerSet.md) + +*** +
+$MadelineProto->[stickers->createStickerSet](stickers.createStickerSet.md)(\['masks' => [Bool](../types/Bool.md), 'animated' => [Bool](../types/Bool.md), 'user_id' => [InputUser](../types/InputUser.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'thumb' => [InputDocument](../types/InputDocument.md), 'stickers' => \[[InputStickerSetItem](../types/InputStickerSetItem.md)\], \]) === [$messages.StickerSet](../types/messages.StickerSet.md) + +*** +
+$MadelineProto->[stickers->removeStickerFromSet](stickers.removeStickerFromSet.md)(\['sticker' => [InputDocument](../types/InputDocument.md), \]) === [$messages.StickerSet](../types/messages.StickerSet.md) + +*** +
+$MadelineProto->[stickers->setStickerSetThumb](stickers.setStickerSetThumb.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'thumb' => [InputDocument](../types/InputDocument.md), \]) === [$messages.StickerSet](../types/messages.StickerSet.md) + +*** +
+$MadelineProto->[updates->getChannelDifference](updates.getChannelDifference.md)(\['force' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelMessagesFilter](../types/ChannelMessagesFilter.md), 'pts' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$updates.ChannelDifference](../types/updates.ChannelDifference.md) + +*** +
+$MadelineProto->[updates->getDifference](updates.getDifference.md)(\['pts' => [int](../types/int.md), 'pts_total_limit' => [int](../types/int.md), 'date' => [int](../types/int.md), 'qts' => [int](../types/int.md), \]) === [$updates.Difference](../types/updates.Difference.md) ***
@@ -632,7 +1360,27 @@ $MadelineProto->[updates->getState](updates.getState.md)(\[\]) === [$updates.Sta ***
-$MadelineProto->[upload->getFile](upload.getFile.md)(\['location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.File](../types/upload.File.md) +$MadelineProto->[upload->getCdnFile](upload.getCdnFile.md)(\['file_token' => [bytes](../types/bytes.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.CdnFile](../types/upload.CdnFile.md) + +*** +
+$MadelineProto->[upload->getCdnFileHashes](upload.getCdnFileHashes.md)(\['file_token' => [bytes](../types/bytes.md), 'offset' => [int](../types/int.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) + +*** +
+$MadelineProto->[upload->getFile](upload.getFile.md)(\['precise' => [Bool](../types/Bool.md), 'cdn_supported' => [Bool](../types/Bool.md), 'location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.File](../types/upload.File.md) + +*** +
+$MadelineProto->[upload->getFileHashes](upload.getFileHashes.md)(\['location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) + +*** +
+$MadelineProto->[upload->getWebFile](upload.getWebFile.md)(\['location' => [InputWebFileLocation](../types/InputWebFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.WebFile](../types/upload.WebFile.md) + +*** +
+$MadelineProto->[upload->reuploadCdnFile](upload.reuploadCdnFile.md)(\['file_token' => [bytes](../types/bytes.md), 'request_token' => [bytes](../types/bytes.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) ***
@@ -650,3 +1398,8 @@ $MadelineProto->[users->getFullUser](users.getFullUser.md)(\['id' => [InputUser]
$MadelineProto->[users->getUsers](users.getUsers.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Vector\_of\_User](../types/User.md) +*** +
+$MadelineProto->[users->setSecureValueErrors](users.setSecureValueErrors.md)(\['id' => [InputUser](../types/InputUser.md), 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], \]) === [$Bool](../types/Bool.md) + + diff --git a/old_docs/API_docs_v44/methods/auth.acceptLoginToken.md b/old_docs/API_docs_v44/methods/auth.acceptLoginToken.md new file mode 100644 index 00000000..0f7353dc --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.acceptLoginToken.md @@ -0,0 +1,54 @@ +--- +title: auth.acceptLoginToken +description: Accept QR code login token, logging in the app that generated it. + +Returns info about the new session. + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_acceptLoginToken.html +--- +# Method: auth.acceptLoginToken +[Back to methods index](index.md) + + + +Accept QR code login token, logging in the app that generated it. + +Returns info about the new session. + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|token|[bytes](../types/bytes.md) | Login token embedded in QR code, for more info, see [login via QR code](https://core.telegram.org/api/qr-login). | Yes| + + +### Return type: [Authorization](../types/Authorization.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Authorization = $MadelineProto->auth->acceptLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Authorization = auth.acceptLoginToken({token='bytes', }) +``` + diff --git a/old_docs/API_docs_v44/methods/auth.bindTempAuthKey.md b/old_docs/API_docs_v44/methods/auth.bindTempAuthKey.md index b72ae700..10257a3e 100644 --- a/old_docs/API_docs_v44/methods/auth.bindTempAuthKey.md +++ b/old_docs/API_docs_v44/methods/auth.bindTempAuthKey.md @@ -1,23 +1,28 @@ --- title: auth.bindTempAuthKey -description: You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info +description: Binds a temporary authorization key `temp_auth_key_id` to the permanent authorization key `perm_auth_key_id`. Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one. + +For more information, see [Perfect Forward Secrecy](https://core.telegram.org/api/pfs). image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_bindTempAuthKey.html --- -# Method: auth.bindTempAuthKey +# Method: auth.bindTempAuthKey [Back to methods index](index.md) -You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info + +Binds a temporary authorization key `temp_auth_key_id` to the permanent authorization key `perm_auth_key_id`. Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one. + +For more information, see [Perfect Forward Secrecy](https://core.telegram.org/api/pfs). ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|perm\_auth\_key\_id|[long](../types/long.md) | You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info | Yes| -|nonce|[long](../types/long.md) | You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info | Yes| -|expires\_at|[int](../types/int.md) | You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info | Yes| -|encrypted\_message|[bytes](../types/bytes.md) | You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info | Yes| +|perm\_auth\_key\_id|[long](../types/long.md) | Permanent auth\_key\_id to bind to | Yes| +|nonce|[long](../types/long.md) | Random long from [Binding message contents](#binding-message-contents) | Yes| +|expires\_at|[int](../types/int.md) | Unix timestamp to invalidate temporary key, see [Binding message contents](#binding-message-contents) | Yes| +|encrypted\_message|[bytes](../types/bytes.md) | See [Generating encrypted\_message](#generating-encrypted-message) | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/auth.cancelCode.md b/old_docs/API_docs_v44/methods/auth.cancelCode.md new file mode 100644 index 00000000..3728a5be --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.cancelCode.md @@ -0,0 +1,55 @@ +--- +title: auth.cancelCode +description: Cancel the login verification code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_cancelCode.html +--- +# Method: auth.cancelCode +[Back to methods index](index.md) + + + +Cancel the login verification code + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash from [auth.sendCode](../methods/auth.sendCode.md) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v44/methods/auth.checkPassword.md b/old_docs/API_docs_v44/methods/auth.checkPassword.md index 6637ef29..2fb92625 100644 --- a/old_docs/API_docs_v44/methods/auth.checkPassword.md +++ b/old_docs/API_docs_v44/methods/auth.checkPassword.md @@ -1,20 +1,21 @@ --- title: auth.checkPassword -description: You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) +description: Try logging to an account protected by a [2FA password](https://core.telegram.org/api/srp). image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_checkPassword.html --- -# Method: auth.checkPassword +# Method: auth.checkPassword [Back to methods index](index.md) -You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) + +Try logging to an account protected by a [2FA password](https://core.telegram.org/api/srp). ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|password\_hash|[bytes](../types/bytes.md) | You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | The account's password (see [SRP](https://core.telegram.org/api/srp)) | Yes| ### Return type: [auth.Authorization](../types/auth.Authorization.md) @@ -34,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$auth.Authorization = $MadelineProto->auth->checkPassword(['password_hash' => 'bytes', ]); +$auth.Authorization = $MadelineProto->auth->checkPassword(['password' => InputCheckPasswordSRP, ]); ``` Or, if you're into Lua: ```lua -auth.Authorization = auth.checkPassword({password_hash='bytes', }) +auth.Authorization = auth.checkPassword({password=InputCheckPasswordSRP, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/auth.checkPhone.md b/old_docs/API_docs_v44/methods/auth.checkPhone.md deleted file mode 100644 index 83039d2c..00000000 --- a/old_docs/API_docs_v44/methods/auth.checkPhone.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: auth.checkPhone -description: Check if this phone number is registered on telegram -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/auth_checkPhone.html ---- -# Method: auth.checkPhone -[Back to methods index](index.md) - - -Check if this phone number is registered on telegram - -### Parameters: - -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | The phone number to check | Yes| - - -### Return type: [auth.CheckedPhone](../types/auth.CheckedPhone.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(); - -$auth.CheckedPhone = $MadelineProto->auth->checkPhone(['phone_number' => 'string', ]); -``` - -Or, if you're into Lua: - -```lua -auth.CheckedPhone = auth.checkPhone({phone_number='string', }) -``` - -### Errors - -| Code | Type | Description | -|------|----------|---------------| -|400|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| -|400|PHONE_NUMBER_INVALID|The phone number is invalid| -|406|PHONE_NUMBER_INVALID|The phone number is invalid| -|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| - - diff --git a/old_docs/API_docs_v44/methods/auth.dropTempAuthKeys.md b/old_docs/API_docs_v44/methods/auth.dropTempAuthKeys.md new file mode 100644 index 00000000..0b682d2c --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.dropTempAuthKeys.md @@ -0,0 +1,46 @@ +--- +title: auth.dropTempAuthKeys +description: Delete all temporary authorization keys **except for** the ones specified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_dropTempAuthKeys.html +--- +# Method: auth.dropTempAuthKeys +[Back to methods index](index.md) + + + +Delete all temporary authorization keys **except for** the ones specified + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_auth\_keys|Array of [long](../types/long.md) | The auth keys that **shouldn't** be dropped. | 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->auth->dropTempAuthKeys(['except_auth_keys' => [long, long], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.dropTempAuthKeys({except_auth_keys={long}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/auth.exportAuthorization.md b/old_docs/API_docs_v44/methods/auth.exportAuthorization.md index b0362fbb..ba2e7be7 100644 --- a/old_docs/API_docs_v44/methods/auth.exportAuthorization.md +++ b/old_docs/API_docs_v44/methods/auth.exportAuthorization.md @@ -1,20 +1,21 @@ --- title: auth.exportAuthorization -description: You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +description: Returns data for copying authorization to another data-centre. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_exportAuthorization.html --- -# Method: auth.exportAuthorization +# Method: auth.exportAuthorization [Back to methods index](index.md) -You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html + +Returns data for copying authorization to another data-centre. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|dc\_id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| +|dc\_id|[int](../types/int.md) | Number of a target data-centre | Yes| ### Return type: [auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md) diff --git a/old_docs/API_docs_v44/methods/auth.exportLoginToken.md b/old_docs/API_docs_v44/methods/auth.exportLoginToken.md new file mode 100644 index 00000000..7cba4bab --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.exportLoginToken.md @@ -0,0 +1,54 @@ +--- +title: auth.exportLoginToken +description: Generate a login token, for [login via QR code](https://core.telegram.org/api/qr-login). +The generated login token should be encoded using base64url, then shown as a `tg://login?token=base64encodedtoken` URL in the QR code. + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_exportLoginToken.html +--- +# Method: auth.exportLoginToken +[Back to methods index](index.md) + + + +Generate a login token, for [login via QR code](https://core.telegram.org/api/qr-login). +The generated login token should be encoded using base64url, then shown as a `tg://login?token=base64encodedtoken` URL in the QR code. + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|api\_id|[int](../types/int.md) | Application identifier (see. [App configuration](https://core.telegram.org/myapp)) | Yes| +|api\_hash|[string](../types/string.md) | Application identifier hash (see. [App configuration](https://core.telegram.org/myapp)) | Yes| +|except\_ids|Array of [int](../types/int.md) | List of already logged-in user IDs, to prevent logging in twice with the same user | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **NO** + + +### 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(); + +$auth.LoginToken = $MadelineProto->auth->exportLoginToken(['api_id' => int, 'api_hash' => 'string', 'except_ids' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.exportLoginToken({api_id=int, api_hash='string', except_ids={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/auth.importAuthorization.md b/old_docs/API_docs_v44/methods/auth.importAuthorization.md index 3ebbe66e..80029084 100644 --- a/old_docs/API_docs_v44/methods/auth.importAuthorization.md +++ b/old_docs/API_docs_v44/methods/auth.importAuthorization.md @@ -1,21 +1,22 @@ --- title: auth.importAuthorization -description: You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +description: Logs in a user using a key transmitted from his native data-centre. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_importAuthorization.html --- -# Method: auth.importAuthorization +# Method: auth.importAuthorization [Back to methods index](index.md) -You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html + +Logs in a user using a key transmitted from his native data-centre. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| -|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| +|id|[int](../types/int.md) | User ID | Yes| +|bytes|[bytes](../types/bytes.md) | Authorization key | Yes| ### Return type: [auth.Authorization](../types/auth.Authorization.md) diff --git a/old_docs/API_docs_v44/methods/auth.importBotAuthorization.md b/old_docs/API_docs_v44/methods/auth.importBotAuthorization.md index fc42caec..1964df26 100644 --- a/old_docs/API_docs_v44/methods/auth.importBotAuthorization.md +++ b/old_docs/API_docs_v44/methods/auth.importBotAuthorization.md @@ -1,22 +1,23 @@ --- title: auth.importBotAuthorization -description: You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) +description: Login as a bot image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_importBotAuthorization.html --- -# Method: auth.importBotAuthorization +# Method: auth.importBotAuthorization [Back to methods index](index.md) -You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) + +Login as a bot ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|api\_id|[int](../types/int.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|api\_hash|[string](../types/string.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|bot\_auth\_token|[string](../types/string.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|api\_id|[int](../types/int.md) | Application identifier (see. [App configuration](https://core.telegram.org/myapp)) | Yes| +|api\_hash|[string](../types/string.md) | Application identifier hash (see. [App configuration](https://core.telegram.org/myapp)) | Yes| +|bot\_auth\_token|[string](../types/string.md) | Bot token (see [bots](https://core.telegram.org/bots)) | Yes| ### Return type: [auth.Authorization](../types/auth.Authorization.md) diff --git a/old_docs/API_docs_v44/methods/auth.importLoginToken.md b/old_docs/API_docs_v44/methods/auth.importLoginToken.md new file mode 100644 index 00000000..b5d453ce --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.importLoginToken.md @@ -0,0 +1,50 @@ +--- +title: auth.importLoginToken +description: Login using a redirected login token, generated in case of DC mismatch during [QR code login](https://core.telegram.org/api/qr-login). + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_importLoginToken.html +--- +# Method: auth.importLoginToken +[Back to methods index](index.md) + + + +Login using a redirected login token, generated in case of DC mismatch during [QR code login](https://core.telegram.org/api/qr-login). + +For more info, see [login via QR code](https://core.telegram.org/api/qr-login). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|token|[bytes](../types/bytes.md) | Login token | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **NO** + + +### 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(); + +$auth.LoginToken = $MadelineProto->auth->importLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.importLoginToken({token='bytes', }) +``` + diff --git a/old_docs/API_docs_v44/methods/auth.logOut.md b/old_docs/API_docs_v44/methods/auth.logOut.md index e3aac602..4d34fc6c 100644 --- a/old_docs/API_docs_v44/methods/auth.logOut.md +++ b/old_docs/API_docs_v44/methods/auth.logOut.md @@ -1,14 +1,15 @@ --- title: auth.logOut -description: You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info) +description: Logs out the user. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_logOut.html --- -# Method: auth.logOut +# Method: auth.logOut [Back to methods index](index.md) -You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info) + +Logs out the user. diff --git a/old_docs/API_docs_v44/methods/auth.recoverPassword.md b/old_docs/API_docs_v44/methods/auth.recoverPassword.md index 9d0183b9..a996aff0 100644 --- a/old_docs/API_docs_v44/methods/auth.recoverPassword.md +++ b/old_docs/API_docs_v44/methods/auth.recoverPassword.md @@ -4,10 +4,11 @@ description: Reset the [2FA password](https://core.telegram.org/api/srp) using t image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_recoverPassword.html --- -# Method: auth.recoverPassword +# Method: auth.recoverPassword [Back to methods index](index.md) + Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md). ### Parameters: diff --git a/old_docs/API_docs_v44/methods/auth.requestPasswordRecovery.md b/old_docs/API_docs_v44/methods/auth.requestPasswordRecovery.md index a7ee1a9e..6daecc47 100644 --- a/old_docs/API_docs_v44/methods/auth.requestPasswordRecovery.md +++ b/old_docs/API_docs_v44/methods/auth.requestPasswordRecovery.md @@ -4,10 +4,11 @@ description: Request recovery code of a [2FA password](https://core.telegram.org image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_requestPasswordRecovery.html --- -# Method: auth.requestPasswordRecovery +# Method: auth.requestPasswordRecovery [Back to methods index](index.md) + Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification). diff --git a/old_docs/API_docs_v44/methods/auth.resendCode.md b/old_docs/API_docs_v44/methods/auth.resendCode.md new file mode 100644 index 00000000..fcda2dd1 --- /dev/null +++ b/old_docs/API_docs_v44/methods/auth.resendCode.md @@ -0,0 +1,56 @@ +--- +title: auth.resendCode +description: Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see [login](https://core.telegram.org/api/auth) for more info. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_resendCode.html +--- +# Method: auth.resendCode +[Back to methods index](index.md) + + + +Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see [login](https://core.telegram.org/api/auth) for more info. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | The phone code hash obtained from [auth.sendCode](../methods/auth.sendCode.md) | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### 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(); + +$auth.SentCode = $MadelineProto->auth->resendCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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_HASH_EMPTY|phone_code_hash is missing| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v44/methods/auth.resetAuthorizations.md b/old_docs/API_docs_v44/methods/auth.resetAuthorizations.md index c98b3099..ea1a880d 100644 --- a/old_docs/API_docs_v44/methods/auth.resetAuthorizations.md +++ b/old_docs/API_docs_v44/methods/auth.resetAuthorizations.md @@ -6,10 +6,11 @@ After calling this method it is necessary to reregister the current device using image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_resetAuthorizations.html --- -# Method: auth.resetAuthorizations +# Method: auth.resetAuthorizations [Back to methods index](index.md) + Terminates all user's authorized sessions except for the current one. After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md) @@ -18,7 +19,7 @@ After calling this method it is necessary to reregister the current device using ### Return type: [Bool](../types/Bool.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): diff --git a/old_docs/API_docs_v44/methods/auth.sendCode.md b/old_docs/API_docs_v44/methods/auth.sendCode.md index 14477462..69e4428f 100644 --- a/old_docs/API_docs_v44/methods/auth.sendCode.md +++ b/old_docs/API_docs_v44/methods/auth.sendCode.md @@ -1,24 +1,24 @@ --- title: auth.sendCode -description: You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) +description: Send the verification code for login image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_sendCode.html --- -# Method: auth.sendCode +# Method: auth.sendCode [Back to methods index](index.md) -You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) + +Send the verification code for login ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|sms\_type|[int](../types/int.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|api\_id|[int](../types/int.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|api\_hash|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|lang\_code|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_number|[string](../types/string.md) | Phone number in international format | Yes| +|api\_id|[int](../types/int.md) | Application identifier (see [App configuration](https://core.telegram.org/myapp)) | Yes| +|api\_hash|[string](../types/string.md) | Application secret hash (see [App configuration](https://core.telegram.org/myapp)) | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Settings for the code type to send | Yes| ### Return type: [auth.SentCode](../types/auth.SentCode.md) @@ -38,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$auth.SentCode = $MadelineProto->auth->sendCode(['phone_number' => 'string', 'sms_type' => int, 'api_id' => int, 'api_hash' => 'string', 'lang_code' => 'string', ]); +$auth.SentCode = $MadelineProto->auth->sendCode(['phone_number' => 'string', 'api_id' => int, 'api_hash' => 'string', 'settings' => CodeSettings, ]); ``` Or, if you're into Lua: ```lua -auth.SentCode = auth.sendCode({phone_number='string', sms_type=int, api_id=int, api_hash='string', lang_code='string', }) +auth.SentCode = auth.sendCode({phone_number='string', api_id=int, api_hash='string', settings=CodeSettings, }) ``` ### Errors @@ -60,7 +60,9 @@ 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.| diff --git a/old_docs/API_docs_v44/methods/auth.signIn.md b/old_docs/API_docs_v44/methods/auth.signIn.md index 575f3268..e2fbe281 100644 --- a/old_docs/API_docs_v44/methods/auth.signIn.md +++ b/old_docs/API_docs_v44/methods/auth.signIn.md @@ -1,22 +1,23 @@ --- title: auth.signIn -description: You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) +description: Signs in a user with a validated phone number. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_signIn.html --- -# Method: auth.signIn +# Method: auth.signIn [Back to methods index](index.md) -You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) + +Signs in a user with a validated phone number. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|phone\_code\_hash|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|phone\_code|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_number|[string](../types/string.md) | Phone number in the international format | Yes| +|phone\_code\_hash|[string](../types/string.md) | SMS-message ID, obtained from [auth.sendCode](../methods/auth.sendCode.md) | Yes| +|phone\_code|[string](../types/string.md) | Valid numerical code from the SMS-message | Yes| ### Return type: [auth.Authorization](../types/auth.Authorization.md) diff --git a/old_docs/API_docs_v44/methods/auth.signUp.md b/old_docs/API_docs_v44/methods/auth.signUp.md index 8ed0a094..02605b49 100644 --- a/old_docs/API_docs_v44/methods/auth.signUp.md +++ b/old_docs/API_docs_v44/methods/auth.signUp.md @@ -1,24 +1,24 @@ --- title: auth.signUp -description: You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) +description: Registers a validated phone number in the system. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/auth_signUp.html --- -# Method: auth.signUp +# Method: auth.signUp [Back to methods index](index.md) -You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) + +Registers a validated phone number in the system. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|phone\_code\_hash|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|phone\_code|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|first\_name|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| -|last\_name|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_number|[string](../types/string.md) | Phone number in the international format | Yes| +|phone\_code\_hash|[string](../types/string.md) | SMS-message ID | Yes| +|first\_name|[string](../types/string.md) | New user first name | Yes| +|last\_name|[string](../types/string.md) | New user last name | Yes| ### Return type: [auth.Authorization](../types/auth.Authorization.md) @@ -38,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$auth.Authorization = $MadelineProto->auth->signUp(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', 'first_name' => 'string', 'last_name' => 'string', ]); +$auth.Authorization = $MadelineProto->auth->signUp(['phone_number' => 'string', 'phone_code_hash' => 'string', 'first_name' => 'string', 'last_name' => 'string', ]); ``` Or, if you're into Lua: ```lua -auth.Authorization = auth.signUp({phone_number='string', phone_code_hash='string', phone_code='string', first_name='string', last_name='string', }) +auth.Authorization = auth.signUp({phone_number='string', phone_code_hash='string', first_name='string', last_name='string', }) ``` ### Errors @@ -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| diff --git a/old_docs/API_docs_v44/methods/bots.answerWebhookJSONQuery.md b/old_docs/API_docs_v44/methods/bots.answerWebhookJSONQuery.md new file mode 100644 index 00000000..90296376 --- /dev/null +++ b/old_docs/API_docs_v44/methods/bots.answerWebhookJSONQuery.md @@ -0,0 +1,55 @@ +--- +title: bots.answerWebhookJSONQuery +description: Answers a custom query; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/bots_answerWebhookJSONQuery.html +--- +# Method: bots.answerWebhookJSONQuery +[Back to methods index](index.md) + + + +Answers a custom query; for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Identifier of a custom query | Yes| +|data|[DataJSON](../types/DataJSON.md) | JSON-serialized answer to the query | 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->bots->answerWebhookJSONQuery(['query_id' => long, 'data' => DataJSON, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| +|400|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/bots.sendCustomRequest.md b/old_docs/API_docs_v44/methods/bots.sendCustomRequest.md new file mode 100644 index 00000000..27e43785 --- /dev/null +++ b/old_docs/API_docs_v44/methods/bots.sendCustomRequest.md @@ -0,0 +1,55 @@ +--- +title: bots.sendCustomRequest +description: Sends a custom request; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/bots_sendCustomRequest.html +--- +# Method: bots.sendCustomRequest +[Back to methods index](index.md) + + + +Sends a custom request; for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|custom\_method|[string](../types/string.md) | The method name | Yes| +|params|[DataJSON](../types/DataJSON.md) | JSON-serialized method parameters | Yes| + + +### Return type: [DataJSON](../types/DataJSON.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(); + +$DataJSON = $MadelineProto->bots->sendCustomRequest(['custom_method' => 'string', 'params' => DataJSON, ]); +``` + +Or, if you're into Lua: + +```lua +DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|METHOD_INVALID|The specified method is invalid| +|400|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/auth.sendSms.md b/old_docs/API_docs_v44/methods/bots.setBotCommands.md similarity index 60% rename from old_docs/API_docs_v44/methods/auth.sendSms.md rename to old_docs/API_docs_v44/methods/bots.setBotCommands.md index 134189b1..593a1863 100644 --- a/old_docs/API_docs_v44/methods/auth.sendSms.md +++ b/old_docs/API_docs_v44/methods/bots.setBotCommands.md @@ -1,21 +1,21 @@ --- -title: auth.sendSms -description: Send SMS verification code +title: bots.setBotCommands +description: Set bot command list image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/auth_sendSms.html +redirect_from: /API_docs/methods/bots_setBotCommands.html --- -# Method: auth.sendSms +# Method: bots.setBotCommands [Back to methods index](index.md) -Send SMS verification code + +Set bot command list ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | Phone number | Yes| -|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| +|commands|Array of [BotCommand](../types/BotCommand.md) | Bot commands | Yes| ### Return type: [Bool](../types/Bool.md) @@ -35,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->auth->sendSms(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +$Bool = $MadelineProto->bots->setBotCommands(['commands' => [BotCommand, BotCommand], ]); ``` Or, if you're into Lua: ```lua -Bool = auth.sendSms({phone_number='string', phone_code_hash='string', }) +Bool = bots.setBotCommands({commands={BotCommand}, }) ``` diff --git a/old_docs/API_docs_v44/methods/channels.checkUsername.md b/old_docs/API_docs_v44/methods/channels.checkUsername.md index 32ffa7e0..103c044f 100644 --- a/old_docs/API_docs_v44/methods/channels.checkUsername.md +++ b/old_docs/API_docs_v44/methods/channels.checkUsername.md @@ -4,10 +4,11 @@ description: Check if a username is free and can be assigned to a channel/superg image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_checkUsername.html --- -# Method: channels.checkUsername +# Method: channels.checkUsername [Back to methods index](index.md) + Check if a username is free and can be assigned to a channel/supergroup ### Parameters: @@ -49,6 +50,7 @@ Bool = channels.checkUsername({channel=InputChannel, username='string', }) | Code | Type | Description | |------|----------|---------------| |400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| |400|CHAT_ID_INVALID|The provided chat id is invalid| |400|USERNAME_INVALID|The provided username is not valid| diff --git a/old_docs/API_docs_v44/methods/channels.createChannel.md b/old_docs/API_docs_v44/methods/channels.createChannel.md index 571e6311..0f256bcd 100644 --- a/old_docs/API_docs_v44/methods/channels.createChannel.md +++ b/old_docs/API_docs_v44/methods/channels.createChannel.md @@ -4,10 +4,11 @@ description: Create a [supergroup/channel](https://core.telegram.org/api/channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_createChannel.html --- -# Method: channels.createChannel +# Method: channels.createChannel [Back to methods index](index.md) + Create a [supergroup/channel](https://core.telegram.org/api/channel). ### Parameters: @@ -18,6 +19,8 @@ Create a [supergroup/channel](https://core.telegram.org/api/channel). |megagroup|[Bool](../types/Bool.md) | Whether to create a [supergroup](https://core.telegram.org/api/channel) | Optional| |title|[string](../types/string.md) | Channel title | Yes| |about|[string](../types/string.md) | Channel description | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geogroup location | Optional| +|address|[string](../types/string.md) | Geogroup address | Optional| ### Return type: [Updates](../types/Updates.md) @@ -37,13 +40,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => 'string', 'about' => 'string', ]); +$Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => 'string', 'about' => 'string', 'geo_point' => InputGeoPoint, 'address' => 'string', ]); ``` Or, if you're into Lua: ```lua -Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) +Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', geo_point=InputGeoPoint, address='string', }) ``` ### Errors @@ -53,6 +56,7 @@ Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string' |400|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| |400|CHAT_ABOUT_TOO_LONG|Chat about too long| |400|CHAT_TITLE_EMPTY|No chat title provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| |406|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| |403|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| diff --git a/old_docs/API_docs_v44/methods/channels.deleteChannel.md b/old_docs/API_docs_v44/methods/channels.deleteChannel.md index a5ca2dfb..0697fd88 100644 --- a/old_docs/API_docs_v44/methods/channels.deleteChannel.md +++ b/old_docs/API_docs_v44/methods/channels.deleteChannel.md @@ -4,10 +4,11 @@ description: Delete a [channel/supergroup](https://core.telegram.org/api/channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_deleteChannel.html --- -# Method: channels.deleteChannel +# Method: channels.deleteChannel [Back to methods index](index.md) + Delete a [channel/supergroup](https://core.telegram.org/api/channel) ### Parameters: @@ -49,6 +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|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| diff --git a/old_docs/API_docs_v44/methods/channels.deleteHistory.md b/old_docs/API_docs_v44/methods/channels.deleteHistory.md new file mode 100644 index 00000000..cd3d9343 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.deleteHistory.md @@ -0,0 +1,55 @@ +--- +title: channels.deleteHistory +description: Delete the history of a [supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_deleteHistory.html +--- +# Method: channels.deleteHistory +[Back to methods index](index.md) + + + +Delete the history of a [supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Supergroup](https://core.telegram.org/api/channel) whose history must be deleted | Optional| +|max\_id|[int](../types/int.md) | ID of message **up to which** the history must be deleted | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->channels->deleteHistory(['channel' => InputChannel, 'max_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.deleteHistory({channel=InputChannel, max_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v44/methods/channels.deleteMessages.md b/old_docs/API_docs_v44/methods/channels.deleteMessages.md index 4d81e81e..cce88669 100644 --- a/old_docs/API_docs_v44/methods/channels.deleteMessages.md +++ b/old_docs/API_docs_v44/methods/channels.deleteMessages.md @@ -4,10 +4,11 @@ description: Delete messages in a [channel/supergroup](https://core.telegram.org image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_deleteMessages.html --- -# Method: channels.deleteMessages +# Method: channels.deleteMessages [Back to methods index](index.md) + Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel) ### Parameters: @@ -15,7 +16,7 @@ Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel) | Name | Type | Description | Required | |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) | Optional| -|id|Array of [int](../types/int.md) | The IDs of messages to delete | Yes| +|id|Array of [int](../types/int.md) | IDs of messages to delete | Yes| ### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) @@ -52,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| diff --git a/old_docs/API_docs_v44/methods/channels.deleteUserHistory.md b/old_docs/API_docs_v44/methods/channels.deleteUserHistory.md index 2acb5717..742908f3 100644 --- a/old_docs/API_docs_v44/methods/channels.deleteUserHistory.md +++ b/old_docs/API_docs_v44/methods/channels.deleteUserHistory.md @@ -4,10 +4,11 @@ description: Delete all messages sent by a certain user in a [supergroup](https: image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_deleteUserHistory.html --- -# Method: channels.deleteUserHistory +# Method: channels.deleteUserHistory [Back to methods index](index.md) + Delete all messages sent by a certain user in a [supergroup](https://core.telegram.org/api/channel) ### Parameters: diff --git a/old_docs/API_docs_v44/methods/channels.editAdmin.md b/old_docs/API_docs_v44/methods/channels.editAdmin.md index 3cc45b5e..0b310cad 100644 --- a/old_docs/API_docs_v44/methods/channels.editAdmin.md +++ b/old_docs/API_docs_v44/methods/channels.editAdmin.md @@ -4,10 +4,11 @@ description: Modify the admin rights of a user in a [supergroup/channel](https:/ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_editAdmin.html --- -# Method: channels.editAdmin +# Method: channels.editAdmin [Back to methods index](index.md) + Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel). ### Parameters: @@ -16,7 +17,8 @@ Modify the admin rights of a user in a [supergroup/channel](https://core.telegra |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup/channel](https://core.telegram.org/api/channel). | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ID of the user whose admin rights should be modified | Optional| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | The admin rights | Yes| +|rank|[string](../types/string.md) | Indicates the role (rank) of the admin in the group: just an arbitrary string | Yes| ### Return type: [Updates](../types/Updates.md) @@ -36,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->channels->editAdmin(['channel' => InputChannel, 'user_id' => InputUser, 'role' => ChannelParticipantRole, ]); +$Updates = $MadelineProto->channels->editAdmin(['channel' => InputChannel, 'user_id' => InputUser, 'admin_rights' => ChatAdminRights, 'rank' => 'string', ]); ``` Or, if you're into Lua: ```lua -Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=ChannelParticipantRole, }) +Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChatAdminRights, rank='string', }) ``` ### Errors @@ -51,16 +53,20 @@ Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, role=Chan |------|----------|---------------| |400|ADMINS_TOO_MUCH|There are too many admins| |400|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|400|BOTS_TOO_MUCH|There are too many bots in this chat/channel| |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|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| +|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| |403|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| diff --git a/old_docs/API_docs_v44/methods/channels.editBanned.md b/old_docs/API_docs_v44/methods/channels.editBanned.md new file mode 100644 index 00000000..e48217eb --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.editBanned.md @@ -0,0 +1,62 @@ +--- +title: channels.editBanned +description: Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editBanned.html +--- +# Method: channels.editBanned +[Back to methods index](index.md) + + + +Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup/channel](https://core.telegram.org/api/channel). | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ID of the user whose banned rights should be modified | Optional| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | The banned rights | Yes| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->channels->editBanned(['channel' => InputChannel, 'user_id' => InputUser, 'banned_rights' => ChatBannedRights, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChatBannedRights, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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|MSG_ID_INVALID|Invalid message ID provided| +|400|PINNED_DIALOGS_TOO_MUCH|Too many pinned dialogs| +|400|USER_ADMIN_INVALID|You're not an admin| +|400|USER_ID_INVALID|The provided user ID is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v44/methods/channels.editCreator.md b/old_docs/API_docs_v44/methods/channels.editCreator.md new file mode 100644 index 00000000..403fb2f9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.editCreator.md @@ -0,0 +1,61 @@ +--- +title: channels.editCreator +description: Transfer channel ownership +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editCreator.html +--- +# Method: channels.editCreator +[Back to methods index](index.md) + + + +Transfer channel ownership + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | New channel owner | Optional| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | [2FA password](https://core.telegram.org/api/srp) of account | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->channels->editCreator(['channel' => InputChannel, 'user_id' => InputUser, 'password' => InputCheckPasswordSRP, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editCreator({channel=InputChannel, user_id=InputUser, password=InputCheckPasswordSRP, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|PASSWORD_MISSING|You must enable 2FA in order to transfer ownership of a channel| +|400|PASSWORD_TOO_FRESH_X|The password was modified less than 24 hours ago, try again in X seconds| +|400|SESSION_TOO_FRESH_X|This session was created less than 24 hours ago, try again in X seconds| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/channels.editLocation.md b/old_docs/API_docs_v44/methods/channels.editLocation.md new file mode 100644 index 00000000..033e56d4 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.editLocation.md @@ -0,0 +1,48 @@ +--- +title: channels.editLocation +description: Edit location of geogroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editLocation.html +--- +# Method: channels.editLocation +[Back to methods index](index.md) + + + +Edit location of geogroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Geogroup](https://core.telegram.org/api/channel) | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | New geolocation | Optional| +|address|[string](../types/string.md) | Address string | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->channels->editLocation(['channel' => InputChannel, 'geo_point' => InputGeoPoint, 'address' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.editLocation({channel=InputChannel, geo_point=InputGeoPoint, address='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/channels.editPhoto.md b/old_docs/API_docs_v44/methods/channels.editPhoto.md index 1ed27382..15989882 100644 --- a/old_docs/API_docs_v44/methods/channels.editPhoto.md +++ b/old_docs/API_docs_v44/methods/channels.editPhoto.md @@ -4,10 +4,11 @@ description: Change the photo of a [channel/supergroup](https://core.telegram.or image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_editPhoto.html --- -# Method: channels.editPhoto +# Method: channels.editPhoto [Back to methods index](index.md) + Change the photo of a [channel/supergroup](https://core.telegram.org/api/channel) ### Parameters: diff --git a/old_docs/API_docs_v44/methods/channels.editTitle.md b/old_docs/API_docs_v44/methods/channels.editTitle.md index 293902d5..616001be 100644 --- a/old_docs/API_docs_v44/methods/channels.editTitle.md +++ b/old_docs/API_docs_v44/methods/channels.editTitle.md @@ -4,10 +4,11 @@ description: Edit the name of a [channel/supergroup](https://core.telegram.org/a image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_editTitle.html --- -# Method: channels.editTitle +# Method: channels.editTitle [Back to methods index](index.md) + Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel) ### Parameters: diff --git a/old_docs/API_docs_v44/methods/channels.exportMessageLink.md b/old_docs/API_docs_v44/methods/channels.exportMessageLink.md new file mode 100644 index 00000000..e2184816 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.exportMessageLink.md @@ -0,0 +1,57 @@ +--- +title: channels.exportMessageLink +description: Get link and embed info of a message in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_exportMessageLink.html +--- +# Method: channels.exportMessageLink +[Back to methods index](index.md) + + + +Get link and embed info of a message in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|id|[int](../types/int.md) | Message ID | Yes| +|grouped|[Bool](../types/Bool.md) | Whether to include other grouped media (for albums) | Yes| + + +### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) + +### Can bots use this method: **NO** + + +### 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(); + +$ExportedMessageLink = $MadelineProto->channels->exportMessageLink(['channel' => InputChannel, 'id' => int, 'grouped' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, grouped=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/channels.getAdminLog.md b/old_docs/API_docs_v44/methods/channels.getAdminLog.md new file mode 100644 index 00000000..6ddc08ed --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.getAdminLog.md @@ -0,0 +1,63 @@ +--- +title: channels.getAdminLog +description: Get the admin log of a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getAdminLog.html +--- +# Method: channels.getAdminLog +[Back to methods index](index.md) + + + +Get the admin log of a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|q|[string](../types/string.md) | Search query, can be empty | Yes| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Event filter | Optional| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Only show events from these admins | Optional| +|max\_id|[long](../types/long.md) | Maximum ID of message to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|min\_id|[long](../types/long.md) | Minimum ID of message to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [channels.AdminLogResults](../types/channels.AdminLogResults.md) + +### Can bots use this method: **NO** + + +### 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(); + +$channels.AdminLogResults = $MadelineProto->channels->getAdminLog(['channel' => InputChannel, 'q' => 'string', 'events_filter' => ChannelAdminLogEventsFilter, 'admins' => [InputUser, InputUser], 'max_id' => long, 'min_id' => long, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +channels.AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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|MSG_ID_INVALID|Invalid message ID provided| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v44/methods/channels.getAdminedPublicChannels.md b/old_docs/API_docs_v44/methods/channels.getAdminedPublicChannels.md new file mode 100644 index 00000000..81445e6f --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.getAdminedPublicChannels.md @@ -0,0 +1,47 @@ +--- +title: channels.getAdminedPublicChannels +description: Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getAdminedPublicChannels.html +--- +# Method: channels.getAdminedPublicChannels +[Back to methods index](index.md) + + + +Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|by\_location|[Bool](../types/Bool.md) | Get geogroups | Optional| +|check\_limit|[Bool](../types/Bool.md) | If set and the user has reached the limit of owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), instead of returning the channel list one of the specified [errors](#possible-errors) will be returned.
Useful to check if a new public channel can indeed be created, even before asking the user to enter a channel username to use in [channels.checkUsername](../methods/channels.checkUsername.md)/[channels.updateUsername](../methods/channels.updateUsername.md). | Optional| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Chats = $MadelineProto->channels->getAdminedPublicChannels(['by_location' => Bool, 'check_limit' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getAdminedPublicChannels({by_location=Bool, check_limit=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/channels.getChannels.md b/old_docs/API_docs_v44/methods/channels.getChannels.md index 218b620b..1844fc1a 100644 --- a/old_docs/API_docs_v44/methods/channels.getChannels.md +++ b/old_docs/API_docs_v44/methods/channels.getChannels.md @@ -4,17 +4,18 @@ description: Get info about [channels/supergroups](https://core.telegram.org/api image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_getChannels.html --- -# Method: channels.getChannels +# Method: channels.getChannels [Back to methods index](index.md) + Get info about [channels/supergroups](https://core.telegram.org/api/channel) ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup MTProto IDs | Yes| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | IDs of channels/supergroups to get info about | Yes| ### Return type: [messages.Chats](../types/messages.Chats.md) @@ -52,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| diff --git a/old_docs/API_docs_v44/methods/channels.getFullChannel.md b/old_docs/API_docs_v44/methods/channels.getFullChannel.md index a71e0380..85b648d3 100644 --- a/old_docs/API_docs_v44/methods/channels.getFullChannel.md +++ b/old_docs/API_docs_v44/methods/channels.getFullChannel.md @@ -1,20 +1,21 @@ --- title: channels.getFullChannel -description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +description: Get full info about a channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_getFullChannel.html --- -# Method: channels.getFullChannel +# Method: channels.getFullChannel [Back to methods index](index.md) -You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +Get full info about a channel ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel to get info about | Optional| ### Return type: [messages.ChatFull](../types/messages.ChatFull.md) diff --git a/old_docs/API_docs_v44/methods/channels.getGroupsForDiscussion.md b/old_docs/API_docs_v44/methods/channels.getGroupsForDiscussion.md new file mode 100644 index 00000000..c5fecefc --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.getGroupsForDiscussion.md @@ -0,0 +1,41 @@ +--- +title: channels.getGroupsForDiscussion +description: Get all groups that can be used as [discussion groups](https://telegram.org/blog/privacy-discussions-web-bots) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getGroupsForDiscussion.html +--- +# Method: channels.getGroupsForDiscussion +[Back to methods index](index.md) + + + +Get all groups that can be used as [discussion groups](https://telegram.org/blog/privacy-discussions-web-bots) + + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Chats = $MadelineProto->channels->getGroupsForDiscussion(); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getGroupsForDiscussion({}) +``` + diff --git a/old_docs/API_docs_v44/methods/channels.getImportantHistory.md b/old_docs/API_docs_v44/methods/channels.getImportantHistory.md deleted file mode 100644 index 9bbbe65f..00000000 --- a/old_docs/API_docs_v44/methods/channels.getImportantHistory.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: channels.getImportantHistory -description: Get important channel/supergroup history -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_getImportantHistory.html ---- -# Method: channels.getImportantHistory -[Back to methods index](index.md) - - -Get important channel/supergroup history - -### Parameters: - -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| -|offset\_id|[int](../types/int.md) | Message ID offset | Yes| -|add\_offset|[int](../types/int.md) | Additional offset | Yes| -|limit|[int](../types/int.md) | Number of results to return | Yes| -|max\_id|[int](../types/int.md) | Maximum message ID | Yes| -|min\_id|[int](../types/int.md) | Minumum message ID | Yes| - - -### Return type: [messages.Messages](../types/messages.Messages.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(); - -$messages.Messages = $MadelineProto->channels->getImportantHistory(['channel' => InputChannel, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]); -``` - -Or, if you're into Lua: - -```lua -messages.Messages = channels.getImportantHistory({channel=InputChannel, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) -``` - diff --git a/old_docs/API_docs_v44/methods/channels.getInactiveChannels.md b/old_docs/API_docs_v44/methods/channels.getInactiveChannels.md new file mode 100644 index 00000000..7c18fa97 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.getInactiveChannels.md @@ -0,0 +1,41 @@ +--- +title: channels.getInactiveChannels +description: Get inactive channels and supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getInactiveChannels.html +--- +# Method: channels.getInactiveChannels +[Back to methods index](index.md) + + + +Get inactive channels and supergroups + + + +### Return type: [messages.InactiveChats](../types/messages.InactiveChats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.InactiveChats = $MadelineProto->channels->getInactiveChannels(); +``` + +Or, if you're into Lua: + +```lua +messages.InactiveChats = channels.getInactiveChannels({}) +``` + diff --git a/old_docs/API_docs_v44/methods/channels.getLeftChannels.md b/old_docs/API_docs_v44/methods/channels.getLeftChannels.md new file mode 100644 index 00000000..78134ba3 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.getLeftChannels.md @@ -0,0 +1,53 @@ +--- +title: channels.getLeftChannels +description: Get a list of [channels/supergroups](https://core.telegram.org/api/channel) we left +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getLeftChannels.html +--- +# Method: channels.getLeftChannels +[Back to methods index](index.md) + + + +Get a list of [channels/supergroups](https://core.telegram.org/api/channel) we left + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset for [pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Chats = $MadelineProto->channels->getLeftChannels(['offset' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getLeftChannels({offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| + + diff --git a/old_docs/API_docs_v44/methods/channels.getMessages.md b/old_docs/API_docs_v44/methods/channels.getMessages.md index 0b6438d8..440601e2 100644 --- a/old_docs/API_docs_v44/methods/channels.getMessages.md +++ b/old_docs/API_docs_v44/methods/channels.getMessages.md @@ -4,10 +4,11 @@ description: Get [channel/supergroup](https://core.telegram.org/api/channel) mes image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_getMessages.html --- -# Method: channels.getMessages +# Method: channels.getMessages [Back to methods index](index.md) + Get [channel/supergroup](https://core.telegram.org/api/channel) messages ### Parameters: @@ -15,7 +16,7 @@ Get [channel/supergroup](https://core.telegram.org/api/channel) messages | Name | Type | Description | Required | |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| -|id|Array of [int](../types/int.md) | The message IDs | Yes| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | IDs of messages to get | Yes| ### Return type: [messages.Messages](../types/messages.Messages.md) @@ -35,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->channels->getMessages(['channel' => InputChannel, 'id' => [int, int], ]); +$messages.Messages = $MadelineProto->channels->getMessages(['channel' => InputChannel, 'id' => [InputMessage, InputMessage], ]); ``` Or, if you're into Lua: ```lua -messages.Messages = channels.getMessages({channel=InputChannel, id={int}, }) +messages.Messages = channels.getMessages({channel=InputChannel, id={InputMessage}, }) ``` ### Errors @@ -51,6 +52,7 @@ messages.Messages = channels.getMessages({channel=InputChannel, id={int}, }) |400|CHANNEL_INVALID|The provided channel is invalid| |400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| |400|MESSAGE_IDS_EMPTY|No message ids were provided| +|400|MSG_ID_INVALID|Invalid message ID provided| |406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/channels.getParticipant.md b/old_docs/API_docs_v44/methods/channels.getParticipant.md index 02440ea4..4ba21623 100644 --- a/old_docs/API_docs_v44/methods/channels.getParticipant.md +++ b/old_docs/API_docs_v44/methods/channels.getParticipant.md @@ -4,10 +4,11 @@ description: Get info about a [channel/supergroup](https://core.telegram.org/api image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_getParticipant.html --- -# Method: channels.getParticipant +# Method: channels.getParticipant [Back to methods index](index.md) + Get info about a [channel/supergroup](https://core.telegram.org/api/channel) participant ### Parameters: @@ -54,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| diff --git a/old_docs/API_docs_v44/methods/channels.getParticipants.md b/old_docs/API_docs_v44/methods/channels.getParticipants.md index be44e519..bcb34180 100644 --- a/old_docs/API_docs_v44/methods/channels.getParticipants.md +++ b/old_docs/API_docs_v44/methods/channels.getParticipants.md @@ -4,10 +4,11 @@ description: Get the participants of a channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_getParticipants.html --- -# Method: channels.getParticipants +# Method: channels.getParticipants [Back to methods index](index.md) + Get the participants of a channel ### Parameters: @@ -18,6 +19,7 @@ Get the participants of a channel |filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Which participant types to fetch | Yes| |offset|[int](../types/int.md) | [Offset](https://core.telegram.org/api/offsets) | Yes| |limit|[int](../types/int.md) | [Limit](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | [Hash](https://core.telegram.org/api/offsets) | Optional| ### Return type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md) @@ -37,13 +39,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$channels.ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, ]); +$channels.ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -channels.ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, }) +channels.ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash={int}, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/channels.inviteToChannel.md b/old_docs/API_docs_v44/methods/channels.inviteToChannel.md index 1719f83e..5da21395 100644 --- a/old_docs/API_docs_v44/methods/channels.inviteToChannel.md +++ b/old_docs/API_docs_v44/methods/channels.inviteToChannel.md @@ -4,10 +4,11 @@ description: Invite users to a channel/supergroup image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_inviteToChannel.html --- -# Method: channels.inviteToChannel +# Method: channels.inviteToChannel [Back to methods index](index.md) + Invite users to a channel/supergroup ### Parameters: @@ -15,7 +16,7 @@ Invite users to a channel/supergroup | Name | Type | Description | Required | |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add | Yes| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Users to invite | Yes| ### Return type: [Updates](../types/Updates.md) @@ -59,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| diff --git a/old_docs/API_docs_v44/methods/channels.joinChannel.md b/old_docs/API_docs_v44/methods/channels.joinChannel.md index de94774e..4904d9ae 100644 --- a/old_docs/API_docs_v44/methods/channels.joinChannel.md +++ b/old_docs/API_docs_v44/methods/channels.joinChannel.md @@ -4,10 +4,11 @@ description: Join a channel/supergroup image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_joinChannel.html --- -# Method: channels.joinChannel +# Method: channels.joinChannel [Back to methods index](index.md) + Join a channel/supergroup ### Parameters: @@ -57,6 +58,7 @@ Updates = channels.joinChannel({channel=InputChannel, }) |400|PEER_ID_INVALID|The provided peer id is invalid| |400|USER_ALREADY_PARTICIPANT|The user is already in the group| |400|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|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| |401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/channels.kickFromChannel.md b/old_docs/API_docs_v44/methods/channels.kickFromChannel.md deleted file mode 100644 index b6080328..00000000 --- a/old_docs/API_docs_v44/methods/channels.kickFromChannel.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: channels.kickFromChannel -description: Kick user from channel -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_kickFromChannel.html ---- -# Method: channels.kickFromChannel -[Back to methods index](index.md) - - -Kick user from channel - -### Parameters: - -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to kick | Optional| -|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| - - -### Return type: [Updates](../types/Updates.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(); - -$Updates = $MadelineProto->channels->kickFromChannel(['channel' => InputChannel, 'user_id' => InputUser, 'kicked' => Bool, ]); -``` - -Or, if you're into Lua: - -```lua -Updates = channels.kickFromChannel({channel=InputChannel, user_id=InputUser, kicked=Bool, }) -``` - diff --git a/old_docs/API_docs_v44/methods/channels.leaveChannel.md b/old_docs/API_docs_v44/methods/channels.leaveChannel.md index b4cb4fce..789f2e5e 100644 --- a/old_docs/API_docs_v44/methods/channels.leaveChannel.md +++ b/old_docs/API_docs_v44/methods/channels.leaveChannel.md @@ -4,10 +4,11 @@ description: Leave a [channel/supergroup](https://core.telegram.org/api/channel) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_leaveChannel.html --- -# Method: channels.leaveChannel +# Method: channels.leaveChannel [Back to methods index](index.md) + Leave a [channel/supergroup](https://core.telegram.org/api/channel) ### Parameters: @@ -52,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| diff --git a/old_docs/API_docs_v44/methods/channels.readHistory.md b/old_docs/API_docs_v44/methods/channels.readHistory.md index 16ae166c..1b6a7aa7 100644 --- a/old_docs/API_docs_v44/methods/channels.readHistory.md +++ b/old_docs/API_docs_v44/methods/channels.readHistory.md @@ -4,10 +4,11 @@ description: Mark [channel/supergroup](https://core.telegram.org/api/channel) hi image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_readHistory.html --- -# Method: channels.readHistory +# Method: channels.readHistory [Back to methods index](index.md) + Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read ### Parameters: @@ -52,5 +53,6 @@ Bool = channels.readHistory({channel=InputChannel, max_id=int, }) |400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| |400|MSG_ID_INVALID|Invalid message ID provided| |406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/channels.readMessageContents.md b/old_docs/API_docs_v44/methods/channels.readMessageContents.md new file mode 100644 index 00000000..37d81f3c --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.readMessageContents.md @@ -0,0 +1,56 @@ +--- +title: channels.readMessageContents +description: Mark [channel/supergroup](https://core.telegram.org/api/channel) message contents as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_readMessageContents.html +--- +# Method: channels.readMessageContents +[Back to methods index](index.md) + + + +Mark [channel/supergroup](https://core.telegram.org/api/channel) message contents as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) | Optional| +|id|Array of [int](../types/int.md) | IDs of messages whose contents should be marked as read | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->channels->readMessageContents(['channel' => InputChannel, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v44/methods/channels.reportSpam.md b/old_docs/API_docs_v44/methods/channels.reportSpam.md index 9866a14c..90219efb 100644 --- a/old_docs/API_docs_v44/methods/channels.reportSpam.md +++ b/old_docs/API_docs_v44/methods/channels.reportSpam.md @@ -4,10 +4,11 @@ description: Reports some messages from a user in a supergroup as spam; requires image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_reportSpam.html --- -# Method: channels.reportSpam +# Method: channels.reportSpam [Back to methods index](index.md) + Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup ### Parameters: @@ -16,7 +17,7 @@ Reports some messages from a user in a supergroup as spam; requires administrato |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Supergroup | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | ID of the user that sent the spam messages | Optional| -|id|Array of [int](../types/int.md) | The IDs of messages to report | Yes| +|id|Array of [int](../types/int.md) | IDs of spam messages | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels.setDiscussionGroup.md b/old_docs/API_docs_v44/methods/channels.setDiscussionGroup.md new file mode 100644 index 00000000..9d26c500 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.setDiscussionGroup.md @@ -0,0 +1,56 @@ +--- +title: channels.setDiscussionGroup +description: Associate a group to a channel as [discussion group](https://telegram.org/blog/privacy-discussions-web-bots) for that channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_setDiscussionGroup.html +--- +# Method: channels.setDiscussionGroup +[Back to methods index](index.md) + + + +Associate a group to a channel as [discussion group](https://telegram.org/blog/privacy-discussions-web-bots) for that channel + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|group|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Discussion group to associate to the channel | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->channels->setDiscussionGroup(['broadcast' => InputChannel, 'group' => InputChannel, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.setDiscussionGroup({broadcast=InputChannel, group=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BROADCAST_ID_INVALID|Broadcast ID invalid| +|400|LINK_NOT_MODIFIED|Discussion link not modified| +|400|MEGAGROUP_ID_INVALID|Invalid supergroup ID| + + diff --git a/old_docs/API_docs_v44/methods/channels.editAbout.md b/old_docs/API_docs_v44/methods/channels.setStickers.md similarity index 58% rename from old_docs/API_docs_v44/methods/channels.editAbout.md rename to old_docs/API_docs_v44/methods/channels.setStickers.md index 007551a6..88ebadb9 100644 --- a/old_docs/API_docs_v44/methods/channels.editAbout.md +++ b/old_docs/API_docs_v44/methods/channels.setStickers.md @@ -1,21 +1,22 @@ --- -title: channels.editAbout -description: Edit the about text of a channel/supergroup +title: channels.setStickers +description: Associate a stickerset to the supergroup image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_editAbout.html +redirect_from: /API_docs/methods/channels_setStickers.html --- -# Method: channels.editAbout +# Method: channels.setStickers [Back to methods index](index.md) -Edit the about text of a channel/supergroup + +Associate a stickerset to the supergroup ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| -|about|[string](../types/string.md) | The new about text | Yes| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Supergroup | Optional| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to associate | Optional| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->channels->editAbout(['channel' => InputChannel, 'about' => 'string', ]); +$Bool = $MadelineProto->channels->setStickers(['channel' => InputChannel, 'stickerset' => InputStickerSet, ]); ``` Or, if you're into Lua: ```lua -Bool = channels.editAbout({channel=InputChannel, about='string', }) +Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) ``` ### Errors @@ -49,8 +50,6 @@ Bool = channels.editAbout({channel=InputChannel, about='string', }) | Code | Type | Description | |------|----------|---------------| |400|CHANNEL_INVALID|The provided channel is invalid| -|400|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| -|400|CHAT_ABOUT_TOO_LONG|Chat about too long| -|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|PARTICIPANTS_TOO_FEW|Not enough participants| diff --git a/old_docs/API_docs_v44/methods/channels.togglePreHistoryHidden.md b/old_docs/API_docs_v44/methods/channels.togglePreHistoryHidden.md new file mode 100644 index 00000000..7c5d78e9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.togglePreHistoryHidden.md @@ -0,0 +1,59 @@ +--- +title: channels.togglePreHistoryHidden +description: Hide/unhide message history for new channel/supergroup users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_togglePreHistoryHidden.html +--- +# Method: channels.togglePreHistoryHidden +[Back to methods index](index.md) + + + +Hide/unhide message history for new channel/supergroup users + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|enabled|[Bool](../types/Bool.md) | Hide/unhide | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->channels->togglePreHistoryHidden(['channel' => InputChannel, 'enabled' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.togglePreHistoryHidden({channel=InputChannel, enabled=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| + + diff --git a/old_docs/API_docs_v44/methods/channels.exportInvite.md b/old_docs/API_docs_v44/methods/channels.toggleSignatures.md similarity index 56% rename from old_docs/API_docs_v44/methods/channels.exportInvite.md rename to old_docs/API_docs_v44/methods/channels.toggleSignatures.md index a7a92d0d..e1f0c6b1 100644 --- a/old_docs/API_docs_v44/methods/channels.exportInvite.md +++ b/old_docs/API_docs_v44/methods/channels.toggleSignatures.md @@ -1,25 +1,27 @@ --- -title: channels.exportInvite -description: Export the invite link of a channel +title: channels.toggleSignatures +description: Enable/disable message signatures in channels image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_exportInvite.html +redirect_from: /API_docs/methods/channels_toggleSignatures.html --- -# Method: channels.exportInvite +# Method: channels.toggleSignatures [Back to methods index](index.md) -Export the invite link of a channel + +Enable/disable message signatures in channels ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|enabled|[Bool](../types/Bool.md) | Value | Yes| -### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) +### Return type: [Updates](../types/Updates.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -34,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$ExportedChatInvite = $MadelineProto->channels->exportInvite(['channel' => InputChannel, ]); +$Updates = $MadelineProto->channels->toggleSignatures(['channel' => InputChannel, 'enabled' => Bool, ]); ``` Or, if you're into Lua: ```lua -ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) +Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) ``` ### Errors @@ -48,7 +50,6 @@ ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) | Code | Type | Description | |------|----------|---------------| |400|CHANNEL_INVALID|The provided channel is invalid| -|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| -|400|INVITE_HASH_EXPIRED|The invite link has expired| +|400|CHAT_ID_INVALID|The provided chat id is invalid| diff --git a/old_docs/API_docs_v44/methods/channels.toggleSlowMode.md b/old_docs/API_docs_v44/methods/channels.toggleSlowMode.md new file mode 100644 index 00000000..3ed6138d --- /dev/null +++ b/old_docs/API_docs_v44/methods/channels.toggleSlowMode.md @@ -0,0 +1,55 @@ +--- +title: channels.toggleSlowMode +description: Toggle supergroup slow mode: if enabled, users will only be able to send one message every `seconds` seconds +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_toggleSlowMode.html +--- +# Method: channels.toggleSlowMode +[Back to methods index](index.md) + + + +Toggle supergroup slow mode: if enabled, users will only be able to send one message every `seconds` seconds + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup](https://core.telegram.org/api/channel) | Optional| +|seconds|[int](../types/int.md) | Users will only be able to send one message every `seconds` seconds, `0` to disable the limitation | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->channels->toggleSlowMode(['channel' => InputChannel, 'seconds' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.toggleSlowMode({channel=InputChannel, seconds=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|SECONDS_INVALID|Invalid duration provided| + + diff --git a/old_docs/API_docs_v44/methods/channels.updateUsername.md b/old_docs/API_docs_v44/methods/channels.updateUsername.md index 4afcb6fb..4ccf9e1b 100644 --- a/old_docs/API_docs_v44/methods/channels.updateUsername.md +++ b/old_docs/API_docs_v44/methods/channels.updateUsername.md @@ -4,10 +4,11 @@ description: Change the username of a supergroup/channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/channels_updateUsername.html --- -# Method: channels.updateUsername +# Method: channels.updateUsername [Back to methods index](index.md) + Change the username of a supergroup/channel ### Parameters: @@ -55,6 +56,7 @@ Bool = channels.updateUsername({channel=InputChannel, username='string', }) |400|USERNAME_INVALID|The provided username is not valid| |400|USERNAME_NOT_MODIFIED|The username was not modified| |400|USERNAME_OCCUPIED|The provided username is already occupied| +|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| diff --git a/old_docs/API_docs_v44/methods/contacts.acceptContact.md b/old_docs/API_docs_v44/methods/contacts.acceptContact.md new file mode 100644 index 00000000..2090f1db --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.acceptContact.md @@ -0,0 +1,55 @@ +--- +title: contacts.acceptContact +description: If the [peer settings](../constructors/peerSettings.md) of a new user allow us to add him as contact, add that user as contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_acceptContact.html +--- +# Method: contacts.acceptContact +[Back to methods index](index.md) + + + +If the [peer settings](../constructors/peerSettings.md) of a new user allow us to add him as contact, add that user as contact + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to add as contact | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->contacts->acceptContact(['id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.acceptContact({id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_ADD_MISSING|Contact to add is missing| +|400|CONTACT_ID_INVALID|The provided contact ID is invalid| +|400|CONTACT_REQ_MISSING|Missing contact request| + + diff --git a/old_docs/API_docs_v44/methods/contacts.addContact.md b/old_docs/API_docs_v44/methods/contacts.addContact.md new file mode 100644 index 00000000..7fef619c --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.addContact.md @@ -0,0 +1,63 @@ +--- +title: contacts.addContact +description: Add an existing telegram user as contact. + +Use [contacts.importContacts](../methods/contacts.importContacts.md) to add contacts by phone number, without knowing their Telegram ID. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_addContact.html +--- +# Method: contacts.addContact +[Back to methods index](index.md) + + + +Add an existing telegram user as contact. + +Use [contacts.importContacts](../methods/contacts.importContacts.md) to add contacts by phone number, without knowing their Telegram ID. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|add\_phone\_privacy\_exception|[Bool](../types/Bool.md) | Allow the other user to see our phone number? | Optional| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Telegram ID of the other user | Optional| +|first\_name|[string](../types/string.md) | First name | Yes| +|last\_name|[string](../types/string.md) | Last name | Yes| +|phone|[string](../types/string.md) | User's phone number | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->contacts->addContact(['add_phone_privacy_exception' => Bool, 'id' => InputUser, 'first_name' => 'string', 'last_name' => 'string', 'phone' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.addContact({add_phone_privacy_exception=Bool, id=InputUser, first_name='string', last_name='string', phone='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_ID_INVALID|The provided contact ID is invalid| +|400|CONTACT_NAME_EMPTY|Contact name empty| +|400|MSG_ID_INVALID|Invalid message ID provided| + + diff --git a/old_docs/API_docs_v44/methods/contacts.block.md b/old_docs/API_docs_v44/methods/contacts.block.md index 6e17aa42..6b58f991 100644 --- a/old_docs/API_docs_v44/methods/contacts.block.md +++ b/old_docs/API_docs_v44/methods/contacts.block.md @@ -4,10 +4,11 @@ description: Adds the user to the blacklist. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_block.html --- -# Method: contacts.block +# Method: contacts.block [Back to methods index](index.md) + Adds the user to the blacklist. ### Parameters: @@ -49,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| diff --git a/old_docs/API_docs_v44/methods/contacts.deleteByPhones.md b/old_docs/API_docs_v44/methods/contacts.deleteByPhones.md new file mode 100644 index 00000000..45504243 --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.deleteByPhones.md @@ -0,0 +1,46 @@ +--- +title: contacts.deleteByPhones +description: Delete contacts by phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_deleteByPhones.html +--- +# Method: contacts.deleteByPhones +[Back to methods index](index.md) + + + +Delete contacts by phone number + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phones|Array of [string](../types/string.md) | Phone numbers | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->contacts->deleteByPhones(['phones' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.deleteByPhones({phones={'string'}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.deleteContacts.md b/old_docs/API_docs_v44/methods/contacts.deleteContacts.md index f1036871..ff444e79 100644 --- a/old_docs/API_docs_v44/methods/contacts.deleteContacts.md +++ b/old_docs/API_docs_v44/methods/contacts.deleteContacts.md @@ -4,20 +4,21 @@ description: Deletes several contacts from the list. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_deleteContacts.html --- -# Method: contacts.deleteContacts +# Method: contacts.deleteContacts [Back to methods index](index.md) + Deletes several contacts from the list. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contacts to delete | Yes| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID list | Yes| -### Return type: [Bool](../types/Bool.md) +### Return type: [Updates](../types/Updates.md) ### Can bots use this method: **NO** @@ -34,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]); +$Updates = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]); ``` Or, if you're into Lua: ```lua -Bool = contacts.deleteContacts({id={InputUser}, }) +Updates = contacts.deleteContacts({id={InputUser}, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/contacts.getBlocked.md b/old_docs/API_docs_v44/methods/contacts.getBlocked.md index 8ed43319..1f006475 100644 --- a/old_docs/API_docs_v44/methods/contacts.getBlocked.md +++ b/old_docs/API_docs_v44/methods/contacts.getBlocked.md @@ -4,10 +4,11 @@ description: Returns the list of blocked users. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_getBlocked.html --- -# Method: contacts.getBlocked +# Method: contacts.getBlocked [Back to methods index](index.md) + Returns the list of blocked users. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/contacts.getContactIDs.md b/old_docs/API_docs_v44/methods/contacts.getContactIDs.md new file mode 100644 index 00000000..05a2cd10 --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.getContactIDs.md @@ -0,0 +1,46 @@ +--- +title: contacts.getContactIDs +description: Get contact by telegram IDs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getContactIDs.html +--- +# Method: contacts.getContactIDs +[Back to methods index](index.md) + + + +Get contact by telegram IDs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [Vector\_of\_int](../types/int.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_int = $MadelineProto->contacts->getContactIDs(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_int = contacts.getContactIDs({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.getContacts.md b/old_docs/API_docs_v44/methods/contacts.getContacts.md index 52a45351..36198d12 100644 --- a/old_docs/API_docs_v44/methods/contacts.getContacts.md +++ b/old_docs/API_docs_v44/methods/contacts.getContacts.md @@ -4,17 +4,18 @@ description: Returns the current user's contact list. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_getContacts.html --- -# Method: contacts.getContacts +# Method: contacts.getContacts [Back to methods index](index.md) + Returns the current user's contact list. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|hash|[string](../types/string.md) | List of contact user IDs you already cached | Yes| +|hash|Array of [int](../types/int.md) | If there already is a full contact list on the client, a [hash](https://core.telegram.org/api/offsets#hash-generation) of a the list of contact IDs in ascending order may be passed in this parameter. If the contact set was not changed, [(contacts.contactsNotModified)](../constructors/contacts.contactsNotModified.md) will be returned. | Optional| ### Return type: [contacts.Contacts](../types/contacts.Contacts.md) @@ -34,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$contacts.Contacts = $MadelineProto->contacts->getContacts(['hash' => 'string', ]); +$contacts.Contacts = $MadelineProto->contacts->getContacts(['hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -contacts.Contacts = contacts.getContacts({hash='string', }) +contacts.Contacts = contacts.getContacts({hash={int}, }) ``` diff --git a/old_docs/API_docs_v44/methods/contacts.getLocated.md b/old_docs/API_docs_v44/methods/contacts.getLocated.md new file mode 100644 index 00000000..e16bc320 --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.getLocated.md @@ -0,0 +1,56 @@ +--- +title: contacts.getLocated +description: Get contacts near you +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getLocated.html +--- +# Method: contacts.getLocated +[Back to methods index](index.md) + + + +Get contacts near you + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|background|[Bool](../types/Bool.md) | While the geolocation of the current user is public, clients should update it in the background every half-an-hour or so, while setting this flag.
Do this only if the new location is more than 1 KM away from the previous one, or if the previous location is unknown. | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geolocation | Optional| +|self\_expires|[int](../types/int.md) | If set, the geolocation of the current user will be public for the specified number of seconds; pass 0x7fffffff to disable expiry, 0 to make the current geolocation private; if the flag isn't set, no changes will be applied. | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->contacts->getLocated(['background' => Bool, 'geo_point' => InputGeoPoint, 'self_expires' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.getLocated({background=Bool, geo_point=InputGeoPoint, self_expires=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|GEO_POINT_INVALID|Invalid geoposition provided| +|406|USERPIC_UPLOAD_REQUIRED|You must have a profile picture to publish your geolocation| + + diff --git a/old_docs/API_docs_v44/methods/contacts.getSaved.md b/old_docs/API_docs_v44/methods/contacts.getSaved.md new file mode 100644 index 00000000..0ef01e9d --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.getSaved.md @@ -0,0 +1,48 @@ +--- +title: contacts.getSaved +description: Get all contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getSaved.html +--- +# Method: contacts.getSaved +[Back to methods index](index.md) + + + +Get all contacts + + + +### Return type: [Vector\_of\_SavedContact](../types/SavedContact.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_SavedContact = $MadelineProto->contacts->getSaved(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SavedContact = contacts.getSaved({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| + + diff --git a/old_docs/API_docs_v44/methods/contacts.getStatuses.md b/old_docs/API_docs_v44/methods/contacts.getStatuses.md index f0ebcd1b..b16884e9 100644 --- a/old_docs/API_docs_v44/methods/contacts.getStatuses.md +++ b/old_docs/API_docs_v44/methods/contacts.getStatuses.md @@ -4,10 +4,11 @@ description: Returns the list of contact statuses. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_getStatuses.html --- -# Method: contacts.getStatuses +# Method: contacts.getStatuses [Back to methods index](index.md) + Returns the list of contact statuses. diff --git a/old_docs/API_docs_v44/methods/contacts.getTopPeers.md b/old_docs/API_docs_v44/methods/contacts.getTopPeers.md new file mode 100644 index 00000000..444132fa --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.getTopPeers.md @@ -0,0 +1,63 @@ +--- +title: contacts.getTopPeers +description: Get most used peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getTopPeers.html +--- +# Method: contacts.getTopPeers +[Back to methods index](index.md) + + + +Get most used peers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|correspondents|[Bool](../types/Bool.md) | Users we've chatted most frequently with | Optional| +|bots\_pm|[Bool](../types/Bool.md) | Most used bots | Optional| +|bots\_inline|[Bool](../types/Bool.md) | Most used inline bots | Optional| +|phone\_calls|[Bool](../types/Bool.md) | Most frequently called users | Optional| +|forward\_users|[Bool](../types/Bool.md) | Users to which the users often forwards messages to | Optional| +|forward\_chats|[Bool](../types/Bool.md) | Chats to which the users often forwards messages to | Optional| +|groups|[Bool](../types/Bool.md) | Often-opened groups and supergroups | Optional| +|channels|[Bool](../types/Bool.md) | Most frequently visited channels | Optional| +|offset|[int](../types/int.md) | Offset for [pagination](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [contacts.TopPeers](../types/contacts.TopPeers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$contacts.TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'phone_calls' => Bool, 'forward_users' => Bool, 'forward_chats' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +contacts.TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, forward_users=Bool, forward_chats=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|TYPES_EMPTY|No top peer type was provided| + + diff --git a/old_docs/API_docs_v44/methods/contacts.importContacts.md b/old_docs/API_docs_v44/methods/contacts.importContacts.md index 8b3e8572..79109bae 100644 --- a/old_docs/API_docs_v44/methods/contacts.importContacts.md +++ b/old_docs/API_docs_v44/methods/contacts.importContacts.md @@ -1,21 +1,25 @@ --- title: contacts.importContacts description: Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. + +Use [contacts.addContact](../methods/contacts.addContact.md) to add Telegram contacts without actually using their phone number. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_importContacts.html --- -# Method: contacts.importContacts +# Method: contacts.importContacts [Back to methods index](index.md) + Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. +Use [contacts.addContact](../methods/contacts.addContact.md) to add Telegram contacts without actually using their phone number. + ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| -|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| +|contacts|Array of [InputContact](../types/InputContact.md) | List of contacts to import | Yes| ### Return type: [contacts.ImportedContacts](../types/contacts.ImportedContacts.md) @@ -35,12 +39,19 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$contacts.ImportedContacts = $MadelineProto->contacts->importContacts(['contacts' => [InputContact, InputContact], 'replace' => Bool, ]); +$contacts.ImportedContacts = $MadelineProto->contacts->importContacts(['contacts' => [InputContact, InputContact], ]); ``` Or, if you're into Lua: ```lua -contacts.ImportedContacts = contacts.importContacts({contacts={InputContact}, replace=Bool, }) +contacts.ImportedContacts = contacts.importContacts({contacts={InputContact}, }) ``` +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v44/methods/contacts.resetSaved.md b/old_docs/API_docs_v44/methods/contacts.resetSaved.md new file mode 100644 index 00000000..57fe0bec --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.resetSaved.md @@ -0,0 +1,41 @@ +--- +title: contacts.resetSaved +description: Delete saved contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_resetSaved.html +--- +# Method: contacts.resetSaved +[Back to methods index](index.md) + + + +Delete saved contacts + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->contacts->resetSaved(); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.resetSaved({}) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.resetTopPeerRating.md b/old_docs/API_docs_v44/methods/contacts.resetTopPeerRating.md new file mode 100644 index 00000000..54b35ea0 --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.resetTopPeerRating.md @@ -0,0 +1,54 @@ +--- +title: contacts.resetTopPeerRating +description: Reset [rating](https://core.telegram.org/api/top-rating) of top peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_resetTopPeerRating.html +--- +# Method: contacts.resetTopPeerRating +[Back to methods index](index.md) + + + +Reset [rating](https://core.telegram.org/api/top-rating) of top peer + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Top peer category | Yes| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer whose rating should be reset | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->contacts->resetTopPeerRating(['category' => TopPeerCategory, 'peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/contacts.resolveUsername.md b/old_docs/API_docs_v44/methods/contacts.resolveUsername.md index a4dbcab1..894b0f23 100644 --- a/old_docs/API_docs_v44/methods/contacts.resolveUsername.md +++ b/old_docs/API_docs_v44/methods/contacts.resolveUsername.md @@ -1,20 +1,21 @@ --- title: contacts.resolveUsername -description: You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +description: Resolve a @username to get peer info image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_resolveUsername.html --- -# Method: contacts.resolveUsername +# Method: contacts.resolveUsername [Back to methods index](index.md) -You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +Resolve a @username to get peer info ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|username|[string](../types/string.md) | You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Yes| +|username|[string](../types/string.md) | @username to resolve | Yes| ### Return type: [contacts.ResolvedPeer](../types/contacts.ResolvedPeer.md) @@ -47,6 +48,7 @@ contacts.ResolvedPeer = contacts.resolveUsername({username='string', }) | Code | Type | Description | |------|----------|---------------| +|400|CONNECTION_LAYER_INVALID|Layer invalid| |400|USERNAME_INVALID|The provided username is not valid| |400|USERNAME_NOT_OCCUPIED|The provided username is not occupied| |406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| diff --git a/old_docs/API_docs_v44/methods/contacts.search.md b/old_docs/API_docs_v44/methods/contacts.search.md index 54c55c48..30fb0444 100644 --- a/old_docs/API_docs_v44/methods/contacts.search.md +++ b/old_docs/API_docs_v44/methods/contacts.search.md @@ -4,10 +4,11 @@ description: Returns users found by username substring. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_search.html --- -# Method: contacts.search +# Method: contacts.search [Back to methods index](index.md) + Returns users found by username substring. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/contacts.toggleTopPeers.md b/old_docs/API_docs_v44/methods/contacts.toggleTopPeers.md new file mode 100644 index 00000000..c6fe1c72 --- /dev/null +++ b/old_docs/API_docs_v44/methods/contacts.toggleTopPeers.md @@ -0,0 +1,46 @@ +--- +title: contacts.toggleTopPeers +description: Enable/disable [top peers](https://core.telegram.org/api/top-rating) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_toggleTopPeers.html +--- +# Method: contacts.toggleTopPeers +[Back to methods index](index.md) + + + +Enable/disable [top peers](https://core.telegram.org/api/top-rating) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|enabled|[Bool](../types/Bool.md) | Enable/disable | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->contacts->toggleTopPeers(['enabled' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.toggleTopPeers({enabled=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.unblock.md b/old_docs/API_docs_v44/methods/contacts.unblock.md index 97a5f1a2..86542ae1 100644 --- a/old_docs/API_docs_v44/methods/contacts.unblock.md +++ b/old_docs/API_docs_v44/methods/contacts.unblock.md @@ -4,10 +4,11 @@ description: Deletes the user from the blacklist. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/contacts_unblock.html --- -# Method: contacts.unblock +# Method: contacts.unblock [Back to methods index](index.md) + Deletes the user from the blacklist. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/channels.toggleComments.md b/old_docs/API_docs_v44/methods/folders.deleteFolder.md similarity index 54% rename from old_docs/API_docs_v44/methods/channels.toggleComments.md rename to old_docs/API_docs_v44/methods/folders.deleteFolder.md index d63a1e63..79c0916f 100644 --- a/old_docs/API_docs_v44/methods/channels.toggleComments.md +++ b/old_docs/API_docs_v44/methods/folders.deleteFolder.md @@ -1,26 +1,26 @@ --- -title: channels.toggleComments -description: Enable channel comments +title: folders.deleteFolder +description: Delete a [peer folder](https://core.telegram.org/api/folders#peer-folders) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/channels_toggleComments.html +redirect_from: /API_docs/methods/folders_deleteFolder.html --- -# Method: channels.toggleComments +# Method: folders.deleteFolder [Back to methods index](index.md) -Enable channel comments + +Delete a [peer folder](https://core.telegram.org/api/folders#peer-folders) ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| -|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| +|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Yes| ### Return type: [Updates](../types/Updates.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -35,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->channels->toggleComments(['channel' => InputChannel, 'enabled' => Bool, ]); +$Updates = $MadelineProto->folders->deleteFolder(['folder_id' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = channels.toggleComments({channel=InputChannel, enabled=Bool, }) +Updates = folders.deleteFolder({folder_id=int, }) ``` diff --git a/old_docs/API_docs_v44/methods/folders.editPeerFolders.md b/old_docs/API_docs_v44/methods/folders.editPeerFolders.md new file mode 100644 index 00000000..d881ee1e --- /dev/null +++ b/old_docs/API_docs_v44/methods/folders.editPeerFolders.md @@ -0,0 +1,53 @@ +--- +title: folders.editPeerFolders +description: Edit peers in [peer folder](https://core.telegram.org/api/folders#peer-folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/folders_editPeerFolders.html +--- +# Method: folders.editPeerFolders +[Back to methods index](index.md) + + + +Edit peers in [peer folder](https://core.telegram.org/api/folders#peer-folders) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_peers|Array of [InputFolderPeer](../types/InputFolderPeer.md) | New peer list | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->folders->editPeerFolders(['folder_peers' => [InputFolderPeer, InputFolderPeer], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = folders.editPeerFolders({folder_peers={InputFolderPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FOLDER_ID_INVALID|Invalid folder ID| + + diff --git a/old_docs/API_docs_v44/methods/help.acceptTermsOfService.md b/old_docs/API_docs_v44/methods/help.acceptTermsOfService.md new file mode 100644 index 00000000..6fd168fe --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.acceptTermsOfService.md @@ -0,0 +1,46 @@ +--- +title: help.acceptTermsOfService +description: Accept the new terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_acceptTermsOfService.html +--- +# Method: help.acceptTermsOfService +[Back to methods index](index.md) + + + +Accept the new terms of service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[DataJSON](../types/DataJSON.md) | ID of terms of service | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->acceptTermsOfService(['id' => DataJSON, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = help.acceptTermsOfService({id=DataJSON, }) +``` + diff --git a/old_docs/API_docs_v44/methods/help.dismissSuggestion.md b/old_docs/API_docs_v44/methods/help.dismissSuggestion.md new file mode 100644 index 00000000..041522cb --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.dismissSuggestion.md @@ -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', }) +``` + diff --git a/old_docs/API_docs_v44/methods/help.editUserInfo.md b/old_docs/API_docs_v44/methods/help.editUserInfo.md new file mode 100644 index 00000000..ec67bfdf --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.editUserInfo.md @@ -0,0 +1,91 @@ +--- +title: help.editUserInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_editUserInfo.html +--- +# Method: help.editUserInfo +[Back to methods index](index.md) + + + +Internal use + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User | Optional| +|message|[string](../types/string.md) | Message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | [Message entities for styled text](https://core.telegram.org/api/entities) | Yes| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [help.UserInfo](../types/help.UserInfo.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.UserInfo = $MadelineProto->help->editUserInfo(['user_id' => InputUser, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +help.UserInfo = help.editUserInfo({user_id=InputUser, message='string', entities={MessageEntity}, parseMode='string', }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [help.UserInfo](../types/help.UserInfo.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). diff --git a/old_docs/API_docs_v44/methods/help.getAppChangelog.md b/old_docs/API_docs_v44/methods/help.getAppChangelog.md index 5efaf1c9..b9d2f146 100644 --- a/old_docs/API_docs_v44/methods/help.getAppChangelog.md +++ b/old_docs/API_docs_v44/methods/help.getAppChangelog.md @@ -1,26 +1,26 @@ --- title: help.getAppChangelog -description: Get changelog of current app +description: Get changelog of current app. +Typically, an [updates](../constructors/updates.md) constructor will be returned, containing one or more [updateServiceNotification](../constructors/updateServiceNotification.md) updates with app-specific changelogs. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getAppChangelog.html --- -# Method: help.getAppChangelog +# Method: help.getAppChangelog [Back to methods index](index.md) -Get changelog of current app + +Get changelog of current app. +Typically, an [updates](../constructors/updates.md) constructor will be returned, containing one or more [updateServiceNotification](../constructors/updateServiceNotification.md) updates with app-specific changelogs. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|device\_model|[string](../types/string.md) | Device model | Yes| -|system\_version|[string](../types/string.md) | System version | Yes| -|app\_version|[string](../types/string.md) | App version | Yes| -|lang\_code|[string](../types/string.md) | Language code | Yes| +|prev\_app\_version|[string](../types/string.md) | Previous app version | Yes| -### Return type: [help.AppChangelog](../types/help.AppChangelog.md) +### Return type: [Updates](../types/Updates.md) ### Can bots use this method: **NO** @@ -37,12 +37,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$help.AppChangelog = $MadelineProto->help->getAppChangelog(['device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'lang_code' => 'string', ]); +$Updates = $MadelineProto->help->getAppChangelog(['prev_app_version' => 'string', ]); ``` Or, if you're into Lua: ```lua -help.AppChangelog = help.getAppChangelog({device_model='string', system_version='string', app_version='string', lang_code='string', }) +Updates = help.getAppChangelog({prev_app_version='string', }) ``` diff --git a/old_docs/API_docs_v44/methods/help.getAppConfig.md b/old_docs/API_docs_v44/methods/help.getAppConfig.md new file mode 100644 index 00000000..20dc2360 --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getAppConfig.md @@ -0,0 +1,41 @@ +--- +title: help.getAppConfig +description: Get app-specific configuration, see [client configuration](https://core.telegram.org/api/config#client-configuration) for more info on the result. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getAppConfig.html +--- +# Method: help.getAppConfig +[Back to methods index](index.md) + + + +Get app-specific configuration, see [client configuration](https://core.telegram.org/api/config#client-configuration) for more info on the result. + + + +### Return type: [JSONValue](../types/JSONValue.md) + +### Can bots use this method: **NO** + + +### 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(); + +$JSONValue = $MadelineProto->help->getAppConfig(); +``` + +Or, if you're into Lua: + +```lua +JSONValue = help.getAppConfig({}) +``` + diff --git a/old_docs/API_docs_v44/methods/help.getAppUpdate.md b/old_docs/API_docs_v44/methods/help.getAppUpdate.md index 66627def..099e2771 100644 --- a/old_docs/API_docs_v44/methods/help.getAppUpdate.md +++ b/old_docs/API_docs_v44/methods/help.getAppUpdate.md @@ -4,20 +4,18 @@ description: Returns information on update availability for the current applicat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getAppUpdate.html --- -# Method: help.getAppUpdate +# Method: help.getAppUpdate [Back to methods index](index.md) + Returns information on update availability for the current application. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|device\_model|[string](../types/string.md) | Device model | Yes| -|system\_version|[string](../types/string.md) | System version | Yes| -|app\_version|[string](../types/string.md) | App version | Yes| -|lang\_code|[string](../types/string.md) | Langauge code | Yes| +|source|[string](../types/string.md) | Source | Yes| ### Return type: [help.AppUpdate](../types/help.AppUpdate.md) @@ -37,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$help.AppUpdate = $MadelineProto->help->getAppUpdate(['device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'lang_code' => 'string', ]); +$help.AppUpdate = $MadelineProto->help->getAppUpdate(['source' => 'string', ]); ``` Or, if you're into Lua: ```lua -help.AppUpdate = help.getAppUpdate({device_model='string', system_version='string', app_version='string', lang_code='string', }) +help.AppUpdate = help.getAppUpdate({source='string', }) ``` diff --git a/old_docs/API_docs_v44/methods/help.getCdnConfig.md b/old_docs/API_docs_v44/methods/help.getCdnConfig.md new file mode 100644 index 00000000..560f718c --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getCdnConfig.md @@ -0,0 +1,52 @@ +--- +title: help.getCdnConfig +description: Get configuration for [CDN](https://core.telegram.org/cdn) file downloads. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getCdnConfig.html +--- +# Method: help.getCdnConfig +[Back to methods index](index.md) + + + +Get configuration for [CDN](https://core.telegram.org/cdn) file downloads. + + + +### Return type: [CdnConfig](../types/CdnConfig.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(); + +$CdnConfig = $MadelineProto->help->getCdnConfig(); +``` + +Or, if you're into Lua: + +```lua +CdnConfig = help.getCdnConfig({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| + + diff --git a/old_docs/API_docs_v44/methods/help.getConfig.md b/old_docs/API_docs_v44/methods/help.getConfig.md index 398f819b..2cae2441 100644 --- a/old_docs/API_docs_v44/methods/help.getConfig.md +++ b/old_docs/API_docs_v44/methods/help.getConfig.md @@ -1,14 +1,15 @@ --- title: help.getConfig -description: Returns current configuration, icluding data center configuration. +description: Returns current configuration, including data center configuration. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getConfig.html --- -# Method: help.getConfig +# Method: help.getConfig [Back to methods index](index.md) -Returns current configuration, icluding data center configuration. + +Returns current configuration, including data center configuration. @@ -42,9 +43,14 @@ Config = help.getConfig({}) | Code | Type | Description | |------|----------|---------------| +|400|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|400|CONNECTION_APP_VERSION_EMPTY|App version is empty| |400|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|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| diff --git a/old_docs/API_docs_v44/methods/help.getDeepLinkInfo.md b/old_docs/API_docs_v44/methods/help.getDeepLinkInfo.md new file mode 100644 index 00000000..45803857 --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getDeepLinkInfo.md @@ -0,0 +1,46 @@ +--- +title: help.getDeepLinkInfo +description: Get info about a `t.me` link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getDeepLinkInfo.html +--- +# Method: help.getDeepLinkInfo +[Back to methods index](index.md) + + + +Get info about a `t.me` link + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|path|[string](../types/string.md) | Path in `t.me/path` | Yes| + + +### Return type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.DeepLinkInfo = $MadelineProto->help->getDeepLinkInfo(['path' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +help.DeepLinkInfo = help.getDeepLinkInfo({path='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/help.getInviteText.md b/old_docs/API_docs_v44/methods/help.getInviteText.md index f347dabb..56e3b0fa 100644 --- a/old_docs/API_docs_v44/methods/help.getInviteText.md +++ b/old_docs/API_docs_v44/methods/help.getInviteText.md @@ -1,20 +1,16 @@ --- title: help.getInviteText -description: Returns text of a text message with an invitation. +description: Returns localized text of a text message with an invitation. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getInviteText.html --- -# Method: help.getInviteText +# Method: help.getInviteText [Back to methods index](index.md) -Returns text of a text message with an invitation. -### Parameters: +Returns localized text of a text message with an invitation. -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help.InviteText](../types/help.InviteText.md) @@ -34,12 +30,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$help.InviteText = $MadelineProto->help->getInviteText(['lang_code' => 'string', ]); +$help.InviteText = $MadelineProto->help->getInviteText(); ``` Or, if you're into Lua: ```lua -help.InviteText = help.getInviteText({lang_code='string', }) +help.InviteText = help.getInviteText({}) ``` diff --git a/old_docs/API_docs_v44/methods/help.getNearestDc.md b/old_docs/API_docs_v44/methods/help.getNearestDc.md index 805b9ef7..a51c5996 100644 --- a/old_docs/API_docs_v44/methods/help.getNearestDc.md +++ b/old_docs/API_docs_v44/methods/help.getNearestDc.md @@ -4,10 +4,11 @@ description: Returns info on data centre nearest to the user. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getNearestDc.html --- -# Method: help.getNearestDc +# Method: help.getNearestDc [Back to methods index](index.md) + Returns info on data centre nearest to the user. diff --git a/old_docs/API_docs_v44/methods/help.getPassportConfig.md b/old_docs/API_docs_v44/methods/help.getPassportConfig.md new file mode 100644 index 00000000..d2b9c70f --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getPassportConfig.md @@ -0,0 +1,46 @@ +--- +title: help.getPassportConfig +description: Get [passport](https://core.telegram.org/passport) configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getPassportConfig.html +--- +# Method: help.getPassportConfig +[Back to methods index](index.md) + + + +Get [passport](https://core.telegram.org/passport) configuration + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [help.PassportConfig](../types/help.PassportConfig.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.PassportConfig = $MadelineProto->help->getPassportConfig(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +help.PassportConfig = help.getPassportConfig({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/contacts.exportCard.md b/old_docs/API_docs_v44/methods/help.getPromoData.md similarity index 59% rename from old_docs/API_docs_v44/methods/contacts.exportCard.md rename to old_docs/API_docs_v44/methods/help.getPromoData.md index 337ff6f7..425cdf7a 100644 --- a/old_docs/API_docs_v44/methods/contacts.exportCard.md +++ b/old_docs/API_docs_v44/methods/help.getPromoData.md @@ -1,18 +1,19 @@ --- -title: contacts.exportCard -description: Export contact as card +title: help.getPromoData +description: Get MTProxy/Public Service Announcement information image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/contacts_exportCard.html +redirect_from: /API_docs/methods/help_getPromoData.html --- -# Method: contacts.exportCard +# Method: help.getPromoData [Back to methods index](index.md) -Export contact as card + +Get MTProxy/Public Service Announcement information -### Return type: [Vector\_of\_int](../types/int.md) +### Return type: [help.PromoData](../types/help.PromoData.md) ### Can bots use this method: **YES** @@ -29,12 +30,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Vector_of_int = $MadelineProto->contacts->exportCard(); +$help.PromoData = $MadelineProto->help->getPromoData(); ``` Or, if you're into Lua: ```lua -Vector_of_int = contacts.exportCard({}) +help.PromoData = help.getPromoData({}) ``` diff --git a/old_docs/API_docs_v44/methods/help.getRecentMeUrls.md b/old_docs/API_docs_v44/methods/help.getRecentMeUrls.md new file mode 100644 index 00000000..4732d61a --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getRecentMeUrls.md @@ -0,0 +1,46 @@ +--- +title: help.getRecentMeUrls +description: Get recently used `t.me` links +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getRecentMeUrls.html +--- +# Method: help.getRecentMeUrls +[Back to methods index](index.md) + + + +Get recently used `t.me` links + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|referer|[string](../types/string.md) | Referer | Yes| + + +### Return type: [help.RecentMeUrls](../types/help.RecentMeUrls.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.RecentMeUrls = $MadelineProto->help->getRecentMeUrls(['referer' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +help.RecentMeUrls = help.getRecentMeUrls({referer='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/help.getSupport.md b/old_docs/API_docs_v44/methods/help.getSupport.md index f9440dbe..b0d6780e 100644 --- a/old_docs/API_docs_v44/methods/help.getSupport.md +++ b/old_docs/API_docs_v44/methods/help.getSupport.md @@ -4,10 +4,11 @@ description: Returns the support user for the 'ask a question' feature. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_getSupport.html --- -# Method: help.getSupport +# Method: help.getSupport [Back to methods index](index.md) + Returns the support user for the 'ask a question' feature. diff --git a/old_docs/API_docs_v44/methods/help.getSupportName.md b/old_docs/API_docs_v44/methods/help.getSupportName.md new file mode 100644 index 00000000..23c698c8 --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getSupportName.md @@ -0,0 +1,48 @@ +--- +title: help.getSupportName +description: Get localized name of the telegram support user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getSupportName.html +--- +# Method: help.getSupportName +[Back to methods index](index.md) + + + +Get localized name of the telegram support user + + + +### Return type: [help.SupportName](../types/help.SupportName.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.SupportName = $MadelineProto->help->getSupportName(); +``` + +Or, if you're into Lua: + +```lua +help.SupportName = help.getSupportName({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|USER_INVALID|Invalid user provided| + + diff --git a/old_docs/API_docs_v44/methods/help.getTermsOfServiceUpdate.md b/old_docs/API_docs_v44/methods/help.getTermsOfServiceUpdate.md new file mode 100644 index 00000000..b86cf333 --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getTermsOfServiceUpdate.md @@ -0,0 +1,49 @@ +--- +title: help.getTermsOfServiceUpdate +description: Look for updates of telegram's terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getTermsOfServiceUpdate.html +--- +# Method: help.getTermsOfServiceUpdate +[Back to methods index](index.md) + + + +Look for updates of telegram's terms of service + + + +### Return type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.TermsOfServiceUpdate = $MadelineProto->help->getTermsOfServiceUpdate(); +``` + +Or, if you're into Lua: + +```lua +help.TermsOfServiceUpdate = help.getTermsOfServiceUpdate({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| + + diff --git a/old_docs/API_docs_v44/methods/help.getUserInfo.md b/old_docs/API_docs_v44/methods/help.getUserInfo.md new file mode 100644 index 00000000..7e12f0da --- /dev/null +++ b/old_docs/API_docs_v44/methods/help.getUserInfo.md @@ -0,0 +1,53 @@ +--- +title: help.getUserInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getUserInfo.html +--- +# Method: help.getUserInfo +[Back to methods index](index.md) + + + +Internal use + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| + + +### Return type: [help.UserInfo](../types/help.UserInfo.md) + +### Can bots use this method: **NO** + + +### 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(); + +$help.UserInfo = $MadelineProto->help->getUserInfo(['user_id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +help.UserInfo = help.getUserInfo({user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|USER_INVALID|Invalid user provided| + + diff --git a/old_docs/API_docs_v44/methods/auth.sendCall.md b/old_docs/API_docs_v44/methods/help.hidePromoData.md similarity index 59% rename from old_docs/API_docs_v44/methods/auth.sendCall.md rename to old_docs/API_docs_v44/methods/help.hidePromoData.md index 3ca92b38..5c4069a0 100644 --- a/old_docs/API_docs_v44/methods/auth.sendCall.md +++ b/old_docs/API_docs_v44/methods/help.hidePromoData.md @@ -1,21 +1,21 @@ --- -title: auth.sendCall -description: Send verification phone call +title: help.hidePromoData +description: Hide MTProxy/Public Service Announcement information image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/auth_sendCall.html +redirect_from: /API_docs/methods/help_hidePromoData.html --- -# Method: auth.sendCall +# Method: help.hidePromoData [Back to methods index](index.md) -Send verification phone call + +Hide MTProxy/Public Service Announcement information ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_number|[string](../types/string.md) | The phone number | Yes| -|phone\_code\_hash|[string](../types/string.md) | The phone code hash | Yes| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer to hide | Optional| ### Return type: [Bool](../types/Bool.md) @@ -35,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->auth->sendCall(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +$Bool = $MadelineProto->help->hidePromoData(['peer' => InputPeer, ]); ``` Or, if you're into Lua: ```lua -Bool = auth.sendCall({phone_number='string', phone_code_hash='string', }) +Bool = help.hidePromoData({peer=InputPeer, }) ``` diff --git a/old_docs/API_docs_v44/methods/help.saveAppLog.md b/old_docs/API_docs_v44/methods/help.saveAppLog.md index b04b139a..303c67e9 100644 --- a/old_docs/API_docs_v44/methods/help.saveAppLog.md +++ b/old_docs/API_docs_v44/methods/help.saveAppLog.md @@ -4,17 +4,18 @@ description: Saves logs of application on the server. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/help_saveAppLog.html --- -# Method: help.saveAppLog +# Method: help.saveAppLog [Back to methods index](index.md) + Saves logs of application on the server. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Event list | Yes| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | List of input events | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/auth.sendInvites.md b/old_docs/API_docs_v44/methods/help.setBotUpdatesStatus.md similarity index 58% rename from old_docs/API_docs_v44/methods/auth.sendInvites.md rename to old_docs/API_docs_v44/methods/help.setBotUpdatesStatus.md index 97e58afc..32cdd877 100644 --- a/old_docs/API_docs_v44/methods/auth.sendInvites.md +++ b/old_docs/API_docs_v44/methods/help.setBotUpdatesStatus.md @@ -1,21 +1,22 @@ --- -title: auth.sendInvites -description: Invite friends to telegram! +title: help.setBotUpdatesStatus +description: Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/auth_sendInvites.html +redirect_from: /API_docs/methods/help_setBotUpdatesStatus.html --- -# Method: auth.sendInvites +# Method: help.setBotUpdatesStatus [Back to methods index](index.md) -Invite friends to telegram! + +Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| -|message|[string](../types/string.md) | The message to send | Yes| +|pending\_updates\_count|[int](../types/int.md) | Number of pending updates | Yes| +|message|[string](../types/string.md) | Error message, if present | Yes| ### Return type: [Bool](../types/Bool.md) @@ -35,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string', 'string'], 'message' => 'string', ]); +$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]); ``` Or, if you're into Lua: ```lua -Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) +Bool = help.setBotUpdatesStatus({pending_updates_count=int, message='string', }) ``` @@ -50,10 +51,3 @@ Bool = auth.sendInvites({phone_numbers={'string'}, message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. -### Errors - -| Code | Type | Description | -|------|----------|---------------| -|400|MESSAGE_EMPTY|The provided message is empty| - - diff --git a/old_docs/API_docs_v44/methods/initConnection.md b/old_docs/API_docs_v44/methods/initConnection.md index 0490ea0f..e224aaca 100644 --- a/old_docs/API_docs_v44/methods/initConnection.md +++ b/old_docs/API_docs_v44/methods/initConnection.md @@ -3,10 +3,11 @@ title: initConnection description: Initialize connection image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Method: initConnection +# Method: initConnection [Back to methods index](index.md) + Initialize connection ### Parameters: @@ -17,7 +18,11 @@ Initialize connection |device\_model|[string](../types/string.md) | Device model | Yes| |system\_version|[string](../types/string.md) | Operation system version | Yes| |app\_version|[string](../types/string.md) | Application version | Yes| +|system\_lang\_code|[string](../types/string.md) | Code for the language used on the device's OS, ISO 639-1 standard | Yes| +|lang\_pack|[string](../types/string.md) | Language pack to use | Yes| |lang\_code|[string](../types/string.md) | Code for the language used on the client, ISO 639-1 standard | Yes| +|proxy|[InputClientProxy](../types/InputClientProxy.md) | Info about an MTProto proxy | Optional| +|params|[JSONValue](../types/JSONValue.md) | Additional initConnection parameters.
For now, only the `tz_offset` field is supported, for specifying timezone offset in seconds. | Optional| |query|[!X](../types/!X.md) | The query itself | Yes| @@ -38,13 +43,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$X = $MadelineProto->initConnection(['api_id' => int, 'device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'lang_code' => 'string', 'query' => !X, ]); +$X = $MadelineProto->initConnection(['api_id' => int, 'device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'system_lang_code' => 'string', 'lang_pack' => 'string', 'lang_code' => 'string', 'proxy' => InputClientProxy, 'params' => JSONValue, 'query' => !X, ]); ``` Or, if you're into Lua: ```lua -X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', lang_code='string', query=!X, }) +X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', proxy=InputClientProxy, params=JSONValue, query=!X, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsg.md b/old_docs/API_docs_v44/methods/invokeAfterMsg.md index 490feafa..6d154d3e 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsg.md @@ -3,10 +3,11 @@ title: invokeAfterMsg description: Invokes a query after successfull completion of one of the previous queries. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Method: invokeAfterMsg +# Method: invokeAfterMsg [Back to methods index](index.md) + Invokes a query after successfull completion of one of the previous queries. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md index 8ad0d8d6..0dc4ada3 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md @@ -3,10 +3,11 @@ title: invokeAfterMsgs description: Invokes a query after a successfull completion of previous queries image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Method: invokeAfterMsgs +# Method: invokeAfterMsgs [Back to methods index](index.md) + Invokes a query after a successfull completion of previous queries ### Parameters: diff --git a/old_docs/API_docs_v44/methods/invokeWithLayer.md b/old_docs/API_docs_v44/methods/invokeWithLayer.md index 4cfa6e84..7426e89f 100644 --- a/old_docs/API_docs_v44/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v44/methods/invokeWithLayer.md @@ -3,10 +3,11 @@ title: invokeWithLayer description: Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Method: invokeWithLayer +# Method: invokeWithLayer [Back to methods index](index.md) + Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers) ### Parameters: diff --git a/old_docs/API_docs_v44/methods/contacts.getSuggested.md b/old_docs/API_docs_v44/methods/invokeWithMessagesRange.md similarity index 59% rename from old_docs/API_docs_v44/methods/contacts.getSuggested.md rename to old_docs/API_docs_v44/methods/invokeWithMessagesRange.md index 2b22ad56..5975ec09 100644 --- a/old_docs/API_docs_v44/methods/contacts.getSuggested.md +++ b/old_docs/API_docs_v44/methods/invokeWithMessagesRange.md @@ -1,23 +1,24 @@ --- -title: contacts.getSuggested -description: Get suggested contacts +title: invokeWithMessagesRange +description: Invoke with the given message range image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/contacts_getSuggested.html --- -# Method: contacts.getSuggested +# Method: invokeWithMessagesRange [Back to methods index](index.md) -Get suggested contacts + +Invoke with the given message range ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|limit|[int](../types/int.md) | Number of results to return | Yes| +|range|[MessageRange](../types/MessageRange.md) | Message range | Yes| +|query|[!X](../types/!X.md) | Query | Yes| -### Return type: [contacts.Suggested](../types/contacts.Suggested.md) +### Return type: [X](../types/X.md) ### Can bots use this method: **YES** @@ -34,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$contacts.Suggested = $MadelineProto->contacts->getSuggested(['limit' => int, ]); +$X = $MadelineProto->invokeWithMessagesRange(['range' => MessageRange, 'query' => !X, ]); ``` Or, if you're into Lua: ```lua -contacts.Suggested = contacts.getSuggested({limit=int, }) +X = invokeWithMessagesRange({range=MessageRange, query=!X, }) ``` diff --git a/old_docs/API_docs_v44/methods/contacts.importCard.md b/old_docs/API_docs_v44/methods/invokeWithTakeout.md similarity index 61% rename from old_docs/API_docs_v44/methods/contacts.importCard.md rename to old_docs/API_docs_v44/methods/invokeWithTakeout.md index a31427da..1c28c385 100644 --- a/old_docs/API_docs_v44/methods/contacts.importCard.md +++ b/old_docs/API_docs_v44/methods/invokeWithTakeout.md @@ -1,23 +1,24 @@ --- -title: contacts.importCard -description: Import card as contact +title: invokeWithTakeout +description: Invoke a method within a takeout session image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/contacts_importCard.html --- -# Method: contacts.importCard +# Method: invokeWithTakeout [Back to methods index](index.md) -Import card as contact + +Invoke a method within a takeout session ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|export\_card|Array of [int](../types/int.md) | The card | Yes| +|takeout\_id|[long](../types/long.md) | Takeout session ID | Yes| +|query|[!X](../types/!X.md) | Query | Yes| -### Return type: [User](../types/User.md) +### Return type: [X](../types/X.md) ### Can bots use this method: **YES** @@ -34,19 +35,19 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$User = $MadelineProto->contacts->importCard(['export_card' => [int, int], ]); +$X = $MadelineProto->invokeWithTakeout(['takeout_id' => long, 'query' => !X, ]); ``` Or, if you're into Lua: ```lua -User = contacts.importCard({export_card={int}, }) +X = invokeWithTakeout({takeout_id=long, query=!X, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| -|400|EXPORT_CARD_INVALID|Provided card is invalid| +|400|INPUT_FETCH_FAIL|Failed deserializing TL payload| diff --git a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md index 48ae4806..204fad66 100644 --- a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md @@ -3,10 +3,11 @@ title: invokeWithoutUpdates description: Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)). image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Method: invokeWithoutUpdates +# Method: invokeWithoutUpdates [Back to methods index](index.md) + Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)). ### Parameters: diff --git a/old_docs/API_docs_v44/methods/langpack.getDifference.md b/old_docs/API_docs_v44/methods/langpack.getDifference.md new file mode 100644 index 00000000..0b6c5681 --- /dev/null +++ b/old_docs/API_docs_v44/methods/langpack.getDifference.md @@ -0,0 +1,55 @@ +--- +title: langpack.getDifference +description: Get new strings in languagepack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getDifference.html +--- +# Method: langpack.getDifference +[Back to methods index](index.md) + + + +Get new strings in languagepack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|from\_version|[int](../types/int.md) | Previous localization pack version | Yes| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### 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(); + +$LangPackDifference = $MadelineProto->langpack->getDifference(['lang_pack' => 'string', 'lang_code' => 'string', 'from_version' => int, ]); +``` + +Or, if you're into Lua: + +```lua +LangPackDifference = langpack.getDifference({lang_pack='string', lang_code='string', from_version=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v44/methods/langpack.getLangPack.md b/old_docs/API_docs_v44/methods/langpack.getLangPack.md new file mode 100644 index 00000000..c0daaa0a --- /dev/null +++ b/old_docs/API_docs_v44/methods/langpack.getLangPack.md @@ -0,0 +1,54 @@ +--- +title: langpack.getLangPack +description: Get localization pack strings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLangPack.html +--- +# Method: langpack.getLangPack +[Back to methods index](index.md) + + + +Get localization pack strings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### 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(); + +$LangPackDifference = $MadelineProto->langpack->getLangPack(['lang_pack' => 'string', 'lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +LangPackDifference = langpack.getLangPack({lang_pack='string', lang_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v44/methods/langpack.getLanguage.md b/old_docs/API_docs_v44/methods/langpack.getLanguage.md new file mode 100644 index 00000000..384f1f58 --- /dev/null +++ b/old_docs/API_docs_v44/methods/langpack.getLanguage.md @@ -0,0 +1,47 @@ +--- +title: langpack.getLanguage +description: Get information about a language in a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLanguage.html +--- +# Method: langpack.getLanguage +[Back to methods index](index.md) + + + +Get information about a language in a localization pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| + + +### Return type: [LangPackLanguage](../types/LangPackLanguage.md) + +### Can bots use this method: **NO** + + +### 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(); + +$LangPackLanguage = $MadelineProto->langpack->getLanguage(['lang_pack' => 'string', 'lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +LangPackLanguage = langpack.getLanguage({lang_pack='string', lang_code='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/langpack.getLanguages.md b/old_docs/API_docs_v44/methods/langpack.getLanguages.md new file mode 100644 index 00000000..5f6f0358 --- /dev/null +++ b/old_docs/API_docs_v44/methods/langpack.getLanguages.md @@ -0,0 +1,53 @@ +--- +title: langpack.getLanguages +description: Get information about all languages in a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLanguages.html +--- +# Method: langpack.getLanguages +[Back to methods index](index.md) + + + +Get information about all languages in a localization pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack | Yes| + + +### Return type: [Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_LangPackLanguage = $MadelineProto->langpack->getLanguages(['lang_pack' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_LangPackLanguage = langpack.getLanguages({lang_pack='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v44/methods/langpack.getStrings.md b/old_docs/API_docs_v44/methods/langpack.getStrings.md new file mode 100644 index 00000000..f8646c81 --- /dev/null +++ b/old_docs/API_docs_v44/methods/langpack.getStrings.md @@ -0,0 +1,55 @@ +--- +title: langpack.getStrings +description: Get strings from a language pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getStrings.html +--- +# Method: langpack.getStrings +[Back to methods index](index.md) + + + +Get strings from a language pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|keys|Array of [string](../types/string.md) | Strings to get | Yes| + + +### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_LangPackString = $MadelineProto->langpack->getStrings(['lang_pack' => 'string', 'lang_code' => 'string', 'keys' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_LangPackString = langpack.getStrings({lang_pack='string', lang_code='string', keys={'string'}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.acceptEncryption.md b/old_docs/API_docs_v44/methods/messages.acceptEncryption.md index 8d9ed8c4..d592625e 100644 --- a/old_docs/API_docs_v44/methods/messages.acceptEncryption.md +++ b/old_docs/API_docs_v44/methods/messages.acceptEncryption.md @@ -1,22 +1,23 @@ --- title: messages.acceptEncryption -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +description: Confirms creation of a secret chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_acceptEncryption.html --- -# Method: messages.acceptEncryption +# Method: messages.acceptEncryption [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats + +Confirms creation of a secret chat ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| -|g\_b|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| -|key\_fingerprint|[long](../types/long.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|g\_b|[bytes](../types/bytes.md) | `B = g ^ b mod p`, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange) | Yes| +|key\_fingerprint|[long](../types/long.md) | 64-bit fingerprint of the received key | Yes| ### Return type: [EncryptedChat](../types/EncryptedChat.md) diff --git a/old_docs/API_docs_v44/methods/messages.acceptUrlAuth.md b/old_docs/API_docs_v44/methods/messages.acceptUrlAuth.md new file mode 100644 index 00000000..16650ed2 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.acceptUrlAuth.md @@ -0,0 +1,49 @@ +--- +title: messages.acceptUrlAuth +description: Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_acceptUrlAuth.html +--- +# Method: messages.acceptUrlAuth +[Back to methods index](index.md) + + + +Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|write\_allowed|[Bool](../types/Bool.md) | Set this flag to allow the bot to send messages to you (if requested) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The location of the message | Optional| +|msg\_id|[int](../types/int.md) | Message ID of the message with the login button | Yes| +|button\_id|[int](../types/int.md) | ID of the login button | Yes| + + +### Return type: [UrlAuthResult](../types/UrlAuthResult.md) + +### Can bots use this method: **NO** + + +### 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(); + +$UrlAuthResult = $MadelineProto->messages->acceptUrlAuth(['write_allowed' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'button_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +UrlAuthResult = messages.acceptUrlAuth({write_allowed=Bool, peer=InputPeer, msg_id=int, button_id=int, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.addChatUser.md b/old_docs/API_docs_v44/methods/messages.addChatUser.md index 6eb571fc..7462f950 100644 --- a/old_docs/API_docs_v44/methods/messages.addChatUser.md +++ b/old_docs/API_docs_v44/methods/messages.addChatUser.md @@ -4,17 +4,18 @@ description: Adds a user to a chat and sends a service message on it. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_addChatUser.html --- -# Method: messages.addChatUser +# Method: messages.addChatUser [Back to methods index](index.md) + Adds a user to a chat and sends a service message on it. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to invite users | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID to be added | Optional| |fwd\_limit|[int](../types/int.md) | Number of last messages to be forwarded | Yes| diff --git a/old_docs/API_docs_v44/methods/messages.checkChatInvite.md b/old_docs/API_docs_v44/methods/messages.checkChatInvite.md index 4f0877fe..d12929ff 100644 --- a/old_docs/API_docs_v44/methods/messages.checkChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages.checkChatInvite.md @@ -4,10 +4,11 @@ description: Check the validity of a chat invite link and get basic info about i image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_checkChatInvite.html --- -# Method: messages.checkChatInvite +# Method: messages.checkChatInvite [Back to methods index](index.md) + Check the validity of a chat invite link and get basic info about it ### Parameters: @@ -50,6 +51,7 @@ ChatInvite = messages.checkChatInvite({hash='string', }) |400|INVITE_HASH_EMPTY|The invite hash is empty| |400|INVITE_HASH_EXPIRED|The invite link has expired| |400|INVITE_HASH_INVALID|The invite hash 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| diff --git a/old_docs/API_docs_v44/methods/messages.clearAllDrafts.md b/old_docs/API_docs_v44/methods/messages.clearAllDrafts.md new file mode 100644 index 00000000..7c92ac51 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.clearAllDrafts.md @@ -0,0 +1,41 @@ +--- +title: messages.clearAllDrafts +description: Clear all [drafts](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_clearAllDrafts.html +--- +# Method: messages.clearAllDrafts +[Back to methods index](index.md) + + + +Clear all [drafts](https://core.telegram.org/api/drafts). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->clearAllDrafts(); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.clearAllDrafts({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.clearRecentStickers.md b/old_docs/API_docs_v44/methods/messages.clearRecentStickers.md new file mode 100644 index 00000000..e197e83a --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.clearRecentStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.clearRecentStickers +description: Clear recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_clearRecentStickers.html +--- +# Method: messages.clearRecentStickers +[Back to methods index](index.md) + + + +Clear recent stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Set this flag to clear the list of stickers recently attached to photo or video files | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->clearRecentStickers(['attached' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.clearRecentStickers({attached=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.createChat.md b/old_docs/API_docs_v44/methods/messages.createChat.md index 14c522d5..5400e2a8 100644 --- a/old_docs/API_docs_v44/methods/messages.createChat.md +++ b/old_docs/API_docs_v44/methods/messages.createChat.md @@ -4,17 +4,18 @@ description: Creates a new chat. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_createChat.html --- -# Method: messages.createChat +# Method: messages.createChat [Back to methods index](index.md) + Creates a new chat. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | List of user IDs to be invited | Yes| |title|[string](../types/string.md) | Chat name | Yes| diff --git a/old_docs/API_docs_v44/methods/messages.deleteChatUser.md b/old_docs/API_docs_v44/methods/messages.deleteChatUser.md index 60274efe..c791bb9e 100644 --- a/old_docs/API_docs_v44/methods/messages.deleteChatUser.md +++ b/old_docs/API_docs_v44/methods/messages.deleteChatUser.md @@ -4,17 +4,18 @@ description: Deletes a user from a chat and sends a service message on it. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_deleteChatUser.html --- -# Method: messages.deleteChatUser +# Method: messages.deleteChatUser [Back to methods index](index.md) + Deletes a user from a chat and sends a service message on it. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID to be deleted | Optional| diff --git a/old_docs/API_docs_v44/methods/messages.deleteHistory.md b/old_docs/API_docs_v44/methods/messages.deleteHistory.md index 1ccfc759..a97970b6 100644 --- a/old_docs/API_docs_v44/methods/messages.deleteHistory.md +++ b/old_docs/API_docs_v44/methods/messages.deleteHistory.md @@ -4,16 +4,19 @@ description: Deletes communication history. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_deleteHistory.html --- -# Method: messages.deleteHistory +# Method: messages.deleteHistory [Back to methods index](index.md) + Deletes communication history. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Just clear history for the current user, without actually removing messages for every chat user | Optional| +|revoke|[Bool](../types/Bool.md) | Whether to delete the message history for all chat participants | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, communication history of which will be deleted | Optional| |max\_id|[int](../types/int.md) | Maximum ID of message to delete | Yes| @@ -35,20 +38,24 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.AffectedHistory = $MadelineProto->messages->deleteHistory(['peer' => InputPeer, 'max_id' => int, ]); +$messages.AffectedHistory = $MadelineProto->messages->deleteHistory(['just_clear' => Bool, 'revoke' => Bool, 'peer' => InputPeer, 'max_id' => int, ]); ``` Or, if you're into Lua: ```lua -messages.AffectedHistory = messages.deleteHistory({peer=InputPeer, max_id=int, }) +messages.AffectedHistory = messages.deleteHistory({just_clear=Bool, revoke=Bool, peer=InputPeer, max_id=int, }) ``` ### Errors | 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| diff --git a/old_docs/API_docs_v44/methods/messages.deleteMessages.md b/old_docs/API_docs_v44/methods/messages.deleteMessages.md index 4ece4933..125a22c5 100644 --- a/old_docs/API_docs_v44/methods/messages.deleteMessages.md +++ b/old_docs/API_docs_v44/methods/messages.deleteMessages.md @@ -4,17 +4,19 @@ description: Deletes messages by their identifiers. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_deleteMessages.html --- -# Method: messages.deleteMessages +# Method: messages.deleteMessages [Back to methods index](index.md) + Deletes messages by their identifiers. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| +|revoke|[Bool](../types/Bool.md) | Whether to delete messages for all participants of the chat | Optional| +|id|Array of [int](../types/int.md) | Message ID list | Yes| ### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) @@ -34,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.AffectedMessages = $MadelineProto->messages->deleteMessages(['id' => [int, int], ]); +$messages.AffectedMessages = $MadelineProto->messages->deleteMessages(['revoke' => Bool, 'id' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.AffectedMessages = messages.deleteMessages({id={int}, }) +messages.AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/messages.deleteScheduledMessages.md b/old_docs/API_docs_v44/methods/messages.deleteScheduledMessages.md new file mode 100644 index 00000000..c11b8c6d --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.deleteScheduledMessages.md @@ -0,0 +1,47 @@ +--- +title: messages.deleteScheduledMessages +description: Delete scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_deleteScheduledMessages.html +--- +# Method: messages.deleteScheduledMessages +[Back to methods index](index.md) + + + +Delete scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | Scheduled message IDs | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->deleteScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.deleteScheduledMessages({peer=InputPeer, id={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.discardEncryption.md b/old_docs/API_docs_v44/methods/messages.discardEncryption.md index e7684cbf..a52c9b8e 100644 --- a/old_docs/API_docs_v44/methods/messages.discardEncryption.md +++ b/old_docs/API_docs_v44/methods/messages.discardEncryption.md @@ -1,20 +1,21 @@ --- title: messages.discardEncryption -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +description: Cancels a request for creation and/or delete info on secret chat. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_discardEncryption.html --- -# Method: messages.discardEncryption +# Method: messages.discardEncryption [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats + +Cancels a request for creation and/or delete info on secret chat. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| +|chat\_id|[int](../types/int.md) | Secret chat ID | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages.editChatAbout.md b/old_docs/API_docs_v44/methods/messages.editChatAbout.md new file mode 100644 index 00000000..9a474433 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.editChatAbout.md @@ -0,0 +1,61 @@ +--- +title: messages.editChatAbout +description: Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatAbout.html +--- +# Method: messages.editChatAbout +[Back to methods index](index.md) + + + +Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The [group/supergroup/channel](https://core.telegram.org/api/channel). | Optional| +|about|[string](../types/string.md) | The new description | 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->messages->editChatAbout(['peer' => InputPeer, 'about' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.editChatAbout({peer=InputPeer, about='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|400|CHAT_ABOUT_TOO_LONG|Chat about too long| +|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|PEER_ID_INVALID|The provided peer id is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v44/methods/messages.editChatAdmin.md b/old_docs/API_docs_v44/methods/messages.editChatAdmin.md index fa94a5c4..a405da4b 100644 --- a/old_docs/API_docs_v44/methods/messages.editChatAdmin.md +++ b/old_docs/API_docs_v44/methods/messages.editChatAdmin.md @@ -4,17 +4,18 @@ description: Make a user admin in a [legacy group](https://core.telegram.org/api image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_editChatAdmin.html --- -# Method: messages.editChatAdmin +# Method: messages.editChatAdmin [Back to methods index](index.md) + Make a user admin in a [legacy group](https://core.telegram.org/api/channel). ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to make admin | Optional| |is\_admin|[Bool](../types/Bool.md) | Whether to make him admin | Yes| @@ -50,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| diff --git a/old_docs/API_docs_v44/methods/messages.editChatDefaultBannedRights.md b/old_docs/API_docs_v44/methods/messages.editChatDefaultBannedRights.md new file mode 100644 index 00000000..897873d3 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.editChatDefaultBannedRights.md @@ -0,0 +1,58 @@ +--- +title: messages.editChatDefaultBannedRights +description: Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatDefaultBannedRights.html +--- +# Method: messages.editChatDefaultBannedRights +[Back to methods index](index.md) + + + +Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | The new global rights | Yes| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->messages->editChatDefaultBannedRights(['peer' => InputPeer, 'banned_rights' => ChatBannedRights, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editChatDefaultBannedRights({peer=InputPeer, banned_rights=ChatBannedRights, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BANNED_RIGHTS_INVALID|You provided some invalid flags in the banned rights| +|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|PEER_ID_INVALID|The provided peer id is invalid| +|400|UNTIL_DATE_INVALID|Invalid until date provided| + + diff --git a/old_docs/API_docs_v44/methods/messages.editChatPhoto.md b/old_docs/API_docs_v44/methods/messages.editChatPhoto.md index addf9c4f..7d04eb6a 100644 --- a/old_docs/API_docs_v44/methods/messages.editChatPhoto.md +++ b/old_docs/API_docs_v44/methods/messages.editChatPhoto.md @@ -4,17 +4,18 @@ description: Changes chat photo and sends a service message on it image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_editChatPhoto.html --- -# Method: messages.editChatPhoto +# Method: messages.editChatPhoto [Back to methods index](index.md) + Changes chat photo and sends a service message on it ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| |photo|[InputChatPhoto](../types/InputChatPhoto.md) | Photo to be set | Optional| diff --git a/old_docs/API_docs_v44/methods/messages.editChatTitle.md b/old_docs/API_docs_v44/methods/messages.editChatTitle.md index 96010ee9..b9637633 100644 --- a/old_docs/API_docs_v44/methods/messages.editChatTitle.md +++ b/old_docs/API_docs_v44/methods/messages.editChatTitle.md @@ -4,17 +4,18 @@ description: Chanages chat name and sends a service message on it. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_editChatTitle.html --- -# Method: messages.editChatTitle +# Method: messages.editChatTitle [Back to methods index](index.md) + Chanages chat name and sends a service message on it. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| |title|[string](../types/string.md) | New chat name, different from the old one | Yes| diff --git a/old_docs/API_docs_v44/methods/messages.editInlineBotMessage.md b/old_docs/API_docs_v44/methods/messages.editInlineBotMessage.md new file mode 100644 index 00000000..ef2bc626 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.editInlineBotMessage.md @@ -0,0 +1,108 @@ +--- +title: messages.editInlineBotMessage +description: Edit an inline bot message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editInlineBotMessage.html +--- +# Method: messages.editInlineBotMessage +[Back to methods index](index.md) + + + +Edit an inline bot message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Sent inline message ID | Yes| +|message|[string](../types/string.md) | Message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Media | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for inline keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | [Message entities for styled text](https://core.telegram.org/api/entities) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### 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->messages->editInlineBotMessage(['no_webpage' => Bool, 'id' => InputBotInlineMessageID, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.editInlineBotMessage({no_webpage=Bool, id=InputBotInlineMessageID, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v44/methods/messages.editMessage.md b/old_docs/API_docs_v44/methods/messages.editMessage.md new file mode 100644 index 00000000..4a1d0e74 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.editMessage.md @@ -0,0 +1,131 @@ +--- +title: messages.editMessage +description: Edit message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editMessage.html +--- +# Method: messages.editMessage +[Back to methods index](index.md) + + + +Edit message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the message sent | Optional| +|id|[int](../types/int.md) | ID of the message to edit | Yes| +|message|[string](../types/string.md) | New message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | New attached media | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for inline keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | [Message entities for styled text](https://core.telegram.org/api/entities) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->messages->editMessage(['no_webpage' => Bool, 'peer' => InputPeer, 'id' => int, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editMessage({no_webpage=Bool, peer=InputPeer, id=int, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', schedule_date=int, }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| +|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|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| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_NOT_MODIFIED|The message text has not changed| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|400|SCHEDULE_DATE_INVALID|Invalid schedule date provided| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|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| +|403|INLINE_BOT_REQUIRED|Only the inline bot can edit message| +|403|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v44/methods/messages.exportChatInvite.md b/old_docs/API_docs_v44/methods/messages.exportChatInvite.md index bc4a45ad..79b3c449 100644 --- a/old_docs/API_docs_v44/methods/messages.exportChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages.exportChatInvite.md @@ -4,22 +4,23 @@ description: Export an invite link for a chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_exportChatInvite.html --- -# Method: messages.exportChatInvite +# Method: messages.exportChatInvite [Back to methods index](index.md) + Export an invite link for a chat ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) -### Can bots use this method: **NO** +### Can bots use this method: **YES** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -34,13 +35,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$ExportedChatInvite = $MadelineProto->messages->exportChatInvite(['chat_id' => InputPeer, ]); +$ExportedChatInvite = $MadelineProto->messages->exportChatInvite(['peer' => InputPeer, ]); ``` Or, if you're into Lua: ```lua -ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) +ExportedChatInvite = messages.exportChatInvite({peer=InputPeer, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/messages.faveSticker.md b/old_docs/API_docs_v44/methods/messages.faveSticker.md new file mode 100644 index 00000000..8280c6b1 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.faveSticker.md @@ -0,0 +1,54 @@ +--- +title: messages.faveSticker +description: Mark a sticker as favorite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_faveSticker.html +--- +# Method: messages.faveSticker +[Back to methods index](index.md) + + + +Mark a sticker as favorite + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Sticker to mark as favorite | Optional| +|unfave|[Bool](../types/Bool.md) | Unfavorite | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.forwardMessages.md b/old_docs/API_docs_v44/methods/messages.forwardMessages.md index cc2e03a1..cd39fe32 100644 --- a/old_docs/API_docs_v44/methods/messages.forwardMessages.md +++ b/old_docs/API_docs_v44/methods/messages.forwardMessages.md @@ -4,20 +4,25 @@ description: Forwards messages by their IDs. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_forwardMessages.html --- -# Method: messages.forwardMessages +# Method: messages.forwardMessages [Back to methods index](index.md) + Forwards messages by their IDs. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Whether to send messages silently (no notification will be triggered on the destination clients) | Optional| +|background|[Bool](../types/Bool.md) | Whether to send the message in background | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | When forwarding games, whether to include your score in the game | Optional| +|grouped|[Bool](../types/Bool.md) | Whether the specified messages represent an album (grouped media) | Optional| |from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Source of messages | Optional| -|id|Array of [int](../types/int.md) | The message IDs | Yes| +|id|Array of [int](../types/int.md) | IDs of messages | Yes| |to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination peer | Optional| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| ### Return type: [Updates](../types/Updates.md) @@ -37,19 +42,21 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->messages->forwardMessages(['broadcast' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, ]); +$Updates = $MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'grouped' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, 'schedule_date' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) +Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, schedule_date=int, }) ``` ### Errors | 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| |400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| @@ -67,12 +74,12 @@ Updates = messages.forwardMessages({broadcast=Bool, from_peer=InputPeer, id={int |400|USER_IS_BLOCKED|You were blocked by this user| |400|USER_IS_BOT|Bots can't send messages to other bots| |400|YOU_BLOCKED_USER|You blocked this user| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| |403|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| |403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| |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| diff --git a/old_docs/API_docs_v44/methods/messages.getAllChats.md b/old_docs/API_docs_v44/methods/messages.getAllChats.md new file mode 100644 index 00000000..0337a223 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getAllChats.md @@ -0,0 +1,53 @@ +--- +title: messages.getAllChats +description: Get all chats, channels and supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAllChats.html +--- +# Method: messages.getAllChats +[Back to methods index](index.md) + + + +Get all chats, channels and supergroups + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Except these chats/channels/supergroups | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Chats = $MadelineProto->messages->getAllChats(['except_ids' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = messages.getAllChats({except_ids={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v44/methods/messages.getAllDrafts.md b/old_docs/API_docs_v44/methods/messages.getAllDrafts.md new file mode 100644 index 00000000..af9f553d --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getAllDrafts.md @@ -0,0 +1,41 @@ +--- +title: messages.getAllDrafts +description: Save get all message [drafts](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAllDrafts.html +--- +# Method: messages.getAllDrafts +[Back to methods index](index.md) + + + +Save get all message [drafts](https://core.telegram.org/api/drafts). + + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->getAllDrafts(); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.getAllDrafts({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getAllStickers.md b/old_docs/API_docs_v44/methods/messages.getAllStickers.md index 2f0cd4cf..241a4e4e 100644 --- a/old_docs/API_docs_v44/methods/messages.getAllStickers.md +++ b/old_docs/API_docs_v44/methods/messages.getAllStickers.md @@ -4,17 +4,18 @@ description: Get all installed stickers image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getAllStickers.html --- -# Method: messages.getAllStickers +# Method: messages.getAllStickers [Back to methods index](index.md) + Get all installed stickers ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|hash|Array of [int](../types/int.md) | The hash parameter of the previous result of this method | Optional| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| ### Return type: [messages.AllStickers](../types/messages.AllStickers.md) diff --git a/old_docs/API_docs_v44/methods/messages.getArchivedStickers.md b/old_docs/API_docs_v44/methods/messages.getArchivedStickers.md new file mode 100644 index 00000000..fda5ac07 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getArchivedStickers.md @@ -0,0 +1,48 @@ +--- +title: messages.getArchivedStickers +description: Get all archived stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getArchivedStickers.html +--- +# Method: messages.getArchivedStickers +[Back to methods index](index.md) + + + +Get all archived stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get mask stickers | Optional| +|offset\_id|[long](../types/long.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.ArchivedStickers](../types/messages.ArchivedStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.ArchivedStickers = $MadelineProto->messages->getArchivedStickers(['masks' => Bool, 'offset_id' => long, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.ArchivedStickers = messages.getArchivedStickers({masks=Bool, offset_id=long, limit=int, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getAttachedStickers.md b/old_docs/API_docs_v44/methods/messages.getAttachedStickers.md new file mode 100644 index 00000000..52e948d1 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getAttachedStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getAttachedStickers +description: Get stickers attached to a photo or video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAttachedStickers.html +--- +# Method: messages.getAttachedStickers +[Back to methods index](index.md) + + + +Get stickers attached to a photo or video + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Stickered media | Yes| + + +### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_StickerSetCovered = $MadelineProto->messages->getAttachedStickers(['media' => InputStickeredMedia, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_StickerSetCovered = messages.getAttachedStickers({media=InputStickeredMedia, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getBotCallbackAnswer.md b/old_docs/API_docs_v44/methods/messages.getBotCallbackAnswer.md new file mode 100644 index 00000000..fe5be1f7 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getBotCallbackAnswer.md @@ -0,0 +1,63 @@ +--- +title: messages.getBotCallbackAnswer +description: Press an inline callback button and get a callback answer from the bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getBotCallbackAnswer.html +--- +# Method: messages.getBotCallbackAnswer +[Back to methods index](index.md) + + + +Press an inline callback button and get a callback answer from the bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Whether this is a "play game" button | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the inline keyboard sent | Optional| +|msg\_id|[int](../types/int.md) | ID of the Message with the inline keyboard | Yes| +|data|[bytes](../types/bytes.md) | Callback data | Optional| + + +### Return type: [messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.BotCallbackAnswer = $MadelineProto->messages->getBotCallbackAnswer(['game' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'data' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +messages.BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) +``` + +### Errors + +| 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| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|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| + + diff --git a/old_docs/API_docs_v44/methods/messages.getChats.md b/old_docs/API_docs_v44/methods/messages.getChats.md index 496e0f7c..3251cfc6 100644 --- a/old_docs/API_docs_v44/methods/messages.getChats.md +++ b/old_docs/API_docs_v44/methods/messages.getChats.md @@ -4,17 +4,18 @@ description: Returns chat basic info on their IDs. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getChats.html --- -# Method: messages.getChats +# Method: messages.getChats [Back to methods index](index.md) + Returns chat basic info on their IDs. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| +|id|Array of [int](../types/int.md) | List of chat IDs | Yes| ### Return type: [messages.Chats](../types/messages.Chats.md) diff --git a/old_docs/API_docs_v44/methods/messages.getCommonChats.md b/old_docs/API_docs_v44/methods/messages.getCommonChats.md new file mode 100644 index 00000000..561b7d7e --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getCommonChats.md @@ -0,0 +1,56 @@ +--- +title: messages.getCommonChats +description: Get chats in common with a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getCommonChats.html +--- +# Method: messages.getCommonChats +[Back to methods index](index.md) + + + +Get chats in common with a user + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|max\_id|[int](../types/int.md) | Maximum ID of chat to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Chats = $MadelineProto->messages->getCommonChats(['user_id' => InputUser, 'max_id' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getDhConfig.md b/old_docs/API_docs_v44/methods/messages.getDhConfig.md index a23ce8ec..f3622904 100644 --- a/old_docs/API_docs_v44/methods/messages.getDhConfig.md +++ b/old_docs/API_docs_v44/methods/messages.getDhConfig.md @@ -1,21 +1,22 @@ --- title: messages.getDhConfig -description: You cannot use this method directly, instead use $MadelineProto->getDhConfig(); +description: Returns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getDhConfig.html --- -# Method: messages.getDhConfig +# Method: messages.getDhConfig [Back to methods index](index.md) -You cannot use this method directly, instead use $MadelineProto->getDhConfig(); + +Returns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|version|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes| -|random\_length|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes| +|version|[int](../types/int.md) | Value of the **version** parameter from [messages.dhConfig](../constructors/messages.dhConfig.md), avialable at the client | Yes| +|random\_length|[int](../types/int.md) | Length of the required random sequence | Yes| ### Return type: [messages.DhConfig](../types/messages.DhConfig.md) diff --git a/old_docs/API_docs_v44/methods/messages.getDialogFilters.md b/old_docs/API_docs_v44/methods/messages.getDialogFilters.md new file mode 100644 index 00000000..3f49e361 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getDialogFilters.md @@ -0,0 +1,41 @@ +--- +title: messages.getDialogFilters +description: Get [folders](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDialogFilters.html +--- +# Method: messages.getDialogFilters +[Back to methods index](index.md) + + + +Get [folders](https://core.telegram.org/api/folders) + + + +### Return type: [Vector\_of\_DialogFilter](../types/DialogFilter.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_DialogFilter = $MadelineProto->messages->getDialogFilters(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_DialogFilter = messages.getDialogFilters({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getDialogUnreadMarks.md b/old_docs/API_docs_v44/methods/messages.getDialogUnreadMarks.md new file mode 100644 index 00000000..1f886ce9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getDialogUnreadMarks.md @@ -0,0 +1,41 @@ +--- +title: messages.getDialogUnreadMarks +description: Get dialogs manually marked as unread +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDialogUnreadMarks.html +--- +# Method: messages.getDialogUnreadMarks +[Back to methods index](index.md) + + + +Get dialogs manually marked as unread + + + +### Return type: [Vector\_of\_DialogPeer](../types/DialogPeer.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_DialogPeer = $MadelineProto->messages->getDialogUnreadMarks(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_DialogPeer = messages.getDialogUnreadMarks({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getDialogs.md b/old_docs/API_docs_v44/methods/messages.getDialogs.md index 80edbb2a..505d883a 100644 --- a/old_docs/API_docs_v44/methods/messages.getDialogs.md +++ b/old_docs/API_docs_v44/methods/messages.getDialogs.md @@ -4,20 +4,24 @@ description: Returns the current user dialog list. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getDialogs.html --- -# Method: messages.getDialogs +# Method: messages.getDialogs [Back to methods index](index.md) + Returns the current user dialog list. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Exclude pinned dialogs | Optional| +|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Optional| |offset\_date|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| |offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offset peer for pagination](https://core.telegram.org/api/offsets) | Optional| |limit|[int](../types/int.md) | Number of list elements to be returned | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| ### Return type: [messages.Dialogs](../types/messages.Dialogs.md) @@ -37,23 +41,25 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Dialogs = $MadelineProto->messages->getDialogs(['offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, ]); +$messages.Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bool, 'folder_id' => int, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) +messages.Dialogs = messages.getDialogs({exclude_pinned=Bool, folder_id=int, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, hash={int}, }) ``` ### Errors | 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| diff --git a/old_docs/API_docs_v44/methods/messages.getDocumentByHash.md b/old_docs/API_docs_v44/methods/messages.getDocumentByHash.md index 4b665301..73881923 100644 --- a/old_docs/API_docs_v44/methods/messages.getDocumentByHash.md +++ b/old_docs/API_docs_v44/methods/messages.getDocumentByHash.md @@ -4,10 +4,11 @@ description: Get a document by its SHA256 hash, mainly used for gifs image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getDocumentByHash.html --- -# Method: messages.getDocumentByHash +# Method: messages.getDocumentByHash [Back to methods index](index.md) + Get a document by its SHA256 hash, mainly used for gifs ### Parameters: diff --git a/old_docs/API_docs_v44/methods/help.getTermsOfService.md b/old_docs/API_docs_v44/methods/messages.getEmojiKeywords.md similarity index 58% rename from old_docs/API_docs_v44/methods/help.getTermsOfService.md rename to old_docs/API_docs_v44/methods/messages.getEmojiKeywords.md index 36eed4ff..3a64db7d 100644 --- a/old_docs/API_docs_v44/methods/help.getTermsOfService.md +++ b/old_docs/API_docs_v44/methods/messages.getEmojiKeywords.md @@ -1,14 +1,15 @@ --- -title: help.getTermsOfService -description: Get terms of service +title: messages.getEmojiKeywords +description: Get localized emoji keywords image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/help_getTermsOfService.html +redirect_from: /API_docs/methods/messages_getEmojiKeywords.html --- -# Method: help.getTermsOfService +# Method: messages.getEmojiKeywords [Back to methods index](index.md) -Get terms of service + +Get localized emoji keywords ### Parameters: @@ -17,9 +18,9 @@ Get terms of service |lang\_code|[string](../types/string.md) | Language code | Yes| -### Return type: [help.TermsOfService](../types/help.TermsOfService.md) +### Return type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -34,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$help.TermsOfService = $MadelineProto->help->getTermsOfService(['lang_code' => 'string', ]); +$EmojiKeywordsDifference = $MadelineProto->messages->getEmojiKeywords(['lang_code' => 'string', ]); ``` Or, if you're into Lua: ```lua -help.TermsOfService = help.getTermsOfService({lang_code='string', }) +EmojiKeywordsDifference = messages.getEmojiKeywords({lang_code='string', }) ``` diff --git a/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsDifference.md b/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsDifference.md new file mode 100644 index 00000000..e4ab87f3 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsDifference.md @@ -0,0 +1,47 @@ +--- +title: messages.getEmojiKeywordsDifference +description: Get changed emoji keywords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiKeywordsDifference.html +--- +# Method: messages.getEmojiKeywordsDifference +[Back to methods index](index.md) + + + +Get changed emoji keywords + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|from\_version|[int](../types/int.md) | Previous emoji keyword localization version | Yes| + + +### Return type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +### Can bots use this method: **NO** + + +### 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(); + +$EmojiKeywordsDifference = $MadelineProto->messages->getEmojiKeywordsDifference(['lang_code' => 'string', 'from_version' => int, ]); +``` + +Or, if you're into Lua: + +```lua +EmojiKeywordsDifference = messages.getEmojiKeywordsDifference({lang_code='string', from_version=int, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsLanguages.md b/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsLanguages.md new file mode 100644 index 00000000..43f12488 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getEmojiKeywordsLanguages.md @@ -0,0 +1,46 @@ +--- +title: messages.getEmojiKeywordsLanguages +description: Get info about an emoji keyword localization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiKeywordsLanguages.html +--- +# Method: messages.getEmojiKeywordsLanguages +[Back to methods index](index.md) + + + +Get info about an emoji keyword localization + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_codes|Array of [string](../types/string.md) | Language codes | Yes| + + +### Return type: [Vector\_of\_EmojiLanguage](../types/EmojiLanguage.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_EmojiLanguage = $MadelineProto->messages->getEmojiKeywordsLanguages(['lang_codes' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_EmojiLanguage = messages.getEmojiKeywordsLanguages({lang_codes={'string'}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getEmojiURL.md b/old_docs/API_docs_v44/methods/messages.getEmojiURL.md new file mode 100644 index 00000000..21dc8642 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getEmojiURL.md @@ -0,0 +1,46 @@ +--- +title: messages.getEmojiURL +description: Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiURL.html +--- +# Method: messages.getEmojiURL +[Back to methods index](index.md) + + + +Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language code for which the emoji replacements will be suggested | Yes| + + +### Return type: [EmojiURL](../types/EmojiURL.md) + +### Can bots use this method: **NO** + + +### 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(); + +$EmojiURL = $MadelineProto->messages->getEmojiURL(['lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +EmojiURL = messages.getEmojiURL({lang_code='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getFavedStickers.md b/old_docs/API_docs_v44/methods/messages.getFavedStickers.md new file mode 100644 index 00000000..a4d34e01 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getFavedStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getFavedStickers +description: Get faved stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getFavedStickers.html +--- +# Method: messages.getFavedStickers +[Back to methods index](index.md) + + + +Get faved stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.FavedStickers](../types/messages.FavedStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.FavedStickers = $MadelineProto->messages->getFavedStickers(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FavedStickers = messages.getFavedStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getFeaturedStickers.md b/old_docs/API_docs_v44/methods/messages.getFeaturedStickers.md new file mode 100644 index 00000000..f1894d0c --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getFeaturedStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getFeaturedStickers +description: Get featured stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getFeaturedStickers.html +--- +# Method: messages.getFeaturedStickers +[Back to methods index](index.md) + + + +Get featured stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.FeaturedStickers = $MadelineProto->messages->getFeaturedStickers(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FeaturedStickers = messages.getFeaturedStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getFullChat.md b/old_docs/API_docs_v44/methods/messages.getFullChat.md index 4be62e50..777f18cb 100644 --- a/old_docs/API_docs_v44/methods/messages.getFullChat.md +++ b/old_docs/API_docs_v44/methods/messages.getFullChat.md @@ -1,20 +1,21 @@ --- title: messages.getFullChat -description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +description: Returns full chat info according to its ID. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getFullChat.html --- -# Method: messages.getFullChat +# Method: messages.getFullChat [Back to methods index](index.md) -You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +Returns full chat info according to its ID. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| ### Return type: [messages.ChatFull](../types/messages.ChatFull.md) @@ -49,5 +50,6 @@ messages.ChatFull = messages.getFullChat({chat_id=InputPeer, }) |------|----------|---------------| |400|CHAT_ID_INVALID|The provided chat id is invalid| |400|PEER_ID_INVALID|The provided peer id is invalid| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| diff --git a/old_docs/API_docs_v44/methods/messages.getGameHighScores.md b/old_docs/API_docs_v44/methods/messages.getGameHighScores.md new file mode 100644 index 00000000..901a86fe --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getGameHighScores.md @@ -0,0 +1,57 @@ +--- +title: messages.getGameHighScores +description: Get highscores of a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getGameHighScores.html +--- +# Method: messages.getGameHighScores +[Back to methods index](index.md) + + + +Get highscores of a game + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the game sent | Optional| +|id|[int](../types/int.md) | ID of message with game media attachment | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Get high scores made by a certain user | Optional| + + +### Return type: [messages.HighScores](../types/messages.HighScores.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(); + +$messages.HighScores = $MadelineProto->messages->getGameHighScores(['peer' => InputPeer, 'id' => int, 'user_id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +messages.HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/messages.getHistory.md b/old_docs/API_docs_v44/methods/messages.getHistory.md index 32b4594a..02721b98 100644 --- a/old_docs/API_docs_v44/methods/messages.getHistory.md +++ b/old_docs/API_docs_v44/methods/messages.getHistory.md @@ -4,10 +4,11 @@ description: Gets back the conversation history with one interlocutor / within a image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getHistory.html --- -# Method: messages.getHistory +# Method: messages.getHistory [Back to methods index](index.md) + Gets back the conversation history with one interlocutor / within a chat ### Parameters: @@ -16,10 +17,12 @@ Gets back the conversation history with one interlocutor / within a chat |----------|---------------|-------------|----------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Target peer | Optional| |offset\_id|[int](../types/int.md) | Only return messages starting from the specified message ID | Yes| +|offset\_date|[int](../types/int.md) | Only return messages sent before the specified date | Yes| |add\_offset|[int](../types/int.md) | Number of list elements to be skipped, negative values are also accepted. | Yes| |limit|[int](../types/int.md) | Number of results to return | Yes| |max\_id|[int](../types/int.md) | If a positive value was transferred, the method will return only messages with IDs less than **max\_id** | Yes| |min\_id|[int](../types/int.md) | If a positive value was transferred, the method will return only messages with IDs more than **min\_id** | Yes| +|hash|Array of [int](../types/int.md) | [Result hash](https://core.telegram.org/api/offsets) | Optional| ### Return type: [messages.Messages](../types/messages.Messages.md) @@ -39,13 +42,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->getHistory(['peer' => InputPeer, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]); +$messages.Messages = $MadelineProto->messages->getHistory(['peer' => InputPeer, 'offset_id' => int, 'offset_date' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) +messages.Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, }) ``` ### Errors @@ -59,6 +62,7 @@ messages.Messages = messages.getHistory({peer=InputPeer, offset_id=int, add_offs |400|PEER_ID_INVALID|The provided peer id is invalid| |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.| +|-504|memory limit exit|Internal error| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/messages.getInlineBotResults.md b/old_docs/API_docs_v44/methods/messages.getInlineBotResults.md new file mode 100644 index 00000000..ad3c9682 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getInlineBotResults.md @@ -0,0 +1,63 @@ +--- +title: messages.getInlineBotResults +description: Query an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getInlineBotResults.html +--- +# Method: messages.getInlineBotResults +[Back to methods index](index.md) + + + +Query an inline bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to query | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The currently opened chat | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The geolocation, if requested | Optional| +|query|[string](../types/string.md) | The query | Yes| +|offset|[string](../types/string.md) | The offset within the results, will be passed directly as-is to the bot. | Yes| + + +### Return type: [messages.BotResults](../types/messages.BotResults.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.BotResults = $MadelineProto->messages->getInlineBotResults(['bot' => InputUser, 'peer' => InputPeer, 'geo_point' => InputGeoPoint, 'query' => 'string', 'offset' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +messages.BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| + + diff --git a/old_docs/API_docs_v44/methods/messages.getInlineGameHighScores.md b/old_docs/API_docs_v44/methods/messages.getInlineGameHighScores.md new file mode 100644 index 00000000..4ab30aa8 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getInlineGameHighScores.md @@ -0,0 +1,55 @@ +--- +title: messages.getInlineGameHighScores +description: Get highscores of a game sent using an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getInlineGameHighScores.html +--- +# Method: messages.getInlineGameHighScores +[Back to methods index](index.md) + + + +Get highscores of a game sent using an inline bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | ID of inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Get high scores of a certain user | Optional| + + +### Return type: [messages.HighScores](../types/messages.HighScores.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(); + +$messages.HighScores = $MadelineProto->messages->getInlineGameHighScores(['id' => InputBotInlineMessageID, 'user_id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +messages.HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/messages.getMaskStickers.md b/old_docs/API_docs_v44/methods/messages.getMaskStickers.md new file mode 100644 index 00000000..90d5efb8 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getMaskStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getMaskStickers +description: Get installed mask stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMaskStickers.html +--- +# Method: messages.getMaskStickers +[Back to methods index](index.md) + + + +Get installed mask stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.AllStickers](../types/messages.AllStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.AllStickers = $MadelineProto->messages->getMaskStickers(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AllStickers = messages.getMaskStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getMessageEditData.md b/old_docs/API_docs_v44/methods/messages.getMessageEditData.md new file mode 100644 index 00000000..e357fb69 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getMessageEditData.md @@ -0,0 +1,57 @@ +--- +title: messages.getMessageEditData +description: Find out if a media message's caption can be edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMessageEditData.html +--- +# Method: messages.getMessageEditData +[Back to methods index](index.md) + + + +Find out if a media message's caption can be edited + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the media was sent | Optional| +|id|[int](../types/int.md) | ID of message | Yes| + + +### Return type: [messages.MessageEditData](../types/messages.MessageEditData.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.MessageEditData = $MadelineProto->messages->getMessageEditData(['peer' => InputPeer, 'id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|403|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v44/methods/messages.getMessages.md b/old_docs/API_docs_v44/methods/messages.getMessages.md index 5f95fd0a..5b8a5bd0 100644 --- a/old_docs/API_docs_v44/methods/messages.getMessages.md +++ b/old_docs/API_docs_v44/methods/messages.getMessages.md @@ -4,17 +4,18 @@ description: Returns the list of messages by their IDs. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getMessages.html --- -# Method: messages.getMessages +# Method: messages.getMessages [Back to methods index](index.md) + Returns the list of messages by their IDs. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Message ID list | Yes| ### Return type: [messages.Messages](../types/messages.Messages.md) @@ -34,12 +35,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->getMessages(['id' => [int, int], ]); +$messages.Messages = $MadelineProto->messages->getMessages(['id' => [InputMessage, InputMessage], ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.getMessages({id={int}, }) +messages.Messages = messages.getMessages({id={InputMessage}, }) ``` diff --git a/old_docs/API_docs_v44/methods/messages.getMessagesViews.md b/old_docs/API_docs_v44/methods/messages.getMessagesViews.md index 2b808720..1a8e9f5d 100644 --- a/old_docs/API_docs_v44/methods/messages.getMessagesViews.md +++ b/old_docs/API_docs_v44/methods/messages.getMessagesViews.md @@ -4,10 +4,11 @@ description: Get and increase the view counter of a message sent or forwarded fr image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getMessagesViews.html --- -# Method: messages.getMessagesViews +# Method: messages.getMessagesViews [Back to methods index](index.md) + Get and increase the view counter of a message sent or forwarded from a [channel](https://core.telegram.org/api/channel) ### Parameters: @@ -15,7 +16,7 @@ Get and increase the view counter of a message sent or forwarded from a [channel | Name | Type | Description | Required | |----------|---------------|-------------|----------| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the message was found | Optional| -|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|id|Array of [int](../types/int.md) | ID of message | Yes| |increment|[Bool](../types/Bool.md) | Whether to mark the message as viewed and increment the view counter | Yes| diff --git a/old_docs/API_docs_v44/methods/messages.getOldFeaturedStickers.md b/old_docs/API_docs_v44/methods/messages.getOldFeaturedStickers.md new file mode 100644 index 00000000..ec1cc98c --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getOldFeaturedStickers.md @@ -0,0 +1,48 @@ +--- +title: messages.getOldFeaturedStickers +description: Method for fetching previously featured stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getOldFeaturedStickers.html +--- +# Method: messages.getOldFeaturedStickers +[Back to methods index](index.md) + + + +Method for fetching previously featured stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.FeaturedStickers = $MadelineProto->messages->getOldFeaturedStickers(['offset' => int, 'limit' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FeaturedStickers = messages.getOldFeaturedStickers({offset=int, limit=int, hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getOnlines.md b/old_docs/API_docs_v44/methods/messages.getOnlines.md new file mode 100644 index 00000000..e551e2f9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getOnlines.md @@ -0,0 +1,54 @@ +--- +title: messages.getOnlines +description: Get count of online users in a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getOnlines.html +--- +# Method: messages.getOnlines +[Back to methods index](index.md) + + + +Get count of online users in a chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| + + +### Return type: [ChatOnlines](../types/ChatOnlines.md) + +### Can bots use this method: **NO** + + +### 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(); + +$ChatOnlines = $MadelineProto->messages->getOnlines(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +ChatOnlines = messages.getOnlines({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getPeerDialogs.md b/old_docs/API_docs_v44/methods/messages.getPeerDialogs.md new file mode 100644 index 00000000..912741fe --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getPeerDialogs.md @@ -0,0 +1,57 @@ +--- +title: messages.getPeerDialogs +description: Get dialog info of specified peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPeerDialogs.html +--- +# Method: messages.getPeerDialogs +[Back to methods index](index.md) + + + +Get dialog info of specified peers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | Peers | Yes| + + +### Return type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.PeerDialogs = $MadelineProto->messages->getPeerDialogs(['peers' => [InputDialogPeer, InputDialogPeer], ]); +``` + +Or, if you're into Lua: + +```lua +messages.PeerDialogs = messages.getPeerDialogs({peers={InputDialogPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|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| + + diff --git a/old_docs/API_docs_v44/methods/messages.getPeerSettings.md b/old_docs/API_docs_v44/methods/messages.getPeerSettings.md new file mode 100644 index 00000000..251b47fe --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getPeerSettings.md @@ -0,0 +1,54 @@ +--- +title: messages.getPeerSettings +description: Get peer settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPeerSettings.html +--- +# Method: messages.getPeerSettings +[Back to methods index](index.md) + + + +Get peer settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| + + +### Return type: [PeerSettings](../types/PeerSettings.md) + +### Can bots use this method: **NO** + + +### 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(); + +$PeerSettings = $MadelineProto->messages->getPeerSettings(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +PeerSettings = messages.getPeerSettings({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getPinnedDialogs.md b/old_docs/API_docs_v44/methods/messages.getPinnedDialogs.md new file mode 100644 index 00000000..ac84ba91 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getPinnedDialogs.md @@ -0,0 +1,53 @@ +--- +title: messages.getPinnedDialogs +description: Get pinned dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPinnedDialogs.html +--- +# Method: messages.getPinnedDialogs +[Back to methods index](index.md) + + + +Get pinned dialogs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Yes| + + +### Return type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.PeerDialogs = $MadelineProto->messages->getPinnedDialogs(['folder_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.PeerDialogs = messages.getPinnedDialogs({folder_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FOLDER_ID_INVALID|Invalid folder ID| + + diff --git a/old_docs/API_docs_v44/methods/messages.forwardMessage.md b/old_docs/API_docs_v44/methods/messages.getPollResults.md similarity index 58% rename from old_docs/API_docs_v44/methods/messages.forwardMessage.md rename to old_docs/API_docs_v44/methods/messages.getPollResults.md index 892e2403..b0932343 100644 --- a/old_docs/API_docs_v44/methods/messages.forwardMessage.md +++ b/old_docs/API_docs_v44/methods/messages.getPollResults.md @@ -1,26 +1,27 @@ --- -title: messages.forwardMessage -description: Forward message +title: messages.getPollResults +description: Get poll results image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/messages_forwardMessage.html +redirect_from: /API_docs/methods/messages_getPollResults.html --- -# Method: messages.forwardMessage +# Method: messages.getPollResults [Back to methods index](index.md) -Forward message + +Get poll results ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| -|id|[int](../types/int.md) | The message ID | Yes| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the poll was found | Optional| +|msg\_id|[int](../types/int.md) | Message ID of poll message | Yes| ### Return type: [Updates](../types/Updates.md) -### Can bots use this method: **YES** +### Can bots use this method: **NO** ### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): @@ -35,22 +36,19 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->messages->forwardMessage(['peer' => InputPeer, 'id' => int, ]); +$Updates = $MadelineProto->messages->getPollResults(['peer' => InputPeer, 'msg_id' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = messages.forwardMessage({peer=InputPeer, id=int, }) +Updates = messages.getPollResults({peer=InputPeer, msg_id=int, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| -|400|CHAT_ID_INVALID|The provided chat id is invalid| |400|MESSAGE_ID_INVALID|The provided message id is invalid| -|400|PEER_ID_INVALID|The provided peer id is invalid| -|400|YOU_BLOCKED_USER|You blocked this user| diff --git a/old_docs/API_docs_v44/methods/messages.getPollVotes.md b/old_docs/API_docs_v44/methods/messages.getPollVotes.md new file mode 100644 index 00000000..d6faa95e --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getPollVotes.md @@ -0,0 +1,57 @@ +--- +title: messages.getPollVotes +description: Get poll results for non-anonymous polls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPollVotes.html +--- +# Method: messages.getPollVotes +[Back to methods index](index.md) + + + +Get poll results for non-anonymous polls + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat where the poll was sent | Optional| +|id|[int](../types/int.md) | Message ID | Yes| +|option|[bytes](../types/bytes.md) | Get only results for the specified poll `option` | Optional| +|offset|[string](../types/string.md) | Offset for results, taken from the `next_offset` field of [messages.votesList](../constructors/messages.votesList.md), initially an empty string.
Note: if no more results are available, the method call will return an empty `next_offset`; thus, avoid providing the `next_offset` returned in [messages.votesList](../constructors/messages.votesList.md) if it is empty, to avoid an infinite loop. | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| + + +### Return type: [messages.VotesList](../types/messages.VotesList.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.VotesList = $MadelineProto->messages->getPollVotes(['peer' => InputPeer, 'id' => int, 'option' => 'bytes', 'offset' => 'string', 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.VotesList = messages.getPollVotes({peer=InputPeer, id=int, option='bytes', offset='string', limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|POLL_VOTE_REQUIRED|Cast a vote in the poll before calling this method| + + diff --git a/old_docs/API_docs_v44/methods/messages.getRecentLocations.md b/old_docs/API_docs_v44/methods/messages.getRecentLocations.md new file mode 100644 index 00000000..cbbaec0a --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getRecentLocations.md @@ -0,0 +1,48 @@ +--- +title: messages.getRecentLocations +description: Get live location history of a certain user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getRecentLocations.html +--- +# Method: messages.getRecentLocations +[Back to methods index](index.md) + + + +Get live location history of a certain user + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User | Optional| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Messages = $MadelineProto->messages->getRecentLocations(['peer' => InputPeer, 'limit' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getRecentLocations({peer=InputPeer, limit=int, hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getRecentStickers.md b/old_docs/API_docs_v44/methods/messages.getRecentStickers.md new file mode 100644 index 00000000..deb1fbfd --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getRecentStickers.md @@ -0,0 +1,47 @@ +--- +title: messages.getRecentStickers +description: Get recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getRecentStickers.html +--- +# Method: messages.getRecentStickers +[Back to methods index](index.md) + + + +Get recent stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers recently attached to photo or video files | Optional| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.RecentStickers](../types/messages.RecentStickers.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.RecentStickers = $MadelineProto->messages->getRecentStickers(['attached' => Bool, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.RecentStickers = messages.getRecentStickers({attached=Bool, hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getSavedGifs.md b/old_docs/API_docs_v44/methods/messages.getSavedGifs.md new file mode 100644 index 00000000..dbcc42b2 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getSavedGifs.md @@ -0,0 +1,46 @@ +--- +title: messages.getSavedGifs +description: Get saved GIFs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSavedGifs.html +--- +# Method: messages.getSavedGifs +[Back to methods index](index.md) + + + +Get saved GIFs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.SavedGifs](../types/messages.SavedGifs.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.SavedGifs = $MadelineProto->messages->getSavedGifs(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.SavedGifs = messages.getSavedGifs({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getScheduledHistory.md b/old_docs/API_docs_v44/methods/messages.getScheduledHistory.md new file mode 100644 index 00000000..dfba00f3 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getScheduledHistory.md @@ -0,0 +1,55 @@ +--- +title: messages.getScheduledHistory +description: Get scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getScheduledHistory.html +--- +# Method: messages.getScheduledHistory +[Back to methods index](index.md) + + + +Get scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Messages = $MadelineProto->messages->getScheduledHistory(['peer' => InputPeer, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getScheduledHistory({peer=InputPeer, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getScheduledMessages.md b/old_docs/API_docs_v44/methods/messages.getScheduledMessages.md new file mode 100644 index 00000000..ae4bd509 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getScheduledMessages.md @@ -0,0 +1,54 @@ +--- +title: messages.getScheduledMessages +description: Get scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getScheduledMessages.html +--- +# Method: messages.getScheduledMessages +[Back to methods index](index.md) + + + +Get scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | IDs of scheduled messages | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Messages = $MadelineProto->messages->getScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getScheduledMessages({peer=InputPeer, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v44/methods/messages.getSearchCounters.md b/old_docs/API_docs_v44/methods/messages.getSearchCounters.md new file mode 100644 index 00000000..b2e8444b --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getSearchCounters.md @@ -0,0 +1,47 @@ +--- +title: messages.getSearchCounters +description: Get the number of results that would be found by a [messages.search](../methods/messages.search.md) call with the same parameters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSearchCounters.html +--- +# Method: messages.getSearchCounters +[Back to methods index](index.md) + + + +Get the number of results that would be found by a [messages.search](../methods/messages.search.md) call with the same parameters + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where to search | Optional| +|filters|Array of [MessagesFilter](../types/MessagesFilter.md) | Search filters | Yes| + + +### Return type: [Vector\_of\_messages.SearchCounter](../types/messages.SearchCounter.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_messages.SearchCounter = $MadelineProto->messages->getSearchCounters(['peer' => InputPeer, 'filters' => [MessagesFilter, MessagesFilter], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_messages.SearchCounter = messages.getSearchCounters({peer=InputPeer, filters={MessagesFilter}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getSplitRanges.md b/old_docs/API_docs_v44/methods/messages.getSplitRanges.md new file mode 100644 index 00000000..f6776068 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getSplitRanges.md @@ -0,0 +1,41 @@ +--- +title: messages.getSplitRanges +description: Get message ranges for saving the user's chat history +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSplitRanges.html +--- +# Method: messages.getSplitRanges +[Back to methods index](index.md) + + + +Get message ranges for saving the user's chat history + + + +### Return type: [Vector\_of\_MessageRange](../types/MessageRange.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_MessageRange = $MadelineProto->messages->getSplitRanges(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_MessageRange = messages.getSplitRanges({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getStatsURL.md b/old_docs/API_docs_v44/methods/messages.getStatsURL.md new file mode 100644 index 00000000..198de22c --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getStatsURL.md @@ -0,0 +1,55 @@ +--- +title: messages.getStatsURL +description: Returns URL with the chat statistics. Currently this method can be used only for channels +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getStatsURL.html +--- +# Method: messages.getStatsURL +[Back to methods index](index.md) + + + +Returns URL with the chat statistics. Currently this method can be used only for channels + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dark|[Bool](../types/Bool.md) | Pass true if a URL with the dark theme must be returned | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat identifier | Optional| +|params|[string](../types/string.md) | Parameters from `tg://statsrefresh?params=******` link | Yes| + + +### Return type: [StatsURL](../types/StatsURL.md) + +### Can bots use this method: **NO** + + +### 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(); + +$StatsURL = $MadelineProto->messages->getStatsURL(['dark' => Bool, 'peer' => InputPeer, 'params' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +StatsURL = messages.getStatsURL({dark=Bool, peer=InputPeer, params='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getStickerSet.md b/old_docs/API_docs_v44/methods/messages.getStickerSet.md index 00a600b6..ae883b7d 100644 --- a/old_docs/API_docs_v44/methods/messages.getStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages.getStickerSet.md @@ -4,10 +4,11 @@ description: Get info about a stickerset image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getStickerSet.html --- -# Method: messages.getStickerSet +# Method: messages.getStickerSet [Back to methods index](index.md) + Get info about a stickerset ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.getStickers.md b/old_docs/API_docs_v44/methods/messages.getStickers.md index 9d361204..af4352fc 100644 --- a/old_docs/API_docs_v44/methods/messages.getStickers.md +++ b/old_docs/API_docs_v44/methods/messages.getStickers.md @@ -4,10 +4,11 @@ description: Get stickers by emoji image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getStickers.html --- -# Method: messages.getStickers +# Method: messages.getStickers [Back to methods index](index.md) + Get stickers by emoji ### Parameters: @@ -15,7 +16,7 @@ Get stickers by emoji | Name | Type | Description | Required | |----------|---------------|-------------|----------| |emoticon|[string](../types/string.md) | The emoji | Yes| -|hash|[string](../types/string.md) | Previously fetched sticker IDs | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| ### Return type: [messages.Stickers](../types/messages.Stickers.md) @@ -35,12 +36,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Stickers = $MadelineProto->messages->getStickers(['emoticon' => 'string', 'hash' => 'string', ]); +$messages.Stickers = $MadelineProto->messages->getStickers(['emoticon' => 'string', 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.Stickers = messages.getStickers({emoticon='string', hash='string', }) +messages.Stickers = messages.getStickers({emoticon='string', hash={int}, }) ``` diff --git a/old_docs/API_docs_v44/methods/messages.getSuggestedDialogFilters.md b/old_docs/API_docs_v44/methods/messages.getSuggestedDialogFilters.md new file mode 100644 index 00000000..68a8947c --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getSuggestedDialogFilters.md @@ -0,0 +1,41 @@ +--- +title: messages.getSuggestedDialogFilters +description: Get [suggested folders](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSuggestedDialogFilters.html +--- +# Method: messages.getSuggestedDialogFilters +[Back to methods index](index.md) + + + +Get [suggested folders](https://core.telegram.org/api/folders) + + + +### Return type: [Vector\_of\_DialogFilterSuggested](../types/DialogFilterSuggested.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Vector_of_DialogFilterSuggested = $MadelineProto->messages->getSuggestedDialogFilters(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_DialogFilterSuggested = messages.getSuggestedDialogFilters({}) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.getUnreadMentions.md b/old_docs/API_docs_v44/methods/messages.getUnreadMentions.md new file mode 100644 index 00000000..0ebf53f8 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getUnreadMentions.md @@ -0,0 +1,60 @@ +--- +title: messages.getUnreadMentions +description: Get unread messages where we were mentioned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getUnreadMentions.html +--- +# Method: messages.getUnreadMentions +[Back to methods index](index.md) + + + +Get unread messages where we were mentioned + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where to look for mentions | Optional| +|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|add\_offset|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|min\_id|[int](../types/int.md) | Minimum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.Messages = $MadelineProto->messages->getUnreadMentions(['peer' => InputPeer, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) +``` + +### Errors + +| 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| + + diff --git a/old_docs/API_docs_v44/methods/messages.getWebPage.md b/old_docs/API_docs_v44/methods/messages.getWebPage.md new file mode 100644 index 00000000..f5f4933f --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.getWebPage.md @@ -0,0 +1,54 @@ +--- +title: messages.getWebPage +description: Get [instant view](https://instantview.telegram.org) page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getWebPage.html +--- +# Method: messages.getWebPage +[Back to methods index](index.md) + + + +Get [instant view](https://instantview.telegram.org) page + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL of IV page to fetch | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [WebPage](../types/WebPage.md) + +### Can bots use this method: **NO** + + +### 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(); + +$WebPage = $MadelineProto->messages->getWebPage(['url' => 'string', 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +WebPage = messages.getWebPage({url='string', hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.getWebPagePreview.md b/old_docs/API_docs_v44/methods/messages.getWebPagePreview.md index d06a8c2e..06c94a74 100644 --- a/old_docs/API_docs_v44/methods/messages.getWebPagePreview.md +++ b/old_docs/API_docs_v44/methods/messages.getWebPagePreview.md @@ -4,10 +4,11 @@ description: Get preview of webpage image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_getWebPagePreview.html --- -# Method: messages.getWebPagePreview +# Method: messages.getWebPagePreview [Back to methods index](index.md) + Get preview of webpage ### Parameters: @@ -15,6 +16,8 @@ Get preview of webpage | Name | Type | Description | Required | |----------|---------------|-------------|----------| |message|[string](../types/string.md) | Message from which to extract the preview | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | [Message entities for styled text](https://core.telegram.org/api/entities) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | ### Return type: [MessageMedia](../types/MessageMedia.md) @@ -34,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', ]); +$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); ``` Or, if you're into Lua: ```lua -MessageMedia = messages.getWebPagePreview({message='string', }) +MessageMedia = messages.getWebPagePreview({message='string', entities={MessageEntity}, parseMode='string', }) ``` @@ -49,6 +52,42 @@ MessageMedia = messages.getWebPagePreview({message='string', }) If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [MessageMedia](../types/MessageMedia.md) will be returned instead. + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). ### Errors | Code | Type | Description | diff --git a/old_docs/API_docs_v44/methods/messages.hidePeerSettingsBar.md b/old_docs/API_docs_v44/methods/messages.hidePeerSettingsBar.md new file mode 100644 index 00000000..71c4e926 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.hidePeerSettingsBar.md @@ -0,0 +1,46 @@ +--- +title: messages.hidePeerSettingsBar +description: Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the [peer's settings](../constructors/peerSettings.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_hidePeerSettingsBar.html +--- +# Method: messages.hidePeerSettingsBar +[Back to methods index](index.md) + + + +Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the [peer's settings](../constructors/peerSettings.md). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->hidePeerSettingsBar(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.hidePeerSettingsBar({peer=InputPeer, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.importChatInvite.md b/old_docs/API_docs_v44/methods/messages.importChatInvite.md index 4ba80715..7186c855 100644 --- a/old_docs/API_docs_v44/methods/messages.importChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages.importChatInvite.md @@ -4,10 +4,11 @@ description: Import a chat invite and join a private chat/supergroup/channel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_importChatInvite.html --- -# Method: messages.importChatInvite +# Method: messages.importChatInvite [Back to methods index](index.md) + Import a chat invite and join a private chat/supergroup/channel ### Parameters: @@ -59,5 +60,6 @@ Updates = messages.importChatInvite({hash='string', }) |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| |401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/messages.installStickerSet.md b/old_docs/API_docs_v44/methods/messages.installStickerSet.md index 1e3c2f28..9b1567e1 100644 --- a/old_docs/API_docs_v44/methods/messages.installStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages.installStickerSet.md @@ -4,10 +4,11 @@ description: Install a stickerset image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_installStickerSet.html --- -# Method: messages.installStickerSet +# Method: messages.installStickerSet [Back to methods index](index.md) + Install a stickerset ### Parameters: @@ -15,10 +16,10 @@ Install a stickerset | Name | Type | Description | Required | |----------|---------------|-------------|----------| |stickerset|[InputStickerSet](../types/InputStickerSet.md) | Stickerset to install | Optional| -|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| +|archived|[Bool](../types/Bool.md) | Whether to archive stickerset | Yes| -### Return type: [Bool](../types/Bool.md) +### Return type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) ### Can bots use this method: **NO** @@ -35,13 +36,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->messages->installStickerSet(['stickerset' => InputStickerSet, 'disabled' => Bool, ]); +$messages.StickerSetInstallResult = $MadelineProto->messages->installStickerSet(['stickerset' => InputStickerSet, 'archived' => Bool, ]); ``` Or, if you're into Lua: ```lua -Bool = messages.installStickerSet({stickerset=InputStickerSet, disabled=Bool, }) +messages.StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) ``` ### Errors diff --git a/old_docs/API_docs_v44/methods/messages.markDialogUnread.md b/old_docs/API_docs_v44/methods/messages.markDialogUnread.md new file mode 100644 index 00000000..75dd03b6 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.markDialogUnread.md @@ -0,0 +1,47 @@ +--- +title: messages.markDialogUnread +description: Manually mark dialog as unread +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_markDialogUnread.html +--- +# Method: messages.markDialogUnread +[Back to methods index](index.md) + + + +Manually mark dialog as unread + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|unread|[Bool](../types/Bool.md) | Mark as unread/read | Optional| +|peer|[Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | Dialog | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->markDialogUnread(['unread' => Bool, 'peer' => InputDialogPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.markDialogUnread({unread=Bool, peer=InputDialogPeer, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.migrateChat.md b/old_docs/API_docs_v44/methods/messages.migrateChat.md index 1bb62e02..7188d8b8 100644 --- a/old_docs/API_docs_v44/methods/messages.migrateChat.md +++ b/old_docs/API_docs_v44/methods/messages.migrateChat.md @@ -4,17 +4,18 @@ description: Turn a [legacy group into a supergroup](https://core.telegram.org/a image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_migrateChat.html --- -# Method: messages.migrateChat +# Method: messages.migrateChat [Back to methods index](index.md) + Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel) ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages.readEncryptedHistory.md b/old_docs/API_docs_v44/methods/messages.readEncryptedHistory.md index 118316d0..9e6be5ca 100644 --- a/old_docs/API_docs_v44/methods/messages.readEncryptedHistory.md +++ b/old_docs/API_docs_v44/methods/messages.readEncryptedHistory.md @@ -4,10 +4,11 @@ description: Marks message history within a secret chat as read. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_readEncryptedHistory.html --- -# Method: messages.readEncryptedHistory +# Method: messages.readEncryptedHistory [Back to methods index](index.md) + Marks message history within a secret chat as read. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.readFeaturedStickers.md b/old_docs/API_docs_v44/methods/messages.readFeaturedStickers.md new file mode 100644 index 00000000..089288db --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.readFeaturedStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.readFeaturedStickers +description: Mark new featured stickers as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readFeaturedStickers.html +--- +# Method: messages.readFeaturedStickers +[Back to methods index](index.md) + + + +Mark new featured stickers as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | IDs of stickersets to mark as read | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->readFeaturedStickers(['id' => [long, long], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.readFeaturedStickers({id={long}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.readHistory.md b/old_docs/API_docs_v44/methods/messages.readHistory.md index 665a8b74..dc23bc8c 100644 --- a/old_docs/API_docs_v44/methods/messages.readHistory.md +++ b/old_docs/API_docs_v44/methods/messages.readHistory.md @@ -4,10 +4,11 @@ description: Marks message history as read. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_readHistory.html --- -# Method: messages.readHistory +# Method: messages.readHistory [Back to methods index](index.md) + Marks message history as read. ### Parameters: @@ -48,8 +49,10 @@ 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| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/messages.readMentions.md b/old_docs/API_docs_v44/methods/messages.readMentions.md new file mode 100644 index 00000000..a2a75943 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.readMentions.md @@ -0,0 +1,57 @@ +--- +title: messages.readMentions +description: Mark mentions as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readMentions.html +--- +# Method: messages.readMentions +[Back to methods index](index.md) + + + +Mark mentions as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Dialog | Optional| + + +### Return type: [messages.AffectedHistory](../types/messages.AffectedHistory.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.AffectedHistory = $MadelineProto->messages->readMentions(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedHistory = messages.readMentions({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|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| + + diff --git a/old_docs/API_docs_v44/methods/messages.readMessageContents.md b/old_docs/API_docs_v44/methods/messages.readMessageContents.md index 5a4009b0..24c99dd7 100644 --- a/old_docs/API_docs_v44/methods/messages.readMessageContents.md +++ b/old_docs/API_docs_v44/methods/messages.readMessageContents.md @@ -4,17 +4,18 @@ description: Notifies the sender about the recipient having listened a voice mes image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_readMessageContents.html --- -# Method: messages.readMessageContents +# Method: messages.readMessageContents [Back to methods index](index.md) + Notifies the sender about the recipient having listened a voice message or watched a video. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| +|id|Array of [int](../types/int.md) | Message ID list | Yes| ### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages.receivedMessages.md b/old_docs/API_docs_v44/methods/messages.receivedMessages.md index 62016b0f..d6c382f9 100644 --- a/old_docs/API_docs_v44/methods/messages.receivedMessages.md +++ b/old_docs/API_docs_v44/methods/messages.receivedMessages.md @@ -4,10 +4,11 @@ description: Confirms receipt of messages by a client, cancels PUSH-notification image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_receivedMessages.html --- -# Method: messages.receivedMessages +# Method: messages.receivedMessages [Back to methods index](index.md) + Confirms receipt of messages by a client, cancels PUSH-notification sending. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.receivedQueue.md b/old_docs/API_docs_v44/methods/messages.receivedQueue.md index 728f43be..edc7778f 100644 --- a/old_docs/API_docs_v44/methods/messages.receivedQueue.md +++ b/old_docs/API_docs_v44/methods/messages.receivedQueue.md @@ -1,20 +1,21 @@ --- title: messages.receivedQueue -description: You cannot use this method directly +description: Confirms receipt of messages in a secret chat by client, cancels push notifications. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_receivedQueue.html --- -# Method: messages.receivedQueue +# Method: messages.receivedQueue [Back to methods index](index.md) -You cannot use this method directly + +Confirms receipt of messages in a secret chat by client, cancels push notifications. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|max\_qts|[int](../types/int.md) | You cannot use this method directly | Yes| +|max\_qts|[int](../types/int.md) | Maximum qts value available at the client | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v44/methods/messages.reorderPinnedDialogs.md b/old_docs/API_docs_v44/methods/messages.reorderPinnedDialogs.md new file mode 100644 index 00000000..3f884788 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.reorderPinnedDialogs.md @@ -0,0 +1,55 @@ +--- +title: messages.reorderPinnedDialogs +description: Reorder pinned dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reorderPinnedDialogs.html +--- +# Method: messages.reorderPinnedDialogs +[Back to methods index](index.md) + + + +Reorder pinned dialogs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | If set, dialogs pinned server-side but not present in the `order` field will be unpinned. | Optional| +|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Yes| +|order|Array of [Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | New dialog order | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->reorderPinnedDialogs(['force' => Bool, 'folder_id' => int, 'order' => [InputDialogPeer, InputDialogPeer], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reorderPinnedDialogs({force=Bool, folder_id=int, order={InputDialogPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.reorderStickerSets.md b/old_docs/API_docs_v44/methods/messages.reorderStickerSets.md index e64b154b..3795d5e1 100644 --- a/old_docs/API_docs_v44/methods/messages.reorderStickerSets.md +++ b/old_docs/API_docs_v44/methods/messages.reorderStickerSets.md @@ -4,17 +4,19 @@ description: Reorder installed stickersets image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_reorderStickerSets.html --- -# Method: messages.reorderStickerSets +# Method: messages.reorderStickerSets [Back to methods index](index.md) + Reorder installed stickersets ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|order|Array of [long](../types/long.md) | The order | Yes| +|masks|[Bool](../types/Bool.md) | Reorder mask stickersets | Optional| +|order|Array of [long](../types/long.md) | New stickerset order by stickerset IDs | Yes| ### Return type: [Bool](../types/Bool.md) @@ -34,12 +36,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->messages->reorderStickerSets(['order' => [long, long], ]); +$Bool = $MadelineProto->messages->reorderStickerSets(['masks' => Bool, 'order' => [long, long], ]); ``` Or, if you're into Lua: ```lua -Bool = messages.reorderStickerSets({order={long}, }) +Bool = messages.reorderStickerSets({masks=Bool, order={long}, }) ``` diff --git a/old_docs/API_docs_v44/methods/messages.report.md b/old_docs/API_docs_v44/methods/messages.report.md new file mode 100644 index 00000000..30a8e37b --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.report.md @@ -0,0 +1,55 @@ +--- +title: messages.report +description: Report a message in a chat for violation of telegram's Terms of Service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_report.html +--- +# Method: messages.report +[Back to methods index](index.md) + + + +Report a message in a chat for violation of telegram's Terms of Service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to report | Yes| +|reason|[ReportReason](../types/ReportReason.md) | Why are these messages being reported | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->report(['peer' => InputPeer, 'id' => [int, int], 'reason' => ReportReason, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.report({peer=InputPeer, id={int}, reason=ReportReason, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.reportEncryptedSpam.md b/old_docs/API_docs_v44/methods/messages.reportEncryptedSpam.md new file mode 100644 index 00000000..2cd6897e --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.reportEncryptedSpam.md @@ -0,0 +1,53 @@ +--- +title: messages.reportEncryptedSpam +description: Report a secret chat for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reportEncryptedSpam.html +--- +# Method: messages.reportEncryptedSpam +[Back to methods index](index.md) + + + +Report a secret chat for spam + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat to report | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->reportEncryptedSpam(['peer' => InputEncryptedChat, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.reportSpam.md b/old_docs/API_docs_v44/methods/messages.reportSpam.md index f3a508ff..7637cc8d 100644 --- a/old_docs/API_docs_v44/methods/messages.reportSpam.md +++ b/old_docs/API_docs_v44/methods/messages.reportSpam.md @@ -4,10 +4,11 @@ description: Report a new incoming chat for spam, if the [peer settings](../cons image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_reportSpam.html --- -# Method: messages.reportSpam +# Method: messages.reportSpam [Back to methods index](index.md) + Report a new incoming chat for spam, if the [peer settings](../constructors/peerSettings.md) of the chat allow us to do that ### Parameters: @@ -47,6 +48,7 @@ Bool = messages.reportSpam({peer=InputPeer, }) | Code | Type | Description | |------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| |400|PEER_ID_INVALID|The provided peer id is invalid| diff --git a/old_docs/API_docs_v44/methods/messages.requestEncryption.md b/old_docs/API_docs_v44/methods/messages.requestEncryption.md index bd78eb67..cff24e40 100644 --- a/old_docs/API_docs_v44/methods/messages.requestEncryption.md +++ b/old_docs/API_docs_v44/methods/messages.requestEncryption.md @@ -1,21 +1,22 @@ --- title: messages.requestEncryption -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +description: Sends a request to start a secret chat to the user. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_requestEncryption.html --- -# Method: messages.requestEncryption +# Method: messages.requestEncryption [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats + +Sends a request to start a secret chat to the user. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Optional| -|g\_a|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|g\_a|[bytes](../types/bytes.md) | `A = g ^ a mod p`, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange) | Yes| ### Return type: [EncryptedChat](../types/EncryptedChat.md) diff --git a/old_docs/API_docs_v44/methods/messages.requestUrlAuth.md b/old_docs/API_docs_v44/methods/messages.requestUrlAuth.md new file mode 100644 index 00000000..bf31c224 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.requestUrlAuth.md @@ -0,0 +1,48 @@ +--- +title: messages.requestUrlAuth +description: Get more info about a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_requestUrlAuth.html +--- +# Method: messages.requestUrlAuth +[Back to methods index](index.md) + + + +Get more info about a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the message is located | Optional| +|msg\_id|[int](../types/int.md) | The message | Yes| +|button\_id|[int](../types/int.md) | The ID of the button with the authorization request | Yes| + + +### Return type: [UrlAuthResult](../types/UrlAuthResult.md) + +### Can bots use this method: **NO** + + +### 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(); + +$UrlAuthResult = $MadelineProto->messages->requestUrlAuth(['peer' => InputPeer, 'msg_id' => int, 'button_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +UrlAuthResult = messages.requestUrlAuth({peer=InputPeer, msg_id=int, button_id=int, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.saveDraft.md b/old_docs/API_docs_v44/methods/messages.saveDraft.md new file mode 100644 index 00000000..f8bf8019 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.saveDraft.md @@ -0,0 +1,100 @@ +--- +title: messages.saveDraft +description: Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveDraft.html +--- +# Method: messages.saveDraft +[Back to methods index](index.md) + + + +Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable generation of the webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Message ID the message should reply to | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination of the message that should be sent | Optional| +|message|[string](../types/string.md) | The draft | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Message [entities](https://core.telegram.org/api/entities) for styled text | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg_id' => int, 'peer' => InputPeer, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveDraft({no_webpage=Bool, reply_to_msg_id=int, peer=InputPeer, message='string', entities={MessageEntity}, parseMode='string', }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.saveGif.md b/old_docs/API_docs_v44/methods/messages.saveGif.md new file mode 100644 index 00000000..bc6e563d --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.saveGif.md @@ -0,0 +1,54 @@ +--- +title: messages.saveGif +description: Add GIF to saved gifs list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveGif.html +--- +# Method: messages.saveGif +[Back to methods index](index.md) + + + +Add GIF to saved gifs list + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Whether to remove GIF from saved gifs list | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->saveGif(['id' => InputDocument, 'unsave' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.saveRecentSticker.md b/old_docs/API_docs_v44/methods/messages.saveRecentSticker.md new file mode 100644 index 00000000..a1464d18 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.saveRecentSticker.md @@ -0,0 +1,55 @@ +--- +title: messages.saveRecentSticker +description: Add/remove sticker from recent stickers list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveRecentSticker.html +--- +# Method: messages.saveRecentSticker +[Back to methods index](index.md) + + + +Add/remove sticker from recent stickers list + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Whether to add/remove stickers recently attached to photo or video files | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Whether to save or unsave the sticker | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->saveRecentSticker(['attached' => Bool, 'id' => InputDocument, 'unsave' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.search.md b/old_docs/API_docs_v44/methods/messages.search.md index 42113066..bfd87423 100644 --- a/old_docs/API_docs_v44/methods/messages.search.md +++ b/old_docs/API_docs_v44/methods/messages.search.md @@ -4,25 +4,29 @@ description: Gets back found messages image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_search.html --- -# Method: messages.search +# Method: messages.search [Back to methods index](index.md) + Gets back found messages ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, histories with which are searched, or [(inputPeerEmpty)](../constructors/inputPeerEmpty.md) constructor for global search | Optional| |q|[string](../types/string.md) | Text search request | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Only return messages sent by the specified user ID | Optional| |filter|[MessagesFilter](../types/MessagesFilter.md) | Filter to return only specified message types | Optional| |min\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned | Yes| |max\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned | Yes| -|offset|[int](../types/int.md) | Offset | Yes| -|max\_id|[int](../types/int.md) | [Maximum message ID to return](https://core.telegram.org/api/offsets) | Yes| +|offset\_id|[int](../types/int.md) | Only return messages starting from the specified message ID | Yes| +|add\_offset|[int](../types/int.md) | [Additional offset](https://core.telegram.org/api/offsets) | Yes| |limit|[int](../types/int.md) | [Number of results to return](https://core.telegram.org/api/offsets) | Yes| +|max\_id|[int](../types/int.md) | [Maximum message ID to return](https://core.telegram.org/api/offsets) | Yes| +|min\_id|[int](../types/int.md) | [Minimum message ID to return](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | [Hash](https://core.telegram.org/api/offsets) | Optional| ### Return type: [messages.Messages](../types/messages.Messages.md) @@ -42,13 +46,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->search(['important_only' => Bool, 'peer' => InputPeer, 'q' => 'string', 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset' => int, 'max_id' => int, 'limit' => int, ]); +$messages.Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, }) +messages.Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, }) ``` ### Errors @@ -56,6 +60,7 @@ messages.Messages = messages.search({important_only=Bool, peer=InputPeer, q='str | Code | Type | Description | |------|----------|---------------| |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|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| |400|INPUT_USER_DEACTIVATED|The specified user was deleted| diff --git a/old_docs/API_docs_v44/methods/messages.searchGlobal.md b/old_docs/API_docs_v44/methods/messages.searchGlobal.md index 8c62cfe2..f07b5213 100644 --- a/old_docs/API_docs_v44/methods/messages.searchGlobal.md +++ b/old_docs/API_docs_v44/methods/messages.searchGlobal.md @@ -4,18 +4,20 @@ description: Search for messages and peers globally image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_searchGlobal.html --- -# Method: messages.searchGlobal +# Method: messages.searchGlobal [Back to methods index](index.md) + Search for messages and peers globally ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Optional| |q|[string](../types/string.md) | Query | Yes| -|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_rate|[int](../types/int.md) | Initially 0, then set to the [`next_rate` parameter of messages.messagesSlice](../constructors/messages.messagesSlice.md) | Yes| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Optional| |offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| |limit|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| @@ -38,19 +40,20 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'offset_date' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); +$messages.Messages = $MadelineProto->messages->searchGlobal(['folder_id' => int, 'q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); ``` Or, if you're into Lua: ```lua -messages.Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) +messages.Messages = messages.searchGlobal({folder_id=int, q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| +|400|FOLDER_ID_INVALID|Invalid folder ID| |400|SEARCH_QUERY_EMPTY|The search query is empty| diff --git a/old_docs/API_docs_v44/methods/messages.searchStickerSets.md b/old_docs/API_docs_v44/methods/messages.searchStickerSets.md new file mode 100644 index 00000000..cbecd817 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.searchStickerSets.md @@ -0,0 +1,48 @@ +--- +title: messages.searchStickerSets +description: Search for stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_searchStickerSets.html +--- +# Method: messages.searchStickerSets +[Back to methods index](index.md) + + + +Search for stickersets + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_featured|[Bool](../types/Bool.md) | Exclude featured stickersets from results | Optional| +|q|[string](../types/string.md) | Query string | Yes| +|hash|Array of [int](../types/int.md) | [Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation) | Optional| + + +### Return type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + +### Can bots use this method: **NO** + + +### 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(); + +$messages.FoundStickerSets = $MadelineProto->messages->searchStickerSets(['exclude_featured' => Bool, 'q' => 'string', 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FoundStickerSets = messages.searchStickerSets({exclude_featured=Bool, q='string', hash={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.sendBroadcast.md b/old_docs/API_docs_v44/methods/messages.sendBroadcast.md deleted file mode 100644 index 14604587..00000000 --- a/old_docs/API_docs_v44/methods/messages.sendBroadcast.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: messages.sendBroadcast -description: Send a message to all users in the chat list -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/messages_sendBroadcast.html ---- -# Method: messages.sendBroadcast -[Back to methods index](index.md) - - -Send a message to all users in the chat list - -### Parameters: - -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| -|message|[string](../types/string.md) | The message | Yes| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| - - -### Return type: [Updates](../types/Updates.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(); - -$Updates = $MadelineProto->messages->sendBroadcast(['contacts' => [InputUser, InputUser], 'message' => 'string', 'media' => InputMedia, ]); -``` - -Or, if you're into Lua: - -```lua -Updates = messages.sendBroadcast({contacts={InputUser}, message='string', media=InputMedia, }) -``` - - -## Return value - -If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. - - diff --git a/old_docs/API_docs_v44/methods/messages.sendEncrypted.md b/old_docs/API_docs_v44/methods/messages.sendEncrypted.md index 2db0059e..ef7dbe53 100644 --- a/old_docs/API_docs_v44/methods/messages.sendEncrypted.md +++ b/old_docs/API_docs_v44/methods/messages.sendEncrypted.md @@ -4,10 +4,11 @@ description: Sends a text message to a secret chat. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_sendEncrypted.html --- -# Method: messages.sendEncrypted +# Method: messages.sendEncrypted [Back to methods index](index.md) + Sends a text message to a secret chat. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.sendEncryptedFile.md b/old_docs/API_docs_v44/methods/messages.sendEncryptedFile.md index b0324e42..ddc82a90 100644 --- a/old_docs/API_docs_v44/methods/messages.sendEncryptedFile.md +++ b/old_docs/API_docs_v44/methods/messages.sendEncryptedFile.md @@ -4,10 +4,11 @@ description: Sends a message with a file attachment to a secret chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_sendEncryptedFile.html --- -# Method: messages.sendEncryptedFile +# Method: messages.sendEncryptedFile [Back to methods index](index.md) + Sends a message with a file attachment to a secret chat ### Parameters: @@ -50,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| diff --git a/old_docs/API_docs_v44/methods/messages.sendEncryptedService.md b/old_docs/API_docs_v44/methods/messages.sendEncryptedService.md index e775822a..bd7ebc63 100644 --- a/old_docs/API_docs_v44/methods/messages.sendEncryptedService.md +++ b/old_docs/API_docs_v44/methods/messages.sendEncryptedService.md @@ -4,10 +4,11 @@ description: Sends a service message to a secret chat. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_sendEncryptedService.html --- -# Method: messages.sendEncryptedService +# Method: messages.sendEncryptedService [Back to methods index](index.md) + Sends a service message to a secret chat. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.sendInlineBotResult.md b/old_docs/API_docs_v44/methods/messages.sendInlineBotResult.md new file mode 100644 index 00000000..54f09d4f --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.sendInlineBotResult.md @@ -0,0 +1,80 @@ +--- +title: messages.sendInlineBotResult +description: Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendInlineBotResult.html +--- +# Method: messages.sendInlineBotResult +[Back to methods index](index.md) + + + +Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to send the message silently (no notification will be triggered on the other client) | Optional| +|background|[Bool](../types/Bool.md) | Whether to send the message in background | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Whether to clear the [draft](https://core.telegram.org/api/drafts) | Optional| +|hide\_via|[Bool](../types/Bool.md) | Whether to hide the `via @botname` in the resulting message (only for bot usernames encountered in the [config](../constructors/config.md)) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | ID of the message this message should reply to | Optional| +|query\_id|[long](../types/long.md) | Query ID from [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md) | Yes| +|id|[string](../types/string.md) | Result ID from [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md) | Yes| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->sendInlineBotResult(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'hide_via' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'query_id' => long, 'id' => 'string', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, hide_via=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', schedule_date=int, }) +``` + +### Errors + +| 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| +|400|RESULT_ID_EMPTY|Result ID empty| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|400|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|400|YOU_BLOCKED_USER|You blocked this user| +|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| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v44/methods/messages.sendMedia.md b/old_docs/API_docs_v44/methods/messages.sendMedia.md index a1676e22..7a112520 100644 --- a/old_docs/API_docs_v44/methods/messages.sendMedia.md +++ b/old_docs/API_docs_v44/methods/messages.sendMedia.md @@ -4,21 +4,28 @@ description: Send a media image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_sendMedia.html --- -# Method: messages.sendMedia +# Method: messages.sendMedia [Back to methods index](index.md) + Send a media ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Send message silently (no notification should be triggered) | Optional| +|background|[Bool](../types/Bool.md) | Send message in background | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the draft | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination | Optional| |reply\_to\_msg\_id|[int](../types/int.md) | Message ID to which this message should reply to | Optional| |media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Attached media | Optional| +|message|[string](../types/string.md) | Caption | Yes| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for bot keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Message [entities](https://core.telegram.org/api/entities) for styled text | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| ### Return type: [Updates](../types/Updates.md) @@ -38,13 +45,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->messages->sendMedia(['broadcast' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'reply_markup' => ReplyMarkup, ]); +$Updates = $MadelineProto->messages->sendMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'schedule_date' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=int, media=InputMedia, reply_markup=ReplyMarkup, }) +Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, media=InputMedia, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', schedule_date=int, }) ``` @@ -53,10 +60,54 @@ Updates = messages.sendMedia({broadcast=Bool, peer=InputPeer, reply_to_msg_id=in You can provide bot API reply_markup objects here. + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough+strikethrough+strikethrough+inline fixed-width code
+pre-formatted fixed-width code block+pre-formatted fixed-width code block+URL +Mention by username +Mention by user id +Pre tags can have a language attribute+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +```markdown +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). ### Errors | 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| @@ -80,9 +131,11 @@ You can provide bot API reply_markup objects here. |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| @@ -95,7 +148,7 @@ You can provide bot API reply_markup objects here. |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| diff --git a/old_docs/API_docs_v44/methods/messages.sendMessage.md b/old_docs/API_docs_v44/methods/messages.sendMessage.md index b13c9057..37449d1c 100644 --- a/old_docs/API_docs_v44/methods/messages.sendMessage.md +++ b/old_docs/API_docs_v44/methods/messages.sendMessage.md @@ -4,10 +4,11 @@ description: Sends a message to a chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_sendMessage.html --- -# Method: messages.sendMessage +# Method: messages.sendMessage [Back to methods index](index.md) + Sends a message to a chat ### Parameters: @@ -15,13 +16,16 @@ Sends a message to a chat | Name | Type | Description | Required | |----------|---------------|-------------|----------| |no\_webpage|[Bool](../types/Bool.md) | Set this flag to disable generation of the webpage preview | Optional| -|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Send this message silently (no notifications for the receivers) | Optional| +|background|[Bool](../types/Bool.md) | Send this message as background message | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the draft field | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The destination where the message will be sent | Optional| |reply\_to\_msg\_id|[int](../types/int.md) | The message ID to which this message will reply to | Optional| |message|[string](../types/string.md) | The message | Yes| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for sending bot buttons | Optional| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Message [entities](https://core.telegram.org/api/entities) for sending styled text | Optional| |parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| ### Return type: [Updates](../types/Updates.md) @@ -41,13 +45,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Updates = $MadelineProto->messages->sendMessage(['no_webpage' => Bool, 'broadcast' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +$Updates = $MadelineProto->messages->sendMessage(['no_webpage' => Bool, 'silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'schedule_date' => int, ]); ``` Or, if you're into Lua: ```lua -Updates = messages.sendMessage({no_webpage=Bool, broadcast=Bool, peer=InputPeer, reply_to_msg_id=int, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', }) +Updates = messages.sendMessage({no_webpage=Bool, silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', schedule_date=int, }) ``` @@ -102,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| @@ -131,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| diff --git a/old_docs/API_docs_v44/methods/messages.sendMultiMedia.md b/old_docs/API_docs_v44/methods/messages.sendMultiMedia.md new file mode 100644 index 00000000..dc27d361 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.sendMultiMedia.md @@ -0,0 +1,65 @@ +--- +title: messages.sendMultiMedia +description: Send an album of media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendMultiMedia.html +--- +# Method: messages.sendMultiMedia +[Back to methods index](index.md) + + + +Send an album of media + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to send the album silently (no notification triggered) | Optional| +|background|[Bool](../types/Bool.md) | Send in background? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Whether to clear [drafts](https://core.telegram.org/api/drafts) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The destination chat | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | The message to reply to | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The medias to send | Yes| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->messages->sendMultiMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'multi_media' => [InputSingleMedia, InputSingleMedia], 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendMultiMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, multi_media={InputSingleMedia}, schedule_date=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|MEDIA_EMPTY|The provided media object is invalid| +|400|MEDIA_INVALID|Media invalid| +|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| + + diff --git a/old_docs/API_docs_v44/methods/messages.sendScheduledMessages.md b/old_docs/API_docs_v44/methods/messages.sendScheduledMessages.md new file mode 100644 index 00000000..22bba992 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.sendScheduledMessages.md @@ -0,0 +1,54 @@ +--- +title: messages.sendScheduledMessages +description: Send scheduled messages right away +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendScheduledMessages.html +--- +# Method: messages.sendScheduledMessages +[Back to methods index](index.md) + + + +Send scheduled messages right away + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | Scheduled message IDs | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->sendScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendScheduledMessages({peer=InputPeer, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.sendScreenshotNotification.md b/old_docs/API_docs_v44/methods/messages.sendScreenshotNotification.md new file mode 100644 index 00000000..f576dada --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.sendScreenshotNotification.md @@ -0,0 +1,54 @@ +--- +title: messages.sendScreenshotNotification +description: Notify the other user in a private chat that a screenshot of the chat was taken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendScreenshotNotification.html +--- +# Method: messages.sendScreenshotNotification +[Back to methods index](index.md) + + + +Notify the other user in a private chat that a screenshot of the chat was taken + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Other user | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | ID of message that was screenshotted, can be 0 | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->sendScreenshotNotification(['peer' => InputPeer, 'reply_to_msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.sendVote.md b/old_docs/API_docs_v44/methods/messages.sendVote.md new file mode 100644 index 00000000..910dacb2 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.sendVote.md @@ -0,0 +1,58 @@ +--- +title: messages.sendVote +description: Vote in a [poll](../constructors/poll.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendVote.html +--- +# Method: messages.sendVote +[Back to methods index](index.md) + + + +Vote in a [poll](../constructors/poll.md) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the poll was sent | Optional| +|msg\_id|[int](../types/int.md) | The message ID of the poll | Yes| +|options|Array of [bytes](../types/bytes.md) | The options that were chosen | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->messages->sendVote(['peer' => InputPeer, 'msg_id' => int, 'options' => ['bytes', 'bytes'], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendVote({peer=InputPeer, msg_id=int, options={'bytes'}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_POLL_CLOSED|Poll closed| +|400|OPTION_INVALID|Invalid option selected| +|400|OPTIONS_TOO_MUCH|Too many options provided| + + diff --git a/old_docs/API_docs_v44/methods/messages.setBotCallbackAnswer.md b/old_docs/API_docs_v44/methods/messages.setBotCallbackAnswer.md new file mode 100644 index 00000000..598da83b --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setBotCallbackAnswer.md @@ -0,0 +1,64 @@ +--- +title: messages.setBotCallbackAnswer +description: Set the callback answer to a user button press (bots only) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotCallbackAnswer.html +--- +# Method: messages.setBotCallbackAnswer +[Back to methods index](index.md) + + + +Set the callback answer to a user button press (bots only) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Whether to show the message as a popup instead of a toast notification | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|message|[string](../types/string.md) | Popup to show | Optional| +|url|[string](../types/string.md) | URL to open | Optional| +|cache\_time|[int](../types/int.md) | Cache validity | 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->messages->setBotCallbackAnswer(['alert' => Bool, 'query_id' => long, 'message' => 'string', 'url' => 'string', 'cache_time' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string', url='string', cache_time=int, }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| +|400|URL_INVALID|Invalid URL provided| + + diff --git a/old_docs/API_docs_v44/methods/messages.setBotPrecheckoutResults.md b/old_docs/API_docs_v44/methods/messages.setBotPrecheckoutResults.md new file mode 100644 index 00000000..c03da836 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setBotPrecheckoutResults.md @@ -0,0 +1,59 @@ +--- +title: messages.setBotPrecheckoutResults +description: Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. +Use this method to respond to such pre-checkout queries. +**Note**: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotPrecheckoutResults.html +--- +# Method: messages.setBotPrecheckoutResults +[Back to methods index](index.md) + + + +Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. +Use this method to respond to such pre-checkout queries. +**Note**: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Set this flag if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order, otherwise do not set it, and set the `error` field, instead | Optional| +|query\_id|[long](../types/long.md) | Unique identifier for the query to be answered | Yes| +|error|[string](../types/string.md) | Required if the `success` isn't set. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. | Optional| + + +### 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->messages->setBotPrecheckoutResults(['success' => Bool, 'query_id' => long, 'error' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v44/methods/messages.setBotShippingResults.md b/old_docs/API_docs_v44/methods/messages.setBotShippingResults.md new file mode 100644 index 00000000..a93178d9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setBotShippingResults.md @@ -0,0 +1,55 @@ +--- +title: messages.setBotShippingResults +description: If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotShippingResults.html +--- +# Method: messages.setBotShippingResults +[Back to methods index](index.md) + + + +If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Unique identifier for the query to be answered | Yes| +|error|[string](../types/string.md) | Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | A vector of available shipping options. | Optional| + + +### 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->messages->setBotShippingResults(['query_id' => long, 'error' => 'string', 'shipping_options' => [ShippingOption, ShippingOption], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.setEncryptedTyping.md b/old_docs/API_docs_v44/methods/messages.setEncryptedTyping.md index 5478ed8e..9df63c2e 100644 --- a/old_docs/API_docs_v44/methods/messages.setEncryptedTyping.md +++ b/old_docs/API_docs_v44/methods/messages.setEncryptedTyping.md @@ -4,10 +4,11 @@ description: Send typing event by the current user to a secret chat. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_setEncryptedTyping.html --- -# Method: messages.setEncryptedTyping +# Method: messages.setEncryptedTyping [Back to methods index](index.md) + Send typing event by the current user to a secret chat. ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.setGameScore.md b/old_docs/API_docs_v44/methods/messages.setGameScore.md new file mode 100644 index 00000000..1d4cb43f --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setGameScore.md @@ -0,0 +1,60 @@ +--- +title: messages.setGameScore +description: Use this method to set the score of the specified user in a game sent as a normal message (bots only). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setGameScore.html +--- +# Method: messages.setGameScore +[Back to methods index](index.md) + + + +Use this method to set the score of the specified user in a game sent as a normal message (bots only). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Set this flag if the game message should be automatically edited to include the current scoreboard | Optional| +|force|[Bool](../types/Bool.md) | Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Unique identifier of target chat | Optional| +|id|[int](../types/int.md) | Identifier of the sent message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User identifier | Optional| +|score|[int](../types/int.md) | New score | Yes| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->messages->setGameScore(['edit_message' => Bool, 'force' => Bool, 'peer' => InputPeer, 'id' => int, 'user_id' => InputUser, 'score' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/messages.setInlineBotResults.md b/old_docs/API_docs_v44/methods/messages.setInlineBotResults.md new file mode 100644 index 00000000..5928f809 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setInlineBotResults.md @@ -0,0 +1,80 @@ +--- +title: messages.setInlineBotResults +description: Answer an inline query, for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setInlineBotResults.html +--- +# Method: messages.setInlineBotResults +[Back to methods index](index.md) + + + +Answer an inline query, for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Set this flag if the results are composed of media files | Optional| +|private|[Bool](../types/Bool.md) | Set this flag if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query | Optional| +|query\_id|[long](../types/long.md) | Unique identifier for the answered query | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Vector of results for the inline query | Yes| +|cache\_time|[int](../types/int.md) | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. | Yes| +|next\_offset|[string](../types/string.md) | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with a certain parameter. | Optional| + + +### 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->messages->setInlineBotResults(['gallery' => Bool, 'private' => Bool, 'query_id' => long, 'results' => [InputBotInlineResult, InputBotInlineResult], 'cache_time' => int, 'next_offset' => 'string', 'switch_pm' => InlineBotSwitchPM, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|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| +|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| +|400|WEBDOCUMENT_MIME_INVALID|Invalid webdocument mime type provided| +|400|WEBDOCUMENT_SIZE_TOO_BIG|Webdocument is too big!| +|403|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/messages.setInlineGameScore.md b/old_docs/API_docs_v44/methods/messages.setInlineGameScore.md new file mode 100644 index 00000000..b5ed14dc --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.setInlineGameScore.md @@ -0,0 +1,58 @@ +--- +title: messages.setInlineGameScore +description: Use this method to set the score of the specified user in a game sent as an inline message (bots only). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setInlineGameScore.html +--- +# Method: messages.setInlineGameScore +[Back to methods index](index.md) + + + +Use this method to set the score of the specified user in a game sent as an inline message (bots only). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Set this flag if the game message should be automatically edited to include the current scoreboard | Optional| +|force|[Bool](../types/Bool.md) | Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User identifier | Optional| +|score|[int](../types/int.md) | New score | 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->messages->setInlineGameScore(['edit_message' => Bool, 'force' => Bool, 'id' => InputBotInlineMessageID, 'user_id' => InputUser, 'score' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v44/methods/messages.setTyping.md b/old_docs/API_docs_v44/methods/messages.setTyping.md index d49a87d5..10e565c5 100644 --- a/old_docs/API_docs_v44/methods/messages.setTyping.md +++ b/old_docs/API_docs_v44/methods/messages.setTyping.md @@ -4,10 +4,11 @@ description: Sends a current user typing event (see [SendMessageAction](../types image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_setTyping.html --- -# Method: messages.setTyping +# Method: messages.setTyping [Back to methods index](index.md) + Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group. ### Parameters: @@ -60,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| diff --git a/old_docs/API_docs_v44/methods/messages.startBot.md b/old_docs/API_docs_v44/methods/messages.startBot.md index 9e584cd7..3e3c927e 100644 --- a/old_docs/API_docs_v44/methods/messages.startBot.md +++ b/old_docs/API_docs_v44/methods/messages.startBot.md @@ -4,10 +4,11 @@ description: Start a conversation with a bot using a [deep linking parameter](ht image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_startBot.html --- -# Method: messages.startBot +# Method: messages.startBot [Back to methods index](index.md) + Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking) ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.toggleChatAdmins.md b/old_docs/API_docs_v44/methods/messages.toggleChatAdmins.md deleted file mode 100644 index 6ffba01e..00000000 --- a/old_docs/API_docs_v44/methods/messages.toggleChatAdmins.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: messages.toggleChatAdmins -description: Enable all users are admins in normal groups (not supergroups) -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/messages_toggleChatAdmins.html ---- -# Method: messages.toggleChatAdmins -[Back to methods index](index.md) - - -Enable all users are admins in normal groups (not supergroups) - -### Parameters: - -| Name | Type | Description | Required | -|----------|---------------|-------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| -|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| - - -### Return type: [Updates](../types/Updates.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(); - -$Updates = $MadelineProto->messages->toggleChatAdmins(['chat_id' => InputPeer, 'enabled' => Bool, ]); -``` - -Or, if you're into Lua: - -```lua -Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) -``` - -### Errors - -| Code | Type | Description | -|------|----------|---------------| -|400|CHAT_ID_INVALID|The provided chat id is invalid| -|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| - - diff --git a/old_docs/API_docs_v44/methods/messages.toggleDialogPin.md b/old_docs/API_docs_v44/methods/messages.toggleDialogPin.md new file mode 100644 index 00000000..90546161 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.toggleDialogPin.md @@ -0,0 +1,54 @@ +--- +title: messages.toggleDialogPin +description: Pin/unpin a dialog +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_toggleDialogPin.html +--- +# Method: messages.toggleDialogPin +[Back to methods index](index.md) + + + +Pin/unpin a dialog + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Whether to pin or unpin the dialog | Optional| +|peer|[Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | The dialog to pin | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputDialogPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.toggleDialogPin({pinned=Bool, peer=InputDialogPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.toggleStickerSets.md b/old_docs/API_docs_v44/methods/messages.toggleStickerSets.md new file mode 100644 index 00000000..08735c30 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.toggleStickerSets.md @@ -0,0 +1,49 @@ +--- +title: messages.toggleStickerSets +description: Apply changes to multiple stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_toggleStickerSets.html +--- +# Method: messages.toggleStickerSets +[Back to methods index](index.md) + + + +Apply changes to multiple stickersets + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|uninstall|[Bool](../types/Bool.md) | Uninstall the specified stickersets | Optional| +|archive|[Bool](../types/Bool.md) | Archive the specified stickersets | Optional| +|unarchive|[Bool](../types/Bool.md) | Unarchive the specified stickersets | Optional| +|stickersets|Array of [InputStickerSet](../types/InputStickerSet.md) | Stickersets to act upon | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->toggleStickerSets(['uninstall' => Bool, 'archive' => Bool, 'unarchive' => Bool, 'stickersets' => [InputStickerSet, InputStickerSet], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.toggleStickerSets({uninstall=Bool, archive=Bool, unarchive=Bool, stickersets={InputStickerSet}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.uninstallStickerSet.md b/old_docs/API_docs_v44/methods/messages.uninstallStickerSet.md index 6eeb9ecb..97bed1e9 100644 --- a/old_docs/API_docs_v44/methods/messages.uninstallStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages.uninstallStickerSet.md @@ -4,10 +4,11 @@ description: Uninstall a stickerset image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/messages_uninstallStickerSet.html --- -# Method: messages.uninstallStickerSet +# Method: messages.uninstallStickerSet [Back to methods index](index.md) + Uninstall a stickerset ### Parameters: diff --git a/old_docs/API_docs_v44/methods/messages.updateDialogFilter.md b/old_docs/API_docs_v44/methods/messages.updateDialogFilter.md new file mode 100644 index 00000000..2f206546 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.updateDialogFilter.md @@ -0,0 +1,47 @@ +--- +title: messages.updateDialogFilter +description: Update [folder](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_updateDialogFilter.html +--- +# Method: messages.updateDialogFilter +[Back to methods index](index.md) + + + +Update [folder](https://core.telegram.org/api/folders) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[int](../types/int.md) | [Folder](https://core.telegram.org/api/folders) ID | Yes| +|filter|[DialogFilter](../types/DialogFilter.md) | [Folder](https://core.telegram.org/api/folders) info | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->updateDialogFilter(['id' => int, 'filter' => DialogFilter, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.updateDialogFilter({id=int, filter=DialogFilter, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.updateDialogFiltersOrder.md b/old_docs/API_docs_v44/methods/messages.updateDialogFiltersOrder.md new file mode 100644 index 00000000..ce9d2ea3 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.updateDialogFiltersOrder.md @@ -0,0 +1,46 @@ +--- +title: messages.updateDialogFiltersOrder +description: Reorder [folders](https://core.telegram.org/api/folders) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_updateDialogFiltersOrder.html +--- +# Method: messages.updateDialogFiltersOrder +[Back to methods index](index.md) + + + +Reorder [folders](https://core.telegram.org/api/folders) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [int](../types/int.md) | New [folder](https://core.telegram.org/api/folders) order | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->messages->updateDialogFiltersOrder(['order' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.updateDialogFiltersOrder({order={int}, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.updatePinnedMessage.md b/old_docs/API_docs_v44/methods/messages.updatePinnedMessage.md new file mode 100644 index 00000000..70034a55 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.updatePinnedMessage.md @@ -0,0 +1,60 @@ +--- +title: messages.updatePinnedMessage +description: Pin a message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_updatePinnedMessage.html +--- +# Method: messages.updatePinnedMessage +[Back to methods index](index.md) + + + +Pin a message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Pin the message silently, without triggering a notification | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer where to pin the message | Optional| +|id|[int](../types/int.md) | The message to pin, can be 0 to unpin any currently pinned messages | Yes| + + +### Return type: [Updates](../types/Updates.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(); + +$Updates = $MadelineProto->messages->updatePinnedMessage(['silent' => Bool, 'peer' => InputPeer, 'id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.updatePinnedMessage({silent=Bool, peer=InputPeer, id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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_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| + + diff --git a/old_docs/API_docs_v44/methods/messages.uploadEncryptedFile.md b/old_docs/API_docs_v44/methods/messages.uploadEncryptedFile.md new file mode 100644 index 00000000..e2318115 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.uploadEncryptedFile.md @@ -0,0 +1,47 @@ +--- +title: messages.uploadEncryptedFile +description: Upload encrypted file and associate it to a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_uploadEncryptedFile.html +--- +# Method: messages.uploadEncryptedFile +[Back to methods index](index.md) + + + +Upload encrypted file and associate it to a secret chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat to associate the file to | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| + + +### Return type: [EncryptedFile](../types/EncryptedFile.md) + +### Can bots use this method: **NO** + + +### 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(); + +$EncryptedFile = $MadelineProto->messages->uploadEncryptedFile(['peer' => InputEncryptedChat, 'file' => InputEncryptedFile, ]); +``` + +Or, if you're into Lua: + +```lua +EncryptedFile = messages.uploadEncryptedFile({peer=InputEncryptedChat, file=InputEncryptedFile, }) +``` + diff --git a/old_docs/API_docs_v44/methods/messages.uploadMedia.md b/old_docs/API_docs_v44/methods/messages.uploadMedia.md new file mode 100644 index 00000000..f6b4b485 --- /dev/null +++ b/old_docs/API_docs_v44/methods/messages.uploadMedia.md @@ -0,0 +1,63 @@ +--- +title: messages.uploadMedia +description: Upload a file and associate it to a chat (without actually sending it to the chat) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_uploadMedia.html +--- +# Method: messages.uploadMedia +[Back to methods index](index.md) + + + +Upload a file and associate it to a chat (without actually sending it to the chat) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat, can be an [inputPeerEmpty](../constructors/inputPeerEmpty.md) for bots | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | File uploaded in chunks as described in [files »](https://core.telegram.org/api/files) | Optional| + + +### Return type: [MessageMedia](../types/MessageMedia.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(); + +$MessageMedia = $MadelineProto->messages->uploadMedia(['peer' => InputPeer, 'media' => InputMedia, ]); +``` + +Or, if you're into Lua: + +```lua +MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|400|IMAGE_PROCESS_FAILED|Failure while processing image| +|400|MEDIA_INVALID|Media invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|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| + + diff --git a/old_docs/API_docs_v44/methods/payments.clearSavedInfo.md b/old_docs/API_docs_v44/methods/payments.clearSavedInfo.md new file mode 100644 index 00000000..b115e889 --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.clearSavedInfo.md @@ -0,0 +1,47 @@ +--- +title: payments.clearSavedInfo +description: Clear saved payment information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_clearSavedInfo.html +--- +# Method: payments.clearSavedInfo +[Back to methods index](index.md) + + + +Clear saved payment information + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Remove saved payment credentials | Optional| +|info|[Bool](../types/Bool.md) | Clear the last order settings saved by the user | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->payments->clearSavedInfo(['credentials' => Bool, 'info' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = payments.clearSavedInfo({credentials=Bool, info=Bool, }) +``` + diff --git a/old_docs/API_docs_v44/methods/payments.getBankCardData.md b/old_docs/API_docs_v44/methods/payments.getBankCardData.md new file mode 100644 index 00000000..21bea482 --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.getBankCardData.md @@ -0,0 +1,46 @@ +--- +title: payments.getBankCardData +description: Get info about a credit card +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getBankCardData.html +--- +# Method: payments.getBankCardData +[Back to methods index](index.md) + + + +Get info about a credit card + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|number|[string](../types/string.md) | Credit card number | Yes| + + +### Return type: [payments.BankCardData](../types/payments.BankCardData.md) + +### Can bots use this method: **NO** + + +### 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(); + +$payments.BankCardData = $MadelineProto->payments->getBankCardData(['number' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +payments.BankCardData = payments.getBankCardData({number='string', }) +``` + diff --git a/old_docs/API_docs_v44/methods/payments.getPaymentForm.md b/old_docs/API_docs_v44/methods/payments.getPaymentForm.md new file mode 100644 index 00000000..3aeb5328 --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.getPaymentForm.md @@ -0,0 +1,53 @@ +--- +title: payments.getPaymentForm +description: Get a payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getPaymentForm.html +--- +# Method: payments.getPaymentForm +[Back to methods index](index.md) + + + +Get a payment form + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID of payment form | Yes| + + +### Return type: [payments.PaymentForm](../types/payments.PaymentForm.md) + +### Can bots use this method: **NO** + + +### 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(); + +$payments.PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +payments.PaymentForm = payments.getPaymentForm({msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/messages.searchGifs.md b/old_docs/API_docs_v44/methods/payments.getPaymentReceipt.md similarity index 56% rename from old_docs/API_docs_v44/methods/messages.searchGifs.md rename to old_docs/API_docs_v44/methods/payments.getPaymentReceipt.md index 28798dfe..d443df4b 100644 --- a/old_docs/API_docs_v44/methods/messages.searchGifs.md +++ b/old_docs/API_docs_v44/methods/payments.getPaymentReceipt.md @@ -1,24 +1,24 @@ --- -title: messages.searchGifs -description: Search for GIFs +title: payments.getPaymentReceipt +description: Get payment receipt image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/methods/messages_searchGifs.html +redirect_from: /API_docs/methods/payments_getPaymentReceipt.html --- -# Method: messages.searchGifs +# Method: payments.getPaymentReceipt [Back to methods index](index.md) -Search for GIFs + +Get payment receipt ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|q|[string](../types/string.md) | Text query | Yes| -|offset|[int](../types/int.md) | Offset for [pagination »](https://core.telegram.org/api/offsets) | Yes| +|msg\_id|[int](../types/int.md) | Message ID of receipt | Yes| -### Return type: [messages.FoundGifs](../types/messages.FoundGifs.md) +### Return type: [payments.PaymentReceipt](../types/payments.PaymentReceipt.md) ### Can bots use this method: **NO** @@ -35,19 +35,19 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$messages.FoundGifs = $MadelineProto->messages->searchGifs(['q' => 'string', 'offset' => int, ]); +$payments.PaymentReceipt = $MadelineProto->payments->getPaymentReceipt(['msg_id' => int, ]); ``` Or, if you're into Lua: ```lua -messages.FoundGifs = messages.searchGifs({q='string', offset=int, }) +payments.PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| -|400|SEARCH_QUERY_EMPTY|The search query is empty| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| diff --git a/old_docs/API_docs_v44/methods/payments.getSavedInfo.md b/old_docs/API_docs_v44/methods/payments.getSavedInfo.md new file mode 100644 index 00000000..5eecf77c --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.getSavedInfo.md @@ -0,0 +1,41 @@ +--- +title: payments.getSavedInfo +description: Get saved payment information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getSavedInfo.html +--- +# Method: payments.getSavedInfo +[Back to methods index](index.md) + + + +Get saved payment information + + + +### Return type: [payments.SavedInfo](../types/payments.SavedInfo.md) + +### Can bots use this method: **NO** + + +### 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(); + +$payments.SavedInfo = $MadelineProto->payments->getSavedInfo(); +``` + +Or, if you're into Lua: + +```lua +payments.SavedInfo = payments.getSavedInfo({}) +``` + diff --git a/old_docs/API_docs_v44/methods/payments.sendPaymentForm.md b/old_docs/API_docs_v44/methods/payments.sendPaymentForm.md new file mode 100644 index 00000000..e61ff485 --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.sendPaymentForm.md @@ -0,0 +1,56 @@ +--- +title: payments.sendPaymentForm +description: Send compiled payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_sendPaymentForm.html +--- +# Method: payments.sendPaymentForm +[Back to methods index](index.md) + + + +Send compiled payment form + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID of form | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of saved and validated [order info](../constructors/payments.validatedRequestedInfo.md) | Optional| +|shipping\_option\_id|[string](../types/string.md) | Chosen shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| + + +### Return type: [payments.PaymentResult](../types/payments.PaymentResult.md) + +### Can bots use this method: **NO** + + +### 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(); + +$payments.PaymentResult = $MadelineProto->payments->sendPaymentForm(['msg_id' => int, 'requested_info_id' => 'string', 'shipping_option_id' => 'string', 'credentials' => InputPaymentCredentials, ]); +``` + +Or, if you're into Lua: + +```lua +payments.PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/payments.validateRequestedInfo.md b/old_docs/API_docs_v44/methods/payments.validateRequestedInfo.md new file mode 100644 index 00000000..f9875bf0 --- /dev/null +++ b/old_docs/API_docs_v44/methods/payments.validateRequestedInfo.md @@ -0,0 +1,55 @@ +--- +title: payments.validateRequestedInfo +description: Submit requested order information for validation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_validateRequestedInfo.html +--- +# Method: payments.validateRequestedInfo +[Back to methods index](index.md) + + + +Submit requested order information for validation + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save order information to re-use it for future orders | Optional| +|msg\_id|[int](../types/int.md) | Message ID of payment form | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Requested order information | Yes| + + +### Return type: [payments.ValidatedRequestedInfo](../types/payments.ValidatedRequestedInfo.md) + +### Can bots use this method: **NO** + + +### 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(); + +$payments.ValidatedRequestedInfo = $MadelineProto->payments->validateRequestedInfo(['save' => Bool, 'msg_id' => int, 'info' => PaymentRequestedInfo, ]); +``` + +Or, if you're into Lua: + +```lua +payments.ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.acceptCall.md b/old_docs/API_docs_v44/methods/phone.acceptCall.md new file mode 100644 index 00000000..fbc59e04 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.acceptCall.md @@ -0,0 +1,58 @@ +--- +title: phone.acceptCall +description: Accept incoming call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_acceptCall.html +--- +# Method: phone.acceptCall +[Back to methods index](index.md) + + + +Accept incoming call + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call to accept | Yes| +|g\_b|[bytes](../types/bytes.md) | [Parameter for E2E encryption key exchange »](https://core.telegram.org/api/end-to-end/voice-calls) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Phone call settings | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### 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(); + +$phone.PhoneCall = $MadelineProto->phone->acceptCall(['peer' => InputPhoneCall, 'g_b' => 'bytes', 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.acceptCall({peer=InputPhoneCall, g_b='bytes', protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_ACCEPTED|The call was already accepted| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| +|400|CALL_PROTOCOL_FLAGS_INVALID|Call protocol flags invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.confirmCall.md b/old_docs/API_docs_v44/methods/phone.confirmCall.md new file mode 100644 index 00000000..bc114a49 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.confirmCall.md @@ -0,0 +1,57 @@ +--- +title: phone.confirmCall +description: [Complete phone call E2E encryption key exchange »](https://core.telegram.org/api/end-to-end/voice-calls) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_confirmCall.html +--- +# Method: phone.confirmCall +[Back to methods index](index.md) + + + +[Complete phone call E2E encryption key exchange »](https://core.telegram.org/api/end-to-end/voice-calls) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|g\_a|[bytes](../types/bytes.md) | [Parameter for E2E encryption key exchange »](https://core.telegram.org/api/end-to-end/voice-calls) | Yes| +|key\_fingerprint|[long](../types/long.md) | Key fingerprint | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Phone call settings | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### 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(); + +$phone.PhoneCall = $MadelineProto->phone->confirmCall(['peer' => InputPhoneCall, 'g_a' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.confirmCall({peer=InputPhoneCall, g_a='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.discardCall.md b/old_docs/API_docs_v44/methods/phone.discardCall.md new file mode 100644 index 00000000..ea602676 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.discardCall.md @@ -0,0 +1,58 @@ +--- +title: phone.discardCall +description: Refuse or end running call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_discardCall.html +--- +# Method: phone.discardCall +[Back to methods index](index.md) + + + +Refuse or end running call + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|video|[Bool](../types/Bool.md) | Whether this is a video call | Optional| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|duration|[int](../types/int.md) | Call duration | Yes| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Why was the call discarded | Yes| +|connection\_id|[long](../types/long.md) | Preferred libtgvoip relay ID | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->phone->discardCall(['video' => Bool, 'peer' => InputPhoneCall, 'duration' => int, 'reason' => PhoneCallDiscardReason, 'connection_id' => long, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = phone.discardCall({video=Bool, peer=InputPhoneCall, duration=int, reason=PhoneCallDiscardReason, connection_id=long, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_ACCEPTED|The call was already accepted| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.getCallConfig.md b/old_docs/API_docs_v44/methods/phone.getCallConfig.md new file mode 100644 index 00000000..4152520e --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.getCallConfig.md @@ -0,0 +1,48 @@ +--- +title: phone.getCallConfig +description: Get phone call configuration to be passed to libtgvoip's shared config +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_getCallConfig.html +--- +# Method: phone.getCallConfig +[Back to methods index](index.md) + + + +Get phone call configuration to be passed to libtgvoip's shared config + + + +### Return type: [DataJSON](../types/DataJSON.md) + +### Can bots use this method: **NO** + + +### 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(); + +$DataJSON = $MadelineProto->phone->getCallConfig(); +``` + +Or, if you're into Lua: + +```lua +DataJSON = phone.getCallConfig({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v44/methods/phone.receivedCall.md b/old_docs/API_docs_v44/methods/phone.receivedCall.md new file mode 100644 index 00000000..f0230cea --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.receivedCall.md @@ -0,0 +1,54 @@ +--- +title: phone.receivedCall +description: Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_receivedCall.html +--- +# Method: phone.receivedCall +[Back to methods index](index.md) + + + +Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call we're currently in | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->receivedCall(['peer' => InputPhoneCall, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = phone.receivedCall({peer=InputPhoneCall, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.requestCall.md b/old_docs/API_docs_v44/methods/phone.requestCall.md new file mode 100644 index 00000000..3e9edc2d --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.requestCall.md @@ -0,0 +1,60 @@ +--- +title: phone.requestCall +description: Start a telegram phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_requestCall.html +--- +# Method: phone.requestCall +[Back to methods index](index.md) + + + +Start a telegram phone call + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|video|[Bool](../types/Bool.md) | Whether to start a video call | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Destination of the phone call | Optional| +|g\_a\_hash|[bytes](../types/bytes.md) | [Parameter for E2E encryption key exchange »](https://core.telegram.org/api/end-to-end/voice-calls) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Phone call settings | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### 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(); + +$phone.PhoneCall = $MadelineProto->phone->requestCall(['video' => Bool, 'user_id' => InputUser, 'g_a_hash' => 'bytes', 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.requestCall({video=Bool, user_id=InputUser, g_a_hash='bytes', protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PROTOCOL_FLAGS_INVALID|Call protocol flags invalid| +|400|PARTICIPANT_VERSION_OUTDATED|The other participant does not use an up to date telegram client with support for calls| +|400|USER_ID_INVALID|The provided user ID is invalid| +|403|USER_IS_BLOCKED|You were blocked by this user| +|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v44/methods/phone.saveCallDebug.md b/old_docs/API_docs_v44/methods/phone.saveCallDebug.md new file mode 100644 index 00000000..d268bb68 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.saveCallDebug.md @@ -0,0 +1,55 @@ +--- +title: phone.saveCallDebug +description: Send phone call debug data to server +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_saveCallDebug.html +--- +# Method: phone.saveCallDebug +[Back to methods index](index.md) + + + +Send phone call debug data to server + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Phone call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debug statistics obtained from libtgvoip | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### 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->saveCallDebug(['peer' => InputPhoneCall, 'debug' => DataJSON, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| +|400|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v44/methods/phone.sendSignalingData.md b/old_docs/API_docs_v44/methods/phone.sendSignalingData.md new file mode 100644 index 00000000..ed8c1534 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.sendSignalingData.md @@ -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', }) +``` + diff --git a/old_docs/API_docs_v44/methods/phone.setCallRating.md b/old_docs/API_docs_v44/methods/phone.setCallRating.md new file mode 100644 index 00000000..65ed0706 --- /dev/null +++ b/old_docs/API_docs_v44/methods/phone.setCallRating.md @@ -0,0 +1,56 @@ +--- +title: phone.setCallRating +description: Rate a call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_setCallRating.html +--- +# Method: phone.setCallRating +[Back to methods index](index.md) + + + +Rate a call + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_initiative|[Bool](../types/Bool.md) | Whether the user decided on their own initiative to rate the call | Optional| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call to rate | Yes| +|rating|[int](../types/int.md) | Rating in `1-5` stars | Yes| +|comment|[string](../types/string.md) | An additional comment | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### 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(); + +$Updates = $MadelineProto->phone->setCallRating(['user_initiative' => Bool, 'peer' => InputPhoneCall, 'rating' => int, 'comment' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = phone.setCallRating({user_initiative=Bool, peer=InputPhoneCall, rating=int, comment='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v44/methods/photos.deletePhotos.md b/old_docs/API_docs_v44/methods/photos.deletePhotos.md index 2aa773cd..7d447338 100644 --- a/old_docs/API_docs_v44/methods/photos.deletePhotos.md +++ b/old_docs/API_docs_v44/methods/photos.deletePhotos.md @@ -4,17 +4,18 @@ description: Deletes profile photos. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/photos_deletePhotos.html --- -# Method: photos.deletePhotos +# Method: photos.deletePhotos [Back to methods index](index.md) + Deletes profile photos. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Input photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) @@ -43,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| + + diff --git a/old_docs/API_docs_v44/methods/photos.getUserPhotos.md b/old_docs/API_docs_v44/methods/photos.getUserPhotos.md index 6c6a56a3..d431f544 100644 --- a/old_docs/API_docs_v44/methods/photos.getUserPhotos.md +++ b/old_docs/API_docs_v44/methods/photos.getUserPhotos.md @@ -4,10 +4,11 @@ description: Returns the list of user photos. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/photos_getUserPhotos.html --- -# Method: photos.getUserPhotos +# Method: photos.getUserPhotos [Back to methods index](index.md) + Returns the list of user photos. ### Parameters: @@ -52,5 +53,6 @@ photos.Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long |------|----------|---------------| |400|MAX_ID_INVALID|The provided max ID is invalid| |400|USER_ID_INVALID|The provided user ID is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| diff --git a/old_docs/API_docs_v44/methods/photos.updateProfilePhoto.md b/old_docs/API_docs_v44/methods/photos.updateProfilePhoto.md index bf331244..c2f614f1 100644 --- a/old_docs/API_docs_v44/methods/photos.updateProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos.updateProfilePhoto.md @@ -4,10 +4,11 @@ description: Installs a previously uploaded photo as a profile photo. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/photos_updateProfilePhoto.html --- -# Method: photos.updateProfilePhoto +# Method: photos.updateProfilePhoto [Back to methods index](index.md) + Installs a previously uploaded photo as a profile photo. ### Parameters: @@ -15,10 +16,9 @@ Installs a previously uploaded photo as a profile photo. | Name | Type | Description | Required | |----------|---------------|-------------|----------| |id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Input photo | Optional| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| -### 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, 'crop' => InputPhotoCrop, ]); +$photos.Photo = $MadelineProto->photos->updateProfilePhoto(['id' => InputPhoto, ]); ``` Or, if you're into Lua: ```lua -UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, crop=InputPhotoCrop, }) +photos.Photo = photos.updateProfilePhoto({id=InputPhoto, }) ``` ### Errors @@ -53,5 +53,6 @@ UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, crop=InputPhotoCrop |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| diff --git a/old_docs/API_docs_v44/methods/photos.uploadProfilePhoto.md b/old_docs/API_docs_v44/methods/photos.uploadProfilePhoto.md index c4e3f8f4..a853b81e 100644 --- a/old_docs/API_docs_v44/methods/photos.uploadProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos.uploadProfilePhoto.md @@ -4,20 +4,20 @@ description: Updates current user profile photo. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/photos_uploadProfilePhoto.html --- -# Method: photos.uploadProfilePhoto +# Method: photos.uploadProfilePhoto [Back to methods index](index.md) + Updates current user profile photo. ### Parameters: | 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| -|caption|[string](../types/string.md) | Caption type | Yes| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | 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) @@ -37,13 +37,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$photos.Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, 'caption' => 'string', 'geo_point' => InputGeoPoint, 'crop' => InputPhotoCrop, ]); +$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, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, }) +photos.Photo = photos.uploadProfilePhoto({file=InputFile, video=InputFile, video_start_ts=double, }) ``` ### Errors @@ -55,5 +55,6 @@ photos.Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_ |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| diff --git a/old_docs/API_docs_v44/methods/stats.getBroadcastStats.md b/old_docs/API_docs_v44/methods/stats.getBroadcastStats.md new file mode 100644 index 00000000..7c5bd979 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stats.getBroadcastStats.md @@ -0,0 +1,57 @@ +--- +title: stats.getBroadcastStats +description: Get [channel statistics](https://core.telegram.org/api/stats) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stats_getBroadcastStats.html +--- +# Method: stats.getBroadcastStats +[Back to methods index](index.md) + + + +Get [channel statistics](https://core.telegram.org/api/stats) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dark|[Bool](../types/Bool.md) | Whether to enable dark theme for graph colors | Optional| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| + + +### Return type: [stats.BroadcastStats](../types/stats.BroadcastStats.md) + +### Can bots use this method: **NO** + + +### 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.BroadcastStats = $MadelineProto->stats->getBroadcastStats(['dark' => Bool, 'channel' => InputChannel, ]); +``` + +Or, if you're into Lua: + +```lua +stats.BroadcastStats = stats.getBroadcastStats({dark=Bool, channel=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|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| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v44/methods/stats.getMegagroupStats.md b/old_docs/API_docs_v44/methods/stats.getMegagroupStats.md new file mode 100644 index 00000000..584b3027 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stats.getMegagroupStats.md @@ -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, }) +``` + diff --git a/old_docs/API_docs_v44/methods/stats.loadAsyncGraph.md b/old_docs/API_docs_v44/methods/stats.loadAsyncGraph.md new file mode 100644 index 00000000..5fd03c6a --- /dev/null +++ b/old_docs/API_docs_v44/methods/stats.loadAsyncGraph.md @@ -0,0 +1,55 @@ +--- +title: stats.loadAsyncGraph +description: Load [channel statistics graph](https://core.telegram.org/api/stats) asynchronously +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stats_loadAsyncGraph.html +--- +# Method: stats.loadAsyncGraph +[Back to methods index](index.md) + + + +Load [channel statistics graph](https://core.telegram.org/api/stats) asynchronously + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|token|[string](../types/string.md) | Graph token from [statsGraphAsync](../constructors/statsGraphAsync.md) constructor | Yes| +|x|[long](../types/long.md) | Zoom value, if required | Optional| + + +### Return type: [StatsGraph](../types/StatsGraph.md) + +### Can bots use this method: **NO** + + +### 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(); + +$StatsGraph = $MadelineProto->stats->loadAsyncGraph(['token' => 'string', 'x' => long, ]); +``` + +Or, if you're into Lua: + +```lua +StatsGraph = stats.loadAsyncGraph({token='string', x=long, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|GRAPH_INVALID_RELOAD|Invalid graph token provided, please reload the stats and provide the updated token| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v44/methods/stickers.addStickerToSet.md b/old_docs/API_docs_v44/methods/stickers.addStickerToSet.md new file mode 100644 index 00000000..6df7ca57 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stickers.addStickerToSet.md @@ -0,0 +1,55 @@ +--- +title: stickers.addStickerToSet +description: Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_addStickerToSet.html +--- +# Method: stickers.addStickerToSet +[Back to methods index](index.md) + + + +Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.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(); + +$messages.StickerSet = $MadelineProto->stickers->addStickerToSet(['stickerset' => InputStickerSet, 'sticker' => InputStickerSetItem, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v44/methods/stickers.changeStickerPosition.md b/old_docs/API_docs_v44/methods/stickers.changeStickerPosition.md new file mode 100644 index 00000000..153d5d32 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stickers.changeStickerPosition.md @@ -0,0 +1,55 @@ +--- +title: stickers.changeStickerPosition +description: Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_changeStickerPosition.html +--- +# Method: stickers.changeStickerPosition +[Back to methods index](index.md) + + + +Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | The new position of the sticker, zero-based | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.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(); + +$messages.StickerSet = $MadelineProto->stickers->changeStickerPosition(['sticker' => InputDocument, 'position' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v44/methods/stickers.createStickerSet.md b/old_docs/API_docs_v44/methods/stickers.createStickerSet.md new file mode 100644 index 00000000..61a499e9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stickers.createStickerSet.md @@ -0,0 +1,67 @@ +--- +title: stickers.createStickerSet +description: Create a stickerset, bots only. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_createStickerSet.html +--- +# Method: stickers.createStickerSet +[Back to methods index](index.md) + + + +Create a stickerset, bots only. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Whether this is a mask stickerset | Optional| +|animated|[Bool](../types/Bool.md) | Whether this is an animated stickerset | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Stickerset owner | Optional| +|title|[string](../types/string.md) | Stickerset name, `1-64` chars | Yes| +|short\_name|[string](../types/string.md) | Sticker set name. Can contain only English letters, digits and underscores. Must end with *"*by*" * (** is case insensitive); 1-64 characters | Yes| +|thumb|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Thumbnail | Optional| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Stickers | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.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(); + +$messages.StickerSet = $MadelineProto->stickers->createStickerSet(['masks' => Bool, 'animated' => Bool, 'user_id' => InputUser, 'title' => 'string', 'short_name' => 'string', 'thumb' => InputDocument, 'stickers' => [InputStickerSetItem, InputStickerSetItem], ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.createStickerSet({masks=Bool, animated=Bool, user_id=InputUser, title='string', short_name='string', thumb=InputDocument, stickers={InputStickerSetItem}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|400|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|400|STICKER_FILE_INVALID|Sticker file invalid| +|400|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|400|STICKERS_EMPTY|No sticker provided| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/methods/stickers.removeStickerFromSet.md b/old_docs/API_docs_v44/methods/stickers.removeStickerFromSet.md new file mode 100644 index 00000000..45f17da6 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stickers.removeStickerFromSet.md @@ -0,0 +1,54 @@ +--- +title: stickers.removeStickerFromSet +description: Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_removeStickerFromSet.html +--- +# Method: stickers.removeStickerFromSet +[Back to methods index](index.md) + + + +Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.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(); + +$messages.StickerSet = $MadelineProto->stickers->removeStickerFromSet(['sticker' => InputDocument, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v44/methods/stickers.setStickerSetThumb.md b/old_docs/API_docs_v44/methods/stickers.setStickerSetThumb.md new file mode 100644 index 00000000..f841bf54 --- /dev/null +++ b/old_docs/API_docs_v44/methods/stickers.setStickerSetThumb.md @@ -0,0 +1,54 @@ +--- +title: stickers.setStickerSetThumb +description: Set stickerset thumbnail +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_setStickerSetThumb.html +--- +# Method: stickers.setStickerSetThumb +[Back to methods index](index.md) + + + +Set stickerset thumbnail + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Stickerset | Optional| +|thumb|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Thumbnail | Optional| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.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(); + +$messages.StickerSet = $MadelineProto->stickers->setStickerSetThumb(['stickerset' => InputStickerSet, 'thumb' => InputDocument, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.setStickerSetThumb({stickerset=InputStickerSet, thumb=InputDocument, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v44/methods/updates.getChannelDifference.md b/old_docs/API_docs_v44/methods/updates.getChannelDifference.md index 54ea009a..3f3bdce2 100644 --- a/old_docs/API_docs_v44/methods/updates.getChannelDifference.md +++ b/old_docs/API_docs_v44/methods/updates.getChannelDifference.md @@ -1,23 +1,25 @@ --- title: updates.getChannelDifference -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +description: Returns the difference between the current state of updates of a certain channel and transmitted. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/updates_getChannelDifference.html --- -# Method: updates.getChannelDifference +# Method: updates.getChannelDifference [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates + +Returns the difference between the current state of updates of a certain channel and transmitted. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| -|filter|[ChannelMessagesFilter](../types/ChannelMessagesFilter.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| -|pts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| -|limit|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| +|force|[Bool](../types/Bool.md) | Set to true to skip some possibly unneeded updates and reduce server-side load | Optional| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|filter|[ChannelMessagesFilter](../types/ChannelMessagesFilter.md) | Messsage filter | Optional| +|pts|[int](../types/int.md) | Persistent timestamp (see [updates](https://core.telegram.org/api/updates)) | Yes| +|limit|[int](../types/int.md) | How many updates to fetch, max `100000`
Ordinary (non-bot) users are supposed to pass `10-100` | Yes| ### Return type: [updates.ChannelDifference](../types/updates.ChannelDifference.md) @@ -37,13 +39,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$updates.ChannelDifference = $MadelineProto->updates->getChannelDifference(['channel' => InputChannel, 'filter' => ChannelMessagesFilter, 'pts' => int, 'limit' => int, ]); +$updates.ChannelDifference = $MadelineProto->updates->getChannelDifference(['force' => Bool, 'channel' => InputChannel, 'filter' => ChannelMessagesFilter, 'pts' => int, 'limit' => int, ]); ``` Or, if you're into Lua: ```lua -updates.ChannelDifference = updates.getChannelDifference({channel=InputChannel, filter=ChannelMessagesFilter, pts=int, limit=int, }) +updates.ChannelDifference = updates.getChannelDifference({force=Bool, channel=InputChannel, filter=ChannelMessagesFilter, pts=int, limit=int, }) ``` ### Errors @@ -60,6 +62,8 @@ updates.ChannelDifference = updates.getChannelDifference({channel=InputChannel, |400|RANGES_INVALID|Invalid range provided| |406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| |403|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| +|-500|No workers running|Internal error| +|-504|memory limit exit|Internal error| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/updates.getDifference.md b/old_docs/API_docs_v44/methods/updates.getDifference.md index c77f6d1f..ea531f68 100644 --- a/old_docs/API_docs_v44/methods/updates.getDifference.md +++ b/old_docs/API_docs_v44/methods/updates.getDifference.md @@ -1,22 +1,24 @@ --- title: updates.getDifference -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +description: Get new [updates](https://core.telegram.org/api/updates). image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/updates_getDifference.html --- -# Method: updates.getDifference +# Method: updates.getDifference [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates + +Get new [updates](https://core.telegram.org/api/updates). ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|pts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| -|date|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| -|qts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| +|pts|[int](../types/int.md) | PTS, see [updates](https://core.telegram.org/api/updates). | Yes| +|pts\_total\_limit|[int](../types/int.md) | For fast updating: if provided and `pts + pts_total_limit < remote pts`, [updates.differenceTooLong](../constructors/updates.differenceTooLong.md) will be returned.
Simply tells the server to not return the difference if it is bigger than `pts_total_limit`
If the remote pts is too big (> ~4000000), this field will default to 1000000 | Optional| +|date|[int](../types/int.md) | date, see [updates](https://core.telegram.org/api/updates). | Yes| +|qts|[int](../types/int.md) | QTS, see [updates](https://core.telegram.org/api/updates). | Yes| ### Return type: [updates.Difference](../types/updates.Difference.md) @@ -36,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$updates.Difference = $MadelineProto->updates->getDifference(['pts' => int, 'date' => int, 'qts' => int, ]); +$updates.Difference = $MadelineProto->updates->getDifference(['pts' => int, 'pts_total_limit' => int, 'date' => int, 'qts' => int, ]); ``` Or, if you're into Lua: ```lua -updates.Difference = updates.getDifference({pts=int, date=int, qts=int, }) +updates.Difference = updates.getDifference({pts=int, pts_total_limit=int, date=int, qts=int, }) ``` ### Errors @@ -56,6 +58,8 @@ updates.Difference = updates.getDifference({pts=int, date=int, qts=int, }) |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| +|-504|memory limit exit|Internal error| |-503|Timeout|Timeout while fetching data| diff --git a/old_docs/API_docs_v44/methods/updates.getState.md b/old_docs/API_docs_v44/methods/updates.getState.md index b187e258..1196700d 100644 --- a/old_docs/API_docs_v44/methods/updates.getState.md +++ b/old_docs/API_docs_v44/methods/updates.getState.md @@ -1,14 +1,15 @@ --- title: updates.getState -description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +description: Returns a current state of updates. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/updates_getState.html --- -# Method: updates.getState +# Method: updates.getState [Back to methods index](index.md) -You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates + +Returns a current state of updates. diff --git a/old_docs/API_docs_v44/methods/upload.getCdnFile.md b/old_docs/API_docs_v44/methods/upload.getCdnFile.md new file mode 100644 index 00000000..2e7cf5e9 --- /dev/null +++ b/old_docs/API_docs_v44/methods/upload.getCdnFile.md @@ -0,0 +1,48 @@ +--- +title: upload.getCdnFile +description: Download a [CDN](https://core.telegram.org/cdn) file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getCdnFile.html +--- +# Method: upload.getCdnFile +[Back to methods index](index.md) + + + +Download a [CDN](https://core.telegram.org/cdn) file. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | File token | Yes| +|offset|[int](../types/int.md) | Offset of chunk to download | Yes| +|limit|[int](../types/int.md) | Length of chunk to download | Yes| + + +### Return type: [upload.CdnFile](../types/upload.CdnFile.md) + +### Can bots use this method: **NO** + + +### 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(); + +$upload.CdnFile = $MadelineProto->upload->getCdnFile(['file_token' => 'bytes', 'offset' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +upload.CdnFile = upload.getCdnFile({file_token='bytes', offset=int, limit=int, }) +``` + diff --git a/old_docs/API_docs_v44/methods/upload.getCdnFileHashes.md b/old_docs/API_docs_v44/methods/upload.getCdnFileHashes.md new file mode 100644 index 00000000..b08fb85c --- /dev/null +++ b/old_docs/API_docs_v44/methods/upload.getCdnFileHashes.md @@ -0,0 +1,55 @@ +--- +title: upload.getCdnFileHashes +description: Get SHA256 hashes for verifying downloaded [CDN](https://core.telegram.org/cdn) files +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getCdnFileHashes.html +--- +# Method: upload.getCdnFileHashes +[Back to methods index](index.md) + + + +Get SHA256 hashes for verifying downloaded [CDN](https://core.telegram.org/cdn) files + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | File | Yes| +|offset|[int](../types/int.md) | Offset from which to start getting hashes | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.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(); + +$Vector_of_FileHash = $MadelineProto->upload->getCdnFileHashes(['file_token' => 'bytes', 'offset' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.getCdnFileHashes({file_token='bytes', offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|400|RSA_DECRYPT_FAILED|Internal RSA decryption failed| + + diff --git a/old_docs/API_docs_v44/methods/upload.getFile.md b/old_docs/API_docs_v44/methods/upload.getFile.md index 166eb65e..17dde5da 100644 --- a/old_docs/API_docs_v44/methods/upload.getFile.md +++ b/old_docs/API_docs_v44/methods/upload.getFile.md @@ -1,22 +1,25 @@ --- title: upload.getFile -description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +description: Returns content of a whole file or its part. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/upload_getFile.html --- -# Method: upload.getFile +# Method: upload.getFile [Back to methods index](index.md) -You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +Returns content of a whole file or its part. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|location|[InputFileLocation](../types/InputFileLocation.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|limit|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|precise|[Bool](../types/Bool.md) | Disable some checks on limit and offset values, useful for example to stream videos by keyframes | Optional| +|cdn\_supported|[Bool](../types/Bool.md) | Whether the current client supports [CDN downloads](https://core.telegram.org/cdn) | Optional| +|location|[InputFileLocation](../types/InputFileLocation.md) | File location | Yes| +|offset|[int](../types/int.md) | Number of bytes to be skipped | Yes| +|limit|[int](../types/int.md) | Number of bytes to be returned | Yes| ### Return type: [upload.File](../types/upload.File.md) @@ -36,20 +39,23 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$upload.File = $MadelineProto->upload->getFile(['location' => InputFileLocation, 'offset' => int, 'limit' => int, ]); +$upload.File = $MadelineProto->upload->getFile(['precise' => Bool, 'cdn_supported' => Bool, 'location' => InputFileLocation, 'offset' => int, 'limit' => int, ]); ``` Or, if you're into Lua: ```lua -upload.File = upload.getFile({location=InputFileLocation, offset=int, limit=int, }) +upload.File = upload.getFile({precise=Bool, cdn_supported=Bool, location=InputFileLocation, offset=int, limit=int, }) ``` ### Errors | Code | Type | Description | |------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| |400|FILE_ID_INVALID|The provided file id is invalid| +|400|FILE_REFERENCE_EXPIRED|File reference expired, it must be refetched as described in https://core.telegram.org/api/file_reference| |400|INPUT_FETCH_FAIL|Failed deserializing TL payload| |400|LIMIT_INVALID|The provided limit is invalid| |400|LOCATION_INVALID|The provided location is invalid| diff --git a/old_docs/API_docs_v44/methods/upload.getFileHashes.md b/old_docs/API_docs_v44/methods/upload.getFileHashes.md new file mode 100644 index 00000000..4adf0c82 --- /dev/null +++ b/old_docs/API_docs_v44/methods/upload.getFileHashes.md @@ -0,0 +1,54 @@ +--- +title: upload.getFileHashes +description: Get SHA256 hashes for verifying downloaded files +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getFileHashes.html +--- +# Method: upload.getFileHashes +[Back to methods index](index.md) + + + +Get SHA256 hashes for verifying downloaded files + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputFileLocation](../types/InputFileLocation.md) | File | Yes| +|offset|[int](../types/int.md) | Offset from which to get file hashes | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.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(); + +$Vector_of_FileHash = $MadelineProto->upload->getFileHashes(['location' => InputFileLocation, 'offset' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.getFileHashes({location=InputFileLocation, offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v44/methods/upload.getWebFile.md b/old_docs/API_docs_v44/methods/upload.getWebFile.md new file mode 100644 index 00000000..3d701c18 --- /dev/null +++ b/old_docs/API_docs_v44/methods/upload.getWebFile.md @@ -0,0 +1,55 @@ +--- +title: upload.getWebFile +description: Returns content of an HTTP file or a part, by proxying the request through telegram. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getWebFile.html +--- +# Method: upload.getWebFile +[Back to methods index](index.md) + + + +Returns content of an HTTP file or a part, by proxying the request through telegram. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file to download | Yes| +|offset|[int](../types/int.md) | Number of bytes to be skipped | Yes| +|limit|[int](../types/int.md) | Number of bytes to be returned | Yes| + + +### Return type: [upload.WebFile](../types/upload.WebFile.md) + +### Can bots use this method: **NO** + + +### 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(); + +$upload.WebFile = $MadelineProto->upload->getWebFile(['location' => InputWebFileLocation, 'offset' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +upload.WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v44/methods/upload.reuploadCdnFile.md b/old_docs/API_docs_v44/methods/upload.reuploadCdnFile.md new file mode 100644 index 00000000..e83406f4 --- /dev/null +++ b/old_docs/API_docs_v44/methods/upload.reuploadCdnFile.md @@ -0,0 +1,54 @@ +--- +title: upload.reuploadCdnFile +description: Request a reupload of a certain file to a [CDN DC](https://core.telegram.org/cdn). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_reuploadCdnFile.html +--- +# Method: upload.reuploadCdnFile +[Back to methods index](index.md) + + + +Request a reupload of a certain file to a [CDN DC](https://core.telegram.org/cdn). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | File token | Yes| +|request\_token|[bytes](../types/bytes.md) | Request token | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.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(); + +$Vector_of_FileHash = $MadelineProto->upload->reuploadCdnFile(['file_token' => 'bytes', 'request_token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.reuploadCdnFile({file_token='bytes', request_token='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|RSA_DECRYPT_FAILED|Internal RSA decryption failed| + + diff --git a/old_docs/API_docs_v44/methods/upload.saveBigFilePart.md b/old_docs/API_docs_v44/methods/upload.saveBigFilePart.md index eddb9552..b1250749 100644 --- a/old_docs/API_docs_v44/methods/upload.saveBigFilePart.md +++ b/old_docs/API_docs_v44/methods/upload.saveBigFilePart.md @@ -1,23 +1,24 @@ --- title: upload.saveBigFilePart -description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +description: Saves a part of a large file (over 10Mb in size) to be later passed to one of the methods. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/upload_saveBigFilePart.html --- -# Method: upload.saveBigFilePart +# Method: upload.saveBigFilePart [Back to methods index](index.md) -You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +Saves a part of a large file (over 10Mb in size) to be later passed to one of the methods. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|file\_id|[long](../types/long.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|file\_part|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|file\_total\_parts|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|file\_id|[long](../types/long.md) | Random file id, created by the client | Yes| +|file\_part|[int](../types/int.md) | Part sequence number | Yes| +|file\_total\_parts|[int](../types/int.md) | Total number of parts | Yes| +|bytes|[bytes](../types/bytes.md) | Binary data, part contents | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/upload.saveFilePart.md b/old_docs/API_docs_v44/methods/upload.saveFilePart.md index 4f486043..4dd3b21f 100644 --- a/old_docs/API_docs_v44/methods/upload.saveFilePart.md +++ b/old_docs/API_docs_v44/methods/upload.saveFilePart.md @@ -1,22 +1,23 @@ --- title: upload.saveFilePart -description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +description: Saves a part of file for futher sending to one of the methods. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/upload_saveFilePart.html --- -# Method: upload.saveFilePart +# Method: upload.saveFilePart [Back to methods index](index.md) -You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +Saves a part of file for futher sending to one of the methods. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|file\_id|[long](../types/long.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|file\_part|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| -|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|file\_id|[long](../types/long.md) | Random file identifier created by the client | Yes| +|file\_part|[int](../types/int.md) | Numerical order of a part | Yes| +|bytes|[bytes](../types/bytes.md) | Binary data, contend of a part | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/users.getFullUser.md b/old_docs/API_docs_v44/methods/users.getFullUser.md index a18fa9bc..bdf8b5ec 100644 --- a/old_docs/API_docs_v44/methods/users.getFullUser.md +++ b/old_docs/API_docs_v44/methods/users.getFullUser.md @@ -1,20 +1,21 @@ --- title: users.getFullUser -description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +description: Returns extended user info by ID. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/users_getFullUser.html --- -# Method: users.getFullUser +# Method: users.getFullUser [Back to methods index](index.md) -You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +Returns extended user info by ID. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| ### Return type: [UserFull](../types/UserFull.md) diff --git a/old_docs/API_docs_v44/methods/users.getUsers.md b/old_docs/API_docs_v44/methods/users.getUsers.md index 7e0957e7..58cf029f 100644 --- a/old_docs/API_docs_v44/methods/users.getUsers.md +++ b/old_docs/API_docs_v44/methods/users.getUsers.md @@ -4,17 +4,18 @@ description: Returns basic user info according to their identifiers. image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/methods/users_getUsers.html --- -# Method: users.getUsers +# Method: users.getUsers [Back to methods index](index.md) + Returns basic user info according to their identifiers. ### Parameters: | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | List of user identifiers | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v44/methods/users.setSecureValueErrors.md b/old_docs/API_docs_v44/methods/users.setSecureValueErrors.md new file mode 100644 index 00000000..636245ca --- /dev/null +++ b/old_docs/API_docs_v44/methods/users.setSecureValueErrors.md @@ -0,0 +1,58 @@ +--- +title: users.setSecureValueErrors +description: Notify the user that the sent [passport](https://core.telegram.org/passport) data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). + +Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/users_setSecureValueErrors.html +--- +# Method: users.setSecureValueErrors +[Back to methods index](index.md) + + + +Notify the user that the sent [passport](https://core.telegram.org/passport) data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). + +Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | Errors | 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->users->setSecureValueErrors(['id' => InputUser, 'errors' => [SecureValueError, SecureValueError], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = users.setSecureValueErrors({id=InputUser, errors={SecureValueError}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v44/types/!X.md b/old_docs/API_docs_v44/types/!X.md deleted file mode 100644 index dc27d5cd..00000000 --- a/old_docs/API_docs_v44/types/!X.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: !X -description: Represents a TL serialized payload -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -## Type: !X -[Back to constructor index](index.md) - -Represents a TL serialized payload. diff --git a/old_docs/API_docs_v44/types/AccountDaysTTL.md b/old_docs/API_docs_v44/types/AccountDaysTTL.md index f3494aac..1d9a58bb 100644 --- a/old_docs/API_docs_v44/types/AccountDaysTTL.md +++ b/old_docs/API_docs_v44/types/AccountDaysTTL.md @@ -3,7 +3,7 @@ title: AccountDaysTTL description: constructors and methods of type AccountDaysTTL image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: AccountDaysTTL +# Type: AccountDaysTTL [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[accountDaysTTL](../constructors/accountDaysTTL.md) + +[$MadelineProto->account->getAccountTTL](../methods/account.getAccountTTL.md) + diff --git a/old_docs/API_docs_v44/types/Authorization.md b/old_docs/API_docs_v44/types/Authorization.md index e6760335..db5da7fd 100644 --- a/old_docs/API_docs_v44/types/Authorization.md +++ b/old_docs/API_docs_v44/types/Authorization.md @@ -3,7 +3,7 @@ title: Authorization description: constructors and methods of type Authorization image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Authorization +# Type: Authorization [Back to types index](index.md) @@ -16,5 +16,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->auth->acceptLoginToken](../methods/auth.acceptLoginToken.md) + +[authorization](../constructors/authorization.md) + +[$MadelineProto->auth->acceptLoginToken](../methods/auth.acceptLoginToken.md) + diff --git a/old_docs/API_docs_v44/types/AutoDownloadSettings.md b/old_docs/API_docs_v44/types/AutoDownloadSettings.md new file mode 100644 index 00000000..ae2aa90a --- /dev/null +++ b/old_docs/API_docs_v44/types/AutoDownloadSettings.md @@ -0,0 +1,22 @@ +--- +title: AutoDownloadSettings +description: constructors and methods of type AutoDownloadSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: AutoDownloadSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[autoDownloadSettings](../constructors/autoDownloadSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[autoDownloadSettings](../constructors/autoDownloadSettings.md) + diff --git a/old_docs/API_docs_v44/types/BankCardOpenUrl.md b/old_docs/API_docs_v44/types/BankCardOpenUrl.md new file mode 100644 index 00000000..7ea0665a --- /dev/null +++ b/old_docs/API_docs_v44/types/BankCardOpenUrl.md @@ -0,0 +1,22 @@ +--- +title: BankCardOpenUrl +description: constructors and methods of type BankCardOpenUrl +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BankCardOpenUrl +[Back to types index](index.md) + + + +### Possible values (constructors): + +[bankCardOpenUrl](../constructors/bankCardOpenUrl.md) + + + +### Methods that return an object of this type (methods): + + + +[bankCardOpenUrl](../constructors/bankCardOpenUrl.md) + diff --git a/old_docs/API_docs_v44/types/BaseTheme.md b/old_docs/API_docs_v44/types/BaseTheme.md new file mode 100644 index 00000000..e11e02d7 --- /dev/null +++ b/old_docs/API_docs_v44/types/BaseTheme.md @@ -0,0 +1,38 @@ +--- +title: BaseTheme +description: constructors and methods of type BaseTheme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BaseTheme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[baseThemeClassic](../constructors/baseThemeClassic.md) + +[baseThemeDay](../constructors/baseThemeDay.md) + +[baseThemeNight](../constructors/baseThemeNight.md) + +[baseThemeTinted](../constructors/baseThemeTinted.md) + +[baseThemeArctic](../constructors/baseThemeArctic.md) + + + +### Methods that return an object of this type (methods): + + + +[baseThemeClassic](../constructors/baseThemeClassic.md) + +[baseThemeDay](../constructors/baseThemeDay.md) + +[baseThemeNight](../constructors/baseThemeNight.md) + +[baseThemeTinted](../constructors/baseThemeTinted.md) + +[baseThemeArctic](../constructors/baseThemeArctic.md) + diff --git a/old_docs/API_docs_v44/types/BotCommand.md b/old_docs/API_docs_v44/types/BotCommand.md index 759f2b8b..2087b590 100644 --- a/old_docs/API_docs_v44/types/BotCommand.md +++ b/old_docs/API_docs_v44/types/BotCommand.md @@ -3,7 +3,7 @@ title: BotCommand description: constructors and methods of type BotCommand image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: BotCommand +# Type: BotCommand [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[botCommand](../constructors/botCommand.md) + diff --git a/old_docs/API_docs_v44/types/BotInfo.md b/old_docs/API_docs_v44/types/BotInfo.md index fc4822f5..0b40512f 100644 --- a/old_docs/API_docs_v44/types/BotInfo.md +++ b/old_docs/API_docs_v44/types/BotInfo.md @@ -3,15 +3,13 @@ title: BotInfo description: constructors and methods of type BotInfo image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: BotInfo +# Type: BotInfo [Back to types index](index.md) ### Possible values (constructors): -[botInfoEmpty](../constructors/botInfoEmpty.md) - [botInfo](../constructors/botInfo.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[botInfo](../constructors/botInfo.md) + diff --git a/old_docs/API_docs_v44/types/BotInlineMessage.md b/old_docs/API_docs_v44/types/BotInlineMessage.md new file mode 100644 index 00000000..0375b255 --- /dev/null +++ b/old_docs/API_docs_v44/types/BotInlineMessage.md @@ -0,0 +1,38 @@ +--- +title: BotInlineMessage +description: constructors and methods of type BotInlineMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotInlineMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botInlineMessageMediaAuto](../constructors/botInlineMessageMediaAuto.md) + +[botInlineMessageText](../constructors/botInlineMessageText.md) + +[botInlineMessageMediaGeo](../constructors/botInlineMessageMediaGeo.md) + +[botInlineMessageMediaVenue](../constructors/botInlineMessageMediaVenue.md) + +[botInlineMessageMediaContact](../constructors/botInlineMessageMediaContact.md) + + + +### Methods that return an object of this type (methods): + + + +[botInlineMessageMediaAuto](../constructors/botInlineMessageMediaAuto.md) + +[botInlineMessageText](../constructors/botInlineMessageText.md) + +[botInlineMessageMediaGeo](../constructors/botInlineMessageMediaGeo.md) + +[botInlineMessageMediaVenue](../constructors/botInlineMessageMediaVenue.md) + +[botInlineMessageMediaContact](../constructors/botInlineMessageMediaContact.md) + diff --git a/old_docs/API_docs_v44/types/BotInlineResult.md b/old_docs/API_docs_v44/types/BotInlineResult.md new file mode 100644 index 00000000..c14b737c --- /dev/null +++ b/old_docs/API_docs_v44/types/BotInlineResult.md @@ -0,0 +1,26 @@ +--- +title: BotInlineResult +description: constructors and methods of type BotInlineResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotInlineResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botInlineResult](../constructors/botInlineResult.md) + +[botInlineMediaResult](../constructors/botInlineMediaResult.md) + + + +### Methods that return an object of this type (methods): + + + +[botInlineResult](../constructors/botInlineResult.md) + +[botInlineMediaResult](../constructors/botInlineMediaResult.md) + diff --git a/old_docs/API_docs_v44/types/CdnConfig.md b/old_docs/API_docs_v44/types/CdnConfig.md new file mode 100644 index 00000000..b9a38a30 --- /dev/null +++ b/old_docs/API_docs_v44/types/CdnConfig.md @@ -0,0 +1,26 @@ +--- +title: CdnConfig +description: constructors and methods of type CdnConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: CdnConfig +[Back to types index](index.md) + + + +### Possible values (constructors): + +[cdnConfig](../constructors/cdnConfig.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getCdnConfig](../methods/help.getCdnConfig.md) + + + +[cdnConfig](../constructors/cdnConfig.md) + +[$MadelineProto->help->getCdnConfig](../methods/help.getCdnConfig.md) + diff --git a/old_docs/API_docs_v44/types/InputVideo.md b/old_docs/API_docs_v44/types/CdnPublicKey.md similarity index 52% rename from old_docs/API_docs_v44/types/InputVideo.md rename to old_docs/API_docs_v44/types/CdnPublicKey.md index 27503196..c91d4b54 100644 --- a/old_docs/API_docs_v44/types/InputVideo.md +++ b/old_docs/API_docs_v44/types/CdnPublicKey.md @@ -1,18 +1,16 @@ --- -title: InputVideo -description: constructors and methods of type InputVideo +title: CdnPublicKey +description: constructors and methods of type CdnPublicKey image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputVideo +# Type: CdnPublicKey [Back to types index](index.md) ### Possible values (constructors): -[inputVideoEmpty](../constructors/inputVideoEmpty.md) - -[inputVideo](../constructors/inputVideo.md) +[cdnPublicKey](../constructors/cdnPublicKey.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[cdnPublicKey](../constructors/cdnPublicKey.md) + diff --git a/old_docs/API_docs_v44/types/ChannelAdminLogEvent.md b/old_docs/API_docs_v44/types/ChannelAdminLogEvent.md new file mode 100644 index 00000000..9833bb00 --- /dev/null +++ b/old_docs/API_docs_v44/types/ChannelAdminLogEvent.md @@ -0,0 +1,22 @@ +--- +title: ChannelAdminLogEvent +description: constructors and methods of type ChannelAdminLogEvent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEvent +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEvent](../constructors/channelAdminLogEvent.md) + + + +### Methods that return an object of this type (methods): + + + +[channelAdminLogEvent](../constructors/channelAdminLogEvent.md) + diff --git a/old_docs/API_docs_v44/types/ChannelAdminLogEventAction.md b/old_docs/API_docs_v44/types/ChannelAdminLogEventAction.md new file mode 100644 index 00000000..45664ce0 --- /dev/null +++ b/old_docs/API_docs_v44/types/ChannelAdminLogEventAction.md @@ -0,0 +1,102 @@ +--- +title: ChannelAdminLogEventAction +description: constructors and methods of type ChannelAdminLogEventAction +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEventAction +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEventActionChangeTitle](../constructors/channelAdminLogEventActionChangeTitle.md) + +[channelAdminLogEventActionChangeAbout](../constructors/channelAdminLogEventActionChangeAbout.md) + +[channelAdminLogEventActionChangeUsername](../constructors/channelAdminLogEventActionChangeUsername.md) + +[channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) + +[channelAdminLogEventActionToggleInvites](../constructors/channelAdminLogEventActionToggleInvites.md) + +[channelAdminLogEventActionToggleSignatures](../constructors/channelAdminLogEventActionToggleSignatures.md) + +[channelAdminLogEventActionUpdatePinned](../constructors/channelAdminLogEventActionUpdatePinned.md) + +[channelAdminLogEventActionEditMessage](../constructors/channelAdminLogEventActionEditMessage.md) + +[channelAdminLogEventActionDeleteMessage](../constructors/channelAdminLogEventActionDeleteMessage.md) + +[channelAdminLogEventActionParticipantJoin](../constructors/channelAdminLogEventActionParticipantJoin.md) + +[channelAdminLogEventActionParticipantLeave](../constructors/channelAdminLogEventActionParticipantLeave.md) + +[channelAdminLogEventActionParticipantInvite](../constructors/channelAdminLogEventActionParticipantInvite.md) + +[channelAdminLogEventActionParticipantToggleBan](../constructors/channelAdminLogEventActionParticipantToggleBan.md) + +[channelAdminLogEventActionParticipantToggleAdmin](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md) + +[channelAdminLogEventActionChangeStickerSet](../constructors/channelAdminLogEventActionChangeStickerSet.md) + +[channelAdminLogEventActionTogglePreHistoryHidden](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md) + +[channelAdminLogEventActionDefaultBannedRights](../constructors/channelAdminLogEventActionDefaultBannedRights.md) + +[channelAdminLogEventActionStopPoll](../constructors/channelAdminLogEventActionStopPoll.md) + +[channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md) + +[channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md) + +[channelAdminLogEventActionToggleSlowMode](../constructors/channelAdminLogEventActionToggleSlowMode.md) + + + +### Methods that return an object of this type (methods): + + + +[channelAdminLogEventActionChangeTitle](../constructors/channelAdminLogEventActionChangeTitle.md) + +[channelAdminLogEventActionChangeAbout](../constructors/channelAdminLogEventActionChangeAbout.md) + +[channelAdminLogEventActionChangeUsername](../constructors/channelAdminLogEventActionChangeUsername.md) + +[channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) + +[channelAdminLogEventActionToggleInvites](../constructors/channelAdminLogEventActionToggleInvites.md) + +[channelAdminLogEventActionToggleSignatures](../constructors/channelAdminLogEventActionToggleSignatures.md) + +[channelAdminLogEventActionUpdatePinned](../constructors/channelAdminLogEventActionUpdatePinned.md) + +[channelAdminLogEventActionEditMessage](../constructors/channelAdminLogEventActionEditMessage.md) + +[channelAdminLogEventActionDeleteMessage](../constructors/channelAdminLogEventActionDeleteMessage.md) + +[channelAdminLogEventActionParticipantJoin](../constructors/channelAdminLogEventActionParticipantJoin.md) + +[channelAdminLogEventActionParticipantLeave](../constructors/channelAdminLogEventActionParticipantLeave.md) + +[channelAdminLogEventActionParticipantInvite](../constructors/channelAdminLogEventActionParticipantInvite.md) + +[channelAdminLogEventActionParticipantToggleBan](../constructors/channelAdminLogEventActionParticipantToggleBan.md) + +[channelAdminLogEventActionParticipantToggleAdmin](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md) + +[channelAdminLogEventActionChangeStickerSet](../constructors/channelAdminLogEventActionChangeStickerSet.md) + +[channelAdminLogEventActionTogglePreHistoryHidden](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md) + +[channelAdminLogEventActionDefaultBannedRights](../constructors/channelAdminLogEventActionDefaultBannedRights.md) + +[channelAdminLogEventActionStopPoll](../constructors/channelAdminLogEventActionStopPoll.md) + +[channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md) + +[channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md) + +[channelAdminLogEventActionToggleSlowMode](../constructors/channelAdminLogEventActionToggleSlowMode.md) + diff --git a/old_docs/API_docs_v44/types/ChannelAdminLogEventsFilter.md b/old_docs/API_docs_v44/types/ChannelAdminLogEventsFilter.md new file mode 100644 index 00000000..28dabf39 --- /dev/null +++ b/old_docs/API_docs_v44/types/ChannelAdminLogEventsFilter.md @@ -0,0 +1,22 @@ +--- +title: ChannelAdminLogEventsFilter +description: constructors and methods of type ChannelAdminLogEventsFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEventsFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEventsFilter](../constructors/channelAdminLogEventsFilter.md) + + + +### Methods that return an object of this type (methods): + + + +[channelAdminLogEventsFilter](../constructors/channelAdminLogEventsFilter.md) + diff --git a/old_docs/API_docs_v44/types/ChannelLocation.md b/old_docs/API_docs_v44/types/ChannelLocation.md new file mode 100644 index 00000000..25cf5d80 --- /dev/null +++ b/old_docs/API_docs_v44/types/ChannelLocation.md @@ -0,0 +1,26 @@ +--- +title: ChannelLocation +description: constructors and methods of type ChannelLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelLocationEmpty](../constructors/channelLocationEmpty.md) + +[channelLocation](../constructors/channelLocation.md) + + + +### Methods that return an object of this type (methods): + + + +[channelLocationEmpty](../constructors/channelLocationEmpty.md) + +[channelLocation](../constructors/channelLocation.md) + diff --git a/old_docs/API_docs_v44/types/ChannelMessagesFilter.md b/old_docs/API_docs_v44/types/ChannelMessagesFilter.md index 4fd9f06e..2f0b2e92 100644 --- a/old_docs/API_docs_v44/types/ChannelMessagesFilter.md +++ b/old_docs/API_docs_v44/types/ChannelMessagesFilter.md @@ -3,7 +3,7 @@ title: ChannelMessagesFilter description: constructors and methods of type ChannelMessagesFilter image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChannelMessagesFilter +# Type: ChannelMessagesFilter [Back to types index](index.md) @@ -14,11 +14,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [channelMessagesFilter](../constructors/channelMessagesFilter.md) -[channelMessagesFilterCollapsed](../constructors/channelMessagesFilterCollapsed.md) - ### Methods that return an object of this type (methods): +[channelMessagesFilterEmpty](../constructors/channelMessagesFilterEmpty.md) + +[channelMessagesFilter](../constructors/channelMessagesFilter.md) + diff --git a/old_docs/API_docs_v44/types/ChannelParticipant.md b/old_docs/API_docs_v44/types/ChannelParticipant.md index 29b28f0a..a793ef5f 100644 --- a/old_docs/API_docs_v44/types/ChannelParticipant.md +++ b/old_docs/API_docs_v44/types/ChannelParticipant.md @@ -3,7 +3,7 @@ title: ChannelParticipant description: constructors and methods of type ChannelParticipant image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChannelParticipant +# Type: ChannelParticipant [Back to types index](index.md) @@ -14,17 +14,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [channelParticipantSelf](../constructors/channelParticipantSelf.md) -[channelParticipantModerator](../constructors/channelParticipantModerator.md) - -[channelParticipantEditor](../constructors/channelParticipantEditor.md) - -[channelParticipantKicked](../constructors/channelParticipantKicked.md) - [channelParticipantCreator](../constructors/channelParticipantCreator.md) +[channelParticipantAdmin](../constructors/channelParticipantAdmin.md) + +[channelParticipantBanned](../constructors/channelParticipantBanned.md) + ### Methods that return an object of this type (methods): +[channelParticipant](../constructors/channelParticipant.md) + +[channelParticipantSelf](../constructors/channelParticipantSelf.md) + +[channelParticipantCreator](../constructors/channelParticipantCreator.md) + +[channelParticipantAdmin](../constructors/channelParticipantAdmin.md) + +[channelParticipantBanned](../constructors/channelParticipantBanned.md) + diff --git a/old_docs/API_docs_v44/types/ChannelParticipantRole.md b/old_docs/API_docs_v44/types/ChannelParticipantRole.md deleted file mode 100644 index b183a712..00000000 --- a/old_docs/API_docs_v44/types/ChannelParticipantRole.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: ChannelParticipantRole -description: constructors and methods of type ChannelParticipantRole -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Type: ChannelParticipantRole -[Back to types index](index.md) - - - -### Possible values (constructors): - -[channelRoleEmpty](../constructors/channelRoleEmpty.md) - -[channelRoleModerator](../constructors/channelRoleModerator.md) - -[channelRoleEditor](../constructors/channelRoleEditor.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/old_docs/API_docs_v44/types/ChannelParticipantsFilter.md b/old_docs/API_docs_v44/types/ChannelParticipantsFilter.md index c882f170..a0638797 100644 --- a/old_docs/API_docs_v44/types/ChannelParticipantsFilter.md +++ b/old_docs/API_docs_v44/types/ChannelParticipantsFilter.md @@ -3,7 +3,7 @@ title: ChannelParticipantsFilter description: constructors and methods of type ChannelParticipantsFilter image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChannelParticipantsFilter +# Type: ChannelParticipantsFilter [Back to types index](index.md) @@ -18,9 +18,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [channelParticipantsBots](../constructors/channelParticipantsBots.md) +[channelParticipantsBanned](../constructors/channelParticipantsBanned.md) + +[channelParticipantsSearch](../constructors/channelParticipantsSearch.md) + +[channelParticipantsContacts](../constructors/channelParticipantsContacts.md) + ### Methods that return an object of this type (methods): +[channelParticipantsRecent](../constructors/channelParticipantsRecent.md) + +[channelParticipantsAdmins](../constructors/channelParticipantsAdmins.md) + +[channelParticipantsKicked](../constructors/channelParticipantsKicked.md) + +[channelParticipantsBots](../constructors/channelParticipantsBots.md) + +[channelParticipantsBanned](../constructors/channelParticipantsBanned.md) + +[channelParticipantsSearch](../constructors/channelParticipantsSearch.md) + +[channelParticipantsContacts](../constructors/channelParticipantsContacts.md) + diff --git a/old_docs/API_docs_v44/types/Chat.md b/old_docs/API_docs_v44/types/Chat.md index cd83aacb..e1197a5d 100644 --- a/old_docs/API_docs_v44/types/Chat.md +++ b/old_docs/API_docs_v44/types/Chat.md @@ -3,16 +3,14 @@ title: Chat description: constructors and methods of type Chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Chat +# Type: Chat [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $Chat = '@username'; // Username $Chat = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $Chat = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [chatEmpty](../constructors/chatEmpty.md) @@ -50,3 +50,13 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia +[chatEmpty](../constructors/chatEmpty.md) + +[chat](../constructors/chat.md) + +[chatForbidden](../constructors/chatForbidden.md) + +[channel](../constructors/channel.md) + +[channelForbidden](../constructors/channelForbidden.md) + diff --git a/old_docs/API_docs_v44/types/ChatAdminRights.md b/old_docs/API_docs_v44/types/ChatAdminRights.md new file mode 100644 index 00000000..cb88f674 --- /dev/null +++ b/old_docs/API_docs_v44/types/ChatAdminRights.md @@ -0,0 +1,22 @@ +--- +title: ChatAdminRights +description: constructors and methods of type ChatAdminRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatAdminRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatAdminRights](../constructors/chatAdminRights.md) + + + +### Methods that return an object of this type (methods): + + + +[chatAdminRights](../constructors/chatAdminRights.md) + diff --git a/old_docs/API_docs_v44/types/ChatBannedRights.md b/old_docs/API_docs_v44/types/ChatBannedRights.md new file mode 100644 index 00000000..744d449b --- /dev/null +++ b/old_docs/API_docs_v44/types/ChatBannedRights.md @@ -0,0 +1,22 @@ +--- +title: ChatBannedRights +description: constructors and methods of type ChatBannedRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatBannedRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatBannedRights](../constructors/chatBannedRights.md) + + + +### Methods that return an object of this type (methods): + + + +[chatBannedRights](../constructors/chatBannedRights.md) + diff --git a/old_docs/API_docs_v44/types/ChatFull.md b/old_docs/API_docs_v44/types/ChatFull.md index 615843bc..01dd67af 100644 --- a/old_docs/API_docs_v44/types/ChatFull.md +++ b/old_docs/API_docs_v44/types/ChatFull.md @@ -3,7 +3,7 @@ title: ChatFull description: constructors and methods of type ChatFull image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChatFull +# Type: ChatFull [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[chatFull](../constructors/chatFull.md) + +[channelFull](../constructors/channelFull.md) + diff --git a/old_docs/API_docs_v44/types/ChatInvite.md b/old_docs/API_docs_v44/types/ChatInvite.md index 9fafabb4..0ed5935e 100644 --- a/old_docs/API_docs_v44/types/ChatInvite.md +++ b/old_docs/API_docs_v44/types/ChatInvite.md @@ -3,7 +3,7 @@ title: ChatInvite description: constructors and methods of type ChatInvite image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChatInvite +# Type: ChatInvite [Back to types index](index.md) @@ -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): @@ -22,3 +24,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[chatInviteAlready](../constructors/chatInviteAlready.md) + +[chatInvite](../constructors/chatInvite.md) + +[chatInvitePeek](../constructors/chatInvitePeek.md) + +[$MadelineProto->messages->checkChatInvite](../methods/messages.checkChatInvite.md) + diff --git a/old_docs/API_docs_v44/types/ChatOnlines.md b/old_docs/API_docs_v44/types/ChatOnlines.md new file mode 100644 index 00000000..e38f8e6b --- /dev/null +++ b/old_docs/API_docs_v44/types/ChatOnlines.md @@ -0,0 +1,26 @@ +--- +title: ChatOnlines +description: constructors and methods of type ChatOnlines +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatOnlines +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatOnlines](../constructors/chatOnlines.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getOnlines](../methods/messages.getOnlines.md) + + + +[chatOnlines](../constructors/chatOnlines.md) + +[$MadelineProto->messages->getOnlines](../methods/messages.getOnlines.md) + diff --git a/old_docs/API_docs_v44/types/ChatParticipant.md b/old_docs/API_docs_v44/types/ChatParticipant.md index 30bad422..6a64f7fc 100644 --- a/old_docs/API_docs_v44/types/ChatParticipant.md +++ b/old_docs/API_docs_v44/types/ChatParticipant.md @@ -3,7 +3,7 @@ title: ChatParticipant description: constructors and methods of type ChatParticipant image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChatParticipant +# Type: ChatParticipant [Back to types index](index.md) @@ -22,3 +22,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[chatParticipant](../constructors/chatParticipant.md) + +[chatParticipantCreator](../constructors/chatParticipantCreator.md) + +[chatParticipantAdmin](../constructors/chatParticipantAdmin.md) + diff --git a/old_docs/API_docs_v44/types/ChatParticipants.md b/old_docs/API_docs_v44/types/ChatParticipants.md index ab60023d..77e87316 100644 --- a/old_docs/API_docs_v44/types/ChatParticipants.md +++ b/old_docs/API_docs_v44/types/ChatParticipants.md @@ -3,7 +3,7 @@ title: ChatParticipants description: constructors and methods of type ChatParticipants image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChatParticipants +# Type: ChatParticipants [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[chatParticipantsForbidden](../constructors/chatParticipantsForbidden.md) + +[chatParticipants](../constructors/chatParticipants.md) + diff --git a/old_docs/API_docs_v44/types/ChatPhoto.md b/old_docs/API_docs_v44/types/ChatPhoto.md index 066b2a14..dcdbd649 100644 --- a/old_docs/API_docs_v44/types/ChatPhoto.md +++ b/old_docs/API_docs_v44/types/ChatPhoto.md @@ -3,7 +3,7 @@ title: ChatPhoto description: constructors and methods of type ChatPhoto image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ChatPhoto +# Type: ChatPhoto [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[chatPhotoEmpty](../constructors/chatPhotoEmpty.md) + +[chatPhoto](../constructors/chatPhoto.md) + diff --git a/old_docs/API_docs_v44/types/CodeSettings.md b/old_docs/API_docs_v44/types/CodeSettings.md new file mode 100644 index 00000000..1831c34b --- /dev/null +++ b/old_docs/API_docs_v44/types/CodeSettings.md @@ -0,0 +1,22 @@ +--- +title: CodeSettings +description: constructors and methods of type CodeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: CodeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[codeSettings](../constructors/codeSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[codeSettings](../constructors/codeSettings.md) + diff --git a/old_docs/API_docs_v44/types/Config.md b/old_docs/API_docs_v44/types/Config.md index 3a23b7b7..d298f1f4 100644 --- a/old_docs/API_docs_v44/types/Config.md +++ b/old_docs/API_docs_v44/types/Config.md @@ -3,7 +3,7 @@ title: Config description: constructors and methods of type Config image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Config +# Type: Config [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[config](../constructors/config.md) + +[$MadelineProto->help->getConfig](../methods/help.getConfig.md) + diff --git a/old_docs/API_docs_v44/types/Contact.md b/old_docs/API_docs_v44/types/Contact.md index b8c9db1a..64121eff 100644 --- a/old_docs/API_docs_v44/types/Contact.md +++ b/old_docs/API_docs_v44/types/Contact.md @@ -3,7 +3,7 @@ title: Contact description: constructors and methods of type Contact image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Contact +# Type: Contact [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[contact](../constructors/contact.md) + diff --git a/old_docs/API_docs_v44/types/ContactBlocked.md b/old_docs/API_docs_v44/types/ContactBlocked.md index a3384d9a..575f93fe 100644 --- a/old_docs/API_docs_v44/types/ContactBlocked.md +++ b/old_docs/API_docs_v44/types/ContactBlocked.md @@ -3,7 +3,7 @@ title: ContactBlocked description: constructors and methods of type ContactBlocked image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ContactBlocked +# Type: ContactBlocked [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[contactBlocked](../constructors/contactBlocked.md) + diff --git a/old_docs/API_docs_v44/types/ContactLink.md b/old_docs/API_docs_v44/types/ContactLink.md deleted file mode 100644 index dc0bba05..00000000 --- a/old_docs/API_docs_v44/types/ContactLink.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ContactLink -description: constructors and methods of type ContactLink -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Type: ContactLink -[Back to types index](index.md) - - - -### Possible values (constructors): - -[contactLinkUnknown](../constructors/contactLinkUnknown.md) - -[contactLinkNone](../constructors/contactLinkNone.md) - -[contactLinkHasPhone](../constructors/contactLinkHasPhone.md) - -[contactLinkContact](../constructors/contactLinkContact.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/old_docs/API_docs_v44/types/ContactStatus.md b/old_docs/API_docs_v44/types/ContactStatus.md index 30aee6e2..a9784018 100644 --- a/old_docs/API_docs_v44/types/ContactStatus.md +++ b/old_docs/API_docs_v44/types/ContactStatus.md @@ -3,7 +3,7 @@ title: ContactStatus description: constructors and methods of type ContactStatus image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ContactStatus +# Type: ContactStatus [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[contactStatus](../constructors/contactStatus.md) + +[$MadelineProto->contacts->getStatuses](../methods/contacts.getStatuses.md) + diff --git a/old_docs/API_docs_v44/types/DcOption.md b/old_docs/API_docs_v44/types/DcOption.md index c621fa1d..2da37f5e 100644 --- a/old_docs/API_docs_v44/types/DcOption.md +++ b/old_docs/API_docs_v44/types/DcOption.md @@ -3,7 +3,7 @@ title: DcOption description: constructors and methods of type DcOption image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: DcOption +# Type: DcOption [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[dcOption](../constructors/dcOption.md) + diff --git a/old_docs/API_docs_v44/types/Dialog.md b/old_docs/API_docs_v44/types/Dialog.md index 8bd4498e..f173158c 100644 --- a/old_docs/API_docs_v44/types/Dialog.md +++ b/old_docs/API_docs_v44/types/Dialog.md @@ -3,7 +3,7 @@ title: Dialog description: constructors and methods of type Dialog image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Dialog +# Type: Dialog [Back to types index](index.md) @@ -12,7 +12,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [dialog](../constructors/dialog.md) -[dialogChannel](../constructors/dialogChannel.md) +[dialogFolder](../constructors/dialogFolder.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[dialog](../constructors/dialog.md) + +[dialogFolder](../constructors/dialogFolder.md) + diff --git a/old_docs/API_docs_v44/types/DialogFilter.md b/old_docs/API_docs_v44/types/DialogFilter.md new file mode 100644 index 00000000..7ec4a3b5 --- /dev/null +++ b/old_docs/API_docs_v44/types/DialogFilter.md @@ -0,0 +1,26 @@ +--- +title: DialogFilter +description: constructors and methods of type DialogFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DialogFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[dialogFilter](../constructors/dialogFilter.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDialogFilters](../methods/messages.getDialogFilters.md) + + + +[dialogFilter](../constructors/dialogFilter.md) + +[$MadelineProto->messages->getDialogFilters](../methods/messages.getDialogFilters.md) + diff --git a/old_docs/API_docs_v44/types/DialogFilterSuggested.md b/old_docs/API_docs_v44/types/DialogFilterSuggested.md new file mode 100644 index 00000000..14878867 --- /dev/null +++ b/old_docs/API_docs_v44/types/DialogFilterSuggested.md @@ -0,0 +1,26 @@ +--- +title: DialogFilterSuggested +description: constructors and methods of type DialogFilterSuggested +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DialogFilterSuggested +[Back to types index](index.md) + + + +### Possible values (constructors): + +[dialogFilterSuggested](../constructors/dialogFilterSuggested.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSuggestedDialogFilters](../methods/messages.getSuggestedDialogFilters.md) + + + +[dialogFilterSuggested](../constructors/dialogFilterSuggested.md) + +[$MadelineProto->messages->getSuggestedDialogFilters](../methods/messages.getSuggestedDialogFilters.md) + diff --git a/old_docs/API_docs_v44/types/DialogPeer.md b/old_docs/API_docs_v44/types/DialogPeer.md new file mode 100644 index 00000000..de65b7a7 --- /dev/null +++ b/old_docs/API_docs_v44/types/DialogPeer.md @@ -0,0 +1,54 @@ +--- +title: DialogPeer +description: constructors and methods of type DialogPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DialogPeer +[Back to types index](index.md) + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +```php +$DialogPeer = '@username'; // Username + +$DialogPeer = 'me'; // The currently logged-in user + +$DialogPeer = 44700; // bot API id (users) +$DialogPeer = -492772765; // bot API id (chats) +$DialogPeer = -10038575794; // bot API id (channels) + +$DialogPeer = 'https://t.me/danogentili'; // t.me URLs +$DialogPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$DialogPeer = 'user#44700'; // tg-cli style id (users) +$DialogPeer = 'chat#492772765'; // tg-cli style id (chats) +$DialogPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + + + +### Possible values (constructors): + +[dialogPeer](../constructors/dialogPeer.md) + +[dialogPeerFolder](../constructors/dialogPeerFolder.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDialogUnreadMarks](../methods/messages.getDialogUnreadMarks.md) + + + +[dialogPeer](../constructors/dialogPeer.md) + +[dialogPeerFolder](../constructors/dialogPeerFolder.md) + +[$MadelineProto->messages->getDialogUnreadMarks](../methods/messages.getDialogUnreadMarks.md) + diff --git a/old_docs/API_docs_v44/types/Document.md b/old_docs/API_docs_v44/types/Document.md index 2cb85623..60443b57 100644 --- a/old_docs/API_docs_v44/types/Document.md +++ b/old_docs/API_docs_v44/types/Document.md @@ -3,7 +3,7 @@ title: Document description: constructors and methods of type Document image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Document +# Type: Document [Back to types index](index.md) @@ -18,7 +18,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->account->uploadTheme](../methods/account.uploadTheme.md) + [$MadelineProto->messages->getDocumentByHash](../methods/messages.getDocumentByHash.md) +[documentEmpty](../constructors/documentEmpty.md) + +[document](../constructors/document.md) + +[$MadelineProto->account->uploadTheme](../methods/account.uploadTheme.md) + +[$MadelineProto->messages->getDocumentByHash](../methods/messages.getDocumentByHash.md) + diff --git a/old_docs/API_docs_v44/types/DocumentAttribute.md b/old_docs/API_docs_v44/types/DocumentAttribute.md index 9c013f1c..c6e4b555 100644 --- a/old_docs/API_docs_v44/types/DocumentAttribute.md +++ b/old_docs/API_docs_v44/types/DocumentAttribute.md @@ -3,7 +3,7 @@ title: DocumentAttribute description: constructors and methods of type DocumentAttribute image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: DocumentAttribute +# Type: DocumentAttribute [Back to types index](index.md) @@ -22,9 +22,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [documentAttributeFilename](../constructors/documentAttributeFilename.md) +[documentAttributeHasStickers](../constructors/documentAttributeHasStickers.md) + ### Methods that return an object of this type (methods): +[documentAttributeImageSize](../constructors/documentAttributeImageSize.md) + +[documentAttributeAnimated](../constructors/documentAttributeAnimated.md) + +[documentAttributeSticker](../constructors/documentAttributeSticker.md) + +[documentAttributeVideo](../constructors/documentAttributeVideo.md) + +[documentAttributeAudio](../constructors/documentAttributeAudio.md) + +[documentAttributeFilename](../constructors/documentAttributeFilename.md) + +[documentAttributeHasStickers](../constructors/documentAttributeHasStickers.md) + diff --git a/old_docs/API_docs_v44/types/DraftMessage.md b/old_docs/API_docs_v44/types/DraftMessage.md new file mode 100644 index 00000000..7c33be94 --- /dev/null +++ b/old_docs/API_docs_v44/types/DraftMessage.md @@ -0,0 +1,26 @@ +--- +title: DraftMessage +description: constructors and methods of type DraftMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DraftMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[draftMessageEmpty](../constructors/draftMessageEmpty.md) + +[draftMessage](../constructors/draftMessage.md) + + + +### Methods that return an object of this type (methods): + + + +[draftMessageEmpty](../constructors/draftMessageEmpty.md) + +[draftMessage](../constructors/draftMessage.md) + diff --git a/old_docs/API_docs_v44/types/EmojiKeyword.md b/old_docs/API_docs_v44/types/EmojiKeyword.md new file mode 100644 index 00000000..372e90da --- /dev/null +++ b/old_docs/API_docs_v44/types/EmojiKeyword.md @@ -0,0 +1,26 @@ +--- +title: EmojiKeyword +description: constructors and methods of type EmojiKeyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiKeyword +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiKeyword](../constructors/emojiKeyword.md) + +[emojiKeywordDeleted](../constructors/emojiKeywordDeleted.md) + + + +### Methods that return an object of this type (methods): + + + +[emojiKeyword](../constructors/emojiKeyword.md) + +[emojiKeywordDeleted](../constructors/emojiKeywordDeleted.md) + diff --git a/old_docs/API_docs_v44/types/EmojiKeywordsDifference.md b/old_docs/API_docs_v44/types/EmojiKeywordsDifference.md new file mode 100644 index 00000000..a3dc2c6e --- /dev/null +++ b/old_docs/API_docs_v44/types/EmojiKeywordsDifference.md @@ -0,0 +1,30 @@ +--- +title: EmojiKeywordsDifference +description: constructors and methods of type EmojiKeywordsDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiKeywordsDifference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiKeywordsDifference](../constructors/emojiKeywordsDifference.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiKeywords](../methods/messages.getEmojiKeywords.md) + +[$MadelineProto->messages->getEmojiKeywordsDifference](../methods/messages.getEmojiKeywordsDifference.md) + + + +[emojiKeywordsDifference](../constructors/emojiKeywordsDifference.md) + +[$MadelineProto->messages->getEmojiKeywords](../methods/messages.getEmojiKeywords.md) + +[$MadelineProto->messages->getEmojiKeywordsDifference](../methods/messages.getEmojiKeywordsDifference.md) + diff --git a/old_docs/API_docs_v44/types/EmojiLanguage.md b/old_docs/API_docs_v44/types/EmojiLanguage.md new file mode 100644 index 00000000..c1ee35e0 --- /dev/null +++ b/old_docs/API_docs_v44/types/EmojiLanguage.md @@ -0,0 +1,26 @@ +--- +title: EmojiLanguage +description: constructors and methods of type EmojiLanguage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiLanguage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiLanguage](../constructors/emojiLanguage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiKeywordsLanguages](../methods/messages.getEmojiKeywordsLanguages.md) + + + +[emojiLanguage](../constructors/emojiLanguage.md) + +[$MadelineProto->messages->getEmojiKeywordsLanguages](../methods/messages.getEmojiKeywordsLanguages.md) + diff --git a/old_docs/API_docs_v44/types/EmojiURL.md b/old_docs/API_docs_v44/types/EmojiURL.md new file mode 100644 index 00000000..4ef9d8c2 --- /dev/null +++ b/old_docs/API_docs_v44/types/EmojiURL.md @@ -0,0 +1,26 @@ +--- +title: EmojiURL +description: constructors and methods of type EmojiURL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiURL +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiURL](../constructors/emojiURL.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiURL](../methods/messages.getEmojiURL.md) + + + +[emojiURL](../constructors/emojiURL.md) + +[$MadelineProto->messages->getEmojiURL](../methods/messages.getEmojiURL.md) + diff --git a/old_docs/API_docs_v44/types/EncryptedChat.md b/old_docs/API_docs_v44/types/EncryptedChat.md index 19cf52b0..cb3a3d39 100644 --- a/old_docs/API_docs_v44/types/EncryptedChat.md +++ b/old_docs/API_docs_v44/types/EncryptedChat.md @@ -3,7 +3,7 @@ title: EncryptedChat description: constructors and methods of type EncryptedChat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: EncryptedChat +# Type: EncryptedChat [Back to types index](index.md) @@ -30,3 +30,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[encryptedChatEmpty](../constructors/encryptedChatEmpty.md) + +[encryptedChatWaiting](../constructors/encryptedChatWaiting.md) + +[encryptedChatRequested](../constructors/encryptedChatRequested.md) + +[encryptedChat](../constructors/encryptedChat.md) + +[encryptedChatDiscarded](../constructors/encryptedChatDiscarded.md) + +[$MadelineProto->messages->requestEncryption](../methods/messages.requestEncryption.md) + +[$MadelineProto->messages->acceptEncryption](../methods/messages.acceptEncryption.md) + diff --git a/old_docs/API_docs_v44/types/EncryptedFile.md b/old_docs/API_docs_v44/types/EncryptedFile.md index dc9fae35..22a850d1 100644 --- a/old_docs/API_docs_v44/types/EncryptedFile.md +++ b/old_docs/API_docs_v44/types/EncryptedFile.md @@ -3,7 +3,7 @@ title: EncryptedFile description: constructors and methods of type EncryptedFile image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: EncryptedFile +# Type: EncryptedFile [Back to types index](index.md) @@ -18,5 +18,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->messages->uploadEncryptedFile](../methods/messages.uploadEncryptedFile.md) + +[encryptedFileEmpty](../constructors/encryptedFileEmpty.md) + +[encryptedFile](../constructors/encryptedFile.md) + +[$MadelineProto->messages->uploadEncryptedFile](../methods/messages.uploadEncryptedFile.md) + diff --git a/old_docs/API_docs_v44/types/EncryptedMessage.md b/old_docs/API_docs_v44/types/EncryptedMessage.md index f0b54b7e..479268f5 100644 --- a/old_docs/API_docs_v44/types/EncryptedMessage.md +++ b/old_docs/API_docs_v44/types/EncryptedMessage.md @@ -3,7 +3,7 @@ title: EncryptedMessage description: constructors and methods of type EncryptedMessage image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: EncryptedMessage +# Type: EncryptedMessage [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[encryptedMessage](../constructors/encryptedMessage.md) + +[encryptedMessageService](../constructors/encryptedMessageService.md) + diff --git a/old_docs/API_docs_v44/types/Error.md b/old_docs/API_docs_v44/types/Error.md index 245a4f03..c70c2e18 100644 --- a/old_docs/API_docs_v44/types/Error.md +++ b/old_docs/API_docs_v44/types/Error.md @@ -3,7 +3,7 @@ title: Error description: constructors and methods of type Error image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Error +# Type: Error [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[error](../constructors/error.md) + diff --git a/old_docs/API_docs_v44/types/ExportedChatInvite.md b/old_docs/API_docs_v44/types/ExportedChatInvite.md index 53ce5f59..8cdd82c4 100644 --- a/old_docs/API_docs_v44/types/ExportedChatInvite.md +++ b/old_docs/API_docs_v44/types/ExportedChatInvite.md @@ -3,7 +3,7 @@ title: ExportedChatInvite description: constructors and methods of type ExportedChatInvite image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ExportedChatInvite +# Type: ExportedChatInvite [Back to types index](index.md) @@ -20,7 +20,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->messages->exportChatInvite](../methods/messages.exportChatInvite.md) -[$MadelineProto->channels->exportInvite](../methods/channels.exportInvite.md) +[chatInviteEmpty](../constructors/chatInviteEmpty.md) + +[chatInviteExported](../constructors/chatInviteExported.md) + +[$MadelineProto->messages->exportChatInvite](../methods/messages.exportChatInvite.md) diff --git a/old_docs/API_docs_v44/types/ExportedMessageLink.md b/old_docs/API_docs_v44/types/ExportedMessageLink.md new file mode 100644 index 00000000..23b1e1b7 --- /dev/null +++ b/old_docs/API_docs_v44/types/ExportedMessageLink.md @@ -0,0 +1,26 @@ +--- +title: ExportedMessageLink +description: constructors and methods of type ExportedMessageLink +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ExportedMessageLink +[Back to types index](index.md) + + + +### Possible values (constructors): + +[exportedMessageLink](../constructors/exportedMessageLink.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->exportMessageLink](../methods/channels.exportMessageLink.md) + + + +[exportedMessageLink](../constructors/exportedMessageLink.md) + +[$MadelineProto->channels->exportMessageLink](../methods/channels.exportMessageLink.md) + diff --git a/old_docs/API_docs_v44/types/FileHash.md b/old_docs/API_docs_v44/types/FileHash.md new file mode 100644 index 00000000..0b2c98b1 --- /dev/null +++ b/old_docs/API_docs_v44/types/FileHash.md @@ -0,0 +1,34 @@ +--- +title: FileHash +description: constructors and methods of type FileHash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: FileHash +[Back to types index](index.md) + + + +### Possible values (constructors): + +[fileHash](../constructors/fileHash.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->reuploadCdnFile](../methods/upload.reuploadCdnFile.md) + +[$MadelineProto->upload->getCdnFileHashes](../methods/upload.getCdnFileHashes.md) + +[$MadelineProto->upload->getFileHashes](../methods/upload.getFileHashes.md) + + + +[fileHash](../constructors/fileHash.md) + +[$MadelineProto->upload->reuploadCdnFile](../methods/upload.reuploadCdnFile.md) + +[$MadelineProto->upload->getCdnFileHashes](../methods/upload.getCdnFileHashes.md) + +[$MadelineProto->upload->getFileHashes](../methods/upload.getFileHashes.md) + diff --git a/old_docs/API_docs_v44/types/FileLocation.md b/old_docs/API_docs_v44/types/FileLocation.md index e6169428..8f9ce29f 100644 --- a/old_docs/API_docs_v44/types/FileLocation.md +++ b/old_docs/API_docs_v44/types/FileLocation.md @@ -3,16 +3,14 @@ title: FileLocation description: constructors and methods of type FileLocation image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: FileLocation +# Type: FileLocation [Back to types index](index.md) ### Possible values (constructors): -[fileLocationUnavailable](../constructors/fileLocationUnavailable.md) - -[fileLocation](../constructors/fileLocation.md) +[fileLocationToBeDeprecated](../constructors/fileLocationToBeDeprecated.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[fileLocationToBeDeprecated](../constructors/fileLocationToBeDeprecated.md) + diff --git a/old_docs/API_docs_v44/types/Audio.md b/old_docs/API_docs_v44/types/Folder.md similarity index 57% rename from old_docs/API_docs_v44/types/Audio.md rename to old_docs/API_docs_v44/types/Folder.md index c7113d71..420e90c7 100644 --- a/old_docs/API_docs_v44/types/Audio.md +++ b/old_docs/API_docs_v44/types/Folder.md @@ -1,18 +1,16 @@ --- -title: Audio -description: constructors and methods of type Audio +title: Folder +description: constructors and methods of type Folder image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Audio +# Type: Folder [Back to types index](index.md) ### Possible values (constructors): -[audioEmpty](../constructors/audioEmpty.md) - -[audio](../constructors/audio.md) +[folder](../constructors/folder.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[folder](../constructors/folder.md) + diff --git a/old_docs/API_docs_v44/types/ContactSuggested.md b/old_docs/API_docs_v44/types/FolderPeer.md similarity index 53% rename from old_docs/API_docs_v44/types/ContactSuggested.md rename to old_docs/API_docs_v44/types/FolderPeer.md index d4ed917f..91877e50 100644 --- a/old_docs/API_docs_v44/types/ContactSuggested.md +++ b/old_docs/API_docs_v44/types/FolderPeer.md @@ -1,16 +1,16 @@ --- -title: ContactSuggested -description: constructors and methods of type ContactSuggested +title: FolderPeer +description: constructors and methods of type FolderPeer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ContactSuggested +# Type: FolderPeer [Back to types index](index.md) ### Possible values (constructors): -[contactSuggested](../constructors/contactSuggested.md) +[folderPeer](../constructors/folderPeer.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[folderPeer](../constructors/folderPeer.md) + diff --git a/old_docs/API_docs_v44/types/FoundGif.md b/old_docs/API_docs_v44/types/Game.md similarity index 60% rename from old_docs/API_docs_v44/types/FoundGif.md rename to old_docs/API_docs_v44/types/Game.md index 08c2d15b..9b2aa3a7 100644 --- a/old_docs/API_docs_v44/types/FoundGif.md +++ b/old_docs/API_docs_v44/types/Game.md @@ -1,16 +1,16 @@ --- -title: FoundGif -description: constructors and methods of type FoundGif +title: Game +description: constructors and methods of type Game image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: FoundGif +# Type: Game [Back to types index](index.md) ### Possible values (constructors): -[foundGif](../constructors/foundGif.md) +[game](../constructors/game.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[game](../constructors/game.md) + diff --git a/old_docs/API_docs_v44/types/GeoPoint.md b/old_docs/API_docs_v44/types/GeoPoint.md index 13ac6ebb..0dada21b 100644 --- a/old_docs/API_docs_v44/types/GeoPoint.md +++ b/old_docs/API_docs_v44/types/GeoPoint.md @@ -3,7 +3,7 @@ title: GeoPoint description: constructors and methods of type GeoPoint image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: GeoPoint +# Type: GeoPoint [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[geoPointEmpty](../constructors/geoPointEmpty.md) + +[geoPoint](../constructors/geoPoint.md) + diff --git a/old_docs/API_docs_v44/types/GlobalPrivacySettings.md b/old_docs/API_docs_v44/types/GlobalPrivacySettings.md new file mode 100644 index 00000000..fa6ae512 --- /dev/null +++ b/old_docs/API_docs_v44/types/GlobalPrivacySettings.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/DisabledFeature.md b/old_docs/API_docs_v44/types/HighScore.md similarity index 54% rename from old_docs/API_docs_v44/types/DisabledFeature.md rename to old_docs/API_docs_v44/types/HighScore.md index bff9df97..96d8b013 100644 --- a/old_docs/API_docs_v44/types/DisabledFeature.md +++ b/old_docs/API_docs_v44/types/HighScore.md @@ -1,16 +1,16 @@ --- -title: DisabledFeature -description: constructors and methods of type DisabledFeature +title: HighScore +description: constructors and methods of type HighScore image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: DisabledFeature +# Type: HighScore [Back to types index](index.md) ### Possible values (constructors): -[disabledFeature](../constructors/disabledFeature.md) +[highScore](../constructors/highScore.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[highScore](../constructors/highScore.md) + diff --git a/old_docs/API_docs_v44/types/ImportedContact.md b/old_docs/API_docs_v44/types/ImportedContact.md index 35654f72..d9dc03d8 100644 --- a/old_docs/API_docs_v44/types/ImportedContact.md +++ b/old_docs/API_docs_v44/types/ImportedContact.md @@ -3,7 +3,7 @@ title: ImportedContact description: constructors and methods of type ImportedContact image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ImportedContact +# Type: ImportedContact [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[importedContact](../constructors/importedContact.md) + diff --git a/old_docs/API_docs_v44/types/InlineBotSwitchPM.md b/old_docs/API_docs_v44/types/InlineBotSwitchPM.md new file mode 100644 index 00000000..54ba68c1 --- /dev/null +++ b/old_docs/API_docs_v44/types/InlineBotSwitchPM.md @@ -0,0 +1,22 @@ +--- +title: InlineBotSwitchPM +description: constructors and methods of type InlineBotSwitchPM +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InlineBotSwitchPM +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inlineBotSwitchPM](../constructors/inlineBotSwitchPM.md) + + + +### Methods that return an object of this type (methods): + + + +[inlineBotSwitchPM](../constructors/inlineBotSwitchPM.md) + diff --git a/old_docs/API_docs_v44/types/InputAppEvent.md b/old_docs/API_docs_v44/types/InputAppEvent.md index 64a2d296..54cdedc6 100644 --- a/old_docs/API_docs_v44/types/InputAppEvent.md +++ b/old_docs/API_docs_v44/types/InputAppEvent.md @@ -3,7 +3,7 @@ title: InputAppEvent description: constructors and methods of type InputAppEvent image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputAppEvent +# Type: InputAppEvent [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[inputAppEvent](../constructors/inputAppEvent.md) + diff --git a/old_docs/API_docs_v44/types/InputBotInlineMessage.md b/old_docs/API_docs_v44/types/InputBotInlineMessage.md new file mode 100644 index 00000000..0debdfde --- /dev/null +++ b/old_docs/API_docs_v44/types/InputBotInlineMessage.md @@ -0,0 +1,42 @@ +--- +title: InputBotInlineMessage +description: constructors and methods of type InputBotInlineMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineMessageMediaAuto](../constructors/inputBotInlineMessageMediaAuto.md) + +[inputBotInlineMessageText](../constructors/inputBotInlineMessageText.md) + +[inputBotInlineMessageMediaGeo](../constructors/inputBotInlineMessageMediaGeo.md) + +[inputBotInlineMessageMediaVenue](../constructors/inputBotInlineMessageMediaVenue.md) + +[inputBotInlineMessageMediaContact](../constructors/inputBotInlineMessageMediaContact.md) + +[inputBotInlineMessageGame](../constructors/inputBotInlineMessageGame.md) + + + +### Methods that return an object of this type (methods): + + + +[inputBotInlineMessageMediaAuto](../constructors/inputBotInlineMessageMediaAuto.md) + +[inputBotInlineMessageText](../constructors/inputBotInlineMessageText.md) + +[inputBotInlineMessageMediaGeo](../constructors/inputBotInlineMessageMediaGeo.md) + +[inputBotInlineMessageMediaVenue](../constructors/inputBotInlineMessageMediaVenue.md) + +[inputBotInlineMessageMediaContact](../constructors/inputBotInlineMessageMediaContact.md) + +[inputBotInlineMessageGame](../constructors/inputBotInlineMessageGame.md) + diff --git a/old_docs/API_docs_v44/types/InputBotInlineMessageID.md b/old_docs/API_docs_v44/types/InputBotInlineMessageID.md new file mode 100644 index 00000000..277e52ad --- /dev/null +++ b/old_docs/API_docs_v44/types/InputBotInlineMessageID.md @@ -0,0 +1,22 @@ +--- +title: InputBotInlineMessageID +description: constructors and methods of type InputBotInlineMessageID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineMessageID +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineMessageID](../constructors/inputBotInlineMessageID.md) + + + +### Methods that return an object of this type (methods): + + + +[inputBotInlineMessageID](../constructors/inputBotInlineMessageID.md) + diff --git a/old_docs/API_docs_v44/types/InputBotInlineResult.md b/old_docs/API_docs_v44/types/InputBotInlineResult.md new file mode 100644 index 00000000..49e69fbf --- /dev/null +++ b/old_docs/API_docs_v44/types/InputBotInlineResult.md @@ -0,0 +1,34 @@ +--- +title: InputBotInlineResult +description: constructors and methods of type InputBotInlineResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineResult](../constructors/inputBotInlineResult.md) + +[inputBotInlineResultPhoto](../constructors/inputBotInlineResultPhoto.md) + +[inputBotInlineResultDocument](../constructors/inputBotInlineResultDocument.md) + +[inputBotInlineResultGame](../constructors/inputBotInlineResultGame.md) + + + +### Methods that return an object of this type (methods): + + + +[inputBotInlineResult](../constructors/inputBotInlineResult.md) + +[inputBotInlineResultPhoto](../constructors/inputBotInlineResultPhoto.md) + +[inputBotInlineResultDocument](../constructors/inputBotInlineResultDocument.md) + +[inputBotInlineResultGame](../constructors/inputBotInlineResultGame.md) + diff --git a/old_docs/API_docs_v44/types/InputChannel.md b/old_docs/API_docs_v44/types/InputChannel.md index 3882099d..f7385f4e 100644 --- a/old_docs/API_docs_v44/types/InputChannel.md +++ b/old_docs/API_docs_v44/types/InputChannel.md @@ -3,16 +3,14 @@ title: InputChannel description: constructors and methods of type InputChannel image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputChannel +# Type: InputChannel [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $InputChannel = '@username'; // Username $InputChannel = 'me'; // The currently logged-in user @@ -32,15 +30,25 @@ $InputChannel = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [inputChannelEmpty](../constructors/inputChannelEmpty.md) [inputChannel](../constructors/inputChannel.md) +[inputChannelFromMessage](../constructors/inputChannelFromMessage.md) + ### Methods that return an object of this type (methods): +[inputChannelEmpty](../constructors/inputChannelEmpty.md) + +[inputChannel](../constructors/inputChannel.md) + +[inputChannelFromMessage](../constructors/inputChannelFromMessage.md) + diff --git a/old_docs/API_docs_v44/types/InputChatPhoto.md b/old_docs/API_docs_v44/types/InputChatPhoto.md index 4be81e67..c43cbff5 100644 --- a/old_docs/API_docs_v44/types/InputChatPhoto.md +++ b/old_docs/API_docs_v44/types/InputChatPhoto.md @@ -3,7 +3,7 @@ title: InputChatPhoto description: constructors and methods of type InputChatPhoto image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputChatPhoto +# Type: InputChatPhoto [Back to types index](index.md) @@ -22,3 +22,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[inputChatPhotoEmpty](../constructors/inputChatPhotoEmpty.md) + +[inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) + +[inputChatPhoto](../constructors/inputChatPhoto.md) + diff --git a/old_docs/API_docs_v44/types/InputCheckPasswordSRP.md b/old_docs/API_docs_v44/types/InputCheckPasswordSRP.md new file mode 100644 index 00000000..41981040 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputCheckPasswordSRP.md @@ -0,0 +1,26 @@ +--- +title: InputCheckPasswordSRP +description: constructors and methods of type InputCheckPasswordSRP +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputCheckPasswordSRP +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputCheckPasswordEmpty](../constructors/inputCheckPasswordEmpty.md) + +[inputCheckPasswordSRP](../constructors/inputCheckPasswordSRP.md) + + + +### Methods that return an object of this type (methods): + + + +[inputCheckPasswordEmpty](../constructors/inputCheckPasswordEmpty.md) + +[inputCheckPasswordSRP](../constructors/inputCheckPasswordSRP.md) + diff --git a/old_docs/API_docs_v44/types/InputClientProxy.md b/old_docs/API_docs_v44/types/InputClientProxy.md new file mode 100644 index 00000000..3b90e821 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputClientProxy.md @@ -0,0 +1,22 @@ +--- +title: InputClientProxy +description: constructors and methods of type InputClientProxy +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputClientProxy +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputClientProxy](../constructors/inputClientProxy.md) + + + +### Methods that return an object of this type (methods): + + + +[inputClientProxy](../constructors/inputClientProxy.md) + diff --git a/old_docs/API_docs_v44/types/InputContact.md b/old_docs/API_docs_v44/types/InputContact.md index 10026e98..200c3a8a 100644 --- a/old_docs/API_docs_v44/types/InputContact.md +++ b/old_docs/API_docs_v44/types/InputContact.md @@ -3,7 +3,7 @@ title: InputContact description: constructors and methods of type InputContact image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputContact +# Type: InputContact [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[inputPhoneContact](../constructors/inputPhoneContact.md) + diff --git a/old_docs/API_docs_v44/types/InputDialogPeer.md b/old_docs/API_docs_v44/types/InputDialogPeer.md new file mode 100644 index 00000000..ce1f9cfd --- /dev/null +++ b/old_docs/API_docs_v44/types/InputDialogPeer.md @@ -0,0 +1,50 @@ +--- +title: InputDialogPeer +description: constructors and methods of type InputDialogPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputDialogPeer +[Back to types index](index.md) + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +```php +$InputDialogPeer = '@username'; // Username + +$InputDialogPeer = 'me'; // The currently logged-in user + +$InputDialogPeer = 44700; // bot API id (users) +$InputDialogPeer = -492772765; // bot API id (chats) +$InputDialogPeer = -10038575794; // bot API id (channels) + +$InputDialogPeer = 'https://t.me/danogentili'; // t.me URLs +$InputDialogPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputDialogPeer = 'user#44700'; // tg-cli style id (users) +$InputDialogPeer = 'chat#492772765'; // tg-cli style id (chats) +$InputDialogPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + + + +### Possible values (constructors): + +[inputDialogPeer](../constructors/inputDialogPeer.md) + +[inputDialogPeerFolder](../constructors/inputDialogPeerFolder.md) + + + +### Methods that return an object of this type (methods): + + + +[inputDialogPeer](../constructors/inputDialogPeer.md) + +[inputDialogPeerFolder](../constructors/inputDialogPeerFolder.md) + diff --git a/old_docs/API_docs_v44/types/InputDocument.md b/old_docs/API_docs_v44/types/InputDocument.md index 1227cd74..52b3b3b1 100644 --- a/old_docs/API_docs_v44/types/InputDocument.md +++ b/old_docs/API_docs_v44/types/InputDocument.md @@ -3,13 +3,12 @@ title: InputDocument description: constructors and methods of type InputDocument image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputDocument +# Type: InputDocument [Back to types index](index.md) - - You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Document](Document.md) here, MadelineProto will automatically convert it to the right type. + ### Possible values (constructors): [inputDocumentEmpty](../constructors/inputDocumentEmpty.md) @@ -22,3 +21,7 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [ +[inputDocumentEmpty](../constructors/inputDocumentEmpty.md) + +[inputDocument](../constructors/inputDocument.md) + diff --git a/old_docs/API_docs_v44/types/InputEncryptedChat.md b/old_docs/API_docs_v44/types/InputEncryptedChat.md index 14a4526e..0f0ab714 100644 --- a/old_docs/API_docs_v44/types/InputEncryptedChat.md +++ b/old_docs/API_docs_v44/types/InputEncryptedChat.md @@ -3,20 +3,19 @@ title: InputEncryptedChat description: constructors and methods of type InputEncryptedChat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputEncryptedChat +# Type: InputEncryptedChat [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [EncryptedMessage](EncryptedMessage.md) object here, MadelineProto will automatically extract the destination chat id. The following syntax can also be used: -``` +```php $InputEncryptedChat = -147286699; // Numeric chat id returned by requestSecretChat, can be positive or negative ``` + ### Possible values (constructors): [inputEncryptedChat](../constructors/inputEncryptedChat.md) @@ -27,3 +26,5 @@ $InputEncryptedChat = -147286699; // Numeric chat id returned by requestSecretCh +[inputEncryptedChat](../constructors/inputEncryptedChat.md) + diff --git a/old_docs/API_docs_v44/types/InputEncryptedFile.md b/old_docs/API_docs_v44/types/InputEncryptedFile.md index cd7f365f..504d9d14 100644 --- a/old_docs/API_docs_v44/types/InputEncryptedFile.md +++ b/old_docs/API_docs_v44/types/InputEncryptedFile.md @@ -3,17 +3,18 @@ title: InputEncryptedFile description: constructors and methods of type InputEncryptedFile image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputEncryptedFile +# Type: InputEncryptedFile [Back to types index](index.md) - - The following syntax can also be used: -``` +```php $InputEncryptedFile = 'filename.mp4'; // The file path can also be used +$InputEncryptedFile = 'https://google.com'; // A URL can also be used ``` +You can also use async streams, HTTP response objects, and [much more](https://docs.madelineproto.xyz/docs/FILES.html#downloading-files)! + ### Possible values (constructors): @@ -31,3 +32,11 @@ $InputEncryptedFile = 'filename.mp4'; // The file path can also be used +[inputEncryptedFileEmpty](../constructors/inputEncryptedFileEmpty.md) + +[inputEncryptedFileUploaded](../constructors/inputEncryptedFileUploaded.md) + +[inputEncryptedFile](../constructors/inputEncryptedFile.md) + +[inputEncryptedFileBigUploaded](../constructors/inputEncryptedFileBigUploaded.md) + diff --git a/old_docs/API_docs_v44/types/InputFile.md b/old_docs/API_docs_v44/types/InputFile.md index f76612de..96ea7455 100644 --- a/old_docs/API_docs_v44/types/InputFile.md +++ b/old_docs/API_docs_v44/types/InputFile.md @@ -3,17 +3,18 @@ title: InputFile description: constructors and methods of type InputFile image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputFile +# Type: InputFile [Back to types index](index.md) - - The following syntax can also be used: -``` +```php $InputFile = 'filename.mp4'; // The file path can also be used +$InputFile = 'https://google.com'; // A URL can also be used ``` +You can also use async streams, HTTP response objects, and [much more](https://docs.madelineproto.xyz/docs/FILES.html#downloading-files)! + ### Possible values (constructors): @@ -27,3 +28,7 @@ $InputFile = 'filename.mp4'; // The file path can also be used +[inputFile](../constructors/inputFile.md) + +[inputFileBig](../constructors/inputFileBig.md) + diff --git a/old_docs/API_docs_v44/types/InputFileLocation.md b/old_docs/API_docs_v44/types/InputFileLocation.md index 1f7d421a..0a9d217b 100644 --- a/old_docs/API_docs_v44/types/InputFileLocation.md +++ b/old_docs/API_docs_v44/types/InputFileLocation.md @@ -3,7 +3,7 @@ title: InputFileLocation description: constructors and methods of type InputFileLocation image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputFileLocation +# Type: InputFileLocation [Back to types index](index.md) @@ -12,17 +12,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputFileLocation](../constructors/inputFileLocation.md) -[inputVideoFileLocation](../constructors/inputVideoFileLocation.md) - [inputEncryptedFileLocation](../constructors/inputEncryptedFileLocation.md) -[inputAudioFileLocation](../constructors/inputAudioFileLocation.md) - [inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) +[inputSecureFileLocation](../constructors/inputSecureFileLocation.md) + +[inputTakeoutFileLocation](../constructors/inputTakeoutFileLocation.md) + +[inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) + +[inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) + +[inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) + +[inputStickerSetThumb](../constructors/inputStickerSetThumb.md) + ### Methods that return an object of this type (methods): +[inputFileLocation](../constructors/inputFileLocation.md) + +[inputEncryptedFileLocation](../constructors/inputEncryptedFileLocation.md) + +[inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) + +[inputSecureFileLocation](../constructors/inputSecureFileLocation.md) + +[inputTakeoutFileLocation](../constructors/inputTakeoutFileLocation.md) + +[inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) + +[inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) + +[inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) + +[inputStickerSetThumb](../constructors/inputStickerSetThumb.md) + diff --git a/old_docs/API_docs_v44/types/InputFolderPeer.md b/old_docs/API_docs_v44/types/InputFolderPeer.md new file mode 100644 index 00000000..31b81d37 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputFolderPeer.md @@ -0,0 +1,22 @@ +--- +title: InputFolderPeer +description: constructors and methods of type InputFolderPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputFolderPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputFolderPeer](../constructors/inputFolderPeer.md) + + + +### Methods that return an object of this type (methods): + + + +[inputFolderPeer](../constructors/inputFolderPeer.md) + diff --git a/old_docs/API_docs_v44/types/InputGame.md b/old_docs/API_docs_v44/types/InputGame.md new file mode 100644 index 00000000..62556ae1 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputGame.md @@ -0,0 +1,26 @@ +--- +title: InputGame +description: constructors and methods of type InputGame +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputGame +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputGameID](../constructors/inputGameID.md) + +[inputGameShortName](../constructors/inputGameShortName.md) + + + +### Methods that return an object of this type (methods): + + + +[inputGameID](../constructors/inputGameID.md) + +[inputGameShortName](../constructors/inputGameShortName.md) + diff --git a/old_docs/API_docs_v44/types/InputGeoPoint.md b/old_docs/API_docs_v44/types/InputGeoPoint.md index 87ea6c09..89e0c058 100644 --- a/old_docs/API_docs_v44/types/InputGeoPoint.md +++ b/old_docs/API_docs_v44/types/InputGeoPoint.md @@ -3,7 +3,7 @@ title: InputGeoPoint description: constructors and methods of type InputGeoPoint image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputGeoPoint +# Type: InputGeoPoint [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[inputGeoPointEmpty](../constructors/inputGeoPointEmpty.md) + +[inputGeoPoint](../constructors/inputGeoPoint.md) + diff --git a/old_docs/API_docs_v44/types/InputMedia.md b/old_docs/API_docs_v44/types/InputMedia.md index c026d36f..4865f86c 100644 --- a/old_docs/API_docs_v44/types/InputMedia.md +++ b/old_docs/API_docs_v44/types/InputMedia.md @@ -3,13 +3,12 @@ title: InputMedia description: constructors and methods of type InputMedia image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputMedia +# Type: InputMedia [Back to types index](index.md) - - You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Document](Document.md), [Photo](Photo.md), [InputDocument](InputDocument.md), [InputPhoto](InputPhoto.md) here, MadelineProto will automatically convert it to the right type. + ### Possible values (constructors): [inputMediaEmpty](../constructors/inputMediaEmpty.md) @@ -22,25 +21,25 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [ [inputMediaContact](../constructors/inputMediaContact.md) -[inputMediaUploadedVideo](../constructors/inputMediaUploadedVideo.md) - -[inputMediaUploadedThumbVideo](../constructors/inputMediaUploadedThumbVideo.md) - -[inputMediaVideo](../constructors/inputMediaVideo.md) - -[inputMediaUploadedAudio](../constructors/inputMediaUploadedAudio.md) - -[inputMediaAudio](../constructors/inputMediaAudio.md) - [inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) -[inputMediaUploadedThumbDocument](../constructors/inputMediaUploadedThumbDocument.md) - [inputMediaDocument](../constructors/inputMediaDocument.md) [inputMediaVenue](../constructors/inputMediaVenue.md) -[inputMediaGifExternal](../constructors/inputMediaGifExternal.md) +[inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md) + +[inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md) + +[inputMediaGame](../constructors/inputMediaGame.md) + +[inputMediaInvoice](../constructors/inputMediaInvoice.md) + +[inputMediaGeoLive](../constructors/inputMediaGeoLive.md) + +[inputMediaPoll](../constructors/inputMediaPoll.md) + +[inputMediaDice](../constructors/inputMediaDice.md) @@ -48,3 +47,33 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [ +[inputMediaEmpty](../constructors/inputMediaEmpty.md) + +[inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) + +[inputMediaPhoto](../constructors/inputMediaPhoto.md) + +[inputMediaGeoPoint](../constructors/inputMediaGeoPoint.md) + +[inputMediaContact](../constructors/inputMediaContact.md) + +[inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) + +[inputMediaDocument](../constructors/inputMediaDocument.md) + +[inputMediaVenue](../constructors/inputMediaVenue.md) + +[inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md) + +[inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md) + +[inputMediaGame](../constructors/inputMediaGame.md) + +[inputMediaInvoice](../constructors/inputMediaInvoice.md) + +[inputMediaGeoLive](../constructors/inputMediaGeoLive.md) + +[inputMediaPoll](../constructors/inputMediaPoll.md) + +[inputMediaDice](../constructors/inputMediaDice.md) + diff --git a/old_docs/API_docs_v44/types/InputMessage.md b/old_docs/API_docs_v44/types/InputMessage.md new file mode 100644 index 00000000..bcb99201 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputMessage.md @@ -0,0 +1,37 @@ +--- +title: InputMessage +description: constructors and methods of type InputMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputMessage +[Back to types index](index.md) + +The following syntax can also be used: + +```php +$InputMessage = 142; // Numeric message ID +``` + + + + +### Possible values (constructors): + +[inputMessageID](../constructors/inputMessageID.md) + +[inputMessageReplyTo](../constructors/inputMessageReplyTo.md) + +[inputMessagePinned](../constructors/inputMessagePinned.md) + + + +### Methods that return an object of this type (methods): + + + +[inputMessageID](../constructors/inputMessageID.md) + +[inputMessageReplyTo](../constructors/inputMessageReplyTo.md) + +[inputMessagePinned](../constructors/inputMessagePinned.md) + diff --git a/old_docs/API_docs_v44/types/InputNotifyPeer.md b/old_docs/API_docs_v44/types/InputNotifyPeer.md index ffc1f0cf..b6a400e1 100644 --- a/old_docs/API_docs_v44/types/InputNotifyPeer.md +++ b/old_docs/API_docs_v44/types/InputNotifyPeer.md @@ -3,16 +3,14 @@ title: InputNotifyPeer description: constructors and methods of type InputNotifyPeer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputNotifyPeer +# Type: InputNotifyPeer [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $InputNotifyPeer = '@username'; // Username $InputNotifyPeer = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $InputNotifyPeer = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [inputNotifyPeer](../constructors/inputNotifyPeer.md) @@ -40,7 +40,7 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia [inputNotifyChats](../constructors/inputNotifyChats.md) -[inputNotifyAll](../constructors/inputNotifyAll.md) +[inputNotifyBroadcasts](../constructors/inputNotifyBroadcasts.md) @@ -48,3 +48,11 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia +[inputNotifyPeer](../constructors/inputNotifyPeer.md) + +[inputNotifyUsers](../constructors/inputNotifyUsers.md) + +[inputNotifyChats](../constructors/inputNotifyChats.md) + +[inputNotifyBroadcasts](../constructors/inputNotifyBroadcasts.md) + diff --git a/old_docs/API_docs_v44/types/InputPaymentCredentials.md b/old_docs/API_docs_v44/types/InputPaymentCredentials.md new file mode 100644 index 00000000..64a1454f --- /dev/null +++ b/old_docs/API_docs_v44/types/InputPaymentCredentials.md @@ -0,0 +1,34 @@ +--- +title: InputPaymentCredentials +description: constructors and methods of type InputPaymentCredentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPaymentCredentials +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPaymentCredentialsSaved](../constructors/inputPaymentCredentialsSaved.md) + +[inputPaymentCredentials](../constructors/inputPaymentCredentials.md) + +[inputPaymentCredentialsApplePay](../constructors/inputPaymentCredentialsApplePay.md) + +[inputPaymentCredentialsAndroidPay](../constructors/inputPaymentCredentialsAndroidPay.md) + + + +### Methods that return an object of this type (methods): + + + +[inputPaymentCredentialsSaved](../constructors/inputPaymentCredentialsSaved.md) + +[inputPaymentCredentials](../constructors/inputPaymentCredentials.md) + +[inputPaymentCredentialsApplePay](../constructors/inputPaymentCredentialsApplePay.md) + +[inputPaymentCredentialsAndroidPay](../constructors/inputPaymentCredentialsAndroidPay.md) + diff --git a/old_docs/API_docs_v44/types/InputPeer.md b/old_docs/API_docs_v44/types/InputPeer.md index 2076c00b..881c032f 100644 --- a/old_docs/API_docs_v44/types/InputPeer.md +++ b/old_docs/API_docs_v44/types/InputPeer.md @@ -3,16 +3,14 @@ title: InputPeer description: constructors and methods of type InputPeer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputPeer +# Type: InputPeer [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $InputPeer = '@username'; // Username $InputPeer = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $InputPeer = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [inputPeerEmpty](../constructors/inputPeerEmpty.md) @@ -44,9 +44,27 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia [inputPeerChannel](../constructors/inputPeerChannel.md) +[inputPeerUserFromMessage](../constructors/inputPeerUserFromMessage.md) + +[inputPeerChannelFromMessage](../constructors/inputPeerChannelFromMessage.md) + ### Methods that return an object of this type (methods): +[inputPeerEmpty](../constructors/inputPeerEmpty.md) + +[inputPeerSelf](../constructors/inputPeerSelf.md) + +[inputPeerChat](../constructors/inputPeerChat.md) + +[inputPeerUser](../constructors/inputPeerUser.md) + +[inputPeerChannel](../constructors/inputPeerChannel.md) + +[inputPeerUserFromMessage](../constructors/inputPeerUserFromMessage.md) + +[inputPeerChannelFromMessage](../constructors/inputPeerChannelFromMessage.md) + diff --git a/old_docs/API_docs_v44/types/InputPeerNotifyEvents.md b/old_docs/API_docs_v44/types/InputPeerNotifyEvents.md deleted file mode 100644 index 422672d4..00000000 --- a/old_docs/API_docs_v44/types/InputPeerNotifyEvents.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: InputPeerNotifyEvents -description: constructors and methods of type InputPeerNotifyEvents -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Type: InputPeerNotifyEvents -[Back to types index](index.md) - - - -### Possible values (constructors): - -[inputPeerNotifyEventsEmpty](../constructors/inputPeerNotifyEventsEmpty.md) - -[inputPeerNotifyEventsAll](../constructors/inputPeerNotifyEventsAll.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/old_docs/API_docs_v44/types/InputPeerNotifySettings.md b/old_docs/API_docs_v44/types/InputPeerNotifySettings.md index 47645252..14bb1d35 100644 --- a/old_docs/API_docs_v44/types/InputPeerNotifySettings.md +++ b/old_docs/API_docs_v44/types/InputPeerNotifySettings.md @@ -3,7 +3,7 @@ title: InputPeerNotifySettings description: constructors and methods of type InputPeerNotifySettings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputPeerNotifySettings +# Type: InputPeerNotifySettings [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[inputPeerNotifySettings](../constructors/inputPeerNotifySettings.md) + diff --git a/old_docs/API_docs_v44/types/InputPhoneCall.md b/old_docs/API_docs_v44/types/InputPhoneCall.md new file mode 100644 index 00000000..7b90b4a1 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputPhoneCall.md @@ -0,0 +1,22 @@ +--- +title: InputPhoneCall +description: constructors and methods of type InputPhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPhoneCall +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPhoneCall](../constructors/inputPhoneCall.md) + + + +### Methods that return an object of this type (methods): + + + +[inputPhoneCall](../constructors/inputPhoneCall.md) + diff --git a/old_docs/API_docs_v44/types/InputPhoto.md b/old_docs/API_docs_v44/types/InputPhoto.md index fbad241d..beab93c1 100644 --- a/old_docs/API_docs_v44/types/InputPhoto.md +++ b/old_docs/API_docs_v44/types/InputPhoto.md @@ -3,13 +3,12 @@ title: InputPhoto description: constructors and methods of type InputPhoto image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputPhoto +# Type: InputPhoto [Back to types index](index.md) - - You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Photo](Photo.md) here, MadelineProto will automatically convert it to the right type. + ### Possible values (constructors): [inputPhotoEmpty](../constructors/inputPhotoEmpty.md) @@ -22,3 +21,7 @@ You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [ +[inputPhotoEmpty](../constructors/inputPhotoEmpty.md) + +[inputPhoto](../constructors/inputPhoto.md) + diff --git a/old_docs/API_docs_v44/types/InputPhotoCrop.md b/old_docs/API_docs_v44/types/InputPhotoCrop.md deleted file mode 100644 index 89199b81..00000000 --- a/old_docs/API_docs_v44/types/InputPhotoCrop.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: InputPhotoCrop -description: constructors and methods of type InputPhotoCrop -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Type: InputPhotoCrop -[Back to types index](index.md) - - - -### Possible values (constructors): - -[inputPhotoCropAuto](../constructors/inputPhotoCropAuto.md) - -[inputPhotoCrop](../constructors/inputPhotoCrop.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/old_docs/API_docs_v44/types/InputPrivacyKey.md b/old_docs/API_docs_v44/types/InputPrivacyKey.md index 886bee4c..f0b91010 100644 --- a/old_docs/API_docs_v44/types/InputPrivacyKey.md +++ b/old_docs/API_docs_v44/types/InputPrivacyKey.md @@ -3,7 +3,7 @@ title: InputPrivacyKey description: constructors and methods of type InputPrivacyKey image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputPrivacyKey +# Type: InputPrivacyKey [Back to types index](index.md) @@ -12,9 +12,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputPrivacyKeyStatusTimestamp](../constructors/inputPrivacyKeyStatusTimestamp.md) +[inputPrivacyKeyChatInvite](../constructors/inputPrivacyKeyChatInvite.md) + +[inputPrivacyKeyPhoneCall](../constructors/inputPrivacyKeyPhoneCall.md) + +[inputPrivacyKeyPhoneP2P](../constructors/inputPrivacyKeyPhoneP2P.md) + +[inputPrivacyKeyForwards](../constructors/inputPrivacyKeyForwards.md) + +[inputPrivacyKeyProfilePhoto](../constructors/inputPrivacyKeyProfilePhoto.md) + +[inputPrivacyKeyPhoneNumber](../constructors/inputPrivacyKeyPhoneNumber.md) + +[inputPrivacyKeyAddedByPhone](../constructors/inputPrivacyKeyAddedByPhone.md) + ### Methods that return an object of this type (methods): +[inputPrivacyKeyStatusTimestamp](../constructors/inputPrivacyKeyStatusTimestamp.md) + +[inputPrivacyKeyChatInvite](../constructors/inputPrivacyKeyChatInvite.md) + +[inputPrivacyKeyPhoneCall](../constructors/inputPrivacyKeyPhoneCall.md) + +[inputPrivacyKeyPhoneP2P](../constructors/inputPrivacyKeyPhoneP2P.md) + +[inputPrivacyKeyForwards](../constructors/inputPrivacyKeyForwards.md) + +[inputPrivacyKeyProfilePhoto](../constructors/inputPrivacyKeyProfilePhoto.md) + +[inputPrivacyKeyPhoneNumber](../constructors/inputPrivacyKeyPhoneNumber.md) + +[inputPrivacyKeyAddedByPhone](../constructors/inputPrivacyKeyAddedByPhone.md) + diff --git a/old_docs/API_docs_v44/types/InputPrivacyRule.md b/old_docs/API_docs_v44/types/InputPrivacyRule.md index 92abf96f..a82c8269 100644 --- a/old_docs/API_docs_v44/types/InputPrivacyRule.md +++ b/old_docs/API_docs_v44/types/InputPrivacyRule.md @@ -3,7 +3,7 @@ title: InputPrivacyRule description: constructors and methods of type InputPrivacyRule image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputPrivacyRule +# Type: InputPrivacyRule [Back to types index](index.md) @@ -22,9 +22,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputPrivacyValueDisallowUsers](../constructors/inputPrivacyValueDisallowUsers.md) +[inputPrivacyValueAllowChatParticipants](../constructors/inputPrivacyValueAllowChatParticipants.md) + +[inputPrivacyValueDisallowChatParticipants](../constructors/inputPrivacyValueDisallowChatParticipants.md) + ### Methods that return an object of this type (methods): +[inputPrivacyValueAllowContacts](../constructors/inputPrivacyValueAllowContacts.md) + +[inputPrivacyValueAllowAll](../constructors/inputPrivacyValueAllowAll.md) + +[inputPrivacyValueAllowUsers](../constructors/inputPrivacyValueAllowUsers.md) + +[inputPrivacyValueDisallowContacts](../constructors/inputPrivacyValueDisallowContacts.md) + +[inputPrivacyValueDisallowAll](../constructors/inputPrivacyValueDisallowAll.md) + +[inputPrivacyValueDisallowUsers](../constructors/inputPrivacyValueDisallowUsers.md) + +[inputPrivacyValueAllowChatParticipants](../constructors/inputPrivacyValueAllowChatParticipants.md) + +[inputPrivacyValueDisallowChatParticipants](../constructors/inputPrivacyValueDisallowChatParticipants.md) + diff --git a/old_docs/API_docs_v44/types/InputSecureFile.md b/old_docs/API_docs_v44/types/InputSecureFile.md new file mode 100644 index 00000000..ac182315 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputSecureFile.md @@ -0,0 +1,26 @@ +--- +title: InputSecureFile +description: constructors and methods of type InputSecureFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSecureFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSecureFileUploaded](../constructors/inputSecureFileUploaded.md) + +[inputSecureFile](../constructors/inputSecureFile.md) + + + +### Methods that return an object of this type (methods): + + + +[inputSecureFileUploaded](../constructors/inputSecureFileUploaded.md) + +[inputSecureFile](../constructors/inputSecureFile.md) + diff --git a/old_docs/API_docs_v44/types/InputSecureValue.md b/old_docs/API_docs_v44/types/InputSecureValue.md new file mode 100644 index 00000000..8ae753bc --- /dev/null +++ b/old_docs/API_docs_v44/types/InputSecureValue.md @@ -0,0 +1,22 @@ +--- +title: InputSecureValue +description: constructors and methods of type InputSecureValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSecureValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSecureValue](../constructors/inputSecureValue.md) + + + +### Methods that return an object of this type (methods): + + + +[inputSecureValue](../constructors/inputSecureValue.md) + diff --git a/old_docs/API_docs_v44/types/InputSingleMedia.md b/old_docs/API_docs_v44/types/InputSingleMedia.md new file mode 100644 index 00000000..11fd07a0 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputSingleMedia.md @@ -0,0 +1,22 @@ +--- +title: InputSingleMedia +description: constructors and methods of type InputSingleMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSingleMedia +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSingleMedia](../constructors/inputSingleMedia.md) + + + +### Methods that return an object of this type (methods): + + + +[inputSingleMedia](../constructors/inputSingleMedia.md) + diff --git a/old_docs/API_docs_v44/types/InputStickerSet.md b/old_docs/API_docs_v44/types/InputStickerSet.md index 4ab0897c..029f9646 100644 --- a/old_docs/API_docs_v44/types/InputStickerSet.md +++ b/old_docs/API_docs_v44/types/InputStickerSet.md @@ -3,7 +3,7 @@ title: InputStickerSet description: constructors and methods of type InputStickerSet image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputStickerSet +# Type: InputStickerSet [Back to types index](index.md) @@ -16,9 +16,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputStickerSetShortName](../constructors/inputStickerSetShortName.md) +[inputStickerSetAnimatedEmoji](../constructors/inputStickerSetAnimatedEmoji.md) + +[inputStickerSetDice](../constructors/inputStickerSetDice.md) + ### Methods that return an object of this type (methods): +[inputStickerSetEmpty](../constructors/inputStickerSetEmpty.md) + +[inputStickerSetID](../constructors/inputStickerSetID.md) + +[inputStickerSetShortName](../constructors/inputStickerSetShortName.md) + +[inputStickerSetAnimatedEmoji](../constructors/inputStickerSetAnimatedEmoji.md) + +[inputStickerSetDice](../constructors/inputStickerSetDice.md) + diff --git a/old_docs/API_docs_v44/types/InputStickerSetItem.md b/old_docs/API_docs_v44/types/InputStickerSetItem.md new file mode 100644 index 00000000..33cd4751 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputStickerSetItem.md @@ -0,0 +1,22 @@ +--- +title: InputStickerSetItem +description: constructors and methods of type InputStickerSetItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputStickerSetItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputStickerSetItem](../constructors/inputStickerSetItem.md) + + + +### Methods that return an object of this type (methods): + + + +[inputStickerSetItem](../constructors/inputStickerSetItem.md) + diff --git a/old_docs/API_docs_v44/types/InputStickeredMedia.md b/old_docs/API_docs_v44/types/InputStickeredMedia.md new file mode 100644 index 00000000..608d923e --- /dev/null +++ b/old_docs/API_docs_v44/types/InputStickeredMedia.md @@ -0,0 +1,26 @@ +--- +title: InputStickeredMedia +description: constructors and methods of type InputStickeredMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputStickeredMedia +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputStickeredMediaPhoto](../constructors/inputStickeredMediaPhoto.md) + +[inputStickeredMediaDocument](../constructors/inputStickeredMediaDocument.md) + + + +### Methods that return an object of this type (methods): + + + +[inputStickeredMediaPhoto](../constructors/inputStickeredMediaPhoto.md) + +[inputStickeredMediaDocument](../constructors/inputStickeredMediaDocument.md) + diff --git a/old_docs/API_docs_v44/types/InputTheme.md b/old_docs/API_docs_v44/types/InputTheme.md new file mode 100644 index 00000000..e9a18105 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputTheme.md @@ -0,0 +1,26 @@ +--- +title: InputTheme +description: constructors and methods of type InputTheme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputTheme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputTheme](../constructors/inputTheme.md) + +[inputThemeSlug](../constructors/inputThemeSlug.md) + + + +### Methods that return an object of this type (methods): + + + +[inputTheme](../constructors/inputTheme.md) + +[inputThemeSlug](../constructors/inputThemeSlug.md) + diff --git a/old_docs/API_docs_v44/types/InputThemeSettings.md b/old_docs/API_docs_v44/types/InputThemeSettings.md new file mode 100644 index 00000000..d31304f4 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputThemeSettings.md @@ -0,0 +1,22 @@ +--- +title: InputThemeSettings +description: constructors and methods of type InputThemeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputThemeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputThemeSettings](../constructors/inputThemeSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[inputThemeSettings](../constructors/inputThemeSettings.md) + diff --git a/old_docs/API_docs_v44/types/InputUser.md b/old_docs/API_docs_v44/types/InputUser.md index 7778caf6..2fdb2761 100644 --- a/old_docs/API_docs_v44/types/InputUser.md +++ b/old_docs/API_docs_v44/types/InputUser.md @@ -3,16 +3,14 @@ title: InputUser description: constructors and methods of type InputUser image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: InputUser +# Type: InputUser [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $InputUser = '@username'; // Username $InputUser = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $InputUser = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [inputUserEmpty](../constructors/inputUserEmpty.md) @@ -40,9 +40,19 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia [inputUser](../constructors/inputUser.md) +[inputUserFromMessage](../constructors/inputUserFromMessage.md) + ### Methods that return an object of this type (methods): +[inputUserEmpty](../constructors/inputUserEmpty.md) + +[inputUserSelf](../constructors/inputUserSelf.md) + +[inputUser](../constructors/inputUser.md) + +[inputUserFromMessage](../constructors/inputUserFromMessage.md) + diff --git a/old_docs/API_docs_v44/types/InputWallPaper.md b/old_docs/API_docs_v44/types/InputWallPaper.md new file mode 100644 index 00000000..0619a684 --- /dev/null +++ b/old_docs/API_docs_v44/types/InputWallPaper.md @@ -0,0 +1,30 @@ +--- +title: InputWallPaper +description: constructors and methods of type InputWallPaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWallPaper +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWallPaper](../constructors/inputWallPaper.md) + +[inputWallPaperSlug](../constructors/inputWallPaperSlug.md) + +[inputWallPaperNoFile](../constructors/inputWallPaperNoFile.md) + + + +### Methods that return an object of this type (methods): + + + +[inputWallPaper](../constructors/inputWallPaper.md) + +[inputWallPaperSlug](../constructors/inputWallPaperSlug.md) + +[inputWallPaperNoFile](../constructors/inputWallPaperNoFile.md) + diff --git a/old_docs/API_docs_v44/types/InputWebDocument.md b/old_docs/API_docs_v44/types/InputWebDocument.md new file mode 100644 index 00000000..7551f7ca --- /dev/null +++ b/old_docs/API_docs_v44/types/InputWebDocument.md @@ -0,0 +1,22 @@ +--- +title: InputWebDocument +description: constructors and methods of type InputWebDocument +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWebDocument +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWebDocument](../constructors/inputWebDocument.md) + + + +### Methods that return an object of this type (methods): + + + +[inputWebDocument](../constructors/inputWebDocument.md) + diff --git a/old_docs/API_docs_v44/types/InputWebFileLocation.md b/old_docs/API_docs_v44/types/InputWebFileLocation.md new file mode 100644 index 00000000..084153bc --- /dev/null +++ b/old_docs/API_docs_v44/types/InputWebFileLocation.md @@ -0,0 +1,26 @@ +--- +title: InputWebFileLocation +description: constructors and methods of type InputWebFileLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWebFileLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWebFileLocation](../constructors/inputWebFileLocation.md) + +[inputWebFileGeoPointLocation](../constructors/inputWebFileGeoPointLocation.md) + + + +### Methods that return an object of this type (methods): + + + +[inputWebFileLocation](../constructors/inputWebFileLocation.md) + +[inputWebFileGeoPointLocation](../constructors/inputWebFileGeoPointLocation.md) + diff --git a/old_docs/API_docs_v44/types/Video.md b/old_docs/API_docs_v44/types/Invoice.md similarity index 57% rename from old_docs/API_docs_v44/types/Video.md rename to old_docs/API_docs_v44/types/Invoice.md index e5e0c879..6a40db05 100644 --- a/old_docs/API_docs_v44/types/Video.md +++ b/old_docs/API_docs_v44/types/Invoice.md @@ -1,18 +1,16 @@ --- -title: Video -description: constructors and methods of type Video +title: Invoice +description: constructors and methods of type Invoice image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Video +# Type: Invoice [Back to types index](index.md) ### Possible values (constructors): -[videoEmpty](../constructors/videoEmpty.md) - -[video](../constructors/video.md) +[invoice](../constructors/invoice.md) @@ -20,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[invoice](../constructors/invoice.md) + diff --git a/old_docs/API_docs_v44/types/JSONObjectValue.md b/old_docs/API_docs_v44/types/JSONObjectValue.md new file mode 100644 index 00000000..528501d7 --- /dev/null +++ b/old_docs/API_docs_v44/types/JSONObjectValue.md @@ -0,0 +1,22 @@ +--- +title: JSONObjectValue +description: constructors and methods of type JSONObjectValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: JSONObjectValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[jsonObjectValue](../constructors/jsonObjectValue.md) + + + +### Methods that return an object of this type (methods): + + + +[jsonObjectValue](../constructors/jsonObjectValue.md) + diff --git a/old_docs/API_docs_v44/types/JSONValue.md b/old_docs/API_docs_v44/types/JSONValue.md new file mode 100644 index 00000000..7287a589 --- /dev/null +++ b/old_docs/API_docs_v44/types/JSONValue.md @@ -0,0 +1,46 @@ +--- +title: JSONValue +description: constructors and methods of type JSONValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: JSONValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[jsonNull](../constructors/jsonNull.md) + +[jsonBool](../constructors/jsonBool.md) + +[jsonNumber](../constructors/jsonNumber.md) + +[jsonString](../constructors/jsonString.md) + +[jsonArray](../constructors/jsonArray.md) + +[jsonObject](../constructors/jsonObject.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getAppConfig](../methods/help.getAppConfig.md) + + + +[jsonNull](../constructors/jsonNull.md) + +[jsonBool](../constructors/jsonBool.md) + +[jsonNumber](../constructors/jsonNumber.md) + +[jsonString](../constructors/jsonString.md) + +[jsonArray](../constructors/jsonArray.md) + +[jsonObject](../constructors/jsonObject.md) + +[$MadelineProto->help->getAppConfig](../methods/help.getAppConfig.md) + diff --git a/old_docs/API_docs_v44/types/KeyboardButton.md b/old_docs/API_docs_v44/types/KeyboardButton.md index 6dbace3f..50892e28 100644 --- a/old_docs/API_docs_v44/types/KeyboardButton.md +++ b/old_docs/API_docs_v44/types/KeyboardButton.md @@ -3,16 +3,14 @@ title: KeyboardButton description: constructors and methods of type KeyboardButton image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: KeyboardButton +# Type: KeyboardButton [Back to types index](index.md) - - Clicking these buttons: To click these buttons simply run the `click` method: -``` +```php $result = $KeyboardButton->click(); ``` @@ -28,14 +26,58 @@ $result = $KeyboardButton->click(); * `false` - If the button is an unsupported button, like keyboardButtonRequestPhone, keyboardButtonRequestGeoLocation, keyboardButtonSwitchInlinekeyboardButtonBuy; you will have to parse data from these buttons manually -You can also access the properties of the constructor as a normal array, for example $button['name'] +You can also access the properties of the constructor as a normal array, for example `$button['name']` + + ### Possible values (constructors): [keyboardButton](../constructors/keyboardButton.md) +[keyboardButtonUrl](../constructors/keyboardButtonUrl.md) + +[keyboardButtonCallback](../constructors/keyboardButtonCallback.md) + +[keyboardButtonRequestPhone](../constructors/keyboardButtonRequestPhone.md) + +[keyboardButtonRequestGeoLocation](../constructors/keyboardButtonRequestGeoLocation.md) + +[keyboardButtonSwitchInline](../constructors/keyboardButtonSwitchInline.md) + +[keyboardButtonGame](../constructors/keyboardButtonGame.md) + +[keyboardButtonBuy](../constructors/keyboardButtonBuy.md) + +[keyboardButtonUrlAuth](../constructors/keyboardButtonUrlAuth.md) + +[inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) + +[keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) + ### Methods that return an object of this type (methods): +[keyboardButton](../constructors/keyboardButton.md) + +[keyboardButtonUrl](../constructors/keyboardButtonUrl.md) + +[keyboardButtonCallback](../constructors/keyboardButtonCallback.md) + +[keyboardButtonRequestPhone](../constructors/keyboardButtonRequestPhone.md) + +[keyboardButtonRequestGeoLocation](../constructors/keyboardButtonRequestGeoLocation.md) + +[keyboardButtonSwitchInline](../constructors/keyboardButtonSwitchInline.md) + +[keyboardButtonGame](../constructors/keyboardButtonGame.md) + +[keyboardButtonBuy](../constructors/keyboardButtonBuy.md) + +[keyboardButtonUrlAuth](../constructors/keyboardButtonUrlAuth.md) + +[inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) + +[keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) + diff --git a/old_docs/API_docs_v44/types/KeyboardButtonRow.md b/old_docs/API_docs_v44/types/KeyboardButtonRow.md index 03bf724e..8a81c7f4 100644 --- a/old_docs/API_docs_v44/types/KeyboardButtonRow.md +++ b/old_docs/API_docs_v44/types/KeyboardButtonRow.md @@ -3,7 +3,7 @@ title: KeyboardButtonRow description: constructors and methods of type KeyboardButtonRow image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: KeyboardButtonRow +# Type: KeyboardButtonRow [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[keyboardButtonRow](../constructors/keyboardButtonRow.md) + diff --git a/old_docs/API_docs_v44/types/LabeledPrice.md b/old_docs/API_docs_v44/types/LabeledPrice.md new file mode 100644 index 00000000..4f358bd0 --- /dev/null +++ b/old_docs/API_docs_v44/types/LabeledPrice.md @@ -0,0 +1,22 @@ +--- +title: LabeledPrice +description: constructors and methods of type LabeledPrice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LabeledPrice +[Back to types index](index.md) + + + +### Possible values (constructors): + +[labeledPrice](../constructors/labeledPrice.md) + + + +### Methods that return an object of this type (methods): + + + +[labeledPrice](../constructors/labeledPrice.md) + diff --git a/old_docs/API_docs_v44/types/LangPackDifference.md b/old_docs/API_docs_v44/types/LangPackDifference.md new file mode 100644 index 00000000..b7176d61 --- /dev/null +++ b/old_docs/API_docs_v44/types/LangPackDifference.md @@ -0,0 +1,30 @@ +--- +title: LangPackDifference +description: constructors and methods of type LangPackDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackDifference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackDifference](../constructors/langPackDifference.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getLangPack](../methods/langpack.getLangPack.md) + +[$MadelineProto->langpack->getDifference](../methods/langpack.getDifference.md) + + + +[langPackDifference](../constructors/langPackDifference.md) + +[$MadelineProto->langpack->getLangPack](../methods/langpack.getLangPack.md) + +[$MadelineProto->langpack->getDifference](../methods/langpack.getDifference.md) + diff --git a/old_docs/API_docs_v44/types/LangPackLanguage.md b/old_docs/API_docs_v44/types/LangPackLanguage.md new file mode 100644 index 00000000..2a33f811 --- /dev/null +++ b/old_docs/API_docs_v44/types/LangPackLanguage.md @@ -0,0 +1,30 @@ +--- +title: LangPackLanguage +description: constructors and methods of type LangPackLanguage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackLanguage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackLanguage](../constructors/langPackLanguage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getLanguages](../methods/langpack.getLanguages.md) + +[$MadelineProto->langpack->getLanguage](../methods/langpack.getLanguage.md) + + + +[langPackLanguage](../constructors/langPackLanguage.md) + +[$MadelineProto->langpack->getLanguages](../methods/langpack.getLanguages.md) + +[$MadelineProto->langpack->getLanguage](../methods/langpack.getLanguage.md) + diff --git a/old_docs/API_docs_v44/types/LangPackString.md b/old_docs/API_docs_v44/types/LangPackString.md new file mode 100644 index 00000000..c43e0691 --- /dev/null +++ b/old_docs/API_docs_v44/types/LangPackString.md @@ -0,0 +1,34 @@ +--- +title: LangPackString +description: constructors and methods of type LangPackString +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackString +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackString](../constructors/langPackString.md) + +[langPackStringPluralized](../constructors/langPackStringPluralized.md) + +[langPackStringDeleted](../constructors/langPackStringDeleted.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getStrings](../methods/langpack.getStrings.md) + + + +[langPackString](../constructors/langPackString.md) + +[langPackStringPluralized](../constructors/langPackStringPluralized.md) + +[langPackStringDeleted](../constructors/langPackStringDeleted.md) + +[$MadelineProto->langpack->getStrings](../methods/langpack.getStrings.md) + diff --git a/old_docs/API_docs_v44/types/MaskCoords.md b/old_docs/API_docs_v44/types/MaskCoords.md new file mode 100644 index 00000000..2009aa73 --- /dev/null +++ b/old_docs/API_docs_v44/types/MaskCoords.md @@ -0,0 +1,22 @@ +--- +title: MaskCoords +description: constructors and methods of type MaskCoords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MaskCoords +[Back to types index](index.md) + + + +### Possible values (constructors): + +[maskCoords](../constructors/maskCoords.md) + + + +### Methods that return an object of this type (methods): + + + +[maskCoords](../constructors/maskCoords.md) + diff --git a/old_docs/API_docs_v44/types/Message.md b/old_docs/API_docs_v44/types/Message.md index b306c73c..98fe0b5b 100644 --- a/old_docs/API_docs_v44/types/Message.md +++ b/old_docs/API_docs_v44/types/Message.md @@ -3,7 +3,7 @@ title: Message description: constructors and methods of type Message image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Message +# Type: Message [Back to types index](index.md) @@ -22,3 +22,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[messageEmpty](../constructors/messageEmpty.md) + +[message](../constructors/message.md) + +[messageService](../constructors/messageService.md) + diff --git a/old_docs/API_docs_v44/types/MessageAction.md b/old_docs/API_docs_v44/types/MessageAction.md index fd82752d..ad5f15b4 100644 --- a/old_docs/API_docs_v44/types/MessageAction.md +++ b/old_docs/API_docs_v44/types/MessageAction.md @@ -3,7 +3,7 @@ title: MessageAction description: constructors and methods of type MessageAction image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessageAction +# Type: MessageAction [Back to types index](index.md) @@ -32,9 +32,79 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messageActionChannelMigrateFrom](../constructors/messageActionChannelMigrateFrom.md) +[messageActionPinMessage](../constructors/messageActionPinMessage.md) + +[messageActionHistoryClear](../constructors/messageActionHistoryClear.md) + +[messageActionGameScore](../constructors/messageActionGameScore.md) + +[messageActionPaymentSentMe](../constructors/messageActionPaymentSentMe.md) + +[messageActionPaymentSent](../constructors/messageActionPaymentSent.md) + +[messageActionPhoneCall](../constructors/messageActionPhoneCall.md) + +[messageActionScreenshotTaken](../constructors/messageActionScreenshotTaken.md) + +[messageActionCustomAction](../constructors/messageActionCustomAction.md) + +[messageActionBotAllowed](../constructors/messageActionBotAllowed.md) + +[messageActionSecureValuesSentMe](../constructors/messageActionSecureValuesSentMe.md) + +[messageActionSecureValuesSent](../constructors/messageActionSecureValuesSent.md) + +[messageActionContactSignUp](../constructors/messageActionContactSignUp.md) + ### Methods that return an object of this type (methods): +[messageActionEmpty](../constructors/messageActionEmpty.md) + +[messageActionChatCreate](../constructors/messageActionChatCreate.md) + +[messageActionChatEditTitle](../constructors/messageActionChatEditTitle.md) + +[messageActionChatEditPhoto](../constructors/messageActionChatEditPhoto.md) + +[messageActionChatDeletePhoto](../constructors/messageActionChatDeletePhoto.md) + +[messageActionChatAddUser](../constructors/messageActionChatAddUser.md) + +[messageActionChatDeleteUser](../constructors/messageActionChatDeleteUser.md) + +[messageActionChatJoinedByLink](../constructors/messageActionChatJoinedByLink.md) + +[messageActionChannelCreate](../constructors/messageActionChannelCreate.md) + +[messageActionChatMigrateTo](../constructors/messageActionChatMigrateTo.md) + +[messageActionChannelMigrateFrom](../constructors/messageActionChannelMigrateFrom.md) + +[messageActionPinMessage](../constructors/messageActionPinMessage.md) + +[messageActionHistoryClear](../constructors/messageActionHistoryClear.md) + +[messageActionGameScore](../constructors/messageActionGameScore.md) + +[messageActionPaymentSentMe](../constructors/messageActionPaymentSentMe.md) + +[messageActionPaymentSent](../constructors/messageActionPaymentSent.md) + +[messageActionPhoneCall](../constructors/messageActionPhoneCall.md) + +[messageActionScreenshotTaken](../constructors/messageActionScreenshotTaken.md) + +[messageActionCustomAction](../constructors/messageActionCustomAction.md) + +[messageActionBotAllowed](../constructors/messageActionBotAllowed.md) + +[messageActionSecureValuesSentMe](../constructors/messageActionSecureValuesSentMe.md) + +[messageActionSecureValuesSent](../constructors/messageActionSecureValuesSent.md) + +[messageActionContactSignUp](../constructors/messageActionContactSignUp.md) + diff --git a/old_docs/API_docs_v44/types/MessageEntity.md b/old_docs/API_docs_v44/types/MessageEntity.md index 04aefc1a..0a3c9238 100644 --- a/old_docs/API_docs_v44/types/MessageEntity.md +++ b/old_docs/API_docs_v44/types/MessageEntity.md @@ -3,7 +3,7 @@ title: MessageEntity description: constructors and methods of type MessageEntity image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessageEntity +# Type: MessageEntity [Back to types index](index.md) @@ -32,9 +32,63 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messageEntityTextUrl](../constructors/messageEntityTextUrl.md) +[messageEntityMentionName](../constructors/messageEntityMentionName.md) + +[inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md) + +[messageEntityPhone](../constructors/messageEntityPhone.md) + +[messageEntityCashtag](../constructors/messageEntityCashtag.md) + +[messageEntityUnderline](../constructors/messageEntityUnderline.md) + +[messageEntityStrike](../constructors/messageEntityStrike.md) + +[messageEntityBlockquote](../constructors/messageEntityBlockquote.md) + +[messageEntityBankCard](../constructors/messageEntityBankCard.md) + ### Methods that return an object of this type (methods): +[messageEntityUnknown](../constructors/messageEntityUnknown.md) + +[messageEntityMention](../constructors/messageEntityMention.md) + +[messageEntityHashtag](../constructors/messageEntityHashtag.md) + +[messageEntityBotCommand](../constructors/messageEntityBotCommand.md) + +[messageEntityUrl](../constructors/messageEntityUrl.md) + +[messageEntityEmail](../constructors/messageEntityEmail.md) + +[messageEntityBold](../constructors/messageEntityBold.md) + +[messageEntityItalic](../constructors/messageEntityItalic.md) + +[messageEntityCode](../constructors/messageEntityCode.md) + +[messageEntityPre](../constructors/messageEntityPre.md) + +[messageEntityTextUrl](../constructors/messageEntityTextUrl.md) + +[messageEntityMentionName](../constructors/messageEntityMentionName.md) + +[inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md) + +[messageEntityPhone](../constructors/messageEntityPhone.md) + +[messageEntityCashtag](../constructors/messageEntityCashtag.md) + +[messageEntityUnderline](../constructors/messageEntityUnderline.md) + +[messageEntityStrike](../constructors/messageEntityStrike.md) + +[messageEntityBlockquote](../constructors/messageEntityBlockquote.md) + +[messageEntityBankCard](../constructors/messageEntityBankCard.md) + diff --git a/old_docs/API_docs_v44/types/MessageFwdHeader.md b/old_docs/API_docs_v44/types/MessageFwdHeader.md new file mode 100644 index 00000000..1cc294a4 --- /dev/null +++ b/old_docs/API_docs_v44/types/MessageFwdHeader.md @@ -0,0 +1,22 @@ +--- +title: MessageFwdHeader +description: constructors and methods of type MessageFwdHeader +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageFwdHeader +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageFwdHeader](../constructors/messageFwdHeader.md) + + + +### Methods that return an object of this type (methods): + + + +[messageFwdHeader](../constructors/messageFwdHeader.md) + diff --git a/old_docs/API_docs_v44/types/MessageInteractionCounters.md b/old_docs/API_docs_v44/types/MessageInteractionCounters.md new file mode 100644 index 00000000..020c59e1 --- /dev/null +++ b/old_docs/API_docs_v44/types/MessageInteractionCounters.md @@ -0,0 +1,22 @@ +--- +title: MessageInteractionCounters +description: constructors and methods of type MessageInteractionCounters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageInteractionCounters +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageInteractionCounters](../constructors/messageInteractionCounters.md) + + + +### Methods that return an object of this type (methods): + + + +[messageInteractionCounters](../constructors/messageInteractionCounters.md) + diff --git a/old_docs/API_docs_v44/types/MessageMedia.md b/old_docs/API_docs_v44/types/MessageMedia.md index 9c8475d7..379647e6 100644 --- a/old_docs/API_docs_v44/types/MessageMedia.md +++ b/old_docs/API_docs_v44/types/MessageMedia.md @@ -3,7 +3,7 @@ title: MessageMedia description: constructors and methods of type MessageMedia image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessageMedia +# Type: MessageMedia [Back to types index](index.md) @@ -14,7 +14,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messageMediaPhoto](../constructors/messageMediaPhoto.md) -[messageMediaVideo](../constructors/messageMediaVideo.md) +[messageMediaGeo](../constructors/messageMediaGeo.md) + +[messageMediaContact](../constructors/messageMediaContact.md) + +[messageMediaUnsupported](../constructors/messageMediaUnsupported.md) + +[messageMediaDocument](../constructors/messageMediaDocument.md) + +[messageMediaWebPage](../constructors/messageMediaWebPage.md) + +[messageMediaVenue](../constructors/messageMediaVenue.md) + +[messageMediaGame](../constructors/messageMediaGame.md) + +[messageMediaInvoice](../constructors/messageMediaInvoice.md) + +[messageMediaGeoLive](../constructors/messageMediaGeoLive.md) + +[messageMediaPoll](../constructors/messageMediaPoll.md) + +[messageMediaDice](../constructors/messageMediaDice.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getWebPagePreview](../methods/messages.getWebPagePreview.md) + +[$MadelineProto->messages->uploadMedia](../methods/messages.uploadMedia.md) + + + +[messageMediaEmpty](../constructors/messageMediaEmpty.md) + +[messageMediaPhoto](../constructors/messageMediaPhoto.md) [messageMediaGeo](../constructors/messageMediaGeo.md) @@ -24,17 +58,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messageMediaDocument](../constructors/messageMediaDocument.md) -[messageMediaAudio](../constructors/messageMediaAudio.md) - [messageMediaWebPage](../constructors/messageMediaWebPage.md) [messageMediaVenue](../constructors/messageMediaVenue.md) +[messageMediaGame](../constructors/messageMediaGame.md) +[messageMediaInvoice](../constructors/messageMediaInvoice.md) -### Methods that return an object of this type (methods): +[messageMediaGeoLive](../constructors/messageMediaGeoLive.md) + +[messageMediaPoll](../constructors/messageMediaPoll.md) + +[messageMediaDice](../constructors/messageMediaDice.md) [$MadelineProto->messages->getWebPagePreview](../methods/messages.getWebPagePreview.md) - +[$MadelineProto->messages->uploadMedia](../methods/messages.uploadMedia.md) diff --git a/old_docs/API_docs_v44/types/MessageRange.md b/old_docs/API_docs_v44/types/MessageRange.md index 4425dcbd..73ac85b6 100644 --- a/old_docs/API_docs_v44/types/MessageRange.md +++ b/old_docs/API_docs_v44/types/MessageRange.md @@ -3,7 +3,7 @@ title: MessageRange description: constructors and methods of type MessageRange image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessageRange +# Type: MessageRange [Back to types index](index.md) @@ -16,5 +16,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->messages->getSplitRanges](../methods/messages.getSplitRanges.md) + +[messageRange](../constructors/messageRange.md) + +[$MadelineProto->messages->getSplitRanges](../methods/messages.getSplitRanges.md) + diff --git a/old_docs/API_docs_v44/types/MessageUserVote.md b/old_docs/API_docs_v44/types/MessageUserVote.md new file mode 100644 index 00000000..88d93a73 --- /dev/null +++ b/old_docs/API_docs_v44/types/MessageUserVote.md @@ -0,0 +1,30 @@ +--- +title: MessageUserVote +description: constructors and methods of type MessageUserVote +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageUserVote +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageUserVote](../constructors/messageUserVote.md) + +[messageUserVoteInputOption](../constructors/messageUserVoteInputOption.md) + +[messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) + + + +### Methods that return an object of this type (methods): + + + +[messageUserVote](../constructors/messageUserVote.md) + +[messageUserVoteInputOption](../constructors/messageUserVoteInputOption.md) + +[messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) + diff --git a/old_docs/API_docs_v44/types/MessagesFilter.md b/old_docs/API_docs_v44/types/MessagesFilter.md index d3b79c57..e4893d47 100644 --- a/old_docs/API_docs_v44/types/MessagesFilter.md +++ b/old_docs/API_docs_v44/types/MessagesFilter.md @@ -3,7 +3,7 @@ title: MessagesFilter description: constructors and methods of type MessagesFilter image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessagesFilter +# Type: MessagesFilter [Back to types index](index.md) @@ -18,19 +18,65 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputMessagesFilterPhotoVideo](../constructors/inputMessagesFilterPhotoVideo.md) -[inputMessagesFilterPhotoVideoDocuments](../constructors/inputMessagesFilterPhotoVideoDocuments.md) - [inputMessagesFilterDocument](../constructors/inputMessagesFilterDocument.md) -[inputMessagesFilterAudio](../constructors/inputMessagesFilterAudio.md) - -[inputMessagesFilterAudioDocuments](../constructors/inputMessagesFilterAudioDocuments.md) - [inputMessagesFilterUrl](../constructors/inputMessagesFilterUrl.md) +[inputMessagesFilterGif](../constructors/inputMessagesFilterGif.md) + +[inputMessagesFilterVoice](../constructors/inputMessagesFilterVoice.md) + +[inputMessagesFilterMusic](../constructors/inputMessagesFilterMusic.md) + +[inputMessagesFilterChatPhotos](../constructors/inputMessagesFilterChatPhotos.md) + +[inputMessagesFilterPhoneCalls](../constructors/inputMessagesFilterPhoneCalls.md) + +[inputMessagesFilterRoundVoice](../constructors/inputMessagesFilterRoundVoice.md) + +[inputMessagesFilterRoundVideo](../constructors/inputMessagesFilterRoundVideo.md) + +[inputMessagesFilterMyMentions](../constructors/inputMessagesFilterMyMentions.md) + +[inputMessagesFilterGeo](../constructors/inputMessagesFilterGeo.md) + +[inputMessagesFilterContacts](../constructors/inputMessagesFilterContacts.md) + ### Methods that return an object of this type (methods): +[inputMessagesFilterEmpty](../constructors/inputMessagesFilterEmpty.md) + +[inputMessagesFilterPhotos](../constructors/inputMessagesFilterPhotos.md) + +[inputMessagesFilterVideo](../constructors/inputMessagesFilterVideo.md) + +[inputMessagesFilterPhotoVideo](../constructors/inputMessagesFilterPhotoVideo.md) + +[inputMessagesFilterDocument](../constructors/inputMessagesFilterDocument.md) + +[inputMessagesFilterUrl](../constructors/inputMessagesFilterUrl.md) + +[inputMessagesFilterGif](../constructors/inputMessagesFilterGif.md) + +[inputMessagesFilterVoice](../constructors/inputMessagesFilterVoice.md) + +[inputMessagesFilterMusic](../constructors/inputMessagesFilterMusic.md) + +[inputMessagesFilterChatPhotos](../constructors/inputMessagesFilterChatPhotos.md) + +[inputMessagesFilterPhoneCalls](../constructors/inputMessagesFilterPhoneCalls.md) + +[inputMessagesFilterRoundVoice](../constructors/inputMessagesFilterRoundVoice.md) + +[inputMessagesFilterRoundVideo](../constructors/inputMessagesFilterRoundVideo.md) + +[inputMessagesFilterMyMentions](../constructors/inputMessagesFilterMyMentions.md) + +[inputMessagesFilterGeo](../constructors/inputMessagesFilterGeo.md) + +[inputMessagesFilterContacts](../constructors/inputMessagesFilterContacts.md) + diff --git a/old_docs/API_docs_v44/types/NearestDc.md b/old_docs/API_docs_v44/types/NearestDc.md index 296a4dff..95c849be 100644 --- a/old_docs/API_docs_v44/types/NearestDc.md +++ b/old_docs/API_docs_v44/types/NearestDc.md @@ -3,7 +3,7 @@ title: NearestDc description: constructors and methods of type NearestDc image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: NearestDc +# Type: NearestDc [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[nearestDc](../constructors/nearestDc.md) + +[$MadelineProto->help->getNearestDc](../methods/help.getNearestDc.md) + diff --git a/old_docs/API_docs_v44/types/NotifyPeer.md b/old_docs/API_docs_v44/types/NotifyPeer.md index 6272b82b..80d5d4b2 100644 --- a/old_docs/API_docs_v44/types/NotifyPeer.md +++ b/old_docs/API_docs_v44/types/NotifyPeer.md @@ -3,16 +3,14 @@ title: NotifyPeer description: constructors and methods of type NotifyPeer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: NotifyPeer +# Type: NotifyPeer [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $NotifyPeer = '@username'; // Username $NotifyPeer = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $NotifyPeer = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [notifyPeer](../constructors/notifyPeer.md) @@ -40,7 +40,7 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia [notifyChats](../constructors/notifyChats.md) -[notifyAll](../constructors/notifyAll.md) +[notifyBroadcasts](../constructors/notifyBroadcasts.md) @@ -48,3 +48,11 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia +[notifyPeer](../constructors/notifyPeer.md) + +[notifyUsers](../constructors/notifyUsers.md) + +[notifyChats](../constructors/notifyChats.md) + +[notifyBroadcasts](../constructors/notifyBroadcasts.md) + diff --git a/old_docs/API_docs_v44/types/Null.md b/old_docs/API_docs_v44/types/Null.md index 58d38809..999c520a 100644 --- a/old_docs/API_docs_v44/types/Null.md +++ b/old_docs/API_docs_v44/types/Null.md @@ -3,7 +3,7 @@ title: Null description: constructors and methods of type Null image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Null +# Type: Null [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[null](../constructors/null.md) + diff --git a/old_docs/API_docs_v44/types/Vector t.md b/old_docs/API_docs_v44/types/Page.md similarity index 60% rename from old_docs/API_docs_v44/types/Vector t.md rename to old_docs/API_docs_v44/types/Page.md index 1dcc885f..9a63c947 100644 --- a/old_docs/API_docs_v44/types/Vector t.md +++ b/old_docs/API_docs_v44/types/Page.md @@ -1,16 +1,16 @@ --- -title: Vector t -description: constructors and methods of type Vector t +title: Page +description: constructors and methods of type Page image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Vector t +# Type: Page [Back to types index](index.md) ### Possible values (constructors): -[vector](../constructors/vector.md) +[page](../constructors/page.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[page](../constructors/page.md) + diff --git a/old_docs/API_docs_v44/types/PageBlock.md b/old_docs/API_docs_v44/types/PageBlock.md new file mode 100644 index 00000000..e6649f3e --- /dev/null +++ b/old_docs/API_docs_v44/types/PageBlock.md @@ -0,0 +1,134 @@ +--- +title: PageBlock +description: constructors and methods of type PageBlock +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageBlock +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageBlockUnsupported](../constructors/pageBlockUnsupported.md) + +[pageBlockTitle](../constructors/pageBlockTitle.md) + +[pageBlockSubtitle](../constructors/pageBlockSubtitle.md) + +[pageBlockAuthorDate](../constructors/pageBlockAuthorDate.md) + +[pageBlockHeader](../constructors/pageBlockHeader.md) + +[pageBlockSubheader](../constructors/pageBlockSubheader.md) + +[pageBlockParagraph](../constructors/pageBlockParagraph.md) + +[pageBlockPreformatted](../constructors/pageBlockPreformatted.md) + +[pageBlockFooter](../constructors/pageBlockFooter.md) + +[pageBlockDivider](../constructors/pageBlockDivider.md) + +[pageBlockAnchor](../constructors/pageBlockAnchor.md) + +[pageBlockList](../constructors/pageBlockList.md) + +[pageBlockBlockquote](../constructors/pageBlockBlockquote.md) + +[pageBlockPullquote](../constructors/pageBlockPullquote.md) + +[pageBlockPhoto](../constructors/pageBlockPhoto.md) + +[pageBlockVideo](../constructors/pageBlockVideo.md) + +[pageBlockCover](../constructors/pageBlockCover.md) + +[pageBlockEmbed](../constructors/pageBlockEmbed.md) + +[pageBlockEmbedPost](../constructors/pageBlockEmbedPost.md) + +[pageBlockCollage](../constructors/pageBlockCollage.md) + +[pageBlockSlideshow](../constructors/pageBlockSlideshow.md) + +[pageBlockChannel](../constructors/pageBlockChannel.md) + +[pageBlockAudio](../constructors/pageBlockAudio.md) + +[pageBlockKicker](../constructors/pageBlockKicker.md) + +[pageBlockTable](../constructors/pageBlockTable.md) + +[pageBlockOrderedList](../constructors/pageBlockOrderedList.md) + +[pageBlockDetails](../constructors/pageBlockDetails.md) + +[pageBlockRelatedArticles](../constructors/pageBlockRelatedArticles.md) + +[pageBlockMap](../constructors/pageBlockMap.md) + + + +### Methods that return an object of this type (methods): + + + +[pageBlockUnsupported](../constructors/pageBlockUnsupported.md) + +[pageBlockTitle](../constructors/pageBlockTitle.md) + +[pageBlockSubtitle](../constructors/pageBlockSubtitle.md) + +[pageBlockAuthorDate](../constructors/pageBlockAuthorDate.md) + +[pageBlockHeader](../constructors/pageBlockHeader.md) + +[pageBlockSubheader](../constructors/pageBlockSubheader.md) + +[pageBlockParagraph](../constructors/pageBlockParagraph.md) + +[pageBlockPreformatted](../constructors/pageBlockPreformatted.md) + +[pageBlockFooter](../constructors/pageBlockFooter.md) + +[pageBlockDivider](../constructors/pageBlockDivider.md) + +[pageBlockAnchor](../constructors/pageBlockAnchor.md) + +[pageBlockList](../constructors/pageBlockList.md) + +[pageBlockBlockquote](../constructors/pageBlockBlockquote.md) + +[pageBlockPullquote](../constructors/pageBlockPullquote.md) + +[pageBlockPhoto](../constructors/pageBlockPhoto.md) + +[pageBlockVideo](../constructors/pageBlockVideo.md) + +[pageBlockCover](../constructors/pageBlockCover.md) + +[pageBlockEmbed](../constructors/pageBlockEmbed.md) + +[pageBlockEmbedPost](../constructors/pageBlockEmbedPost.md) + +[pageBlockCollage](../constructors/pageBlockCollage.md) + +[pageBlockSlideshow](../constructors/pageBlockSlideshow.md) + +[pageBlockChannel](../constructors/pageBlockChannel.md) + +[pageBlockAudio](../constructors/pageBlockAudio.md) + +[pageBlockKicker](../constructors/pageBlockKicker.md) + +[pageBlockTable](../constructors/pageBlockTable.md) + +[pageBlockOrderedList](../constructors/pageBlockOrderedList.md) + +[pageBlockDetails](../constructors/pageBlockDetails.md) + +[pageBlockRelatedArticles](../constructors/pageBlockRelatedArticles.md) + +[pageBlockMap](../constructors/pageBlockMap.md) + diff --git a/old_docs/API_docs_v44/types/PageCaption.md b/old_docs/API_docs_v44/types/PageCaption.md new file mode 100644 index 00000000..5a33d96a --- /dev/null +++ b/old_docs/API_docs_v44/types/PageCaption.md @@ -0,0 +1,22 @@ +--- +title: PageCaption +description: constructors and methods of type PageCaption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageCaption +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageCaption](../constructors/pageCaption.md) + + + +### Methods that return an object of this type (methods): + + + +[pageCaption](../constructors/pageCaption.md) + diff --git a/old_docs/API_docs_v44/types/PageListItem.md b/old_docs/API_docs_v44/types/PageListItem.md new file mode 100644 index 00000000..ddce2e3d --- /dev/null +++ b/old_docs/API_docs_v44/types/PageListItem.md @@ -0,0 +1,26 @@ +--- +title: PageListItem +description: constructors and methods of type PageListItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageListItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageListItemText](../constructors/pageListItemText.md) + +[pageListItemBlocks](../constructors/pageListItemBlocks.md) + + + +### Methods that return an object of this type (methods): + + + +[pageListItemText](../constructors/pageListItemText.md) + +[pageListItemBlocks](../constructors/pageListItemBlocks.md) + diff --git a/old_docs/API_docs_v44/types/PageListOrderedItem.md b/old_docs/API_docs_v44/types/PageListOrderedItem.md new file mode 100644 index 00000000..c3462186 --- /dev/null +++ b/old_docs/API_docs_v44/types/PageListOrderedItem.md @@ -0,0 +1,26 @@ +--- +title: PageListOrderedItem +description: constructors and methods of type PageListOrderedItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageListOrderedItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageListOrderedItemText](../constructors/pageListOrderedItemText.md) + +[pageListOrderedItemBlocks](../constructors/pageListOrderedItemBlocks.md) + + + +### Methods that return an object of this type (methods): + + + +[pageListOrderedItemText](../constructors/pageListOrderedItemText.md) + +[pageListOrderedItemBlocks](../constructors/pageListOrderedItemBlocks.md) + diff --git a/old_docs/API_docs_v44/types/PageRelatedArticle.md b/old_docs/API_docs_v44/types/PageRelatedArticle.md new file mode 100644 index 00000000..5bb590ac --- /dev/null +++ b/old_docs/API_docs_v44/types/PageRelatedArticle.md @@ -0,0 +1,22 @@ +--- +title: PageRelatedArticle +description: constructors and methods of type PageRelatedArticle +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageRelatedArticle +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageRelatedArticle](../constructors/pageRelatedArticle.md) + + + +### Methods that return an object of this type (methods): + + + +[pageRelatedArticle](../constructors/pageRelatedArticle.md) + diff --git a/old_docs/API_docs_v44/types/PageTableCell.md b/old_docs/API_docs_v44/types/PageTableCell.md new file mode 100644 index 00000000..26ed9b28 --- /dev/null +++ b/old_docs/API_docs_v44/types/PageTableCell.md @@ -0,0 +1,22 @@ +--- +title: PageTableCell +description: constructors and methods of type PageTableCell +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageTableCell +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageTableCell](../constructors/pageTableCell.md) + + + +### Methods that return an object of this type (methods): + + + +[pageTableCell](../constructors/pageTableCell.md) + diff --git a/old_docs/API_docs_v44/types/PageTableRow.md b/old_docs/API_docs_v44/types/PageTableRow.md new file mode 100644 index 00000000..5bfaa30d --- /dev/null +++ b/old_docs/API_docs_v44/types/PageTableRow.md @@ -0,0 +1,22 @@ +--- +title: PageTableRow +description: constructors and methods of type PageTableRow +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageTableRow +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageTableRow](../constructors/pageTableRow.md) + + + +### Methods that return an object of this type (methods): + + + +[pageTableRow](../constructors/pageTableRow.md) + diff --git a/old_docs/API_docs_v44/types/PasswordKdfAlgo.md b/old_docs/API_docs_v44/types/PasswordKdfAlgo.md new file mode 100644 index 00000000..57a68b80 --- /dev/null +++ b/old_docs/API_docs_v44/types/PasswordKdfAlgo.md @@ -0,0 +1,26 @@ +--- +title: PasswordKdfAlgo +description: constructors and methods of type PasswordKdfAlgo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PasswordKdfAlgo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[passwordKdfAlgoUnknown](../constructors/passwordKdfAlgoUnknown.md) + +[passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow](../constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md) + + + +### Methods that return an object of this type (methods): + + + +[passwordKdfAlgoUnknown](../constructors/passwordKdfAlgoUnknown.md) + +[passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow](../constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md) + diff --git a/old_docs/API_docs_v44/types/PaymentCharge.md b/old_docs/API_docs_v44/types/PaymentCharge.md new file mode 100644 index 00000000..4c745638 --- /dev/null +++ b/old_docs/API_docs_v44/types/PaymentCharge.md @@ -0,0 +1,22 @@ +--- +title: PaymentCharge +description: constructors and methods of type PaymentCharge +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentCharge +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentCharge](../constructors/paymentCharge.md) + + + +### Methods that return an object of this type (methods): + + + +[paymentCharge](../constructors/paymentCharge.md) + diff --git a/old_docs/API_docs_v44/types/PaymentRequestedInfo.md b/old_docs/API_docs_v44/types/PaymentRequestedInfo.md new file mode 100644 index 00000000..546d1220 --- /dev/null +++ b/old_docs/API_docs_v44/types/PaymentRequestedInfo.md @@ -0,0 +1,22 @@ +--- +title: PaymentRequestedInfo +description: constructors and methods of type PaymentRequestedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentRequestedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentRequestedInfo](../constructors/paymentRequestedInfo.md) + + + +### Methods that return an object of this type (methods): + + + +[paymentRequestedInfo](../constructors/paymentRequestedInfo.md) + diff --git a/old_docs/API_docs_v44/types/PaymentSavedCredentials.md b/old_docs/API_docs_v44/types/PaymentSavedCredentials.md new file mode 100644 index 00000000..69cefae0 --- /dev/null +++ b/old_docs/API_docs_v44/types/PaymentSavedCredentials.md @@ -0,0 +1,22 @@ +--- +title: PaymentSavedCredentials +description: constructors and methods of type PaymentSavedCredentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentSavedCredentials +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentSavedCredentialsCard](../constructors/paymentSavedCredentialsCard.md) + + + +### Methods that return an object of this type (methods): + + + +[paymentSavedCredentialsCard](../constructors/paymentSavedCredentialsCard.md) + diff --git a/old_docs/API_docs_v44/types/Peer.md b/old_docs/API_docs_v44/types/Peer.md index ebb98e91..022e8286 100644 --- a/old_docs/API_docs_v44/types/Peer.md +++ b/old_docs/API_docs_v44/types/Peer.md @@ -3,16 +3,14 @@ title: Peer description: constructors and methods of type Peer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Peer +# Type: Peer [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $Peer = '@username'; // Username $Peer = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $Peer = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [peerUser](../constructors/peerUser.md) @@ -46,3 +46,9 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia +[peerUser](../constructors/peerUser.md) + +[peerChat](../constructors/peerChat.md) + +[peerChannel](../constructors/peerChannel.md) + diff --git a/old_docs/API_docs_v44/types/PeerLocated.md b/old_docs/API_docs_v44/types/PeerLocated.md new file mode 100644 index 00000000..a09d7308 --- /dev/null +++ b/old_docs/API_docs_v44/types/PeerLocated.md @@ -0,0 +1,26 @@ +--- +title: PeerLocated +description: constructors and methods of type PeerLocated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerLocated +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerLocated](../constructors/peerLocated.md) + +[peerSelfLocated](../constructors/peerSelfLocated.md) + + + +### Methods that return an object of this type (methods): + + + +[peerLocated](../constructors/peerLocated.md) + +[peerSelfLocated](../constructors/peerSelfLocated.md) + diff --git a/old_docs/API_docs_v44/types/PeerNotifyEvents.md b/old_docs/API_docs_v44/types/PeerNotifyEvents.md deleted file mode 100644 index 397b94c8..00000000 --- a/old_docs/API_docs_v44/types/PeerNotifyEvents.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: PeerNotifyEvents -description: constructors and methods of type PeerNotifyEvents -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Type: PeerNotifyEvents -[Back to types index](index.md) - - - -### Possible values (constructors): - -[peerNotifyEventsEmpty](../constructors/peerNotifyEventsEmpty.md) - -[peerNotifyEventsAll](../constructors/peerNotifyEventsAll.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/old_docs/API_docs_v44/types/PeerNotifySettings.md b/old_docs/API_docs_v44/types/PeerNotifySettings.md index 3d72b7c5..c23287e0 100644 --- a/old_docs/API_docs_v44/types/PeerNotifySettings.md +++ b/old_docs/API_docs_v44/types/PeerNotifySettings.md @@ -3,15 +3,13 @@ title: PeerNotifySettings description: constructors and methods of type PeerNotifySettings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: PeerNotifySettings +# Type: PeerNotifySettings [Back to types index](index.md) ### Possible values (constructors): -[peerNotifySettingsEmpty](../constructors/peerNotifySettingsEmpty.md) - [peerNotifySettings](../constructors/peerNotifySettings.md) @@ -22,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[peerNotifySettings](../constructors/peerNotifySettings.md) + +[$MadelineProto->account->getNotifySettings](../methods/account.getNotifySettings.md) + diff --git a/old_docs/API_docs_v44/types/PeerSettings.md b/old_docs/API_docs_v44/types/PeerSettings.md new file mode 100644 index 00000000..1efabb63 --- /dev/null +++ b/old_docs/API_docs_v44/types/PeerSettings.md @@ -0,0 +1,26 @@ +--- +title: PeerSettings +description: constructors and methods of type PeerSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerSettings](../constructors/peerSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPeerSettings](../methods/messages.getPeerSettings.md) + + + +[peerSettings](../constructors/peerSettings.md) + +[$MadelineProto->messages->getPeerSettings](../methods/messages.getPeerSettings.md) + diff --git a/old_docs/API_docs_v44/types/PhoneCall.md b/old_docs/API_docs_v44/types/PhoneCall.md new file mode 100644 index 00000000..4b6d671c --- /dev/null +++ b/old_docs/API_docs_v44/types/PhoneCall.md @@ -0,0 +1,217 @@ +--- +title: PhoneCall +description: constructors and methods of type PhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCall +[Back to types index](index.md) + +This is an object of type `\danog\MadelineProto\VoIP`. + +It will only be available if the [php-libtgvoip](https://github.com/danog/php-libtgvoip) extension is installed, see [the main docs](https://docs.madelineproto.xyz#calls) for an easy installation script. + +## Constants: + +VoIPController states (these constants are incrementing integers, thus can be compared like numbers): + +* `STATE_CREATED` - controller created +* `STATE_WAIT_INIT` - controller inited +* `STATE_WAIT_INIT_ACK` - controller inited +* `STATE_ESTABLISHED` - connection established +* `STATE_FAILED` - connection failed +* `STATE_RECONNECTING` - reconnecting + +VoIPController errors: + +* `TGVOIP_ERROR_UNKNOWN` - An unknown error occurred +* `TGVOIP_ERROR_INCOMPATIBLE` - The other side is using an unsupported client/protocol +* `TGVOIP_ERROR_TIMEOUT` - A timeout occurred +* `TGVOIP_ERROR_AUDIO_IO` - An I/O error occurred + +Network types (these constants are incrementing integers, thus can be compared like numbers): + +* `NET_TYPE_UNKNOWN` - Unknown network type +* `NET_TYPE_GPRS` - GPRS connection +* `NET_TYPE_EDGE` - EDGE connection +* `NET_TYPE_3G` - 3G connection +* `NET_TYPE_HSPA` - HSPA connection +* `NET_TYPE_LTE` - LTE connection +* `NET_TYPE_WIFI` - WIFI connection +* `NET_TYPE_ETHERNET` - Ethernet connection (this guarantees high audio quality) +* `NET_TYPE_OTHER_HIGH_SPEED` - Other high speed connection +* `NET_TYPE_OTHER_LOW_SPEED` - Other low speed connection +* `NET_TYPE_DIALUP` - Dialup connection +* `NET_TYPE_OTHER_MOBILE` - Other mobile network connection + +Data saving modes (these constants are incrementing integers, thus can be compared like numbers): + +* `DATA_SAVING_NEVER` - Never save data (this guarantees high audio quality) +* `DATA_SAVING_MOBILE` - Use mobile data saving profiles +* `DATA_SAVING_ALWAYS` - Always use data saving profiles + +Proxy settings (these constants are incrementing integers, thus can be compared like numbers): + +* `PROXY_NONE` - No proxy +* `PROXY_SOCKS5` - Use the socks5 protocol + +Audio states (these constants are incrementing integers, thus can be compared like numbers): + +* `AUDIO_STATE_NONE` - The audio module was not created yet +* `AUDIO_STATE_CREATED` - The audio module was created +* `AUDIO_STATE_CONFIGURED` - The audio module was configured +* `AUDIO_STATE_RUNNING` - The audio module is running + +Call states (these constants are incrementing integers, thus can be compared like numbers): + +* `CALL_STATE_NONE` - The call was not created yet +* `CALL_STATE_REQUESTED` - This is an outgoing call +* `CALL_STATE_INCOMING` - This is an incoming call +* `CALL_STATE_ACCEPTED` - The incoming call was accepted, but not yet ready +* `CALL_STATE_CONFIRMED` - The outgoing call was accepted, but not yet ready +* `CALL_STATE_READY` - The call is ready. Audio data is being sent and received +* `CALL_STATE_ENDED` - The call is over. + + + +## Methods: + +* `getState()` - Gets the controller state, as a VoIPController state constant +* `getCallState()` - Gets the call state, as a call state constant +* `getVisualization()` - Gets the visualization of the encryption key, as an array of emojis, can be called only when the call state is bigger than or equal to `CALL_STATE_READY`. If called sooner, returns false. +* `getStats()` Gets connection stats +* `getOtherID()` - Gets the id of the other call participant, as a bot API ID +* `getProtocol()` - Gets the protocol used by the current call, as a [PhoneCallProtocol](https://docs.madelineproto.xyz/API_docs/types/PhoneCallProtocol.html) object +* `getCallID()` - Gets the call ID, as an [InputPhoneCall](https://docs.madelineproto.xyz/API_docs/types/InputPhoneCall.html) object +* `isCreator()` - Returns a boolean that indicates whether you are the creator of the call +* `whenCreated()` - Returns the unix timestamp of when the call was started (when was the call state set to `CALL_STATE_READY`) +* `getOutputState()` - Returns the state of the audio output module, as an audio state constant +* `getInputState()` - Returns the state of the audio input module, as an audio state constant +* `getDebugLog()` - Gets VoIPController debug log +* `getDebugString()` - Gets VoIPController debug string +* `getLastError()` - Gets the last error as a VoIPController error constant +* `getVersion()` - Gets VoIPController version +* `getSignalBarsCount()` - Gets number of signal bars (0-4) + +* `parseConfig()` - Parses the configuration + +* `accept()` - Accepts the phone call, returns `$this` +* `discard($reason = ["_" => "phoneCallDiscardReasonDisconnect"], $rating = [])` - Ends the phone call. + +Accepts two optional parameters: + +`$reason` - can be a [PhoneCallDiscardReason](https://docs.madelineproto.xyz/API_docs/types/PhoneCallDiscardReason.html) object (defaults to a [phoneCallDiscardReasonDisconnect](https://docs.madelineproto.xyz/API_docs/constructors/phoneCallDiscardReasonDisconnect.html) object). + +`$rating` - Can be an array that must contain a rating, and a comment (`["rating" => 5, "comment" => "MadelineProto is very easy to use!"]). Defaults to an empty array.` + + + +* `getOutputParams()` - Returns the output audio configuration + +MadelineProto works using raw signed PCM audio, internally split in packets with `sampleNumber` samples. + +The audio configuration is an array structured in the following way: +```php +[ + "bitsPerSample" => int. // Bits in each PCM sample + "sampleRate" => int, // PCM sample rate + "channels" => int, // Number of PCM audio channels + "sampleNumber" => int, // The audio data is internally split in packets, each having this number of samples + "samplePeriod" => double, // PCM sample period in seconds, useful if you want to generate audio data manually + "writePeriod" => double, // PCM write period in seconds (samplePeriod*sampleNumber), useful if you want to generate audio data manually + "samplesSize" => int, // The audio data is internally split in packets, each having this number of bytes (sampleNumber*bitsPerSample/8) + "level" => int // idk +]; +``` + +* `getInputParams()` - Returns the input audio configuration + +MadelineProto works using raw signed PCM audio, internally split in packets with `sampleNumber` samples. + +The audio configuration is an array structured in the following way: +```php +[ + "bitsPerSample" => int. // Bits in each PCM sample + "sampleRate" => int, // PCM sample rate + "channels" => int, // Number of PCM audio channels + "sampleNumber" => int, // The audio data is internally split in packets, each having this number of samples + "samplePeriod" => double, // PCM sample period in seconds, useful if you want to generate audio data manually + "writePeriod" => double, // PCM write period in seconds (samplePeriod*sampleNumber), useful if you want to generate audio data manually + "samplesSize" => int, // The audio data is internally split in packets, each having this number of bytes (sampleNumber*bitsPerSample/8) +]; +``` + +* `play(string $file)` and `then(string $file)` - Play a certain audio file encoded in PCM, with the audio input configuration, returns `$this` +* `playOnHold(array $files)` - Array of audio files encoded in PCM, with the audio input configuration to loop on hold (when the files given with play/then have finished playing). If not called, no data will be played, returns `$this` +* `isPlaying()` - Returns true if MadelineProto is still playing the files given with play/then, false if the hold files (or nothing) is being played +* `setMicMute(bool $mute)` - Stops/resumes playing files/hold files, returns `$this` + +* `setOutputFile(string $outputfile)` - Writes incoming audio data to file encoded in PCM, with the audio output configuration, returns `$this` +* `unsetOutputFile()` - Stops writing audio data to previously set file, returns `$this` + + +## Properties: + +* `storage`: An array that can be used to store data related to this call. + +Easy as pie: + +```php +$call->storage["pony"] = "fluttershy"; +\danog\MadelineProto\Logger::log($call->storage["pony"]); // fluttershy +``` + +Note: when modifying this property, *never* overwrite the previous values. Always either modify the values of the array separately like showed above, or use array_merge. + + +* `configuration`: An array containing the libtgvoip configuration. + +You can only modify the data saving mode, the network type, the logging file path and the stats dump file path: + +Example: + +```php +$call->configuration["log_file_path"] = "logs".$call->getOtherID().".log"; // Default is /dev/null +$call->configuration["stats_dump_file_path"] = "stats".$call->getOtherID().".log"; // Default is /dev/null +$call->configuration["network_type"] = \danog\MadelineProto\VoIP::NET_TYPE_WIFI; // Default is NET_TYPE_ETHERNET +$call->configuration["data_saving"] = \danog\MadelineProto\VoIP::DATA_SAVING_MOBILE; // Default is DATA_SAVING_NEVER +$call->parseConfig(); // Always call this after changing settings +``` + +Note: when modifying this property, *never* overwrite the previous values. Always either modify the values of the array separately like showed above, or use array_merge. + +After modifying it, you must always parse the new configuration with a call to `parseConfig`. + + + +### Possible values (constructors): + +[phoneCallEmpty](../constructors/phoneCallEmpty.md) + +[phoneCallWaiting](../constructors/phoneCallWaiting.md) + +[phoneCallRequested](../constructors/phoneCallRequested.md) + +[phoneCallAccepted](../constructors/phoneCallAccepted.md) + +[phoneCall](../constructors/phoneCall.md) + +[phoneCallDiscarded](../constructors/phoneCallDiscarded.md) + + + +### Methods that return an object of this type (methods): + + + +[phoneCallEmpty](../constructors/phoneCallEmpty.md) + +[phoneCallWaiting](../constructors/phoneCallWaiting.md) + +[phoneCallRequested](../constructors/phoneCallRequested.md) + +[phoneCallAccepted](../constructors/phoneCallAccepted.md) + +[phoneCall](../constructors/phoneCall.md) + +[phoneCallDiscarded](../constructors/phoneCallDiscarded.md) + diff --git a/old_docs/API_docs_v44/types/PhoneCallDiscardReason.md b/old_docs/API_docs_v44/types/PhoneCallDiscardReason.md new file mode 100644 index 00000000..00f3dcf6 --- /dev/null +++ b/old_docs/API_docs_v44/types/PhoneCallDiscardReason.md @@ -0,0 +1,34 @@ +--- +title: PhoneCallDiscardReason +description: constructors and methods of type PhoneCallDiscardReason +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCallDiscardReason +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneCallDiscardReasonMissed](../constructors/phoneCallDiscardReasonMissed.md) + +[phoneCallDiscardReasonDisconnect](../constructors/phoneCallDiscardReasonDisconnect.md) + +[phoneCallDiscardReasonHangup](../constructors/phoneCallDiscardReasonHangup.md) + +[phoneCallDiscardReasonBusy](../constructors/phoneCallDiscardReasonBusy.md) + + + +### Methods that return an object of this type (methods): + + + +[phoneCallDiscardReasonMissed](../constructors/phoneCallDiscardReasonMissed.md) + +[phoneCallDiscardReasonDisconnect](../constructors/phoneCallDiscardReasonDisconnect.md) + +[phoneCallDiscardReasonHangup](../constructors/phoneCallDiscardReasonHangup.md) + +[phoneCallDiscardReasonBusy](../constructors/phoneCallDiscardReasonBusy.md) + diff --git a/old_docs/API_docs_v44/types/PhoneCallProtocol.md b/old_docs/API_docs_v44/types/PhoneCallProtocol.md new file mode 100644 index 00000000..16f03ed6 --- /dev/null +++ b/old_docs/API_docs_v44/types/PhoneCallProtocol.md @@ -0,0 +1,22 @@ +--- +title: PhoneCallProtocol +description: constructors and methods of type PhoneCallProtocol +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCallProtocol +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneCallProtocol](../constructors/phoneCallProtocol.md) + + + +### Methods that return an object of this type (methods): + + + +[phoneCallProtocol](../constructors/phoneCallProtocol.md) + diff --git a/old_docs/API_docs_v44/types/PhoneConnection.md b/old_docs/API_docs_v44/types/PhoneConnection.md new file mode 100644 index 00000000..ba955b61 --- /dev/null +++ b/old_docs/API_docs_v44/types/PhoneConnection.md @@ -0,0 +1,26 @@ +--- +title: PhoneConnection +description: constructors and methods of type PhoneConnection +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneConnection +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneConnection](../constructors/phoneConnection.md) + +[phoneConnectionWebrtc](../constructors/phoneConnectionWebrtc.md) + + + +### Methods that return an object of this type (methods): + + + +[phoneConnection](../constructors/phoneConnection.md) + +[phoneConnectionWebrtc](../constructors/phoneConnectionWebrtc.md) + diff --git a/old_docs/API_docs_v44/types/Photo.md b/old_docs/API_docs_v44/types/Photo.md index 7cd6e713..14902fdb 100644 --- a/old_docs/API_docs_v44/types/Photo.md +++ b/old_docs/API_docs_v44/types/Photo.md @@ -3,7 +3,7 @@ title: Photo description: constructors and methods of type Photo image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Photo +# Type: Photo [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[photoEmpty](../constructors/photoEmpty.md) + +[photo](../constructors/photo.md) + diff --git a/old_docs/API_docs_v44/types/PhotoSize.md b/old_docs/API_docs_v44/types/PhotoSize.md index caf1684c..31aab16c 100644 --- a/old_docs/API_docs_v44/types/PhotoSize.md +++ b/old_docs/API_docs_v44/types/PhotoSize.md @@ -3,7 +3,7 @@ title: PhotoSize description: constructors and methods of type PhotoSize image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: PhotoSize +# Type: PhotoSize [Back to types index](index.md) @@ -16,9 +16,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [photoCachedSize](../constructors/photoCachedSize.md) +[photoStrippedSize](../constructors/photoStrippedSize.md) + ### Methods that return an object of this type (methods): +[photoSizeEmpty](../constructors/photoSizeEmpty.md) + +[photoSize](../constructors/photoSize.md) + +[photoCachedSize](../constructors/photoCachedSize.md) + +[photoStrippedSize](../constructors/photoStrippedSize.md) + diff --git a/old_docs/API_docs_v44/types/MessageGroup.md b/old_docs/API_docs_v44/types/Poll.md similarity index 58% rename from old_docs/API_docs_v44/types/MessageGroup.md rename to old_docs/API_docs_v44/types/Poll.md index d6b63780..f2d6c77b 100644 --- a/old_docs/API_docs_v44/types/MessageGroup.md +++ b/old_docs/API_docs_v44/types/Poll.md @@ -1,16 +1,16 @@ --- -title: MessageGroup -description: constructors and methods of type MessageGroup +title: Poll +description: constructors and methods of type Poll image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: MessageGroup +# Type: Poll [Back to types index](index.md) ### Possible values (constructors): -[messageGroup](../constructors/messageGroup.md) +[poll](../constructors/poll.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[poll](../constructors/poll.md) + diff --git a/old_docs/API_docs_v44/types/PollAnswer.md b/old_docs/API_docs_v44/types/PollAnswer.md new file mode 100644 index 00000000..d8562fe6 --- /dev/null +++ b/old_docs/API_docs_v44/types/PollAnswer.md @@ -0,0 +1,22 @@ +--- +title: PollAnswer +description: constructors and methods of type PollAnswer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollAnswer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollAnswer](../constructors/pollAnswer.md) + + + +### Methods that return an object of this type (methods): + + + +[pollAnswer](../constructors/pollAnswer.md) + diff --git a/old_docs/API_docs_v44/types/PollAnswerVoters.md b/old_docs/API_docs_v44/types/PollAnswerVoters.md new file mode 100644 index 00000000..e3083ddc --- /dev/null +++ b/old_docs/API_docs_v44/types/PollAnswerVoters.md @@ -0,0 +1,22 @@ +--- +title: PollAnswerVoters +description: constructors and methods of type PollAnswerVoters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollAnswerVoters +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollAnswerVoters](../constructors/pollAnswerVoters.md) + + + +### Methods that return an object of this type (methods): + + + +[pollAnswerVoters](../constructors/pollAnswerVoters.md) + diff --git a/old_docs/API_docs_v44/types/PollResults.md b/old_docs/API_docs_v44/types/PollResults.md new file mode 100644 index 00000000..d9c4a84f --- /dev/null +++ b/old_docs/API_docs_v44/types/PollResults.md @@ -0,0 +1,22 @@ +--- +title: PollResults +description: constructors and methods of type PollResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollResults](../constructors/pollResults.md) + + + +### Methods that return an object of this type (methods): + + + +[pollResults](../constructors/pollResults.md) + diff --git a/old_docs/API_docs_v44/types/PopularContact.md b/old_docs/API_docs_v44/types/PopularContact.md new file mode 100644 index 00000000..2556c6f7 --- /dev/null +++ b/old_docs/API_docs_v44/types/PopularContact.md @@ -0,0 +1,22 @@ +--- +title: PopularContact +description: constructors and methods of type PopularContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PopularContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[popularContact](../constructors/popularContact.md) + + + +### Methods that return an object of this type (methods): + + + +[popularContact](../constructors/popularContact.md) + diff --git a/old_docs/API_docs_v44/types/PostAddress.md b/old_docs/API_docs_v44/types/PostAddress.md new file mode 100644 index 00000000..f4009ff6 --- /dev/null +++ b/old_docs/API_docs_v44/types/PostAddress.md @@ -0,0 +1,22 @@ +--- +title: PostAddress +description: constructors and methods of type PostAddress +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PostAddress +[Back to types index](index.md) + + + +### Possible values (constructors): + +[postAddress](../constructors/postAddress.md) + + + +### Methods that return an object of this type (methods): + + + +[postAddress](../constructors/postAddress.md) + diff --git a/old_docs/API_docs_v44/types/PrivacyKey.md b/old_docs/API_docs_v44/types/PrivacyKey.md index b9d4f8da..aecff816 100644 --- a/old_docs/API_docs_v44/types/PrivacyKey.md +++ b/old_docs/API_docs_v44/types/PrivacyKey.md @@ -3,7 +3,7 @@ title: PrivacyKey description: constructors and methods of type PrivacyKey image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: PrivacyKey +# Type: PrivacyKey [Back to types index](index.md) @@ -12,9 +12,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [privacyKeyStatusTimestamp](../constructors/privacyKeyStatusTimestamp.md) +[privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) + +[privacyKeyPhoneCall](../constructors/privacyKeyPhoneCall.md) + +[privacyKeyPhoneP2P](../constructors/privacyKeyPhoneP2P.md) + +[privacyKeyForwards](../constructors/privacyKeyForwards.md) + +[privacyKeyProfilePhoto](../constructors/privacyKeyProfilePhoto.md) + +[privacyKeyPhoneNumber](../constructors/privacyKeyPhoneNumber.md) + +[privacyKeyAddedByPhone](../constructors/privacyKeyAddedByPhone.md) + ### Methods that return an object of this type (methods): +[privacyKeyStatusTimestamp](../constructors/privacyKeyStatusTimestamp.md) + +[privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) + +[privacyKeyPhoneCall](../constructors/privacyKeyPhoneCall.md) + +[privacyKeyPhoneP2P](../constructors/privacyKeyPhoneP2P.md) + +[privacyKeyForwards](../constructors/privacyKeyForwards.md) + +[privacyKeyProfilePhoto](../constructors/privacyKeyProfilePhoto.md) + +[privacyKeyPhoneNumber](../constructors/privacyKeyPhoneNumber.md) + +[privacyKeyAddedByPhone](../constructors/privacyKeyAddedByPhone.md) + diff --git a/old_docs/API_docs_v44/types/PrivacyRule.md b/old_docs/API_docs_v44/types/PrivacyRule.md index 5f0425b9..24fdccc9 100644 --- a/old_docs/API_docs_v44/types/PrivacyRule.md +++ b/old_docs/API_docs_v44/types/PrivacyRule.md @@ -3,7 +3,7 @@ title: PrivacyRule description: constructors and methods of type PrivacyRule image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: PrivacyRule +# Type: PrivacyRule [Back to types index](index.md) @@ -22,9 +22,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [privacyValueDisallowUsers](../constructors/privacyValueDisallowUsers.md) +[privacyValueAllowChatParticipants](../constructors/privacyValueAllowChatParticipants.md) + +[privacyValueDisallowChatParticipants](../constructors/privacyValueDisallowChatParticipants.md) + ### Methods that return an object of this type (methods): +[privacyValueAllowContacts](../constructors/privacyValueAllowContacts.md) + +[privacyValueAllowAll](../constructors/privacyValueAllowAll.md) + +[privacyValueAllowUsers](../constructors/privacyValueAllowUsers.md) + +[privacyValueDisallowContacts](../constructors/privacyValueDisallowContacts.md) + +[privacyValueDisallowAll](../constructors/privacyValueDisallowAll.md) + +[privacyValueDisallowUsers](../constructors/privacyValueDisallowUsers.md) + +[privacyValueAllowChatParticipants](../constructors/privacyValueAllowChatParticipants.md) + +[privacyValueDisallowChatParticipants](../constructors/privacyValueDisallowChatParticipants.md) + diff --git a/old_docs/API_docs_v44/types/README.md b/old_docs/API_docs_v44/types/README.md index 0bde238e..2d3c576b 100644 --- a/old_docs/API_docs_v44/types/README.md +++ b/old_docs/API_docs_v44/types/README.md @@ -6,61 +6,98 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png # Types [Back to API documentation index](..) - [AccountDaysTTL](AccountDaysTTL.md) -[Audio](Audio.md) - [Authorization](Authorization.md) +[AutoDownloadSettings](AutoDownloadSettings.md) + +[BankCardOpenUrl](BankCardOpenUrl.md) + +[BaseTheme](BaseTheme.md) + [Bool](Bool.md) [BotCommand](BotCommand.md) [BotInfo](BotInfo.md) +[BotInlineMessage](BotInlineMessage.md) + +[BotInlineResult](BotInlineResult.md) + +[CdnConfig](CdnConfig.md) + +[CdnPublicKey](CdnPublicKey.md) + +[ChannelAdminLogEvent](ChannelAdminLogEvent.md) + +[ChannelAdminLogEventAction](ChannelAdminLogEventAction.md) + +[ChannelAdminLogEventsFilter](ChannelAdminLogEventsFilter.md) + +[ChannelLocation](ChannelLocation.md) + [ChannelMessagesFilter](ChannelMessagesFilter.md) [ChannelParticipant](ChannelParticipant.md) -[ChannelParticipantRole](ChannelParticipantRole.md) - [ChannelParticipantsFilter](ChannelParticipantsFilter.md) [Chat](Chat.md) +[ChatAdminRights](ChatAdminRights.md) + +[ChatBannedRights](ChatBannedRights.md) + [ChatFull](ChatFull.md) [ChatInvite](ChatInvite.md) +[ChatOnlines](ChatOnlines.md) + [ChatParticipant](ChatParticipant.md) [ChatParticipants](ChatParticipants.md) [ChatPhoto](ChatPhoto.md) +[CodeSettings](CodeSettings.md) + [Config](Config.md) [Contact](Contact.md) [ContactBlocked](ContactBlocked.md) -[ContactLink](ContactLink.md) - [ContactStatus](ContactStatus.md) -[ContactSuggested](ContactSuggested.md) +[DataJSON](DataJSON.md) [DcOption](DcOption.md) [Dialog](Dialog.md) -[DisabledFeature](DisabledFeature.md) +[DialogFilter](DialogFilter.md) + +[DialogFilterSuggested](DialogFilterSuggested.md) + +[DialogPeer](DialogPeer.md) [Document](Document.md) [DocumentAttribute](DocumentAttribute.md) +[DraftMessage](DraftMessage.md) + +[EmojiKeyword](EmojiKeyword.md) + +[EmojiKeywordsDifference](EmojiKeywordsDifference.md) + +[EmojiLanguage](EmojiLanguage.md) + +[EmojiURL](EmojiURL.md) + [EncryptedChat](EncryptedChat.md) [EncryptedFile](EncryptedFile.md) @@ -71,24 +108,48 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [ExportedChatInvite](ExportedChatInvite.md) +[ExportedMessageLink](ExportedMessageLink.md) + +[FileHash](FileHash.md) + [FileLocation](FileLocation.md) -[FoundGif](FoundGif.md) +[Folder](Folder.md) + +[FolderPeer](FolderPeer.md) + +[Game](Game.md) [GeoPoint](GeoPoint.md) +[GlobalPrivacySettings](GlobalPrivacySettings.md) + +[HighScore](HighScore.md) + [ImportedContact](ImportedContact.md) +[InlineBotSwitchPM](InlineBotSwitchPM.md) + [InputAppEvent](InputAppEvent.md) -[InputAudio](InputAudio.md) +[InputBotInlineMessage](InputBotInlineMessage.md) + +[InputBotInlineMessageID](InputBotInlineMessageID.md) + +[InputBotInlineResult](InputBotInlineResult.md) [InputChannel](InputChannel.md) [InputChatPhoto](InputChatPhoto.md) +[InputCheckPasswordSRP](InputCheckPasswordSRP.md) + +[InputClientProxy](InputClientProxy.md) + [InputContact](InputContact.md) +[InputDialogPeer](InputDialogPeer.md) + [InputDocument](InputDocument.md) [InputEncryptedChat](InputEncryptedChat.md) @@ -99,48 +160,92 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [InputFileLocation](InputFileLocation.md) +[InputFolderPeer](InputFolderPeer.md) + +[InputGame](InputGame.md) + [InputGeoPoint](InputGeoPoint.md) [InputMedia](InputMedia.md) +[InputMessage](InputMessage.md) + [InputNotifyPeer](InputNotifyPeer.md) +[InputPaymentCredentials](InputPaymentCredentials.md) + [InputPeer](InputPeer.md) -[InputPeerNotifyEvents](InputPeerNotifyEvents.md) - [InputPeerNotifySettings](InputPeerNotifySettings.md) -[InputPhoto](InputPhoto.md) +[InputPhoneCall](InputPhoneCall.md) -[InputPhotoCrop](InputPhotoCrop.md) +[InputPhoto](InputPhoto.md) [InputPrivacyKey](InputPrivacyKey.md) [InputPrivacyRule](InputPrivacyRule.md) +[InputSecureFile](InputSecureFile.md) + +[InputSecureValue](InputSecureValue.md) + +[InputSingleMedia](InputSingleMedia.md) + [InputStickerSet](InputStickerSet.md) +[InputStickerSetItem](InputStickerSetItem.md) + +[InputStickeredMedia](InputStickeredMedia.md) + +[InputTheme](InputTheme.md) + +[InputThemeSettings](InputThemeSettings.md) + [InputUser](InputUser.md) -[InputVideo](InputVideo.md) +[InputWallPaper](InputWallPaper.md) + +[InputWebDocument](InputWebDocument.md) + +[InputWebFileLocation](InputWebFileLocation.md) + +[Invoice](Invoice.md) + +[JSONObjectValue](JSONObjectValue.md) + +[JSONValue](JSONValue.md) [KeyboardButton](KeyboardButton.md) [KeyboardButtonRow](KeyboardButtonRow.md) +[LabeledPrice](LabeledPrice.md) + +[LangPackDifference](LangPackDifference.md) + +[LangPackLanguage](LangPackLanguage.md) + +[LangPackString](LangPackString.md) + +[MaskCoords](MaskCoords.md) + [Message](Message.md) [MessageAction](MessageAction.md) [MessageEntity](MessageEntity.md) -[MessageGroup](MessageGroup.md) +[MessageFwdHeader](MessageFwdHeader.md) + +[MessageInteractionCounters](MessageInteractionCounters.md) [MessageMedia](MessageMedia.md) [MessageRange](MessageRange.md) +[MessageUserVote](MessageUserVote.md) + [MessagesFilter](MessagesFilter.md) [NearestDc](NearestDc.md) @@ -149,38 +254,146 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Null](Null.md) +[Page](Page.md) + +[PageBlock](PageBlock.md) + +[PageCaption](PageCaption.md) + +[PageListItem](PageListItem.md) + +[PageListOrderedItem](PageListOrderedItem.md) + +[PageRelatedArticle](PageRelatedArticle.md) + +[PageTableCell](PageTableCell.md) + +[PageTableRow](PageTableRow.md) + +[PasswordKdfAlgo](PasswordKdfAlgo.md) + +[PaymentCharge](PaymentCharge.md) + +[PaymentRequestedInfo](PaymentRequestedInfo.md) + +[PaymentSavedCredentials](PaymentSavedCredentials.md) + [Peer](Peer.md) -[PeerNotifyEvents](PeerNotifyEvents.md) +[PeerLocated](PeerLocated.md) [PeerNotifySettings](PeerNotifySettings.md) +[PeerSettings](PeerSettings.md) + +[PhoneCall](PhoneCall.md) + +[PhoneCallDiscardReason](PhoneCallDiscardReason.md) + +[PhoneCallProtocol](PhoneCallProtocol.md) + +[PhoneConnection](PhoneConnection.md) + [Photo](Photo.md) [PhotoSize](PhotoSize.md) +[Poll](Poll.md) + +[PollAnswer](PollAnswer.md) + +[PollAnswerVoters](PollAnswerVoters.md) + +[PollResults](PollResults.md) + +[PopularContact](PopularContact.md) + +[PostAddress](PostAddress.md) + [PrivacyKey](PrivacyKey.md) [PrivacyRule](PrivacyRule.md) [ReceivedNotifyMessage](ReceivedNotifyMessage.md) +[RecentMeUrl](RecentMeUrl.md) + [ReplyMarkup](ReplyMarkup.md) [ReportReason](ReportReason.md) +[RestrictionReason](RestrictionReason.md) + +[RichText](RichText.md) + +[SavedContact](SavedContact.md) + +[SecureCredentialsEncrypted](SecureCredentialsEncrypted.md) + +[SecureData](SecureData.md) + +[SecureFile](SecureFile.md) + +[SecurePasswordKdfAlgo](SecurePasswordKdfAlgo.md) + +[SecurePlainData](SecurePlainData.md) + +[SecureRequiredType](SecureRequiredType.md) + +[SecureSecretSettings](SecureSecretSettings.md) + +[SecureValue](SecureValue.md) + +[SecureValueError](SecureValueError.md) + +[SecureValueHash](SecureValueHash.md) + +[SecureValueType](SecureValueType.md) + [SendMessageAction](SendMessageAction.md) +[ShippingOption](ShippingOption.md) + +[StatsAbsValueAndPrev](StatsAbsValueAndPrev.md) + +[StatsDateRangeDays](StatsDateRangeDays.md) + +[StatsGraph](StatsGraph.md) + +[StatsGroupTopAdmin](StatsGroupTopAdmin.md) + +[StatsGroupTopInviter](StatsGroupTopInviter.md) + +[StatsGroupTopPoster](StatsGroupTopPoster.md) + +[StatsPercentValue](StatsPercentValue.md) + +[StatsURL](StatsURL.md) + [StickerPack](StickerPack.md) [StickerSet](StickerSet.md) +[StickerSetCovered](StickerSetCovered.md) + +[Theme](Theme.md) + +[ThemeSettings](ThemeSettings.md) + +[TopPeer](TopPeer.md) + +[TopPeerCategory](TopPeerCategory.md) + +[TopPeerCategoryPeers](TopPeerCategoryPeers.md) + [True](True.md) [Update](Update.md) [Updates](Updates.md) +[UrlAuthResult](UrlAuthResult.md) + [User](User.md) [UserFull](UserFull.md) @@ -189,18 +402,30 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [UserStatus](UserStatus.md) -[Vector t](Vector t.md) - -[Video](Video.md) +[VideoSize](VideoSize.md) [WallPaper](WallPaper.md) +[WallPaperSettings](WallPaperSettings.md) + +[WebAuthorization](WebAuthorization.md) + +[WebDocument](WebDocument.md) + [WebPage](WebPage.md) +[WebPageAttribute](WebPageAttribute.md) + [X](X.md) +[account.AuthorizationForm](account.AuthorizationForm.md) + [account.Authorizations](account.Authorizations.md) +[account.AutoDownloadSettings](account.AutoDownloadSettings.md) + +[account.ContentSettings](account.ContentSettings.md) + [account.Password](account.Password.md) [account.PasswordInputSettings](account.PasswordInputSettings.md) @@ -209,18 +434,34 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [account.PrivacyRules](account.PrivacyRules.md) -[account.SentChangePhoneCode](account.SentChangePhoneCode.md) +[account.SentEmailCode](account.SentEmailCode.md) + +[account.Takeout](account.Takeout.md) + +[account.Themes](account.Themes.md) + +[account.TmpPassword](account.TmpPassword.md) + +[account.WallPapers](account.WallPapers.md) + +[account.WebAuthorizations](account.WebAuthorizations.md) [auth.Authorization](auth.Authorization.md) -[auth.CheckedPhone](auth.CheckedPhone.md) +[auth.CodeType](auth.CodeType.md) [auth.ExportedAuthorization](auth.ExportedAuthorization.md) +[auth.LoginToken](auth.LoginToken.md) + [auth.PasswordRecovery](auth.PasswordRecovery.md) [auth.SentCode](auth.SentCode.md) +[auth.SentCodeType](auth.SentCodeType.md) + +[channels.AdminLogResults](channels.AdminLogResults.md) + [channels.ChannelParticipant](channels.ChannelParticipant.md) [channels.ChannelParticipants](channels.ChannelParticipants.md) @@ -233,22 +474,32 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [contacts.ImportedContacts](contacts.ImportedContacts.md) -[contacts.Link](contacts.Link.md) - [contacts.ResolvedPeer](contacts.ResolvedPeer.md) -[contacts.Suggested](contacts.Suggested.md) - -[help.AppChangelog](help.AppChangelog.md) +[contacts.TopPeers](contacts.TopPeers.md) [help.AppUpdate](help.AppUpdate.md) +[help.DeepLinkInfo](help.DeepLinkInfo.md) + [help.InviteText](help.InviteText.md) +[help.PassportConfig](help.PassportConfig.md) + +[help.PromoData](help.PromoData.md) + +[help.RecentMeUrls](help.RecentMeUrls.md) + [help.Support](help.Support.md) +[help.SupportName](help.SupportName.md) + [help.TermsOfService](help.TermsOfService.md) +[help.TermsOfServiceUpdate](help.TermsOfServiceUpdate.md) + +[help.UserInfo](help.UserInfo.md) + [int](int.md) [long](long.md) @@ -259,6 +510,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.AllStickers](messages.AllStickers.md) +[messages.ArchivedStickers](messages.ArchivedStickers.md) + +[messages.BotCallbackAnswer](messages.BotCallbackAnswer.md) + +[messages.BotResults](messages.BotResults.md) + [messages.ChatFull](messages.ChatFull.md) [messages.Chats](messages.Chats.md) @@ -267,20 +524,60 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.Dialogs](messages.Dialogs.md) -[messages.FoundGifs](messages.FoundGifs.md) +[messages.FavedStickers](messages.FavedStickers.md) + +[messages.FeaturedStickers](messages.FeaturedStickers.md) + +[messages.FoundStickerSets](messages.FoundStickerSets.md) + +[messages.HighScores](messages.HighScores.md) + +[messages.InactiveChats](messages.InactiveChats.md) + +[messages.MessageEditData](messages.MessageEditData.md) [messages.Messages](messages.Messages.md) +[messages.PeerDialogs](messages.PeerDialogs.md) + +[messages.RecentStickers](messages.RecentStickers.md) + +[messages.SavedGifs](messages.SavedGifs.md) + +[messages.SearchCounter](messages.SearchCounter.md) + [messages.SentEncryptedMessage](messages.SentEncryptedMessage.md) [messages.StickerSet](messages.StickerSet.md) +[messages.StickerSetInstallResult](messages.StickerSetInstallResult.md) + [messages.Stickers](messages.Stickers.md) +[messages.VotesList](messages.VotesList.md) + +[payments.BankCardData](payments.BankCardData.md) + +[payments.PaymentForm](payments.PaymentForm.md) + +[payments.PaymentReceipt](payments.PaymentReceipt.md) + +[payments.PaymentResult](payments.PaymentResult.md) + +[payments.SavedInfo](payments.SavedInfo.md) + +[payments.ValidatedRequestedInfo](payments.ValidatedRequestedInfo.md) + +[phone.PhoneCall](phone.PhoneCall.md) + [photos.Photo](photos.Photo.md) [photos.Photos](photos.Photos.md) +[stats.BroadcastStats](stats.BroadcastStats.md) + +[stats.MegagroupStats](stats.MegagroupStats.md) + [storage.FileType](storage.FileType.md) [updates.ChannelDifference](updates.ChannelDifference.md) @@ -289,5 +586,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updates.State](updates.State.md) +[upload.CdnFile](upload.CdnFile.md) + [upload.File](upload.File.md) +[upload.WebFile](upload.WebFile.md) + diff --git a/old_docs/API_docs_v44/types/ReceivedNotifyMessage.md b/old_docs/API_docs_v44/types/ReceivedNotifyMessage.md index 416aa275..f2dc2151 100644 --- a/old_docs/API_docs_v44/types/ReceivedNotifyMessage.md +++ b/old_docs/API_docs_v44/types/ReceivedNotifyMessage.md @@ -3,7 +3,7 @@ title: ReceivedNotifyMessage description: constructors and methods of type ReceivedNotifyMessage image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ReceivedNotifyMessage +# Type: ReceivedNotifyMessage [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[receivedNotifyMessage](../constructors/receivedNotifyMessage.md) + +[$MadelineProto->messages->receivedMessages](../methods/messages.receivedMessages.md) + diff --git a/old_docs/API_docs_v44/types/RecentMeUrl.md b/old_docs/API_docs_v44/types/RecentMeUrl.md new file mode 100644 index 00000000..533b7884 --- /dev/null +++ b/old_docs/API_docs_v44/types/RecentMeUrl.md @@ -0,0 +1,38 @@ +--- +title: RecentMeUrl +description: constructors and methods of type RecentMeUrl +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RecentMeUrl +[Back to types index](index.md) + + + +### Possible values (constructors): + +[recentMeUrlUnknown](../constructors/recentMeUrlUnknown.md) + +[recentMeUrlUser](../constructors/recentMeUrlUser.md) + +[recentMeUrlChat](../constructors/recentMeUrlChat.md) + +[recentMeUrlChatInvite](../constructors/recentMeUrlChatInvite.md) + +[recentMeUrlStickerSet](../constructors/recentMeUrlStickerSet.md) + + + +### Methods that return an object of this type (methods): + + + +[recentMeUrlUnknown](../constructors/recentMeUrlUnknown.md) + +[recentMeUrlUser](../constructors/recentMeUrlUser.md) + +[recentMeUrlChat](../constructors/recentMeUrlChat.md) + +[recentMeUrlChatInvite](../constructors/recentMeUrlChatInvite.md) + +[recentMeUrlStickerSet](../constructors/recentMeUrlStickerSet.md) + diff --git a/old_docs/API_docs_v44/types/ReplyMarkup.md b/old_docs/API_docs_v44/types/ReplyMarkup.md index 1dda73c0..22160191 100644 --- a/old_docs/API_docs_v44/types/ReplyMarkup.md +++ b/old_docs/API_docs_v44/types/ReplyMarkup.md @@ -3,7 +3,7 @@ title: ReplyMarkup description: constructors and methods of type ReplyMarkup image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ReplyMarkup +# Type: ReplyMarkup [Back to types index](index.md) @@ -16,9 +16,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [replyKeyboardMarkup](../constructors/replyKeyboardMarkup.md) +[replyInlineMarkup](../constructors/replyInlineMarkup.md) + ### Methods that return an object of this type (methods): +[replyKeyboardHide](../constructors/replyKeyboardHide.md) + +[replyKeyboardForceReply](../constructors/replyKeyboardForceReply.md) + +[replyKeyboardMarkup](../constructors/replyKeyboardMarkup.md) + +[replyInlineMarkup](../constructors/replyInlineMarkup.md) + diff --git a/old_docs/API_docs_v44/types/ReportReason.md b/old_docs/API_docs_v44/types/ReportReason.md index b7d87ec8..4d067aee 100644 --- a/old_docs/API_docs_v44/types/ReportReason.md +++ b/old_docs/API_docs_v44/types/ReportReason.md @@ -3,7 +3,7 @@ title: ReportReason description: constructors and methods of type ReportReason image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: ReportReason +# Type: ReportReason [Back to types index](index.md) @@ -16,11 +16,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputReportReasonPornography](../constructors/inputReportReasonPornography.md) +[inputReportReasonChildAbuse](../constructors/inputReportReasonChildAbuse.md) + [inputReportReasonOther](../constructors/inputReportReasonOther.md) +[inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md) + +[inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md) + ### Methods that return an object of this type (methods): +[inputReportReasonSpam](../constructors/inputReportReasonSpam.md) + +[inputReportReasonViolence](../constructors/inputReportReasonViolence.md) + +[inputReportReasonPornography](../constructors/inputReportReasonPornography.md) + +[inputReportReasonChildAbuse](../constructors/inputReportReasonChildAbuse.md) + +[inputReportReasonOther](../constructors/inputReportReasonOther.md) + +[inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md) + +[inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md) + diff --git a/old_docs/API_docs_v44/types/RestrictionReason.md b/old_docs/API_docs_v44/types/RestrictionReason.md new file mode 100644 index 00000000..f24df4d7 --- /dev/null +++ b/old_docs/API_docs_v44/types/RestrictionReason.md @@ -0,0 +1,22 @@ +--- +title: RestrictionReason +description: constructors and methods of type RestrictionReason +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RestrictionReason +[Back to types index](index.md) + + + +### Possible values (constructors): + +[restrictionReason](../constructors/restrictionReason.md) + + + +### Methods that return an object of this type (methods): + + + +[restrictionReason](../constructors/restrictionReason.md) + diff --git a/old_docs/API_docs_v44/types/RichText.md b/old_docs/API_docs_v44/types/RichText.md new file mode 100644 index 00000000..b1bfe2b8 --- /dev/null +++ b/old_docs/API_docs_v44/types/RichText.md @@ -0,0 +1,82 @@ +--- +title: RichText +description: constructors and methods of type RichText +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RichText +[Back to types index](index.md) + + + +### Possible values (constructors): + +[textEmpty](../constructors/textEmpty.md) + +[textPlain](../constructors/textPlain.md) + +[textBold](../constructors/textBold.md) + +[textItalic](../constructors/textItalic.md) + +[textUnderline](../constructors/textUnderline.md) + +[textStrike](../constructors/textStrike.md) + +[textFixed](../constructors/textFixed.md) + +[textUrl](../constructors/textUrl.md) + +[textEmail](../constructors/textEmail.md) + +[textConcat](../constructors/textConcat.md) + +[textSubscript](../constructors/textSubscript.md) + +[textSuperscript](../constructors/textSuperscript.md) + +[textMarked](../constructors/textMarked.md) + +[textPhone](../constructors/textPhone.md) + +[textImage](../constructors/textImage.md) + +[textAnchor](../constructors/textAnchor.md) + + + +### Methods that return an object of this type (methods): + + + +[textEmpty](../constructors/textEmpty.md) + +[textPlain](../constructors/textPlain.md) + +[textBold](../constructors/textBold.md) + +[textItalic](../constructors/textItalic.md) + +[textUnderline](../constructors/textUnderline.md) + +[textStrike](../constructors/textStrike.md) + +[textFixed](../constructors/textFixed.md) + +[textUrl](../constructors/textUrl.md) + +[textEmail](../constructors/textEmail.md) + +[textConcat](../constructors/textConcat.md) + +[textSubscript](../constructors/textSubscript.md) + +[textSuperscript](../constructors/textSuperscript.md) + +[textMarked](../constructors/textMarked.md) + +[textPhone](../constructors/textPhone.md) + +[textImage](../constructors/textImage.md) + +[textAnchor](../constructors/textAnchor.md) + diff --git a/old_docs/API_docs_v44/types/SavedContact.md b/old_docs/API_docs_v44/types/SavedContact.md new file mode 100644 index 00000000..9611daa0 --- /dev/null +++ b/old_docs/API_docs_v44/types/SavedContact.md @@ -0,0 +1,26 @@ +--- +title: SavedContact +description: constructors and methods of type SavedContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SavedContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[savedPhoneContact](../constructors/savedPhoneContact.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getSaved](../methods/contacts.getSaved.md) + + + +[savedPhoneContact](../constructors/savedPhoneContact.md) + +[$MadelineProto->contacts->getSaved](../methods/contacts.getSaved.md) + diff --git a/old_docs/API_docs_v44/types/SecureCredentialsEncrypted.md b/old_docs/API_docs_v44/types/SecureCredentialsEncrypted.md new file mode 100644 index 00000000..0392065d --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureCredentialsEncrypted.md @@ -0,0 +1,22 @@ +--- +title: SecureCredentialsEncrypted +description: constructors and methods of type SecureCredentialsEncrypted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureCredentialsEncrypted +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureCredentialsEncrypted](../constructors/secureCredentialsEncrypted.md) + + + +### Methods that return an object of this type (methods): + + + +[secureCredentialsEncrypted](../constructors/secureCredentialsEncrypted.md) + diff --git a/old_docs/API_docs_v44/types/SecureData.md b/old_docs/API_docs_v44/types/SecureData.md new file mode 100644 index 00000000..bfeffecc --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureData.md @@ -0,0 +1,22 @@ +--- +title: SecureData +description: constructors and methods of type SecureData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureData](../constructors/secureData.md) + + + +### Methods that return an object of this type (methods): + + + +[secureData](../constructors/secureData.md) + diff --git a/old_docs/API_docs_v44/types/SecureFile.md b/old_docs/API_docs_v44/types/SecureFile.md new file mode 100644 index 00000000..d3e7e1fd --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureFile.md @@ -0,0 +1,26 @@ +--- +title: SecureFile +description: constructors and methods of type SecureFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureFileEmpty](../constructors/secureFileEmpty.md) + +[secureFile](../constructors/secureFile.md) + + + +### Methods that return an object of this type (methods): + + + +[secureFileEmpty](../constructors/secureFileEmpty.md) + +[secureFile](../constructors/secureFile.md) + diff --git a/old_docs/API_docs_v44/types/SecurePasswordKdfAlgo.md b/old_docs/API_docs_v44/types/SecurePasswordKdfAlgo.md new file mode 100644 index 00000000..598aebc4 --- /dev/null +++ b/old_docs/API_docs_v44/types/SecurePasswordKdfAlgo.md @@ -0,0 +1,30 @@ +--- +title: SecurePasswordKdfAlgo +description: constructors and methods of type SecurePasswordKdfAlgo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecurePasswordKdfAlgo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[securePasswordKdfAlgoUnknown](../constructors/securePasswordKdfAlgoUnknown.md) + +[securePasswordKdfAlgoPBKDF2HMACSHA512iter100000](../constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md) + +[securePasswordKdfAlgoSHA512](../constructors/securePasswordKdfAlgoSHA512.md) + + + +### Methods that return an object of this type (methods): + + + +[securePasswordKdfAlgoUnknown](../constructors/securePasswordKdfAlgoUnknown.md) + +[securePasswordKdfAlgoPBKDF2HMACSHA512iter100000](../constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md) + +[securePasswordKdfAlgoSHA512](../constructors/securePasswordKdfAlgoSHA512.md) + diff --git a/old_docs/API_docs_v44/types/SecurePlainData.md b/old_docs/API_docs_v44/types/SecurePlainData.md new file mode 100644 index 00000000..6d61191c --- /dev/null +++ b/old_docs/API_docs_v44/types/SecurePlainData.md @@ -0,0 +1,26 @@ +--- +title: SecurePlainData +description: constructors and methods of type SecurePlainData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecurePlainData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[securePlainPhone](../constructors/securePlainPhone.md) + +[securePlainEmail](../constructors/securePlainEmail.md) + + + +### Methods that return an object of this type (methods): + + + +[securePlainPhone](../constructors/securePlainPhone.md) + +[securePlainEmail](../constructors/securePlainEmail.md) + diff --git a/old_docs/API_docs_v44/types/SecureRequiredType.md b/old_docs/API_docs_v44/types/SecureRequiredType.md new file mode 100644 index 00000000..844f0500 --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureRequiredType.md @@ -0,0 +1,26 @@ +--- +title: SecureRequiredType +description: constructors and methods of type SecureRequiredType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureRequiredType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureRequiredType](../constructors/secureRequiredType.md) + +[secureRequiredTypeOneOf](../constructors/secureRequiredTypeOneOf.md) + + + +### Methods that return an object of this type (methods): + + + +[secureRequiredType](../constructors/secureRequiredType.md) + +[secureRequiredTypeOneOf](../constructors/secureRequiredTypeOneOf.md) + diff --git a/old_docs/API_docs_v44/types/SecureSecretSettings.md b/old_docs/API_docs_v44/types/SecureSecretSettings.md new file mode 100644 index 00000000..06d26ce5 --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureSecretSettings.md @@ -0,0 +1,22 @@ +--- +title: SecureSecretSettings +description: constructors and methods of type SecureSecretSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureSecretSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureSecretSettings](../constructors/secureSecretSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[secureSecretSettings](../constructors/secureSecretSettings.md) + diff --git a/old_docs/API_docs_v44/types/SecureValue.md b/old_docs/API_docs_v44/types/SecureValue.md new file mode 100644 index 00000000..881b9a36 --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureValue.md @@ -0,0 +1,34 @@ +--- +title: SecureValue +description: constructors and methods of type SecureValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValue](../constructors/secureValue.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAllSecureValues](../methods/account.getAllSecureValues.md) + +[$MadelineProto->account->getSecureValue](../methods/account.getSecureValue.md) + +[$MadelineProto->account->saveSecureValue](../methods/account.saveSecureValue.md) + + + +[secureValue](../constructors/secureValue.md) + +[$MadelineProto->account->getAllSecureValues](../methods/account.getAllSecureValues.md) + +[$MadelineProto->account->getSecureValue](../methods/account.getSecureValue.md) + +[$MadelineProto->account->saveSecureValue](../methods/account.saveSecureValue.md) + diff --git a/old_docs/API_docs_v44/types/SecureValueError.md b/old_docs/API_docs_v44/types/SecureValueError.md new file mode 100644 index 00000000..482aa62e --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureValueError.md @@ -0,0 +1,54 @@ +--- +title: SecureValueError +description: constructors and methods of type SecureValueError +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueError +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueErrorData](../constructors/secureValueErrorData.md) + +[secureValueErrorFrontSide](../constructors/secureValueErrorFrontSide.md) + +[secureValueErrorReverseSide](../constructors/secureValueErrorReverseSide.md) + +[secureValueErrorSelfie](../constructors/secureValueErrorSelfie.md) + +[secureValueErrorFile](../constructors/secureValueErrorFile.md) + +[secureValueErrorFiles](../constructors/secureValueErrorFiles.md) + +[secureValueError](../constructors/secureValueError.md) + +[secureValueErrorTranslationFile](../constructors/secureValueErrorTranslationFile.md) + +[secureValueErrorTranslationFiles](../constructors/secureValueErrorTranslationFiles.md) + + + +### Methods that return an object of this type (methods): + + + +[secureValueErrorData](../constructors/secureValueErrorData.md) + +[secureValueErrorFrontSide](../constructors/secureValueErrorFrontSide.md) + +[secureValueErrorReverseSide](../constructors/secureValueErrorReverseSide.md) + +[secureValueErrorSelfie](../constructors/secureValueErrorSelfie.md) + +[secureValueErrorFile](../constructors/secureValueErrorFile.md) + +[secureValueErrorFiles](../constructors/secureValueErrorFiles.md) + +[secureValueError](../constructors/secureValueError.md) + +[secureValueErrorTranslationFile](../constructors/secureValueErrorTranslationFile.md) + +[secureValueErrorTranslationFiles](../constructors/secureValueErrorTranslationFiles.md) + diff --git a/old_docs/API_docs_v44/types/SecureValueHash.md b/old_docs/API_docs_v44/types/SecureValueHash.md new file mode 100644 index 00000000..c925d85e --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureValueHash.md @@ -0,0 +1,22 @@ +--- +title: SecureValueHash +description: constructors and methods of type SecureValueHash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueHash +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueHash](../constructors/secureValueHash.md) + + + +### Methods that return an object of this type (methods): + + + +[secureValueHash](../constructors/secureValueHash.md) + diff --git a/old_docs/API_docs_v44/types/SecureValueType.md b/old_docs/API_docs_v44/types/SecureValueType.md new file mode 100644 index 00000000..fe7fdfbf --- /dev/null +++ b/old_docs/API_docs_v44/types/SecureValueType.md @@ -0,0 +1,70 @@ +--- +title: SecureValueType +description: constructors and methods of type SecureValueType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md) + +[secureValueTypePassport](../constructors/secureValueTypePassport.md) + +[secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md) + +[secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md) + +[secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md) + +[secureValueTypeAddress](../constructors/secureValueTypeAddress.md) + +[secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md) + +[secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md) + +[secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md) + +[secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md) + +[secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md) + +[secureValueTypePhone](../constructors/secureValueTypePhone.md) + +[secureValueTypeEmail](../constructors/secureValueTypeEmail.md) + + + +### Methods that return an object of this type (methods): + + + +[secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md) + +[secureValueTypePassport](../constructors/secureValueTypePassport.md) + +[secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md) + +[secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md) + +[secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md) + +[secureValueTypeAddress](../constructors/secureValueTypeAddress.md) + +[secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md) + +[secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md) + +[secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md) + +[secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md) + +[secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md) + +[secureValueTypePhone](../constructors/secureValueTypePhone.md) + +[secureValueTypeEmail](../constructors/secureValueTypeEmail.md) + diff --git a/old_docs/API_docs_v44/types/SendMessageAction.md b/old_docs/API_docs_v44/types/SendMessageAction.md index 55dd9dcb..be5fddf0 100644 --- a/old_docs/API_docs_v44/types/SendMessageAction.md +++ b/old_docs/API_docs_v44/types/SendMessageAction.md @@ -3,7 +3,7 @@ title: SendMessageAction description: constructors and methods of type SendMessageAction image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: SendMessageAction +# Type: SendMessageAction [Back to types index](index.md) @@ -30,9 +30,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) +[sendMessageGamePlayAction](../constructors/sendMessageGamePlayAction.md) + +[sendMessageRecordRoundAction](../constructors/sendMessageRecordRoundAction.md) + +[sendMessageUploadRoundAction](../constructors/sendMessageUploadRoundAction.md) + ### Methods that return an object of this type (methods): +[sendMessageTypingAction](../constructors/sendMessageTypingAction.md) + +[sendMessageCancelAction](../constructors/sendMessageCancelAction.md) + +[sendMessageRecordVideoAction](../constructors/sendMessageRecordVideoAction.md) + +[sendMessageUploadVideoAction](../constructors/sendMessageUploadVideoAction.md) + +[sendMessageRecordAudioAction](../constructors/sendMessageRecordAudioAction.md) + +[sendMessageUploadAudioAction](../constructors/sendMessageUploadAudioAction.md) + +[sendMessageUploadPhotoAction](../constructors/sendMessageUploadPhotoAction.md) + +[sendMessageUploadDocumentAction](../constructors/sendMessageUploadDocumentAction.md) + +[sendMessageGeoLocationAction](../constructors/sendMessageGeoLocationAction.md) + +[sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) + +[sendMessageGamePlayAction](../constructors/sendMessageGamePlayAction.md) + +[sendMessageRecordRoundAction](../constructors/sendMessageRecordRoundAction.md) + +[sendMessageUploadRoundAction](../constructors/sendMessageUploadRoundAction.md) + diff --git a/old_docs/API_docs_v44/types/ShippingOption.md b/old_docs/API_docs_v44/types/ShippingOption.md new file mode 100644 index 00000000..d5315884 --- /dev/null +++ b/old_docs/API_docs_v44/types/ShippingOption.md @@ -0,0 +1,22 @@ +--- +title: ShippingOption +description: constructors and methods of type ShippingOption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ShippingOption +[Back to types index](index.md) + + + +### Possible values (constructors): + +[shippingOption](../constructors/shippingOption.md) + + + +### Methods that return an object of this type (methods): + + + +[shippingOption](../constructors/shippingOption.md) + diff --git a/old_docs/API_docs_v44/types/StatsAbsValueAndPrev.md b/old_docs/API_docs_v44/types/StatsAbsValueAndPrev.md new file mode 100644 index 00000000..8cce2e10 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsAbsValueAndPrev.md @@ -0,0 +1,22 @@ +--- +title: StatsAbsValueAndPrev +description: constructors and methods of type StatsAbsValueAndPrev +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsAbsValueAndPrev +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsAbsValueAndPrev](../constructors/statsAbsValueAndPrev.md) + + + +### Methods that return an object of this type (methods): + + + +[statsAbsValueAndPrev](../constructors/statsAbsValueAndPrev.md) + diff --git a/old_docs/API_docs_v44/types/StatsDateRangeDays.md b/old_docs/API_docs_v44/types/StatsDateRangeDays.md new file mode 100644 index 00000000..321f4fa5 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsDateRangeDays.md @@ -0,0 +1,22 @@ +--- +title: StatsDateRangeDays +description: constructors and methods of type StatsDateRangeDays +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsDateRangeDays +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsDateRangeDays](../constructors/statsDateRangeDays.md) + + + +### Methods that return an object of this type (methods): + + + +[statsDateRangeDays](../constructors/statsDateRangeDays.md) + diff --git a/old_docs/API_docs_v44/types/StatsGraph.md b/old_docs/API_docs_v44/types/StatsGraph.md new file mode 100644 index 00000000..0c2effe7 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsGraph.md @@ -0,0 +1,34 @@ +--- +title: StatsGraph +description: constructors and methods of type StatsGraph +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsGraph +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsGraphAsync](../constructors/statsGraphAsync.md) + +[statsGraphError](../constructors/statsGraphError.md) + +[statsGraph](../constructors/statsGraph.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->stats->loadAsyncGraph](../methods/stats.loadAsyncGraph.md) + + + +[statsGraphAsync](../constructors/statsGraphAsync.md) + +[statsGraphError](../constructors/statsGraphError.md) + +[statsGraph](../constructors/statsGraph.md) + +[$MadelineProto->stats->loadAsyncGraph](../methods/stats.loadAsyncGraph.md) + diff --git a/old_docs/API_docs_v44/types/StatsGroupTopAdmin.md b/old_docs/API_docs_v44/types/StatsGroupTopAdmin.md new file mode 100644 index 00000000..f8fb78da --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsGroupTopAdmin.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/StatsGroupTopInviter.md b/old_docs/API_docs_v44/types/StatsGroupTopInviter.md new file mode 100644 index 00000000..6f1b10ed --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsGroupTopInviter.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/StatsGroupTopPoster.md b/old_docs/API_docs_v44/types/StatsGroupTopPoster.md new file mode 100644 index 00000000..fe311877 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsGroupTopPoster.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/StatsPercentValue.md b/old_docs/API_docs_v44/types/StatsPercentValue.md new file mode 100644 index 00000000..b78f0797 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsPercentValue.md @@ -0,0 +1,22 @@ +--- +title: StatsPercentValue +description: constructors and methods of type StatsPercentValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsPercentValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsPercentValue](../constructors/statsPercentValue.md) + + + +### Methods that return an object of this type (methods): + + + +[statsPercentValue](../constructors/statsPercentValue.md) + diff --git a/old_docs/API_docs_v44/types/StatsURL.md b/old_docs/API_docs_v44/types/StatsURL.md new file mode 100644 index 00000000..291c5f64 --- /dev/null +++ b/old_docs/API_docs_v44/types/StatsURL.md @@ -0,0 +1,26 @@ +--- +title: StatsURL +description: constructors and methods of type StatsURL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsURL +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsURL](../constructors/statsURL.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getStatsURL](../methods/messages.getStatsURL.md) + + + +[statsURL](../constructors/statsURL.md) + +[$MadelineProto->messages->getStatsURL](../methods/messages.getStatsURL.md) + diff --git a/old_docs/API_docs_v44/types/StickerPack.md b/old_docs/API_docs_v44/types/StickerPack.md index ffb83b15..63973516 100644 --- a/old_docs/API_docs_v44/types/StickerPack.md +++ b/old_docs/API_docs_v44/types/StickerPack.md @@ -3,7 +3,7 @@ title: StickerPack description: constructors and methods of type StickerPack image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: StickerPack +# Type: StickerPack [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[stickerPack](../constructors/stickerPack.md) + diff --git a/old_docs/API_docs_v44/types/StickerSet.md b/old_docs/API_docs_v44/types/StickerSet.md index 70aa63dc..66aff003 100644 --- a/old_docs/API_docs_v44/types/StickerSet.md +++ b/old_docs/API_docs_v44/types/StickerSet.md @@ -3,7 +3,7 @@ title: StickerSet description: constructors and methods of type StickerSet image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: StickerSet +# Type: StickerSet [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[stickerSet](../constructors/stickerSet.md) + diff --git a/old_docs/API_docs_v44/types/StickerSetCovered.md b/old_docs/API_docs_v44/types/StickerSetCovered.md new file mode 100644 index 00000000..87c9ffc0 --- /dev/null +++ b/old_docs/API_docs_v44/types/StickerSetCovered.md @@ -0,0 +1,30 @@ +--- +title: StickerSetCovered +description: constructors and methods of type StickerSetCovered +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StickerSetCovered +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stickerSetCovered](../constructors/stickerSetCovered.md) + +[stickerSetMultiCovered](../constructors/stickerSetMultiCovered.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getAttachedStickers](../methods/messages.getAttachedStickers.md) + + + +[stickerSetCovered](../constructors/stickerSetCovered.md) + +[stickerSetMultiCovered](../constructors/stickerSetMultiCovered.md) + +[$MadelineProto->messages->getAttachedStickers](../methods/messages.getAttachedStickers.md) + diff --git a/old_docs/API_docs_v44/types/Theme.md b/old_docs/API_docs_v44/types/Theme.md new file mode 100644 index 00000000..3882d570 --- /dev/null +++ b/old_docs/API_docs_v44/types/Theme.md @@ -0,0 +1,34 @@ +--- +title: Theme +description: constructors and methods of type Theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Theme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[theme](../constructors/theme.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->createTheme](../methods/account.createTheme.md) + +[$MadelineProto->account->updateTheme](../methods/account.updateTheme.md) + +[$MadelineProto->account->getTheme](../methods/account.getTheme.md) + + + +[theme](../constructors/theme.md) + +[$MadelineProto->account->createTheme](../methods/account.createTheme.md) + +[$MadelineProto->account->updateTheme](../methods/account.updateTheme.md) + +[$MadelineProto->account->getTheme](../methods/account.getTheme.md) + diff --git a/old_docs/API_docs_v44/types/ThemeSettings.md b/old_docs/API_docs_v44/types/ThemeSettings.md new file mode 100644 index 00000000..01127465 --- /dev/null +++ b/old_docs/API_docs_v44/types/ThemeSettings.md @@ -0,0 +1,22 @@ +--- +title: ThemeSettings +description: constructors and methods of type ThemeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ThemeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[themeSettings](../constructors/themeSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[themeSettings](../constructors/themeSettings.md) + diff --git a/old_docs/API_docs_v44/types/TopPeer.md b/old_docs/API_docs_v44/types/TopPeer.md new file mode 100644 index 00000000..169d5b3c --- /dev/null +++ b/old_docs/API_docs_v44/types/TopPeer.md @@ -0,0 +1,22 @@ +--- +title: TopPeer +description: constructors and methods of type TopPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeer](../constructors/topPeer.md) + + + +### Methods that return an object of this type (methods): + + + +[topPeer](../constructors/topPeer.md) + diff --git a/old_docs/API_docs_v44/types/TopPeerCategory.md b/old_docs/API_docs_v44/types/TopPeerCategory.md new file mode 100644 index 00000000..fb123c4d --- /dev/null +++ b/old_docs/API_docs_v44/types/TopPeerCategory.md @@ -0,0 +1,50 @@ +--- +title: TopPeerCategory +description: constructors and methods of type TopPeerCategory +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeerCategory +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeerCategoryBotsPM](../constructors/topPeerCategoryBotsPM.md) + +[topPeerCategoryBotsInline](../constructors/topPeerCategoryBotsInline.md) + +[topPeerCategoryCorrespondents](../constructors/topPeerCategoryCorrespondents.md) + +[topPeerCategoryGroups](../constructors/topPeerCategoryGroups.md) + +[topPeerCategoryChannels](../constructors/topPeerCategoryChannels.md) + +[topPeerCategoryPhoneCalls](../constructors/topPeerCategoryPhoneCalls.md) + +[topPeerCategoryForwardUsers](../constructors/topPeerCategoryForwardUsers.md) + +[topPeerCategoryForwardChats](../constructors/topPeerCategoryForwardChats.md) + + + +### Methods that return an object of this type (methods): + + + +[topPeerCategoryBotsPM](../constructors/topPeerCategoryBotsPM.md) + +[topPeerCategoryBotsInline](../constructors/topPeerCategoryBotsInline.md) + +[topPeerCategoryCorrespondents](../constructors/topPeerCategoryCorrespondents.md) + +[topPeerCategoryGroups](../constructors/topPeerCategoryGroups.md) + +[topPeerCategoryChannels](../constructors/topPeerCategoryChannels.md) + +[topPeerCategoryPhoneCalls](../constructors/topPeerCategoryPhoneCalls.md) + +[topPeerCategoryForwardUsers](../constructors/topPeerCategoryForwardUsers.md) + +[topPeerCategoryForwardChats](../constructors/topPeerCategoryForwardChats.md) + diff --git a/old_docs/API_docs_v44/types/TopPeerCategoryPeers.md b/old_docs/API_docs_v44/types/TopPeerCategoryPeers.md new file mode 100644 index 00000000..1f45ce72 --- /dev/null +++ b/old_docs/API_docs_v44/types/TopPeerCategoryPeers.md @@ -0,0 +1,22 @@ +--- +title: TopPeerCategoryPeers +description: constructors and methods of type TopPeerCategoryPeers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeerCategoryPeers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeerCategoryPeers](../constructors/topPeerCategoryPeers.md) + + + +### Methods that return an object of this type (methods): + + + +[topPeerCategoryPeers](../constructors/topPeerCategoryPeers.md) + diff --git a/old_docs/API_docs_v44/types/True.md b/old_docs/API_docs_v44/types/True.md index ea96d248..f6aeb4a6 100644 --- a/old_docs/API_docs_v44/types/True.md +++ b/old_docs/API_docs_v44/types/True.md @@ -3,7 +3,7 @@ title: True description: constructors and methods of type True image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: True +# Type: True [Back to types index](index.md) @@ -18,3 +18,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[true](../constructors/true.md) + diff --git a/old_docs/API_docs_v44/types/Update.md b/old_docs/API_docs_v44/types/Update.md index 6aae3a38..8e278a0b 100644 --- a/old_docs/API_docs_v44/types/Update.md +++ b/old_docs/API_docs_v44/types/Update.md @@ -3,7 +3,7 @@ title: Update description: constructors and methods of type Update image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Update +# Type: Update [Back to types index](index.md) @@ -28,12 +28,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateUserPhoto](../constructors/updateUserPhoto.md) -[updateContactRegistered](../constructors/updateContactRegistered.md) - -[updateContactLink](../constructors/updateContactLink.md) - -[updateNewAuthorization](../constructors/updateNewAuthorization.md) - [updateNewEncryptedMessage](../constructors/updateNewEncryptedMessage.md) [updateEncryptedChatTyping](../constructors/updateEncryptedChatTyping.md) @@ -70,8 +64,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateChannel](../constructors/updateChannel.md) -[updateChannelGroup](../constructors/updateChannelGroup.md) - [updateNewChannelMessage](../constructors/updateNewChannelMessage.md) [updateReadChannelInbox](../constructors/updateReadChannelInbox.md) @@ -80,8 +72,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateChannelMessageViews](../constructors/updateChannelMessageViews.md) -[updateChatAdmins](../constructors/updateChatAdmins.md) - [updateChatParticipantAdmin](../constructors/updateChatParticipantAdmin.md) [updateNewStickerSet](../constructors/updateNewStickerSet.md) @@ -90,9 +80,267 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateStickerSets](../constructors/updateStickerSets.md) +[updateSavedGifs](../constructors/updateSavedGifs.md) + +[updateBotInlineQuery](../constructors/updateBotInlineQuery.md) + +[updateBotInlineSend](../constructors/updateBotInlineSend.md) + +[updateEditChannelMessage](../constructors/updateEditChannelMessage.md) + +[updateChannelPinnedMessage](../constructors/updateChannelPinnedMessage.md) + +[updateBotCallbackQuery](../constructors/updateBotCallbackQuery.md) + +[updateEditMessage](../constructors/updateEditMessage.md) + +[updateInlineBotCallbackQuery](../constructors/updateInlineBotCallbackQuery.md) + +[updateReadChannelOutbox](../constructors/updateReadChannelOutbox.md) + +[updateDraftMessage](../constructors/updateDraftMessage.md) + +[updateReadFeaturedStickers](../constructors/updateReadFeaturedStickers.md) + +[updateRecentStickers](../constructors/updateRecentStickers.md) + +[updateConfig](../constructors/updateConfig.md) + +[updatePtsChanged](../constructors/updatePtsChanged.md) + +[updateChannelWebPage](../constructors/updateChannelWebPage.md) + +[updateDialogPinned](../constructors/updateDialogPinned.md) + +[updatePinnedDialogs](../constructors/updatePinnedDialogs.md) + +[updateBotWebhookJSON](../constructors/updateBotWebhookJSON.md) + +[updateBotWebhookJSONQuery](../constructors/updateBotWebhookJSONQuery.md) + +[updateBotShippingQuery](../constructors/updateBotShippingQuery.md) + +[updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) + +[updatePhoneCall](../constructors/updatePhoneCall.md) + +[updateLangPackTooLong](../constructors/updateLangPackTooLong.md) + +[updateLangPack](../constructors/updateLangPack.md) + +[updateFavedStickers](../constructors/updateFavedStickers.md) + +[updateChannelReadMessagesContents](../constructors/updateChannelReadMessagesContents.md) + +[updateContactsReset](../constructors/updateContactsReset.md) + +[updateChannelAvailableMessages](../constructors/updateChannelAvailableMessages.md) + +[updateDialogUnreadMark](../constructors/updateDialogUnreadMark.md) + +[updateUserPinnedMessage](../constructors/updateUserPinnedMessage.md) + +[updateChatPinnedMessage](../constructors/updateChatPinnedMessage.md) + +[updateMessagePoll](../constructors/updateMessagePoll.md) + +[updateChatDefaultBannedRights](../constructors/updateChatDefaultBannedRights.md) + +[updateFolderPeers](../constructors/updateFolderPeers.md) + +[updatePeerSettings](../constructors/updatePeerSettings.md) + +[updatePeerLocated](../constructors/updatePeerLocated.md) + +[updateNewScheduledMessage](../constructors/updateNewScheduledMessage.md) + +[updateDeleteScheduledMessages](../constructors/updateDeleteScheduledMessages.md) + +[updateTheme](../constructors/updateTheme.md) + +[updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) + +[updateLoginToken](../constructors/updateLoginToken.md) + +[updateMessagePollVote](../constructors/updateMessagePollVote.md) + +[updateDialogFilter](../constructors/updateDialogFilter.md) + +[updateDialogFilterOrder](../constructors/updateDialogFilterOrder.md) + +[updateDialogFilters](../constructors/updateDialogFilters.md) + +[updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md) + +[updateChannelParticipant](../constructors/updateChannelParticipant.md) + ### Methods that return an object of this type (methods): +[updateNewMessage](../constructors/updateNewMessage.md) + +[updateMessageID](../constructors/updateMessageID.md) + +[updateDeleteMessages](../constructors/updateDeleteMessages.md) + +[updateUserTyping](../constructors/updateUserTyping.md) + +[updateChatUserTyping](../constructors/updateChatUserTyping.md) + +[updateChatParticipants](../constructors/updateChatParticipants.md) + +[updateUserStatus](../constructors/updateUserStatus.md) + +[updateUserName](../constructors/updateUserName.md) + +[updateUserPhoto](../constructors/updateUserPhoto.md) + +[updateNewEncryptedMessage](../constructors/updateNewEncryptedMessage.md) + +[updateEncryptedChatTyping](../constructors/updateEncryptedChatTyping.md) + +[updateEncryption](../constructors/updateEncryption.md) + +[updateEncryptedMessagesRead](../constructors/updateEncryptedMessagesRead.md) + +[updateChatParticipantAdd](../constructors/updateChatParticipantAdd.md) + +[updateChatParticipantDelete](../constructors/updateChatParticipantDelete.md) + +[updateDcOptions](../constructors/updateDcOptions.md) + +[updateUserBlocked](../constructors/updateUserBlocked.md) + +[updateNotifySettings](../constructors/updateNotifySettings.md) + +[updateServiceNotification](../constructors/updateServiceNotification.md) + +[updatePrivacy](../constructors/updatePrivacy.md) + +[updateUserPhone](../constructors/updateUserPhone.md) + +[updateReadHistoryInbox](../constructors/updateReadHistoryInbox.md) + +[updateReadHistoryOutbox](../constructors/updateReadHistoryOutbox.md) + +[updateWebPage](../constructors/updateWebPage.md) + +[updateReadMessagesContents](../constructors/updateReadMessagesContents.md) + +[updateChannelTooLong](../constructors/updateChannelTooLong.md) + +[updateChannel](../constructors/updateChannel.md) + +[updateNewChannelMessage](../constructors/updateNewChannelMessage.md) + +[updateReadChannelInbox](../constructors/updateReadChannelInbox.md) + +[updateDeleteChannelMessages](../constructors/updateDeleteChannelMessages.md) + +[updateChannelMessageViews](../constructors/updateChannelMessageViews.md) + +[updateChatParticipantAdmin](../constructors/updateChatParticipantAdmin.md) + +[updateNewStickerSet](../constructors/updateNewStickerSet.md) + +[updateStickerSetsOrder](../constructors/updateStickerSetsOrder.md) + +[updateStickerSets](../constructors/updateStickerSets.md) + +[updateSavedGifs](../constructors/updateSavedGifs.md) + +[updateBotInlineQuery](../constructors/updateBotInlineQuery.md) + +[updateBotInlineSend](../constructors/updateBotInlineSend.md) + +[updateEditChannelMessage](../constructors/updateEditChannelMessage.md) + +[updateChannelPinnedMessage](../constructors/updateChannelPinnedMessage.md) + +[updateBotCallbackQuery](../constructors/updateBotCallbackQuery.md) + +[updateEditMessage](../constructors/updateEditMessage.md) + +[updateInlineBotCallbackQuery](../constructors/updateInlineBotCallbackQuery.md) + +[updateReadChannelOutbox](../constructors/updateReadChannelOutbox.md) + +[updateDraftMessage](../constructors/updateDraftMessage.md) + +[updateReadFeaturedStickers](../constructors/updateReadFeaturedStickers.md) + +[updateRecentStickers](../constructors/updateRecentStickers.md) + +[updateConfig](../constructors/updateConfig.md) + +[updatePtsChanged](../constructors/updatePtsChanged.md) + +[updateChannelWebPage](../constructors/updateChannelWebPage.md) + +[updateDialogPinned](../constructors/updateDialogPinned.md) + +[updatePinnedDialogs](../constructors/updatePinnedDialogs.md) + +[updateBotWebhookJSON](../constructors/updateBotWebhookJSON.md) + +[updateBotWebhookJSONQuery](../constructors/updateBotWebhookJSONQuery.md) + +[updateBotShippingQuery](../constructors/updateBotShippingQuery.md) + +[updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) + +[updatePhoneCall](../constructors/updatePhoneCall.md) + +[updateLangPackTooLong](../constructors/updateLangPackTooLong.md) + +[updateLangPack](../constructors/updateLangPack.md) + +[updateFavedStickers](../constructors/updateFavedStickers.md) + +[updateChannelReadMessagesContents](../constructors/updateChannelReadMessagesContents.md) + +[updateContactsReset](../constructors/updateContactsReset.md) + +[updateChannelAvailableMessages](../constructors/updateChannelAvailableMessages.md) + +[updateDialogUnreadMark](../constructors/updateDialogUnreadMark.md) + +[updateUserPinnedMessage](../constructors/updateUserPinnedMessage.md) + +[updateChatPinnedMessage](../constructors/updateChatPinnedMessage.md) + +[updateMessagePoll](../constructors/updateMessagePoll.md) + +[updateChatDefaultBannedRights](../constructors/updateChatDefaultBannedRights.md) + +[updateFolderPeers](../constructors/updateFolderPeers.md) + +[updatePeerSettings](../constructors/updatePeerSettings.md) + +[updatePeerLocated](../constructors/updatePeerLocated.md) + +[updateNewScheduledMessage](../constructors/updateNewScheduledMessage.md) + +[updateDeleteScheduledMessages](../constructors/updateDeleteScheduledMessages.md) + +[updateTheme](../constructors/updateTheme.md) + +[updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) + +[updateLoginToken](../constructors/updateLoginToken.md) + +[updateMessagePollVote](../constructors/updateMessagePollVote.md) + +[updateDialogFilter](../constructors/updateDialogFilter.md) + +[updateDialogFilterOrder](../constructors/updateDialogFilterOrder.md) + +[updateDialogFilters](../constructors/updateDialogFilters.md) + +[updatePhoneCallSignalingData](../constructors/updatePhoneCallSignalingData.md) + +[updateChannelParticipant](../constructors/updateChannelParticipant.md) + diff --git a/old_docs/API_docs_v44/types/Updates.md b/old_docs/API_docs_v44/types/Updates.md index edac3968..bedd677d 100644 --- a/old_docs/API_docs_v44/types/Updates.md +++ b/old_docs/API_docs_v44/types/Updates.md @@ -3,7 +3,7 @@ title: Updates description: constructors and methods of type Updates image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: Updates +# Type: Updates [Back to types index](index.md) @@ -28,6 +28,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->account->getNotifyExceptions](../methods/account.getNotifyExceptions.md) + +[$MadelineProto->contacts->deleteContacts](../methods/contacts.deleteContacts.md) + +[$MadelineProto->contacts->addContact](../methods/contacts.addContact.md) + +[$MadelineProto->contacts->acceptContact](../methods/contacts.acceptContact.md) + +[$MadelineProto->contacts->getLocated](../methods/contacts.getLocated.md) + [$MadelineProto->messages->sendMessage](../methods/messages.sendMessage.md) [$MadelineProto->messages->sendMedia](../methods/messages.sendMedia.md) @@ -44,14 +54,38 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->messages->createChat](../methods/messages.createChat.md) -[$MadelineProto->messages->forwardMessage](../methods/messages.forwardMessage.md) - -[$MadelineProto->messages->sendBroadcast](../methods/messages.sendBroadcast.md) - [$MadelineProto->messages->importChatInvite](../methods/messages.importChatInvite.md) [$MadelineProto->messages->startBot](../methods/messages.startBot.md) +[$MadelineProto->messages->migrateChat](../methods/messages.migrateChat.md) + +[$MadelineProto->messages->sendInlineBotResult](../methods/messages.sendInlineBotResult.md) + +[$MadelineProto->messages->editMessage](../methods/messages.editMessage.md) + +[$MadelineProto->messages->getAllDrafts](../methods/messages.getAllDrafts.md) + +[$MadelineProto->messages->setGameScore](../methods/messages.setGameScore.md) + +[$MadelineProto->messages->sendScreenshotNotification](../methods/messages.sendScreenshotNotification.md) + +[$MadelineProto->messages->sendMultiMedia](../methods/messages.sendMultiMedia.md) + +[$MadelineProto->messages->updatePinnedMessage](../methods/messages.updatePinnedMessage.md) + +[$MadelineProto->messages->sendVote](../methods/messages.sendVote.md) + +[$MadelineProto->messages->getPollResults](../methods/messages.getPollResults.md) + +[$MadelineProto->messages->editChatDefaultBannedRights](../methods/messages.editChatDefaultBannedRights.md) + +[$MadelineProto->messages->sendScheduledMessages](../methods/messages.sendScheduledMessages.md) + +[$MadelineProto->messages->deleteScheduledMessages](../methods/messages.deleteScheduledMessages.md) + +[$MadelineProto->help->getAppChangelog](../methods/help.getAppChangelog.md) + [$MadelineProto->channels->createChannel](../methods/channels.createChannel.md) [$MadelineProto->channels->editAdmin](../methods/channels.editAdmin.md) @@ -60,7 +94,113 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->channels->editPhoto](../methods/channels.editPhoto.md) -[$MadelineProto->channels->toggleComments](../methods/channels.toggleComments.md) +[$MadelineProto->channels->joinChannel](../methods/channels.joinChannel.md) + +[$MadelineProto->channels->leaveChannel](../methods/channels.leaveChannel.md) + +[$MadelineProto->channels->inviteToChannel](../methods/channels.inviteToChannel.md) + +[$MadelineProto->channels->deleteChannel](../methods/channels.deleteChannel.md) + +[$MadelineProto->channels->toggleSignatures](../methods/channels.toggleSignatures.md) + +[$MadelineProto->channels->editBanned](../methods/channels.editBanned.md) + +[$MadelineProto->channels->togglePreHistoryHidden](../methods/channels.togglePreHistoryHidden.md) + +[$MadelineProto->channels->editCreator](../methods/channels.editCreator.md) + +[$MadelineProto->channels->toggleSlowMode](../methods/channels.toggleSlowMode.md) + +[$MadelineProto->phone->discardCall](../methods/phone.discardCall.md) + +[$MadelineProto->phone->setCallRating](../methods/phone.setCallRating.md) + +[$MadelineProto->folders->editPeerFolders](../methods/folders.editPeerFolders.md) + +[$MadelineProto->folders->deleteFolder](../methods/folders.deleteFolder.md) + + + +[updatesTooLong](../constructors/updatesTooLong.md) + +[updateShortMessage](../constructors/updateShortMessage.md) + +[updateShortChatMessage](../constructors/updateShortChatMessage.md) + +[updateShort](../constructors/updateShort.md) + +[updatesCombined](../constructors/updatesCombined.md) + +[updates](../constructors/updates.md) + +[updateShortSentMessage](../constructors/updateShortSentMessage.md) + +[$MadelineProto->account->getNotifyExceptions](../methods/account.getNotifyExceptions.md) + +[$MadelineProto->contacts->deleteContacts](../methods/contacts.deleteContacts.md) + +[$MadelineProto->contacts->addContact](../methods/contacts.addContact.md) + +[$MadelineProto->contacts->acceptContact](../methods/contacts.acceptContact.md) + +[$MadelineProto->contacts->getLocated](../methods/contacts.getLocated.md) + +[$MadelineProto->messages->sendMessage](../methods/messages.sendMessage.md) + +[$MadelineProto->messages->sendMedia](../methods/messages.sendMedia.md) + +[$MadelineProto->messages->forwardMessages](../methods/messages.forwardMessages.md) + +[$MadelineProto->messages->editChatTitle](../methods/messages.editChatTitle.md) + +[$MadelineProto->messages->editChatPhoto](../methods/messages.editChatPhoto.md) + +[$MadelineProto->messages->addChatUser](../methods/messages.addChatUser.md) + +[$MadelineProto->messages->deleteChatUser](../methods/messages.deleteChatUser.md) + +[$MadelineProto->messages->createChat](../methods/messages.createChat.md) + +[$MadelineProto->messages->importChatInvite](../methods/messages.importChatInvite.md) + +[$MadelineProto->messages->startBot](../methods/messages.startBot.md) + +[$MadelineProto->messages->migrateChat](../methods/messages.migrateChat.md) + +[$MadelineProto->messages->sendInlineBotResult](../methods/messages.sendInlineBotResult.md) + +[$MadelineProto->messages->editMessage](../methods/messages.editMessage.md) + +[$MadelineProto->messages->getAllDrafts](../methods/messages.getAllDrafts.md) + +[$MadelineProto->messages->setGameScore](../methods/messages.setGameScore.md) + +[$MadelineProto->messages->sendScreenshotNotification](../methods/messages.sendScreenshotNotification.md) + +[$MadelineProto->messages->sendMultiMedia](../methods/messages.sendMultiMedia.md) + +[$MadelineProto->messages->updatePinnedMessage](../methods/messages.updatePinnedMessage.md) + +[$MadelineProto->messages->sendVote](../methods/messages.sendVote.md) + +[$MadelineProto->messages->getPollResults](../methods/messages.getPollResults.md) + +[$MadelineProto->messages->editChatDefaultBannedRights](../methods/messages.editChatDefaultBannedRights.md) + +[$MadelineProto->messages->sendScheduledMessages](../methods/messages.sendScheduledMessages.md) + +[$MadelineProto->messages->deleteScheduledMessages](../methods/messages.deleteScheduledMessages.md) + +[$MadelineProto->help->getAppChangelog](../methods/help.getAppChangelog.md) + +[$MadelineProto->channels->createChannel](../methods/channels.createChannel.md) + +[$MadelineProto->channels->editAdmin](../methods/channels.editAdmin.md) + +[$MadelineProto->channels->editTitle](../methods/channels.editTitle.md) + +[$MadelineProto->channels->editPhoto](../methods/channels.editPhoto.md) [$MadelineProto->channels->joinChannel](../methods/channels.joinChannel.md) @@ -68,13 +208,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->channels->inviteToChannel](../methods/channels.inviteToChannel.md) -[$MadelineProto->channels->kickFromChannel](../methods/channels.kickFromChannel.md) - [$MadelineProto->channels->deleteChannel](../methods/channels.deleteChannel.md) -[$MadelineProto->messages->toggleChatAdmins](../methods/messages.toggleChatAdmins.md) +[$MadelineProto->channels->toggleSignatures](../methods/channels.toggleSignatures.md) -[$MadelineProto->messages->migrateChat](../methods/messages.migrateChat.md) +[$MadelineProto->channels->editBanned](../methods/channels.editBanned.md) +[$MadelineProto->channels->togglePreHistoryHidden](../methods/channels.togglePreHistoryHidden.md) +[$MadelineProto->channels->editCreator](../methods/channels.editCreator.md) + +[$MadelineProto->channels->toggleSlowMode](../methods/channels.toggleSlowMode.md) + +[$MadelineProto->phone->discardCall](../methods/phone.discardCall.md) + +[$MadelineProto->phone->setCallRating](../methods/phone.setCallRating.md) + +[$MadelineProto->folders->editPeerFolders](../methods/folders.editPeerFolders.md) + +[$MadelineProto->folders->deleteFolder](../methods/folders.deleteFolder.md) diff --git a/old_docs/API_docs_v44/types/UrlAuthResult.md b/old_docs/API_docs_v44/types/UrlAuthResult.md new file mode 100644 index 00000000..e9fd5673 --- /dev/null +++ b/old_docs/API_docs_v44/types/UrlAuthResult.md @@ -0,0 +1,38 @@ +--- +title: UrlAuthResult +description: constructors and methods of type UrlAuthResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: UrlAuthResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[urlAuthResultRequest](../constructors/urlAuthResultRequest.md) + +[urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) + +[urlAuthResultDefault](../constructors/urlAuthResultDefault.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->requestUrlAuth](../methods/messages.requestUrlAuth.md) + +[$MadelineProto->messages->acceptUrlAuth](../methods/messages.acceptUrlAuth.md) + + + +[urlAuthResultRequest](../constructors/urlAuthResultRequest.md) + +[urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) + +[urlAuthResultDefault](../constructors/urlAuthResultDefault.md) + +[$MadelineProto->messages->requestUrlAuth](../methods/messages.requestUrlAuth.md) + +[$MadelineProto->messages->acceptUrlAuth](../methods/messages.acceptUrlAuth.md) + diff --git a/old_docs/API_docs_v44/types/User.md b/old_docs/API_docs_v44/types/User.md index 30349c87..b12a0be9 100644 --- a/old_docs/API_docs_v44/types/User.md +++ b/old_docs/API_docs_v44/types/User.md @@ -3,16 +3,14 @@ title: User description: constructors and methods of type User image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: User +# Type: User [Back to types index](index.md) - - You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. The following syntaxes can also be used: -``` +```php $User = '@username'; // Username $User = 'me'; // The currently logged-in user @@ -32,6 +30,8 @@ $User = 'channel#38575794'; // tg-cli style id (channels) A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + ### Possible values (constructors): [userEmpty](../constructors/userEmpty.md) @@ -44,13 +44,23 @@ A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDia [$MadelineProto->account->updateProfile](../methods/account.updateProfile.md) +[$MadelineProto->account->updateUsername](../methods/account.updateUsername.md) + +[$MadelineProto->account->changePhone](../methods/account.changePhone.md) + [$MadelineProto->users->getUsers](../methods/users.getUsers.md) -[$MadelineProto->contacts->importCard](../methods/contacts.importCard.md) + + +[userEmpty](../constructors/userEmpty.md) + +[user](../constructors/user.md) + +[$MadelineProto->account->updateProfile](../methods/account.updateProfile.md) [$MadelineProto->account->updateUsername](../methods/account.updateUsername.md) [$MadelineProto->account->changePhone](../methods/account.changePhone.md) - +[$MadelineProto->users->getUsers](../methods/users.getUsers.md) diff --git a/old_docs/API_docs_v44/types/UserFull.md b/old_docs/API_docs_v44/types/UserFull.md index ac50052f..7294a423 100644 --- a/old_docs/API_docs_v44/types/UserFull.md +++ b/old_docs/API_docs_v44/types/UserFull.md @@ -3,7 +3,7 @@ title: UserFull description: constructors and methods of type UserFull image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: UserFull +# Type: UserFull [Back to types index](index.md) @@ -20,3 +20,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[userFull](../constructors/userFull.md) + +[$MadelineProto->users->getFullUser](../methods/users.getFullUser.md) + diff --git a/old_docs/API_docs_v44/types/UserProfilePhoto.md b/old_docs/API_docs_v44/types/UserProfilePhoto.md index e81e92fd..cf1a1685 100644 --- a/old_docs/API_docs_v44/types/UserProfilePhoto.md +++ b/old_docs/API_docs_v44/types/UserProfilePhoto.md @@ -3,7 +3,7 @@ title: UserProfilePhoto description: constructors and methods of type UserProfilePhoto image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: UserProfilePhoto +# Type: UserProfilePhoto [Back to types index](index.md) @@ -18,7 +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) diff --git a/old_docs/API_docs_v44/types/UserStatus.md b/old_docs/API_docs_v44/types/UserStatus.md index a5f9ec16..ac14b70a 100644 --- a/old_docs/API_docs_v44/types/UserStatus.md +++ b/old_docs/API_docs_v44/types/UserStatus.md @@ -3,7 +3,7 @@ title: UserStatus description: constructors and methods of type UserStatus image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: UserStatus +# Type: UserStatus [Back to types index](index.md) @@ -28,3 +28,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +[userStatusEmpty](../constructors/userStatusEmpty.md) + +[userStatusOnline](../constructors/userStatusOnline.md) + +[userStatusOffline](../constructors/userStatusOffline.md) + +[userStatusRecently](../constructors/userStatusRecently.md) + +[userStatusLastWeek](../constructors/userStatusLastWeek.md) + +[userStatusLastMonth](../constructors/userStatusLastMonth.md) + diff --git a/old_docs/API_docs_v44/types/VideoSize.md b/old_docs/API_docs_v44/types/VideoSize.md new file mode 100644 index 00000000..63223f46 --- /dev/null +++ b/old_docs/API_docs_v44/types/VideoSize.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/WallPaper.md b/old_docs/API_docs_v44/types/WallPaper.md index 45337565..07714135 100644 --- a/old_docs/API_docs_v44/types/WallPaper.md +++ b/old_docs/API_docs_v44/types/WallPaper.md @@ -3,7 +3,7 @@ title: WallPaper description: constructors and methods of type WallPaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: WallPaper +# Type: WallPaper [Back to types index](index.md) @@ -12,13 +12,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [wallPaper](../constructors/wallPaper.md) -[wallPaperSolid](../constructors/wallPaperSolid.md) +[wallPaperNoFile](../constructors/wallPaperNoFile.md) ### Methods that return an object of this type (methods): -[$MadelineProto->account->getWallPapers](../methods/account.getWallPapers.md) +[$MadelineProto->account->getWallPaper](../methods/account.getWallPaper.md) + +[$MadelineProto->account->uploadWallPaper](../methods/account.uploadWallPaper.md) + +[$MadelineProto->account->getMultiWallPapers](../methods/account.getMultiWallPapers.md) +[wallPaper](../constructors/wallPaper.md) + +[wallPaperNoFile](../constructors/wallPaperNoFile.md) + +[$MadelineProto->account->getWallPaper](../methods/account.getWallPaper.md) + +[$MadelineProto->account->uploadWallPaper](../methods/account.uploadWallPaper.md) + +[$MadelineProto->account->getMultiWallPapers](../methods/account.getMultiWallPapers.md) + diff --git a/old_docs/API_docs_v44/types/WallPaperSettings.md b/old_docs/API_docs_v44/types/WallPaperSettings.md new file mode 100644 index 00000000..75169bda --- /dev/null +++ b/old_docs/API_docs_v44/types/WallPaperSettings.md @@ -0,0 +1,22 @@ +--- +title: WallPaperSettings +description: constructors and methods of type WallPaperSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WallPaperSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[wallPaperSettings](../constructors/wallPaperSettings.md) + + + +### Methods that return an object of this type (methods): + + + +[wallPaperSettings](../constructors/wallPaperSettings.md) + diff --git a/old_docs/API_docs_v44/types/WebAuthorization.md b/old_docs/API_docs_v44/types/WebAuthorization.md new file mode 100644 index 00000000..01f71870 --- /dev/null +++ b/old_docs/API_docs_v44/types/WebAuthorization.md @@ -0,0 +1,22 @@ +--- +title: WebAuthorization +description: constructors and methods of type WebAuthorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebAuthorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webAuthorization](../constructors/webAuthorization.md) + + + +### Methods that return an object of this type (methods): + + + +[webAuthorization](../constructors/webAuthorization.md) + diff --git a/old_docs/API_docs_v44/types/WebDocument.md b/old_docs/API_docs_v44/types/WebDocument.md new file mode 100644 index 00000000..4ecbb3dc --- /dev/null +++ b/old_docs/API_docs_v44/types/WebDocument.md @@ -0,0 +1,26 @@ +--- +title: WebDocument +description: constructors and methods of type WebDocument +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebDocument +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webDocument](../constructors/webDocument.md) + +[webDocumentNoProxy](../constructors/webDocumentNoProxy.md) + + + +### Methods that return an object of this type (methods): + + + +[webDocument](../constructors/webDocument.md) + +[webDocumentNoProxy](../constructors/webDocumentNoProxy.md) + diff --git a/old_docs/API_docs_v44/types/WebPage.md b/old_docs/API_docs_v44/types/WebPage.md index bf988c20..3b777ad8 100644 --- a/old_docs/API_docs_v44/types/WebPage.md +++ b/old_docs/API_docs_v44/types/WebPage.md @@ -3,7 +3,7 @@ title: WebPage description: constructors and methods of type WebPage image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: WebPage +# Type: WebPage [Back to types index](index.md) @@ -16,11 +16,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [webPage](../constructors/webPage.md) -[webPageExternal](../constructors/webPageExternal.md) +[webPageNotModified](../constructors/webPageNotModified.md) ### Methods that return an object of this type (methods): +[$MadelineProto->messages->getWebPage](../methods/messages.getWebPage.md) + +[webPageEmpty](../constructors/webPageEmpty.md) + +[webPagePending](../constructors/webPagePending.md) + +[webPage](../constructors/webPage.md) + +[webPageNotModified](../constructors/webPageNotModified.md) + +[$MadelineProto->messages->getWebPage](../methods/messages.getWebPage.md) + diff --git a/old_docs/API_docs_v44/types/WebPageAttribute.md b/old_docs/API_docs_v44/types/WebPageAttribute.md new file mode 100644 index 00000000..93bda5de --- /dev/null +++ b/old_docs/API_docs_v44/types/WebPageAttribute.md @@ -0,0 +1,22 @@ +--- +title: WebPageAttribute +description: constructors and methods of type WebPageAttribute +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebPageAttribute +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webPageAttributeTheme](../constructors/webPageAttributeTheme.md) + + + +### Methods that return an object of this type (methods): + + + +[webPageAttributeTheme](../constructors/webPageAttributeTheme.md) + diff --git a/old_docs/API_docs_v44/types/X.md b/old_docs/API_docs_v44/types/X.md index 3b234633..4e15e9ce 100644 --- a/old_docs/API_docs_v44/types/X.md +++ b/old_docs/API_docs_v44/types/X.md @@ -1,9 +1,46 @@ --- title: X -description: Represents a TL serialized payload +description: constructors and methods of type X image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -## Type: X -[Back to constructor index](index.md) +# Type: X +[Back to types index](index.md) + + + +### Possible values (constructors): + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->invokeAfterMsg](../methods/invokeAfterMsg.md) + +[$MadelineProto->invokeAfterMsgs](../methods/invokeAfterMsgs.md) + +[$MadelineProto->initConnection](../methods/initConnection.md) + +[$MadelineProto->invokeWithLayer](../methods/invokeWithLayer.md) + +[$MadelineProto->invokeWithoutUpdates](../methods/invokeWithoutUpdates.md) + +[$MadelineProto->invokeWithMessagesRange](../methods/invokeWithMessagesRange.md) + +[$MadelineProto->invokeWithTakeout](../methods/invokeWithTakeout.md) + + + +[$MadelineProto->invokeAfterMsg](../methods/invokeAfterMsg.md) + +[$MadelineProto->invokeAfterMsgs](../methods/invokeAfterMsgs.md) + +[$MadelineProto->initConnection](../methods/initConnection.md) + +[$MadelineProto->invokeWithLayer](../methods/invokeWithLayer.md) + +[$MadelineProto->invokeWithoutUpdates](../methods/invokeWithoutUpdates.md) + +[$MadelineProto->invokeWithMessagesRange](../methods/invokeWithMessagesRange.md) + +[$MadelineProto->invokeWithTakeout](../methods/invokeWithTakeout.md) -Represents a TL serialized payload. diff --git a/old_docs/API_docs_v44/types/account.AuthorizationForm.md b/old_docs/API_docs_v44/types/account.AuthorizationForm.md new file mode 100644 index 00000000..73304bdb --- /dev/null +++ b/old_docs/API_docs_v44/types/account.AuthorizationForm.md @@ -0,0 +1,27 @@ +--- +title: account.AuthorizationForm +description: constructors and methods of type account.AuthorizationForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_AuthorizationForm.html +--- +# Type: account.AuthorizationForm +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.authorizationForm](../constructors/account.authorizationForm.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAuthorizationForm](../methods/account.getAuthorizationForm.md) + + + +[account.authorizationForm](../constructors/account.authorizationForm.md) + +[$MadelineProto->account->getAuthorizationForm](../methods/account.getAuthorizationForm.md) + diff --git a/old_docs/API_docs_v44/types/account.Authorizations.md b/old_docs/API_docs_v44/types/account.Authorizations.md index b5503589..be5cc471 100644 --- a/old_docs/API_docs_v44/types/account.Authorizations.md +++ b/old_docs/API_docs_v44/types/account.Authorizations.md @@ -4,7 +4,7 @@ description: constructors and methods of type account.Authorizations image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/account_Authorizations.html --- -# Type: account.Authorizations +# Type: account.Authorizations [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/account_Authorizations.html +[account.authorizations](../constructors/account.authorizations.md) + +[$MadelineProto->account->getAuthorizations](../methods/account.getAuthorizations.md) + diff --git a/old_docs/API_docs_v44/types/account.AutoDownloadSettings.md b/old_docs/API_docs_v44/types/account.AutoDownloadSettings.md new file mode 100644 index 00000000..a85bb3e7 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.AutoDownloadSettings.md @@ -0,0 +1,27 @@ +--- +title: account.AutoDownloadSettings +description: constructors and methods of type account.AutoDownloadSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_AutoDownloadSettings.html +--- +# Type: account.AutoDownloadSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAutoDownloadSettings](../methods/account.getAutoDownloadSettings.md) + + + +[account.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) + +[$MadelineProto->account->getAutoDownloadSettings](../methods/account.getAutoDownloadSettings.md) + diff --git a/old_docs/API_docs_v44/types/account.ContentSettings.md b/old_docs/API_docs_v44/types/account.ContentSettings.md new file mode 100644 index 00000000..76102a37 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.ContentSettings.md @@ -0,0 +1,27 @@ +--- +title: account.ContentSettings +description: constructors and methods of type account.ContentSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_ContentSettings.html +--- +# Type: account.ContentSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.contentSettings](../constructors/account.contentSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getContentSettings](../methods/account.getContentSettings.md) + + + +[account.contentSettings](../constructors/account.contentSettings.md) + +[$MadelineProto->account->getContentSettings](../methods/account.getContentSettings.md) + diff --git a/old_docs/API_docs_v44/types/account.Password.md b/old_docs/API_docs_v44/types/account.Password.md index 5b2f348e..96932574 100644 --- a/old_docs/API_docs_v44/types/account.Password.md +++ b/old_docs/API_docs_v44/types/account.Password.md @@ -4,15 +4,13 @@ description: constructors and methods of type account.Password image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/account_Password.html --- -# Type: account.Password +# Type: account.Password [Back to types index](index.md) ### Possible values (constructors): -[account.noPassword](../constructors/account.noPassword.md) - [account.password](../constructors/account.password.md) @@ -23,3 +21,7 @@ redirect_from: /API_docs/types/account_Password.html +[account.password](../constructors/account.password.md) + +[$MadelineProto->account->getPassword](../methods/account.getPassword.md) + diff --git a/old_docs/API_docs_v44/types/account.PasswordInputSettings.md b/old_docs/API_docs_v44/types/account.PasswordInputSettings.md index 0f2b52a8..10eb710e 100644 --- a/old_docs/API_docs_v44/types/account.PasswordInputSettings.md +++ b/old_docs/API_docs_v44/types/account.PasswordInputSettings.md @@ -4,7 +4,7 @@ description: constructors and methods of type account.PasswordInputSettings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/account_PasswordInputSettings.html --- -# Type: account.PasswordInputSettings +# Type: account.PasswordInputSettings [Back to types index](index.md) @@ -19,3 +19,5 @@ redirect_from: /API_docs/types/account_PasswordInputSettings.html +[account.passwordInputSettings](../constructors/account.passwordInputSettings.md) + diff --git a/old_docs/API_docs_v44/types/account.PasswordSettings.md b/old_docs/API_docs_v44/types/account.PasswordSettings.md index 5526eee0..c3c05801 100644 --- a/old_docs/API_docs_v44/types/account.PasswordSettings.md +++ b/old_docs/API_docs_v44/types/account.PasswordSettings.md @@ -4,7 +4,7 @@ description: constructors and methods of type account.PasswordSettings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/account_PasswordSettings.html --- -# Type: account.PasswordSettings +# Type: account.PasswordSettings [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/account_PasswordSettings.html +[account.passwordSettings](../constructors/account.passwordSettings.md) + +[$MadelineProto->account->getPasswordSettings](../methods/account.getPasswordSettings.md) + diff --git a/old_docs/API_docs_v44/types/account.PrivacyRules.md b/old_docs/API_docs_v44/types/account.PrivacyRules.md index 0aedaf63..bad255fc 100644 --- a/old_docs/API_docs_v44/types/account.PrivacyRules.md +++ b/old_docs/API_docs_v44/types/account.PrivacyRules.md @@ -4,7 +4,7 @@ description: constructors and methods of type account.PrivacyRules image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/account_PrivacyRules.html --- -# Type: account.PrivacyRules +# Type: account.PrivacyRules [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/account_PrivacyRules.html +[account.privacyRules](../constructors/account.privacyRules.md) + +[$MadelineProto->account->getPrivacy](../methods/account.getPrivacy.md) + +[$MadelineProto->account->setPrivacy](../methods/account.setPrivacy.md) + diff --git a/old_docs/API_docs_v44/types/account.SentChangePhoneCode.md b/old_docs/API_docs_v44/types/account.SentChangePhoneCode.md deleted file mode 100644 index 353c214a..00000000 --- a/old_docs/API_docs_v44/types/account.SentChangePhoneCode.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: account.SentChangePhoneCode -description: constructors and methods of type account.SentChangePhoneCode -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/account_SentChangePhoneCode.html ---- -# Type: account.SentChangePhoneCode -[Back to types index](index.md) - - - -### Possible values (constructors): - -[account.sentChangePhoneCode](../constructors/account.sentChangePhoneCode.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->account->sendChangePhoneCode](../methods/account.sendChangePhoneCode.md) - - - diff --git a/old_docs/API_docs_v44/types/account.SentEmailCode.md b/old_docs/API_docs_v44/types/account.SentEmailCode.md new file mode 100644 index 00000000..adee1053 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.SentEmailCode.md @@ -0,0 +1,27 @@ +--- +title: account.SentEmailCode +description: constructors and methods of type account.SentEmailCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_SentEmailCode.html +--- +# Type: account.SentEmailCode +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.sentEmailCode](../constructors/account.sentEmailCode.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->sendVerifyEmailCode](../methods/account.sendVerifyEmailCode.md) + + + +[account.sentEmailCode](../constructors/account.sentEmailCode.md) + +[$MadelineProto->account->sendVerifyEmailCode](../methods/account.sendVerifyEmailCode.md) + diff --git a/old_docs/API_docs_v44/types/account.Takeout.md b/old_docs/API_docs_v44/types/account.Takeout.md new file mode 100644 index 00000000..07350c57 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.Takeout.md @@ -0,0 +1,27 @@ +--- +title: account.Takeout +description: constructors and methods of type account.Takeout +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Takeout.html +--- +# Type: account.Takeout +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.takeout](../constructors/account.takeout.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->initTakeoutSession](../methods/account.initTakeoutSession.md) + + + +[account.takeout](../constructors/account.takeout.md) + +[$MadelineProto->account->initTakeoutSession](../methods/account.initTakeoutSession.md) + diff --git a/old_docs/API_docs_v44/types/account.Themes.md b/old_docs/API_docs_v44/types/account.Themes.md new file mode 100644 index 00000000..72714bbd --- /dev/null +++ b/old_docs/API_docs_v44/types/account.Themes.md @@ -0,0 +1,31 @@ +--- +title: account.Themes +description: constructors and methods of type account.Themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Themes.html +--- +# Type: account.Themes +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.themesNotModified](../constructors/account.themesNotModified.md) + +[account.themes](../constructors/account.themes.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getThemes](../methods/account.getThemes.md) + + + +[account.themesNotModified](../constructors/account.themesNotModified.md) + +[account.themes](../constructors/account.themes.md) + +[$MadelineProto->account->getThemes](../methods/account.getThemes.md) + diff --git a/old_docs/API_docs_v44/types/account.TmpPassword.md b/old_docs/API_docs_v44/types/account.TmpPassword.md new file mode 100644 index 00000000..728f5dbd --- /dev/null +++ b/old_docs/API_docs_v44/types/account.TmpPassword.md @@ -0,0 +1,27 @@ +--- +title: account.TmpPassword +description: constructors and methods of type account.TmpPassword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_TmpPassword.html +--- +# Type: account.TmpPassword +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.tmpPassword](../constructors/account.tmpPassword.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getTmpPassword](../methods/account.getTmpPassword.md) + + + +[account.tmpPassword](../constructors/account.tmpPassword.md) + +[$MadelineProto->account->getTmpPassword](../methods/account.getTmpPassword.md) + diff --git a/old_docs/API_docs_v44/types/account.WallPapers.md b/old_docs/API_docs_v44/types/account.WallPapers.md new file mode 100644 index 00000000..2c9da609 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.WallPapers.md @@ -0,0 +1,31 @@ +--- +title: account.WallPapers +description: constructors and methods of type account.WallPapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_WallPapers.html +--- +# Type: account.WallPapers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.wallPapersNotModified](../constructors/account.wallPapersNotModified.md) + +[account.wallPapers](../constructors/account.wallPapers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWallPapers](../methods/account.getWallPapers.md) + + + +[account.wallPapersNotModified](../constructors/account.wallPapersNotModified.md) + +[account.wallPapers](../constructors/account.wallPapers.md) + +[$MadelineProto->account->getWallPapers](../methods/account.getWallPapers.md) + diff --git a/old_docs/API_docs_v44/types/account.WebAuthorizations.md b/old_docs/API_docs_v44/types/account.WebAuthorizations.md new file mode 100644 index 00000000..6ca35924 --- /dev/null +++ b/old_docs/API_docs_v44/types/account.WebAuthorizations.md @@ -0,0 +1,27 @@ +--- +title: account.WebAuthorizations +description: constructors and methods of type account.WebAuthorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_WebAuthorizations.html +--- +# Type: account.WebAuthorizations +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.webAuthorizations](../constructors/account.webAuthorizations.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWebAuthorizations](../methods/account.getWebAuthorizations.md) + + + +[account.webAuthorizations](../constructors/account.webAuthorizations.md) + +[$MadelineProto->account->getWebAuthorizations](../methods/account.getWebAuthorizations.md) + diff --git a/old_docs/API_docs_v44/types/auth.Authorization.md b/old_docs/API_docs_v44/types/auth.Authorization.md index 7ef23875..f3d7608c 100644 --- a/old_docs/API_docs_v44/types/auth.Authorization.md +++ b/old_docs/API_docs_v44/types/auth.Authorization.md @@ -4,7 +4,7 @@ description: constructors and methods of type auth.Authorization image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/auth_Authorization.html --- -# Type: auth.Authorization +# Type: auth.Authorization [Back to types index](index.md) @@ -13,6 +13,8 @@ redirect_from: /API_docs/types/auth_Authorization.html [auth.authorization](../constructors/auth.authorization.md) +[auth.authorizationSignUpRequired](../constructors/auth.authorizationSignUpRequired.md) + ### Methods that return an object of this type (methods): @@ -31,3 +33,19 @@ redirect_from: /API_docs/types/auth_Authorization.html +[auth.authorization](../constructors/auth.authorization.md) + +[auth.authorizationSignUpRequired](../constructors/auth.authorizationSignUpRequired.md) + +[$MadelineProto->auth->signUp](../methods/auth.signUp.md) + +[$MadelineProto->auth->signIn](../methods/auth.signIn.md) + +[$MadelineProto->auth->importAuthorization](../methods/auth.importAuthorization.md) + +[$MadelineProto->auth->importBotAuthorization](../methods/auth.importBotAuthorization.md) + +[$MadelineProto->auth->checkPassword](../methods/auth.checkPassword.md) + +[$MadelineProto->auth->recoverPassword](../methods/auth.recoverPassword.md) + diff --git a/old_docs/API_docs_v44/types/auth.CheckedPhone.md b/old_docs/API_docs_v44/types/auth.CheckedPhone.md deleted file mode 100644 index 01b5dac7..00000000 --- a/old_docs/API_docs_v44/types/auth.CheckedPhone.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: auth.CheckedPhone -description: constructors and methods of type auth.CheckedPhone -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/auth_CheckedPhone.html ---- -# Type: auth.CheckedPhone -[Back to types index](index.md) - - - -### Possible values (constructors): - -[auth.checkedPhone](../constructors/auth.checkedPhone.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->auth->checkPhone](../methods/auth.checkPhone.md) - - - diff --git a/old_docs/API_docs_v44/types/auth.CodeType.md b/old_docs/API_docs_v44/types/auth.CodeType.md new file mode 100644 index 00000000..68a49639 --- /dev/null +++ b/old_docs/API_docs_v44/types/auth.CodeType.md @@ -0,0 +1,31 @@ +--- +title: auth.CodeType +description: constructors and methods of type auth.CodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_CodeType.html +--- +# Type: auth.CodeType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.codeTypeSms](../constructors/auth.codeTypeSms.md) + +[auth.codeTypeCall](../constructors/auth.codeTypeCall.md) + +[auth.codeTypeFlashCall](../constructors/auth.codeTypeFlashCall.md) + + + +### Methods that return an object of this type (methods): + + + +[auth.codeTypeSms](../constructors/auth.codeTypeSms.md) + +[auth.codeTypeCall](../constructors/auth.codeTypeCall.md) + +[auth.codeTypeFlashCall](../constructors/auth.codeTypeFlashCall.md) + diff --git a/old_docs/API_docs_v44/types/auth.ExportedAuthorization.md b/old_docs/API_docs_v44/types/auth.ExportedAuthorization.md index cf2a2607..eee911d0 100644 --- a/old_docs/API_docs_v44/types/auth.ExportedAuthorization.md +++ b/old_docs/API_docs_v44/types/auth.ExportedAuthorization.md @@ -4,7 +4,7 @@ description: constructors and methods of type auth.ExportedAuthorization image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/auth_ExportedAuthorization.html --- -# Type: auth.ExportedAuthorization +# Type: auth.ExportedAuthorization [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/auth_ExportedAuthorization.html +[auth.exportedAuthorization](../constructors/auth.exportedAuthorization.md) + +[$MadelineProto->auth->exportAuthorization](../methods/auth.exportAuthorization.md) + diff --git a/old_docs/API_docs_v44/types/auth.LoginToken.md b/old_docs/API_docs_v44/types/auth.LoginToken.md new file mode 100644 index 00000000..0fbbbf87 --- /dev/null +++ b/old_docs/API_docs_v44/types/auth.LoginToken.md @@ -0,0 +1,39 @@ +--- +title: auth.LoginToken +description: constructors and methods of type auth.LoginToken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_LoginToken.html +--- +# Type: auth.LoginToken +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.loginToken](../constructors/auth.loginToken.md) + +[auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) + +[auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->exportLoginToken](../methods/auth.exportLoginToken.md) + +[$MadelineProto->auth->importLoginToken](../methods/auth.importLoginToken.md) + + + +[auth.loginToken](../constructors/auth.loginToken.md) + +[auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) + +[auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) + +[$MadelineProto->auth->exportLoginToken](../methods/auth.exportLoginToken.md) + +[$MadelineProto->auth->importLoginToken](../methods/auth.importLoginToken.md) + diff --git a/old_docs/API_docs_v44/types/auth.PasswordRecovery.md b/old_docs/API_docs_v44/types/auth.PasswordRecovery.md index 7d89cc2d..306a872b 100644 --- a/old_docs/API_docs_v44/types/auth.PasswordRecovery.md +++ b/old_docs/API_docs_v44/types/auth.PasswordRecovery.md @@ -4,7 +4,7 @@ description: constructors and methods of type auth.PasswordRecovery image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/auth_PasswordRecovery.html --- -# Type: auth.PasswordRecovery +# Type: auth.PasswordRecovery [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/auth_PasswordRecovery.html +[auth.passwordRecovery](../constructors/auth.passwordRecovery.md) + +[$MadelineProto->auth->requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md) + diff --git a/old_docs/API_docs_v44/types/auth.SentCode.md b/old_docs/API_docs_v44/types/auth.SentCode.md index 6939c4f3..84fee90e 100644 --- a/old_docs/API_docs_v44/types/auth.SentCode.md +++ b/old_docs/API_docs_v44/types/auth.SentCode.md @@ -4,7 +4,7 @@ description: constructors and methods of type auth.SentCode image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/auth_SentCode.html --- -# Type: auth.SentCode +# Type: auth.SentCode [Back to types index](index.md) @@ -13,13 +13,31 @@ redirect_from: /API_docs/types/auth_SentCode.html [auth.sentCode](../constructors/auth.sentCode.md) -[auth.sentAppCode](../constructors/auth.sentAppCode.md) - ### Methods that return an object of this type (methods): [$MadelineProto->auth->sendCode](../methods/auth.sendCode.md) +[$MadelineProto->auth->resendCode](../methods/auth.resendCode.md) + +[$MadelineProto->account->sendChangePhoneCode](../methods/account.sendChangePhoneCode.md) + +[$MadelineProto->account->sendConfirmPhoneCode](../methods/account.sendConfirmPhoneCode.md) + +[$MadelineProto->account->sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) + +[auth.sentCode](../constructors/auth.sentCode.md) + +[$MadelineProto->auth->sendCode](../methods/auth.sendCode.md) + +[$MadelineProto->auth->resendCode](../methods/auth.resendCode.md) + +[$MadelineProto->account->sendChangePhoneCode](../methods/account.sendChangePhoneCode.md) + +[$MadelineProto->account->sendConfirmPhoneCode](../methods/account.sendConfirmPhoneCode.md) + +[$MadelineProto->account->sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) + diff --git a/old_docs/API_docs_v44/types/auth.SentCodeType.md b/old_docs/API_docs_v44/types/auth.SentCodeType.md new file mode 100644 index 00000000..04c036b3 --- /dev/null +++ b/old_docs/API_docs_v44/types/auth.SentCodeType.md @@ -0,0 +1,35 @@ +--- +title: auth.SentCodeType +description: constructors and methods of type auth.SentCodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_SentCodeType.html +--- +# Type: auth.SentCodeType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.sentCodeTypeApp](../constructors/auth.sentCodeTypeApp.md) + +[auth.sentCodeTypeSms](../constructors/auth.sentCodeTypeSms.md) + +[auth.sentCodeTypeCall](../constructors/auth.sentCodeTypeCall.md) + +[auth.sentCodeTypeFlashCall](../constructors/auth.sentCodeTypeFlashCall.md) + + + +### Methods that return an object of this type (methods): + + + +[auth.sentCodeTypeApp](../constructors/auth.sentCodeTypeApp.md) + +[auth.sentCodeTypeSms](../constructors/auth.sentCodeTypeSms.md) + +[auth.sentCodeTypeCall](../constructors/auth.sentCodeTypeCall.md) + +[auth.sentCodeTypeFlashCall](../constructors/auth.sentCodeTypeFlashCall.md) + diff --git a/old_docs/API_docs_v44/types/bytes.md b/old_docs/API_docs_v44/types/bytes.md index 15ea3a1a..04f19e1b 100644 --- a/old_docs/API_docs_v44/types/bytes.md +++ b/old_docs/API_docs_v44/types/bytes.md @@ -13,7 +13,7 @@ $bytes = "simple string of bytes"; Internally, an object of type `\danog\MadelineProto\TL\Types\Bytes`. When casted to string, turns into a string of bytes of variable length, with length smaller than or equal to 16777215. When JSON-serialized, turns into an array of the following format: -``` +```php [ '_' => 'bytes', 'bytes' => base64_encode($contents) diff --git a/old_docs/API_docs_v44/types/channels.AdminLogResults.md b/old_docs/API_docs_v44/types/channels.AdminLogResults.md new file mode 100644 index 00000000..ae390f86 --- /dev/null +++ b/old_docs/API_docs_v44/types/channels.AdminLogResults.md @@ -0,0 +1,27 @@ +--- +title: channels.AdminLogResults +description: constructors and methods of type channels.AdminLogResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/channels_AdminLogResults.html +--- +# Type: channels.AdminLogResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channels.adminLogResults](../constructors/channels.adminLogResults.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getAdminLog](../methods/channels.getAdminLog.md) + + + +[channels.adminLogResults](../constructors/channels.adminLogResults.md) + +[$MadelineProto->channels->getAdminLog](../methods/channels.getAdminLog.md) + diff --git a/old_docs/API_docs_v44/types/channels.ChannelParticipant.md b/old_docs/API_docs_v44/types/channels.ChannelParticipant.md index 47ff36b7..2d6830be 100644 --- a/old_docs/API_docs_v44/types/channels.ChannelParticipant.md +++ b/old_docs/API_docs_v44/types/channels.ChannelParticipant.md @@ -4,7 +4,7 @@ description: constructors and methods of type channels.ChannelParticipant image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/channels_ChannelParticipant.html --- -# Type: channels.ChannelParticipant +# Type: channels.ChannelParticipant [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/channels_ChannelParticipant.html +[channels.channelParticipant](../constructors/channels.channelParticipant.md) + +[$MadelineProto->channels->getParticipant](../methods/channels.getParticipant.md) + diff --git a/old_docs/API_docs_v44/types/channels.ChannelParticipants.md b/old_docs/API_docs_v44/types/channels.ChannelParticipants.md index a2b35c9c..af653c68 100644 --- a/old_docs/API_docs_v44/types/channels.ChannelParticipants.md +++ b/old_docs/API_docs_v44/types/channels.ChannelParticipants.md @@ -4,7 +4,7 @@ description: constructors and methods of type channels.ChannelParticipants image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/channels_ChannelParticipants.html --- -# Type: channels.ChannelParticipants +# Type: channels.ChannelParticipants [Back to types index](index.md) @@ -13,6 +13,8 @@ redirect_from: /API_docs/types/channels_ChannelParticipants.html [channels.channelParticipants](../constructors/channels.channelParticipants.md) +[channels.channelParticipantsNotModified](../constructors/channels.channelParticipantsNotModified.md) + ### Methods that return an object of this type (methods): @@ -21,3 +23,9 @@ redirect_from: /API_docs/types/channels_ChannelParticipants.html +[channels.channelParticipants](../constructors/channels.channelParticipants.md) + +[channels.channelParticipantsNotModified](../constructors/channels.channelParticipantsNotModified.md) + +[$MadelineProto->channels->getParticipants](../methods/channels.getParticipants.md) + diff --git a/old_docs/API_docs_v44/types/contacts.Blocked.md b/old_docs/API_docs_v44/types/contacts.Blocked.md index 7c3a96a9..8f16602a 100644 --- a/old_docs/API_docs_v44/types/contacts.Blocked.md +++ b/old_docs/API_docs_v44/types/contacts.Blocked.md @@ -4,7 +4,7 @@ description: constructors and methods of type contacts.Blocked image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/contacts_Blocked.html --- -# Type: contacts.Blocked +# Type: contacts.Blocked [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/contacts_Blocked.html +[contacts.blocked](../constructors/contacts.blocked.md) + +[contacts.blockedSlice](../constructors/contacts.blockedSlice.md) + +[$MadelineProto->contacts->getBlocked](../methods/contacts.getBlocked.md) + diff --git a/old_docs/API_docs_v44/types/contacts.Contacts.md b/old_docs/API_docs_v44/types/contacts.Contacts.md index c47102bc..1a9c55a8 100644 --- a/old_docs/API_docs_v44/types/contacts.Contacts.md +++ b/old_docs/API_docs_v44/types/contacts.Contacts.md @@ -4,7 +4,7 @@ description: constructors and methods of type contacts.Contacts image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/contacts_Contacts.html --- -# Type: contacts.Contacts +# Type: contacts.Contacts [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/contacts_Contacts.html +[contacts.contactsNotModified](../constructors/contacts.contactsNotModified.md) + +[contacts.contacts](../constructors/contacts.contacts.md) + +[$MadelineProto->contacts->getContacts](../methods/contacts.getContacts.md) + diff --git a/old_docs/API_docs_v44/types/contacts.Found.md b/old_docs/API_docs_v44/types/contacts.Found.md index 35516be1..4e570d28 100644 --- a/old_docs/API_docs_v44/types/contacts.Found.md +++ b/old_docs/API_docs_v44/types/contacts.Found.md @@ -4,7 +4,7 @@ description: constructors and methods of type contacts.Found image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/contacts_Found.html --- -# Type: contacts.Found +# Type: contacts.Found [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/contacts_Found.html +[contacts.found](../constructors/contacts.found.md) + +[$MadelineProto->contacts->search](../methods/contacts.search.md) + diff --git a/old_docs/API_docs_v44/types/contacts.ImportedContacts.md b/old_docs/API_docs_v44/types/contacts.ImportedContacts.md index d812db9a..37d9c5bd 100644 --- a/old_docs/API_docs_v44/types/contacts.ImportedContacts.md +++ b/old_docs/API_docs_v44/types/contacts.ImportedContacts.md @@ -4,7 +4,7 @@ description: constructors and methods of type contacts.ImportedContacts image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/contacts_ImportedContacts.html --- -# Type: contacts.ImportedContacts +# Type: contacts.ImportedContacts [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/contacts_ImportedContacts.html +[contacts.importedContacts](../constructors/contacts.importedContacts.md) + +[$MadelineProto->contacts->importContacts](../methods/contacts.importContacts.md) + diff --git a/old_docs/API_docs_v44/types/contacts.Link.md b/old_docs/API_docs_v44/types/contacts.Link.md deleted file mode 100644 index 25ba2046..00000000 --- a/old_docs/API_docs_v44/types/contacts.Link.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: contacts.Link -description: constructors and methods of type contacts.Link -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/contacts_Link.html ---- -# Type: contacts.Link -[Back to types index](index.md) - - - -### Possible values (constructors): - -[contacts.link](../constructors/contacts.link.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->contacts->deleteContact](../methods/contacts.deleteContact.md) - - - diff --git a/old_docs/API_docs_v44/types/contacts.ResolvedPeer.md b/old_docs/API_docs_v44/types/contacts.ResolvedPeer.md index a24b919f..6310cfb2 100644 --- a/old_docs/API_docs_v44/types/contacts.ResolvedPeer.md +++ b/old_docs/API_docs_v44/types/contacts.ResolvedPeer.md @@ -4,7 +4,7 @@ description: constructors and methods of type contacts.ResolvedPeer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/contacts_ResolvedPeer.html --- -# Type: contacts.ResolvedPeer +# Type: contacts.ResolvedPeer [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/contacts_ResolvedPeer.html +[contacts.resolvedPeer](../constructors/contacts.resolvedPeer.md) + +[$MadelineProto->contacts->resolveUsername](../methods/contacts.resolveUsername.md) + diff --git a/old_docs/API_docs_v44/types/contacts.Suggested.md b/old_docs/API_docs_v44/types/contacts.Suggested.md deleted file mode 100644 index 5b3484f1..00000000 --- a/old_docs/API_docs_v44/types/contacts.Suggested.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: contacts.Suggested -description: constructors and methods of type contacts.Suggested -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/contacts_Suggested.html ---- -# Type: contacts.Suggested -[Back to types index](index.md) - - - -### Possible values (constructors): - -[contacts.suggested](../constructors/contacts.suggested.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->contacts->getSuggested](../methods/contacts.getSuggested.md) - - - diff --git a/old_docs/API_docs_v44/types/contacts.TopPeers.md b/old_docs/API_docs_v44/types/contacts.TopPeers.md new file mode 100644 index 00000000..63d16006 --- /dev/null +++ b/old_docs/API_docs_v44/types/contacts.TopPeers.md @@ -0,0 +1,35 @@ +--- +title: contacts.TopPeers +description: constructors and methods of type contacts.TopPeers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_TopPeers.html +--- +# Type: contacts.TopPeers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts.topPeersNotModified](../constructors/contacts.topPeersNotModified.md) + +[contacts.topPeers](../constructors/contacts.topPeers.md) + +[contacts.topPeersDisabled](../constructors/contacts.topPeersDisabled.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getTopPeers](../methods/contacts.getTopPeers.md) + + + +[contacts.topPeersNotModified](../constructors/contacts.topPeersNotModified.md) + +[contacts.topPeers](../constructors/contacts.topPeers.md) + +[contacts.topPeersDisabled](../constructors/contacts.topPeersDisabled.md) + +[$MadelineProto->contacts->getTopPeers](../methods/contacts.getTopPeers.md) + diff --git a/old_docs/API_docs_v44/types/help.AppChangelog.md b/old_docs/API_docs_v44/types/help.AppChangelog.md deleted file mode 100644 index daa94344..00000000 --- a/old_docs/API_docs_v44/types/help.AppChangelog.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: help.AppChangelog -description: constructors and methods of type help.AppChangelog -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/help_AppChangelog.html ---- -# Type: help.AppChangelog -[Back to types index](index.md) - - - -### Possible values (constructors): - -[help.appChangelogEmpty](../constructors/help.appChangelogEmpty.md) - -[help.appChangelog](../constructors/help.appChangelog.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->help->getAppChangelog](../methods/help.getAppChangelog.md) - - - diff --git a/old_docs/API_docs_v44/types/help.AppUpdate.md b/old_docs/API_docs_v44/types/help.AppUpdate.md index ed36f644..3a679188 100644 --- a/old_docs/API_docs_v44/types/help.AppUpdate.md +++ b/old_docs/API_docs_v44/types/help.AppUpdate.md @@ -4,7 +4,7 @@ description: constructors and methods of type help.AppUpdate image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/help_AppUpdate.html --- -# Type: help.AppUpdate +# Type: help.AppUpdate [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/help_AppUpdate.html +[help.appUpdate](../constructors/help.appUpdate.md) + +[help.noAppUpdate](../constructors/help.noAppUpdate.md) + +[$MadelineProto->help->getAppUpdate](../methods/help.getAppUpdate.md) + diff --git a/old_docs/API_docs_v44/types/help.DeepLinkInfo.md b/old_docs/API_docs_v44/types/help.DeepLinkInfo.md new file mode 100644 index 00000000..e2f68bec --- /dev/null +++ b/old_docs/API_docs_v44/types/help.DeepLinkInfo.md @@ -0,0 +1,31 @@ +--- +title: help.DeepLinkInfo +description: constructors and methods of type help.DeepLinkInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_DeepLinkInfo.html +--- +# Type: help.DeepLinkInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.deepLinkInfoEmpty](../constructors/help.deepLinkInfoEmpty.md) + +[help.deepLinkInfo](../constructors/help.deepLinkInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getDeepLinkInfo](../methods/help.getDeepLinkInfo.md) + + + +[help.deepLinkInfoEmpty](../constructors/help.deepLinkInfoEmpty.md) + +[help.deepLinkInfo](../constructors/help.deepLinkInfo.md) + +[$MadelineProto->help->getDeepLinkInfo](../methods/help.getDeepLinkInfo.md) + diff --git a/old_docs/API_docs_v44/types/help.InviteText.md b/old_docs/API_docs_v44/types/help.InviteText.md index cd945b6f..a498715b 100644 --- a/old_docs/API_docs_v44/types/help.InviteText.md +++ b/old_docs/API_docs_v44/types/help.InviteText.md @@ -4,7 +4,7 @@ description: constructors and methods of type help.InviteText image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/help_InviteText.html --- -# Type: help.InviteText +# Type: help.InviteText [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/help_InviteText.html +[help.inviteText](../constructors/help.inviteText.md) + +[$MadelineProto->help->getInviteText](../methods/help.getInviteText.md) + diff --git a/old_docs/API_docs_v44/types/help.PassportConfig.md b/old_docs/API_docs_v44/types/help.PassportConfig.md new file mode 100644 index 00000000..e3b4645c --- /dev/null +++ b/old_docs/API_docs_v44/types/help.PassportConfig.md @@ -0,0 +1,31 @@ +--- +title: help.PassportConfig +description: constructors and methods of type help.PassportConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_PassportConfig.html +--- +# Type: help.PassportConfig +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.passportConfigNotModified](../constructors/help.passportConfigNotModified.md) + +[help.passportConfig](../constructors/help.passportConfig.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getPassportConfig](../methods/help.getPassportConfig.md) + + + +[help.passportConfigNotModified](../constructors/help.passportConfigNotModified.md) + +[help.passportConfig](../constructors/help.passportConfig.md) + +[$MadelineProto->help->getPassportConfig](../methods/help.getPassportConfig.md) + diff --git a/old_docs/API_docs_v44/types/help.PromoData.md b/old_docs/API_docs_v44/types/help.PromoData.md new file mode 100644 index 00000000..42e9bc38 --- /dev/null +++ b/old_docs/API_docs_v44/types/help.PromoData.md @@ -0,0 +1,31 @@ +--- +title: help.PromoData +description: constructors and methods of type help.PromoData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_PromoData.html +--- +# Type: help.PromoData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.promoDataEmpty](../constructors/help.promoDataEmpty.md) + +[help.promoData](../constructors/help.promoData.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getPromoData](../methods/help.getPromoData.md) + + + +[help.promoDataEmpty](../constructors/help.promoDataEmpty.md) + +[help.promoData](../constructors/help.promoData.md) + +[$MadelineProto->help->getPromoData](../methods/help.getPromoData.md) + diff --git a/old_docs/API_docs_v44/types/help.RecentMeUrls.md b/old_docs/API_docs_v44/types/help.RecentMeUrls.md new file mode 100644 index 00000000..233d68bc --- /dev/null +++ b/old_docs/API_docs_v44/types/help.RecentMeUrls.md @@ -0,0 +1,27 @@ +--- +title: help.RecentMeUrls +description: constructors and methods of type help.RecentMeUrls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_RecentMeUrls.html +--- +# Type: help.RecentMeUrls +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.recentMeUrls](../constructors/help.recentMeUrls.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getRecentMeUrls](../methods/help.getRecentMeUrls.md) + + + +[help.recentMeUrls](../constructors/help.recentMeUrls.md) + +[$MadelineProto->help->getRecentMeUrls](../methods/help.getRecentMeUrls.md) + diff --git a/old_docs/API_docs_v44/types/help.Support.md b/old_docs/API_docs_v44/types/help.Support.md index 3e44b909..c68ecbbc 100644 --- a/old_docs/API_docs_v44/types/help.Support.md +++ b/old_docs/API_docs_v44/types/help.Support.md @@ -4,7 +4,7 @@ description: constructors and methods of type help.Support image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/help_Support.html --- -# Type: help.Support +# Type: help.Support [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/help_Support.html +[help.support](../constructors/help.support.md) + +[$MadelineProto->help->getSupport](../methods/help.getSupport.md) + diff --git a/old_docs/API_docs_v44/types/help.SupportName.md b/old_docs/API_docs_v44/types/help.SupportName.md new file mode 100644 index 00000000..edc1bf7f --- /dev/null +++ b/old_docs/API_docs_v44/types/help.SupportName.md @@ -0,0 +1,27 @@ +--- +title: help.SupportName +description: constructors and methods of type help.SupportName +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_SupportName.html +--- +# Type: help.SupportName +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.supportName](../constructors/help.supportName.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getSupportName](../methods/help.getSupportName.md) + + + +[help.supportName](../constructors/help.supportName.md) + +[$MadelineProto->help->getSupportName](../methods/help.getSupportName.md) + diff --git a/old_docs/API_docs_v44/types/help.TermsOfService.md b/old_docs/API_docs_v44/types/help.TermsOfService.md index de63568a..cd6985fa 100644 --- a/old_docs/API_docs_v44/types/help.TermsOfService.md +++ b/old_docs/API_docs_v44/types/help.TermsOfService.md @@ -4,7 +4,7 @@ description: constructors and methods of type help.TermsOfService image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/help_TermsOfService.html --- -# Type: help.TermsOfService +# Type: help.TermsOfService [Back to types index](index.md) @@ -17,7 +17,7 @@ redirect_from: /API_docs/types/help_TermsOfService.html ### Methods that return an object of this type (methods): -[$MadelineProto->help->getTermsOfService](../methods/help.getTermsOfService.md) +[help.termsOfService](../constructors/help.termsOfService.md) diff --git a/old_docs/API_docs_v44/types/help.TermsOfServiceUpdate.md b/old_docs/API_docs_v44/types/help.TermsOfServiceUpdate.md new file mode 100644 index 00000000..b6595473 --- /dev/null +++ b/old_docs/API_docs_v44/types/help.TermsOfServiceUpdate.md @@ -0,0 +1,31 @@ +--- +title: help.TermsOfServiceUpdate +description: constructors and methods of type help.TermsOfServiceUpdate +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_TermsOfServiceUpdate.html +--- +# Type: help.TermsOfServiceUpdate +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.termsOfServiceUpdateEmpty](../constructors/help.termsOfServiceUpdateEmpty.md) + +[help.termsOfServiceUpdate](../constructors/help.termsOfServiceUpdate.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) + + + +[help.termsOfServiceUpdateEmpty](../constructors/help.termsOfServiceUpdateEmpty.md) + +[help.termsOfServiceUpdate](../constructors/help.termsOfServiceUpdate.md) + +[$MadelineProto->help->getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) + diff --git a/old_docs/API_docs_v44/types/help.UserInfo.md b/old_docs/API_docs_v44/types/help.UserInfo.md new file mode 100644 index 00000000..42a053a6 --- /dev/null +++ b/old_docs/API_docs_v44/types/help.UserInfo.md @@ -0,0 +1,35 @@ +--- +title: help.UserInfo +description: constructors and methods of type help.UserInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_UserInfo.html +--- +# Type: help.UserInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.userInfoEmpty](../constructors/help.userInfoEmpty.md) + +[help.userInfo](../constructors/help.userInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getUserInfo](../methods/help.getUserInfo.md) + +[$MadelineProto->help->editUserInfo](../methods/help.editUserInfo.md) + + + +[help.userInfoEmpty](../constructors/help.userInfoEmpty.md) + +[help.userInfo](../constructors/help.userInfo.md) + +[$MadelineProto->help->getUserInfo](../methods/help.getUserInfo.md) + +[$MadelineProto->help->editUserInfo](../methods/help.editUserInfo.md) + diff --git a/old_docs/API_docs_v44/types/messages.AffectedHistory.md b/old_docs/API_docs_v44/types/messages.AffectedHistory.md index 3477e79c..c35ecfd8 100644 --- a/old_docs/API_docs_v44/types/messages.AffectedHistory.md +++ b/old_docs/API_docs_v44/types/messages.AffectedHistory.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.AffectedHistory image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_AffectedHistory.html --- -# Type: messages.AffectedHistory +# Type: messages.AffectedHistory [Back to types index](index.md) @@ -19,7 +19,17 @@ redirect_from: /API_docs/types/messages_AffectedHistory.html [$MadelineProto->messages->deleteHistory](../methods/messages.deleteHistory.md) +[$MadelineProto->messages->readMentions](../methods/messages.readMentions.md) + [$MadelineProto->channels->deleteUserHistory](../methods/channels.deleteUserHistory.md) +[messages.affectedHistory](../constructors/messages.affectedHistory.md) + +[$MadelineProto->messages->deleteHistory](../methods/messages.deleteHistory.md) + +[$MadelineProto->messages->readMentions](../methods/messages.readMentions.md) + +[$MadelineProto->channels->deleteUserHistory](../methods/channels.deleteUserHistory.md) + diff --git a/old_docs/API_docs_v44/types/messages.AffectedMessages.md b/old_docs/API_docs_v44/types/messages.AffectedMessages.md index b5235fc1..d50d1c88 100644 --- a/old_docs/API_docs_v44/types/messages.AffectedMessages.md +++ b/old_docs/API_docs_v44/types/messages.AffectedMessages.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.AffectedMessages image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_AffectedMessages.html --- -# Type: messages.AffectedMessages +# Type: messages.AffectedMessages [Back to types index](index.md) @@ -27,3 +27,13 @@ redirect_from: /API_docs/types/messages_AffectedMessages.html +[messages.affectedMessages](../constructors/messages.affectedMessages.md) + +[$MadelineProto->messages->readHistory](../methods/messages.readHistory.md) + +[$MadelineProto->messages->deleteMessages](../methods/messages.deleteMessages.md) + +[$MadelineProto->messages->readMessageContents](../methods/messages.readMessageContents.md) + +[$MadelineProto->channels->deleteMessages](../methods/channels.deleteMessages.md) + diff --git a/old_docs/API_docs_v44/types/messages.AllStickers.md b/old_docs/API_docs_v44/types/messages.AllStickers.md index 983c7f3a..d4015042 100644 --- a/old_docs/API_docs_v44/types/messages.AllStickers.md +++ b/old_docs/API_docs_v44/types/messages.AllStickers.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.AllStickers image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_AllStickers.html --- -# Type: messages.AllStickers +# Type: messages.AllStickers [Back to types index](index.md) @@ -21,5 +21,15 @@ redirect_from: /API_docs/types/messages_AllStickers.html [$MadelineProto->messages->getAllStickers](../methods/messages.getAllStickers.md) +[$MadelineProto->messages->getMaskStickers](../methods/messages.getMaskStickers.md) + +[messages.allStickersNotModified](../constructors/messages.allStickersNotModified.md) + +[messages.allStickers](../constructors/messages.allStickers.md) + +[$MadelineProto->messages->getAllStickers](../methods/messages.getAllStickers.md) + +[$MadelineProto->messages->getMaskStickers](../methods/messages.getMaskStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.ArchivedStickers.md b/old_docs/API_docs_v44/types/messages.ArchivedStickers.md new file mode 100644 index 00000000..80a7d42a --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.ArchivedStickers.md @@ -0,0 +1,27 @@ +--- +title: messages.ArchivedStickers +description: constructors and methods of type messages.ArchivedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_ArchivedStickers.html +--- +# Type: messages.ArchivedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.archivedStickers](../constructors/messages.archivedStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getArchivedStickers](../methods/messages.getArchivedStickers.md) + + + +[messages.archivedStickers](../constructors/messages.archivedStickers.md) + +[$MadelineProto->messages->getArchivedStickers](../methods/messages.getArchivedStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.BotCallbackAnswer.md b/old_docs/API_docs_v44/types/messages.BotCallbackAnswer.md new file mode 100644 index 00000000..d94425c1 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.BotCallbackAnswer.md @@ -0,0 +1,27 @@ +--- +title: messages.BotCallbackAnswer +description: constructors and methods of type messages.BotCallbackAnswer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_BotCallbackAnswer.html +--- +# Type: messages.BotCallbackAnswer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.botCallbackAnswer](../constructors/messages.botCallbackAnswer.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getBotCallbackAnswer](../methods/messages.getBotCallbackAnswer.md) + + + +[messages.botCallbackAnswer](../constructors/messages.botCallbackAnswer.md) + +[$MadelineProto->messages->getBotCallbackAnswer](../methods/messages.getBotCallbackAnswer.md) + diff --git a/old_docs/API_docs_v44/types/messages.BotResults.md b/old_docs/API_docs_v44/types/messages.BotResults.md new file mode 100644 index 00000000..000c757c --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.BotResults.md @@ -0,0 +1,27 @@ +--- +title: messages.BotResults +description: constructors and methods of type messages.BotResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_BotResults.html +--- +# Type: messages.BotResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.botResults](../constructors/messages.botResults.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getInlineBotResults](../methods/messages.getInlineBotResults.md) + + + +[messages.botResults](../constructors/messages.botResults.md) + +[$MadelineProto->messages->getInlineBotResults](../methods/messages.getInlineBotResults.md) + diff --git a/old_docs/API_docs_v44/types/messages.ChatFull.md b/old_docs/API_docs_v44/types/messages.ChatFull.md index 7cf57376..60efe8db 100644 --- a/old_docs/API_docs_v44/types/messages.ChatFull.md +++ b/old_docs/API_docs_v44/types/messages.ChatFull.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.ChatFull image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_ChatFull.html --- -# Type: messages.ChatFull +# Type: messages.ChatFull [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/messages_ChatFull.html +[messages.chatFull](../constructors/messages.chatFull.md) + +[$MadelineProto->messages->getFullChat](../methods/messages.getFullChat.md) + +[$MadelineProto->channels->getFullChannel](../methods/channels.getFullChannel.md) + diff --git a/old_docs/API_docs_v44/types/messages.Chats.md b/old_docs/API_docs_v44/types/messages.Chats.md index a0284995..026993f4 100644 --- a/old_docs/API_docs_v44/types/messages.Chats.md +++ b/old_docs/API_docs_v44/types/messages.Chats.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.Chats image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_Chats.html --- -# Type: messages.Chats +# Type: messages.Chats [Back to types index](index.md) @@ -13,13 +13,43 @@ redirect_from: /API_docs/types/messages_Chats.html [messages.chats](../constructors/messages.chats.md) +[messages.chatsSlice](../constructors/messages.chatsSlice.md) + ### Methods that return an object of this type (methods): [$MadelineProto->messages->getChats](../methods/messages.getChats.md) +[$MadelineProto->messages->getCommonChats](../methods/messages.getCommonChats.md) + +[$MadelineProto->messages->getAllChats](../methods/messages.getAllChats.md) + [$MadelineProto->channels->getChannels](../methods/channels.getChannels.md) +[$MadelineProto->channels->getAdminedPublicChannels](../methods/channels.getAdminedPublicChannels.md) + +[$MadelineProto->channels->getLeftChannels](../methods/channels.getLeftChannels.md) + +[$MadelineProto->channels->getGroupsForDiscussion](../methods/channels.getGroupsForDiscussion.md) + +[messages.chats](../constructors/messages.chats.md) + +[messages.chatsSlice](../constructors/messages.chatsSlice.md) + +[$MadelineProto->messages->getChats](../methods/messages.getChats.md) + +[$MadelineProto->messages->getCommonChats](../methods/messages.getCommonChats.md) + +[$MadelineProto->messages->getAllChats](../methods/messages.getAllChats.md) + +[$MadelineProto->channels->getChannels](../methods/channels.getChannels.md) + +[$MadelineProto->channels->getAdminedPublicChannels](../methods/channels.getAdminedPublicChannels.md) + +[$MadelineProto->channels->getLeftChannels](../methods/channels.getLeftChannels.md) + +[$MadelineProto->channels->getGroupsForDiscussion](../methods/channels.getGroupsForDiscussion.md) + diff --git a/old_docs/API_docs_v44/types/messages.DhConfig.md b/old_docs/API_docs_v44/types/messages.DhConfig.md index a2531ae8..e4814153 100644 --- a/old_docs/API_docs_v44/types/messages.DhConfig.md +++ b/old_docs/API_docs_v44/types/messages.DhConfig.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.DhConfig image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_DhConfig.html --- -# Type: messages.DhConfig +# Type: messages.DhConfig [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/messages_DhConfig.html +[messages.dhConfigNotModified](../constructors/messages.dhConfigNotModified.md) + +[messages.dhConfig](../constructors/messages.dhConfig.md) + +[$MadelineProto->messages->getDhConfig](../methods/messages.getDhConfig.md) + diff --git a/old_docs/API_docs_v44/types/messages.Dialogs.md b/old_docs/API_docs_v44/types/messages.Dialogs.md index ed60b66f..be1f4f81 100644 --- a/old_docs/API_docs_v44/types/messages.Dialogs.md +++ b/old_docs/API_docs_v44/types/messages.Dialogs.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.Dialogs image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_Dialogs.html --- -# Type: messages.Dialogs +# Type: messages.Dialogs [Back to types index](index.md) @@ -15,13 +15,21 @@ redirect_from: /API_docs/types/messages_Dialogs.html [messages.dialogsSlice](../constructors/messages.dialogsSlice.md) +[messages.dialogsNotModified](../constructors/messages.dialogsNotModified.md) + ### Methods that return an object of this type (methods): [$MadelineProto->messages->getDialogs](../methods/messages.getDialogs.md) -[$MadelineProto->channels->getDialogs](../methods/channels.getDialogs.md) +[messages.dialogs](../constructors/messages.dialogs.md) + +[messages.dialogsSlice](../constructors/messages.dialogsSlice.md) + +[messages.dialogsNotModified](../constructors/messages.dialogsNotModified.md) + +[$MadelineProto->messages->getDialogs](../methods/messages.getDialogs.md) diff --git a/old_docs/API_docs_v44/types/messages.FavedStickers.md b/old_docs/API_docs_v44/types/messages.FavedStickers.md new file mode 100644 index 00000000..91f9811f --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.FavedStickers.md @@ -0,0 +1,31 @@ +--- +title: messages.FavedStickers +description: constructors and methods of type messages.FavedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FavedStickers.html +--- +# Type: messages.FavedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.favedStickersNotModified](../constructors/messages.favedStickersNotModified.md) + +[messages.favedStickers](../constructors/messages.favedStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getFavedStickers](../methods/messages.getFavedStickers.md) + + + +[messages.favedStickersNotModified](../constructors/messages.favedStickersNotModified.md) + +[messages.favedStickers](../constructors/messages.favedStickers.md) + +[$MadelineProto->messages->getFavedStickers](../methods/messages.getFavedStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.FeaturedStickers.md b/old_docs/API_docs_v44/types/messages.FeaturedStickers.md new file mode 100644 index 00000000..caa49a61 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.FeaturedStickers.md @@ -0,0 +1,35 @@ +--- +title: messages.FeaturedStickers +description: constructors and methods of type messages.FeaturedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FeaturedStickers.html +--- +# Type: messages.FeaturedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) + +[messages.featuredStickers](../constructors/messages.featuredStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getFeaturedStickers](../methods/messages.getFeaturedStickers.md) + +[$MadelineProto->messages->getOldFeaturedStickers](../methods/messages.getOldFeaturedStickers.md) + + + +[messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) + +[messages.featuredStickers](../constructors/messages.featuredStickers.md) + +[$MadelineProto->messages->getFeaturedStickers](../methods/messages.getFeaturedStickers.md) + +[$MadelineProto->messages->getOldFeaturedStickers](../methods/messages.getOldFeaturedStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.FoundGifs.md b/old_docs/API_docs_v44/types/messages.FoundGifs.md deleted file mode 100644 index f9f15856..00000000 --- a/old_docs/API_docs_v44/types/messages.FoundGifs.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messages.FoundGifs -description: constructors and methods of type messages.FoundGifs -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/messages_FoundGifs.html ---- -# Type: messages.FoundGifs -[Back to types index](index.md) - - - -### Possible values (constructors): - -[messages.foundGifs](../constructors/messages.foundGifs.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->messages->searchGifs](../methods/messages.searchGifs.md) - - - diff --git a/old_docs/API_docs_v44/types/messages.FoundStickerSets.md b/old_docs/API_docs_v44/types/messages.FoundStickerSets.md new file mode 100644 index 00000000..8399589c --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.FoundStickerSets.md @@ -0,0 +1,31 @@ +--- +title: messages.FoundStickerSets +description: constructors and methods of type messages.FoundStickerSets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FoundStickerSets.html +--- +# Type: messages.FoundStickerSets +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.foundStickerSetsNotModified](../constructors/messages.foundStickerSetsNotModified.md) + +[messages.foundStickerSets](../constructors/messages.foundStickerSets.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->searchStickerSets](../methods/messages.searchStickerSets.md) + + + +[messages.foundStickerSetsNotModified](../constructors/messages.foundStickerSetsNotModified.md) + +[messages.foundStickerSets](../constructors/messages.foundStickerSets.md) + +[$MadelineProto->messages->searchStickerSets](../methods/messages.searchStickerSets.md) + diff --git a/old_docs/API_docs_v44/types/messages.HighScores.md b/old_docs/API_docs_v44/types/messages.HighScores.md new file mode 100644 index 00000000..c480f08e --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.HighScores.md @@ -0,0 +1,31 @@ +--- +title: messages.HighScores +description: constructors and methods of type messages.HighScores +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_HighScores.html +--- +# Type: messages.HighScores +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.highScores](../constructors/messages.highScores.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getGameHighScores](../methods/messages.getGameHighScores.md) + +[$MadelineProto->messages->getInlineGameHighScores](../methods/messages.getInlineGameHighScores.md) + + + +[messages.highScores](../constructors/messages.highScores.md) + +[$MadelineProto->messages->getGameHighScores](../methods/messages.getGameHighScores.md) + +[$MadelineProto->messages->getInlineGameHighScores](../methods/messages.getInlineGameHighScores.md) + diff --git a/old_docs/API_docs_v44/types/messages.InactiveChats.md b/old_docs/API_docs_v44/types/messages.InactiveChats.md new file mode 100644 index 00000000..9bbd1c78 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.InactiveChats.md @@ -0,0 +1,27 @@ +--- +title: messages.InactiveChats +description: constructors and methods of type messages.InactiveChats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_InactiveChats.html +--- +# Type: messages.InactiveChats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.inactiveChats](../constructors/messages.inactiveChats.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getInactiveChannels](../methods/channels.getInactiveChannels.md) + + + +[messages.inactiveChats](../constructors/messages.inactiveChats.md) + +[$MadelineProto->channels->getInactiveChannels](../methods/channels.getInactiveChannels.md) + diff --git a/old_docs/API_docs_v44/types/messages.MessageEditData.md b/old_docs/API_docs_v44/types/messages.MessageEditData.md new file mode 100644 index 00000000..62bd28cb --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.MessageEditData.md @@ -0,0 +1,27 @@ +--- +title: messages.MessageEditData +description: constructors and methods of type messages.MessageEditData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_MessageEditData.html +--- +# Type: messages.MessageEditData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.messageEditData](../constructors/messages.messageEditData.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getMessageEditData](../methods/messages.getMessageEditData.md) + + + +[messages.messageEditData](../constructors/messages.messageEditData.md) + +[$MadelineProto->messages->getMessageEditData](../methods/messages.getMessageEditData.md) + diff --git a/old_docs/API_docs_v44/types/messages.Messages.md b/old_docs/API_docs_v44/types/messages.Messages.md index 7e8b9fa9..83ac41fc 100644 --- a/old_docs/API_docs_v44/types/messages.Messages.md +++ b/old_docs/API_docs_v44/types/messages.Messages.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.Messages image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_Messages.html --- -# Type: messages.Messages +# Type: messages.Messages [Back to types index](index.md) @@ -17,6 +17,8 @@ redirect_from: /API_docs/types/messages_Messages.html [messages.channelMessages](../constructors/messages.channelMessages.md) +[messages.messagesNotModified](../constructors/messages.messagesNotModified.md) + ### Methods that return an object of this type (methods): @@ -27,11 +29,43 @@ redirect_from: /API_docs/types/messages_Messages.html [$MadelineProto->messages->search](../methods/messages.search.md) -[$MadelineProto->channels->getImportantHistory](../methods/channels.getImportantHistory.md) +[$MadelineProto->messages->searchGlobal](../methods/messages.searchGlobal.md) + +[$MadelineProto->messages->getUnreadMentions](../methods/messages.getUnreadMentions.md) + +[$MadelineProto->messages->getRecentLocations](../methods/messages.getRecentLocations.md) + +[$MadelineProto->messages->getScheduledHistory](../methods/messages.getScheduledHistory.md) + +[$MadelineProto->messages->getScheduledMessages](../methods/messages.getScheduledMessages.md) [$MadelineProto->channels->getMessages](../methods/channels.getMessages.md) + + +[messages.messages](../constructors/messages.messages.md) + +[messages.messagesSlice](../constructors/messages.messagesSlice.md) + +[messages.channelMessages](../constructors/messages.channelMessages.md) + +[messages.messagesNotModified](../constructors/messages.messagesNotModified.md) + +[$MadelineProto->messages->getMessages](../methods/messages.getMessages.md) + +[$MadelineProto->messages->getHistory](../methods/messages.getHistory.md) + +[$MadelineProto->messages->search](../methods/messages.search.md) + [$MadelineProto->messages->searchGlobal](../methods/messages.searchGlobal.md) +[$MadelineProto->messages->getUnreadMentions](../methods/messages.getUnreadMentions.md) +[$MadelineProto->messages->getRecentLocations](../methods/messages.getRecentLocations.md) + +[$MadelineProto->messages->getScheduledHistory](../methods/messages.getScheduledHistory.md) + +[$MadelineProto->messages->getScheduledMessages](../methods/messages.getScheduledMessages.md) + +[$MadelineProto->channels->getMessages](../methods/channels.getMessages.md) diff --git a/old_docs/API_docs_v44/types/messages.PeerDialogs.md b/old_docs/API_docs_v44/types/messages.PeerDialogs.md new file mode 100644 index 00000000..d9dcc974 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.PeerDialogs.md @@ -0,0 +1,31 @@ +--- +title: messages.PeerDialogs +description: constructors and methods of type messages.PeerDialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_PeerDialogs.html +--- +# Type: messages.PeerDialogs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.peerDialogs](../constructors/messages.peerDialogs.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPeerDialogs](../methods/messages.getPeerDialogs.md) + +[$MadelineProto->messages->getPinnedDialogs](../methods/messages.getPinnedDialogs.md) + + + +[messages.peerDialogs](../constructors/messages.peerDialogs.md) + +[$MadelineProto->messages->getPeerDialogs](../methods/messages.getPeerDialogs.md) + +[$MadelineProto->messages->getPinnedDialogs](../methods/messages.getPinnedDialogs.md) + diff --git a/old_docs/API_docs_v44/types/messages.RecentStickers.md b/old_docs/API_docs_v44/types/messages.RecentStickers.md new file mode 100644 index 00000000..d576f3c7 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.RecentStickers.md @@ -0,0 +1,31 @@ +--- +title: messages.RecentStickers +description: constructors and methods of type messages.RecentStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_RecentStickers.html +--- +# Type: messages.RecentStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.recentStickersNotModified](../constructors/messages.recentStickersNotModified.md) + +[messages.recentStickers](../constructors/messages.recentStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getRecentStickers](../methods/messages.getRecentStickers.md) + + + +[messages.recentStickersNotModified](../constructors/messages.recentStickersNotModified.md) + +[messages.recentStickers](../constructors/messages.recentStickers.md) + +[$MadelineProto->messages->getRecentStickers](../methods/messages.getRecentStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.SavedGifs.md b/old_docs/API_docs_v44/types/messages.SavedGifs.md new file mode 100644 index 00000000..27c5766d --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.SavedGifs.md @@ -0,0 +1,31 @@ +--- +title: messages.SavedGifs +description: constructors and methods of type messages.SavedGifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_SavedGifs.html +--- +# Type: messages.SavedGifs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.savedGifsNotModified](../constructors/messages.savedGifsNotModified.md) + +[messages.savedGifs](../constructors/messages.savedGifs.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSavedGifs](../methods/messages.getSavedGifs.md) + + + +[messages.savedGifsNotModified](../constructors/messages.savedGifsNotModified.md) + +[messages.savedGifs](../constructors/messages.savedGifs.md) + +[$MadelineProto->messages->getSavedGifs](../methods/messages.getSavedGifs.md) + diff --git a/old_docs/API_docs_v44/types/messages.SearchCounter.md b/old_docs/API_docs_v44/types/messages.SearchCounter.md new file mode 100644 index 00000000..ab414296 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.SearchCounter.md @@ -0,0 +1,27 @@ +--- +title: messages.SearchCounter +description: constructors and methods of type messages.SearchCounter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_SearchCounter.html +--- +# Type: messages.SearchCounter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.searchCounter](../constructors/messages.searchCounter.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSearchCounters](../methods/messages.getSearchCounters.md) + + + +[messages.searchCounter](../constructors/messages.searchCounter.md) + +[$MadelineProto->messages->getSearchCounters](../methods/messages.getSearchCounters.md) + diff --git a/old_docs/API_docs_v44/types/messages.SentEncryptedMessage.md b/old_docs/API_docs_v44/types/messages.SentEncryptedMessage.md index 2a460974..0f8864f4 100644 --- a/old_docs/API_docs_v44/types/messages.SentEncryptedMessage.md +++ b/old_docs/API_docs_v44/types/messages.SentEncryptedMessage.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.SentEncryptedMessage image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_SentEncryptedMessage.html --- -# Type: messages.SentEncryptedMessage +# Type: messages.SentEncryptedMessage [Back to types index](index.md) @@ -27,3 +27,13 @@ redirect_from: /API_docs/types/messages_SentEncryptedMessage.html +[messages.sentEncryptedMessage](../constructors/messages.sentEncryptedMessage.md) + +[messages.sentEncryptedFile](../constructors/messages.sentEncryptedFile.md) + +[$MadelineProto->messages->sendEncrypted](../methods/messages.sendEncrypted.md) + +[$MadelineProto->messages->sendEncryptedFile](../methods/messages.sendEncryptedFile.md) + +[$MadelineProto->messages->sendEncryptedService](../methods/messages.sendEncryptedService.md) + diff --git a/old_docs/API_docs_v44/types/messages.StickerSet.md b/old_docs/API_docs_v44/types/messages.StickerSet.md index 3981a36c..568fa326 100644 --- a/old_docs/API_docs_v44/types/messages.StickerSet.md +++ b/old_docs/API_docs_v44/types/messages.StickerSet.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.StickerSet image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_StickerSet.html --- -# Type: messages.StickerSet +# Type: messages.StickerSet [Back to types index](index.md) @@ -19,5 +19,29 @@ redirect_from: /API_docs/types/messages_StickerSet.html [$MadelineProto->messages->getStickerSet](../methods/messages.getStickerSet.md) +[$MadelineProto->stickers->createStickerSet](../methods/stickers.createStickerSet.md) + +[$MadelineProto->stickers->removeStickerFromSet](../methods/stickers.removeStickerFromSet.md) + +[$MadelineProto->stickers->changeStickerPosition](../methods/stickers.changeStickerPosition.md) + +[$MadelineProto->stickers->addStickerToSet](../methods/stickers.addStickerToSet.md) + +[$MadelineProto->stickers->setStickerSetThumb](../methods/stickers.setStickerSetThumb.md) + +[messages.stickerSet](../constructors/messages.stickerSet.md) + +[$MadelineProto->messages->getStickerSet](../methods/messages.getStickerSet.md) + +[$MadelineProto->stickers->createStickerSet](../methods/stickers.createStickerSet.md) + +[$MadelineProto->stickers->removeStickerFromSet](../methods/stickers.removeStickerFromSet.md) + +[$MadelineProto->stickers->changeStickerPosition](../methods/stickers.changeStickerPosition.md) + +[$MadelineProto->stickers->addStickerToSet](../methods/stickers.addStickerToSet.md) + +[$MadelineProto->stickers->setStickerSetThumb](../methods/stickers.setStickerSetThumb.md) + diff --git a/old_docs/API_docs_v44/types/messages.StickerSetInstallResult.md b/old_docs/API_docs_v44/types/messages.StickerSetInstallResult.md new file mode 100644 index 00000000..cf5c8674 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.StickerSetInstallResult.md @@ -0,0 +1,31 @@ +--- +title: messages.StickerSetInstallResult +description: constructors and methods of type messages.StickerSetInstallResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_StickerSetInstallResult.html +--- +# Type: messages.StickerSetInstallResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.stickerSetInstallResultSuccess](../constructors/messages.stickerSetInstallResultSuccess.md) + +[messages.stickerSetInstallResultArchive](../constructors/messages.stickerSetInstallResultArchive.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->installStickerSet](../methods/messages.installStickerSet.md) + + + +[messages.stickerSetInstallResultSuccess](../constructors/messages.stickerSetInstallResultSuccess.md) + +[messages.stickerSetInstallResultArchive](../constructors/messages.stickerSetInstallResultArchive.md) + +[$MadelineProto->messages->installStickerSet](../methods/messages.installStickerSet.md) + diff --git a/old_docs/API_docs_v44/types/messages.Stickers.md b/old_docs/API_docs_v44/types/messages.Stickers.md index 0b830b2c..28b2172e 100644 --- a/old_docs/API_docs_v44/types/messages.Stickers.md +++ b/old_docs/API_docs_v44/types/messages.Stickers.md @@ -4,7 +4,7 @@ description: constructors and methods of type messages.Stickers image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/messages_Stickers.html --- -# Type: messages.Stickers +# Type: messages.Stickers [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/messages_Stickers.html +[messages.stickersNotModified](../constructors/messages.stickersNotModified.md) + +[messages.stickers](../constructors/messages.stickers.md) + +[$MadelineProto->messages->getStickers](../methods/messages.getStickers.md) + diff --git a/old_docs/API_docs_v44/types/messages.VotesList.md b/old_docs/API_docs_v44/types/messages.VotesList.md new file mode 100644 index 00000000..ff3ce399 --- /dev/null +++ b/old_docs/API_docs_v44/types/messages.VotesList.md @@ -0,0 +1,27 @@ +--- +title: messages.VotesList +description: constructors and methods of type messages.VotesList +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_VotesList.html +--- +# Type: messages.VotesList +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.votesList](../constructors/messages.votesList.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPollVotes](../methods/messages.getPollVotes.md) + + + +[messages.votesList](../constructors/messages.votesList.md) + +[$MadelineProto->messages->getPollVotes](../methods/messages.getPollVotes.md) + diff --git a/old_docs/API_docs_v44/types/payments.BankCardData.md b/old_docs/API_docs_v44/types/payments.BankCardData.md new file mode 100644 index 00000000..dc51fdab --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.BankCardData.md @@ -0,0 +1,27 @@ +--- +title: payments.BankCardData +description: constructors and methods of type payments.BankCardData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_BankCardData.html +--- +# Type: payments.BankCardData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.bankCardData](../constructors/payments.bankCardData.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getBankCardData](../methods/payments.getBankCardData.md) + + + +[payments.bankCardData](../constructors/payments.bankCardData.md) + +[$MadelineProto->payments->getBankCardData](../methods/payments.getBankCardData.md) + diff --git a/old_docs/API_docs_v44/types/payments.PaymentForm.md b/old_docs/API_docs_v44/types/payments.PaymentForm.md new file mode 100644 index 00000000..894bdbd9 --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.PaymentForm.md @@ -0,0 +1,27 @@ +--- +title: payments.PaymentForm +description: constructors and methods of type payments.PaymentForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentForm.html +--- +# Type: payments.PaymentForm +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.paymentForm](../constructors/payments.paymentForm.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getPaymentForm](../methods/payments.getPaymentForm.md) + + + +[payments.paymentForm](../constructors/payments.paymentForm.md) + +[$MadelineProto->payments->getPaymentForm](../methods/payments.getPaymentForm.md) + diff --git a/old_docs/API_docs_v44/types/payments.PaymentReceipt.md b/old_docs/API_docs_v44/types/payments.PaymentReceipt.md new file mode 100644 index 00000000..6e946dc2 --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.PaymentReceipt.md @@ -0,0 +1,27 @@ +--- +title: payments.PaymentReceipt +description: constructors and methods of type payments.PaymentReceipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentReceipt.html +--- +# Type: payments.PaymentReceipt +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.paymentReceipt](../constructors/payments.paymentReceipt.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getPaymentReceipt](../methods/payments.getPaymentReceipt.md) + + + +[payments.paymentReceipt](../constructors/payments.paymentReceipt.md) + +[$MadelineProto->payments->getPaymentReceipt](../methods/payments.getPaymentReceipt.md) + diff --git a/old_docs/API_docs_v44/types/payments.PaymentResult.md b/old_docs/API_docs_v44/types/payments.PaymentResult.md new file mode 100644 index 00000000..d9aeb389 --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.PaymentResult.md @@ -0,0 +1,31 @@ +--- +title: payments.PaymentResult +description: constructors and methods of type payments.PaymentResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentResult.html +--- +# Type: payments.PaymentResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.paymentResult](../constructors/payments.paymentResult.md) + +[payments.paymentVerificationNeeded](../constructors/payments.paymentVerificationNeeded.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->sendPaymentForm](../methods/payments.sendPaymentForm.md) + + + +[payments.paymentResult](../constructors/payments.paymentResult.md) + +[payments.paymentVerificationNeeded](../constructors/payments.paymentVerificationNeeded.md) + +[$MadelineProto->payments->sendPaymentForm](../methods/payments.sendPaymentForm.md) + diff --git a/old_docs/API_docs_v44/types/payments.SavedInfo.md b/old_docs/API_docs_v44/types/payments.SavedInfo.md new file mode 100644 index 00000000..e3636c75 --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.SavedInfo.md @@ -0,0 +1,27 @@ +--- +title: payments.SavedInfo +description: constructors and methods of type payments.SavedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_SavedInfo.html +--- +# Type: payments.SavedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.savedInfo](../constructors/payments.savedInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getSavedInfo](../methods/payments.getSavedInfo.md) + + + +[payments.savedInfo](../constructors/payments.savedInfo.md) + +[$MadelineProto->payments->getSavedInfo](../methods/payments.getSavedInfo.md) + diff --git a/old_docs/API_docs_v44/types/payments.ValidatedRequestedInfo.md b/old_docs/API_docs_v44/types/payments.ValidatedRequestedInfo.md new file mode 100644 index 00000000..afd14462 --- /dev/null +++ b/old_docs/API_docs_v44/types/payments.ValidatedRequestedInfo.md @@ -0,0 +1,27 @@ +--- +title: payments.ValidatedRequestedInfo +description: constructors and methods of type payments.ValidatedRequestedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_ValidatedRequestedInfo.html +--- +# Type: payments.ValidatedRequestedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.validatedRequestedInfo](../constructors/payments.validatedRequestedInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->validateRequestedInfo](../methods/payments.validateRequestedInfo.md) + + + +[payments.validatedRequestedInfo](../constructors/payments.validatedRequestedInfo.md) + +[$MadelineProto->payments->validateRequestedInfo](../methods/payments.validateRequestedInfo.md) + diff --git a/old_docs/API_docs_v44/types/phone.PhoneCall.md b/old_docs/API_docs_v44/types/phone.PhoneCall.md new file mode 100644 index 00000000..fc591ca0 --- /dev/null +++ b/old_docs/API_docs_v44/types/phone.PhoneCall.md @@ -0,0 +1,35 @@ +--- +title: phone.PhoneCall +description: constructors and methods of type phone.PhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/phone_PhoneCall.html +--- +# Type: phone.PhoneCall +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phone.phoneCall](../constructors/phone.phoneCall.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->phone->requestCall](../methods/phone.requestCall.md) + +[$MadelineProto->phone->acceptCall](../methods/phone.acceptCall.md) + +[$MadelineProto->phone->confirmCall](../methods/phone.confirmCall.md) + + + +[phone.phoneCall](../constructors/phone.phoneCall.md) + +[$MadelineProto->phone->requestCall](../methods/phone.requestCall.md) + +[$MadelineProto->phone->acceptCall](../methods/phone.acceptCall.md) + +[$MadelineProto->phone->confirmCall](../methods/phone.confirmCall.md) + diff --git a/old_docs/API_docs_v44/types/photos.Photo.md b/old_docs/API_docs_v44/types/photos.Photo.md index 1abc47e5..39a4bed2 100644 --- a/old_docs/API_docs_v44/types/photos.Photo.md +++ b/old_docs/API_docs_v44/types/photos.Photo.md @@ -4,7 +4,7 @@ description: constructors and methods of type photos.Photo image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/photos_Photo.html --- -# Type: photos.Photo +# Type: photos.Photo [Back to types index](index.md) @@ -17,7 +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) + diff --git a/old_docs/API_docs_v44/types/photos.Photos.md b/old_docs/API_docs_v44/types/photos.Photos.md index 04600167..fab0970e 100644 --- a/old_docs/API_docs_v44/types/photos.Photos.md +++ b/old_docs/API_docs_v44/types/photos.Photos.md @@ -4,7 +4,7 @@ description: constructors and methods of type photos.Photos image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/photos_Photos.html --- -# Type: photos.Photos +# Type: photos.Photos [Back to types index](index.md) @@ -23,3 +23,9 @@ redirect_from: /API_docs/types/photos_Photos.html +[photos.photos](../constructors/photos.photos.md) + +[photos.photosSlice](../constructors/photos.photosSlice.md) + +[$MadelineProto->photos->getUserPhotos](../methods/photos.getUserPhotos.md) + diff --git a/old_docs/API_docs_v44/types/stats.BroadcastStats.md b/old_docs/API_docs_v44/types/stats.BroadcastStats.md new file mode 100644 index 00000000..99ab377a --- /dev/null +++ b/old_docs/API_docs_v44/types/stats.BroadcastStats.md @@ -0,0 +1,27 @@ +--- +title: stats.BroadcastStats +description: constructors and methods of type stats.BroadcastStats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/stats_BroadcastStats.html +--- +# Type: stats.BroadcastStats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stats.broadcastStats](../constructors/stats.broadcastStats.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->stats->getBroadcastStats](../methods/stats.getBroadcastStats.md) + + + +[stats.broadcastStats](../constructors/stats.broadcastStats.md) + +[$MadelineProto->stats->getBroadcastStats](../methods/stats.getBroadcastStats.md) + diff --git a/old_docs/API_docs_v44/types/stats.MegagroupStats.md b/old_docs/API_docs_v44/types/stats.MegagroupStats.md new file mode 100644 index 00000000..3d4d8066 --- /dev/null +++ b/old_docs/API_docs_v44/types/stats.MegagroupStats.md @@ -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) + diff --git a/old_docs/API_docs_v44/types/storage.FileType.md b/old_docs/API_docs_v44/types/storage.FileType.md index 9c1daf6f..5a45143f 100644 --- a/old_docs/API_docs_v44/types/storage.FileType.md +++ b/old_docs/API_docs_v44/types/storage.FileType.md @@ -4,7 +4,7 @@ description: constructors and methods of type storage.FileType image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/storage_FileType.html --- -# Type: storage.FileType +# Type: storage.FileType [Back to types index](index.md) @@ -13,6 +13,8 @@ redirect_from: /API_docs/types/storage_FileType.html [storage.fileUnknown](../constructors/storage.fileUnknown.md) +[storage.filePartial](../constructors/storage.filePartial.md) + [storage.fileJpeg](../constructors/storage.fileJpeg.md) [storage.fileGif](../constructors/storage.fileGif.md) @@ -25,8 +27,6 @@ redirect_from: /API_docs/types/storage_FileType.html [storage.fileMov](../constructors/storage.fileMov.md) -[storage.filePartial](../constructors/storage.filePartial.md) - [storage.fileMp4](../constructors/storage.fileMp4.md) [storage.fileWebp](../constructors/storage.fileWebp.md) @@ -37,3 +37,23 @@ redirect_from: /API_docs/types/storage_FileType.html +[storage.fileUnknown](../constructors/storage.fileUnknown.md) + +[storage.filePartial](../constructors/storage.filePartial.md) + +[storage.fileJpeg](../constructors/storage.fileJpeg.md) + +[storage.fileGif](../constructors/storage.fileGif.md) + +[storage.filePng](../constructors/storage.filePng.md) + +[storage.filePdf](../constructors/storage.filePdf.md) + +[storage.fileMp3](../constructors/storage.fileMp3.md) + +[storage.fileMov](../constructors/storage.fileMov.md) + +[storage.fileMp4](../constructors/storage.fileMp4.md) + +[storage.fileWebp](../constructors/storage.fileWebp.md) + diff --git a/old_docs/API_docs_v44/types/updates.ChannelDifference.md b/old_docs/API_docs_v44/types/updates.ChannelDifference.md index 1cfd0396..804720ee 100644 --- a/old_docs/API_docs_v44/types/updates.ChannelDifference.md +++ b/old_docs/API_docs_v44/types/updates.ChannelDifference.md @@ -4,7 +4,7 @@ description: constructors and methods of type updates.ChannelDifference image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/updates_ChannelDifference.html --- -# Type: updates.ChannelDifference +# Type: updates.ChannelDifference [Back to types index](index.md) @@ -25,3 +25,11 @@ redirect_from: /API_docs/types/updates_ChannelDifference.html +[updates.channelDifferenceEmpty](../constructors/updates.channelDifferenceEmpty.md) + +[updates.channelDifferenceTooLong](../constructors/updates.channelDifferenceTooLong.md) + +[updates.channelDifference](../constructors/updates.channelDifference.md) + +[$MadelineProto->updates->getChannelDifference](../methods/updates.getChannelDifference.md) + diff --git a/old_docs/API_docs_v44/types/updates.Difference.md b/old_docs/API_docs_v44/types/updates.Difference.md index b1be354b..4b1c19d9 100644 --- a/old_docs/API_docs_v44/types/updates.Difference.md +++ b/old_docs/API_docs_v44/types/updates.Difference.md @@ -4,7 +4,7 @@ description: constructors and methods of type updates.Difference image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/updates_Difference.html --- -# Type: updates.Difference +# Type: updates.Difference [Back to types index](index.md) @@ -17,6 +17,8 @@ redirect_from: /API_docs/types/updates_Difference.html [updates.differenceSlice](../constructors/updates.differenceSlice.md) +[updates.differenceTooLong](../constructors/updates.differenceTooLong.md) + ### Methods that return an object of this type (methods): @@ -25,3 +27,13 @@ redirect_from: /API_docs/types/updates_Difference.html +[updates.differenceEmpty](../constructors/updates.differenceEmpty.md) + +[updates.difference](../constructors/updates.difference.md) + +[updates.differenceSlice](../constructors/updates.differenceSlice.md) + +[updates.differenceTooLong](../constructors/updates.differenceTooLong.md) + +[$MadelineProto->updates->getDifference](../methods/updates.getDifference.md) + diff --git a/old_docs/API_docs_v44/types/updates.State.md b/old_docs/API_docs_v44/types/updates.State.md index 61999d5f..9800e26d 100644 --- a/old_docs/API_docs_v44/types/updates.State.md +++ b/old_docs/API_docs_v44/types/updates.State.md @@ -4,7 +4,7 @@ description: constructors and methods of type updates.State image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/updates_State.html --- -# Type: updates.State +# Type: updates.State [Back to types index](index.md) @@ -21,3 +21,7 @@ redirect_from: /API_docs/types/updates_State.html +[updates.state](../constructors/updates.state.md) + +[$MadelineProto->updates->getState](../methods/updates.getState.md) + diff --git a/old_docs/API_docs_v44/types/upload.CdnFile.md b/old_docs/API_docs_v44/types/upload.CdnFile.md new file mode 100644 index 00000000..8b033e03 --- /dev/null +++ b/old_docs/API_docs_v44/types/upload.CdnFile.md @@ -0,0 +1,31 @@ +--- +title: upload.CdnFile +description: constructors and methods of type upload.CdnFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/upload_CdnFile.html +--- +# Type: upload.CdnFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[upload.cdnFileReuploadNeeded](../constructors/upload.cdnFileReuploadNeeded.md) + +[upload.cdnFile](../constructors/upload.cdnFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->getCdnFile](../methods/upload.getCdnFile.md) + + + +[upload.cdnFileReuploadNeeded](../constructors/upload.cdnFileReuploadNeeded.md) + +[upload.cdnFile](../constructors/upload.cdnFile.md) + +[$MadelineProto->upload->getCdnFile](../methods/upload.getCdnFile.md) + diff --git a/old_docs/API_docs_v44/types/upload.File.md b/old_docs/API_docs_v44/types/upload.File.md index c33d3be9..3953de14 100644 --- a/old_docs/API_docs_v44/types/upload.File.md +++ b/old_docs/API_docs_v44/types/upload.File.md @@ -4,7 +4,7 @@ description: constructors and methods of type upload.File image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png redirect_from: /API_docs/types/upload_File.html --- -# Type: upload.File +# Type: upload.File [Back to types index](index.md) @@ -13,6 +13,8 @@ redirect_from: /API_docs/types/upload_File.html [upload.file](../constructors/upload.file.md) +[upload.fileCdnRedirect](../constructors/upload.fileCdnRedirect.md) + ### Methods that return an object of this type (methods): @@ -21,3 +23,9 @@ redirect_from: /API_docs/types/upload_File.html +[upload.file](../constructors/upload.file.md) + +[upload.fileCdnRedirect](../constructors/upload.fileCdnRedirect.md) + +[$MadelineProto->upload->getFile](../methods/upload.getFile.md) + diff --git a/old_docs/API_docs_v44/types/upload.WebFile.md b/old_docs/API_docs_v44/types/upload.WebFile.md new file mode 100644 index 00000000..2570c297 --- /dev/null +++ b/old_docs/API_docs_v44/types/upload.WebFile.md @@ -0,0 +1,27 @@ +--- +title: upload.WebFile +description: constructors and methods of type upload.WebFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/upload_WebFile.html +--- +# Type: upload.WebFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[upload.webFile](../constructors/upload.webFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->getWebFile](../methods/upload.getWebFile.md) + + + +[upload.webFile](../constructors/upload.webFile.md) + +[$MadelineProto->upload->getWebFile](../methods/upload.getWebFile.md) + diff --git a/old_docs/README.md b/old_docs/README.md index 4ce89de4..d8786c09 100644 --- a/old_docs/README.md +++ b/old_docs/README.md @@ -48,3 +48,4 @@ description: Documentation of old mtproto layers [Layer v41](API_docs_v41/) [Layer v42](API_docs_v42/) [Layer v43](API_docs_v43/) +[Layer v44](API_docs_v44/)