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

Update docs

Browse Source
This commit is contained in:
Daniil Gentili 2020-06-16 17:50:25 +02:00
parent f49ae1bcb6
commit d0fd350e78
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
42959 changed files with 1744898 additions and 39427 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/API_docs/constructors/account.authorizationForm.md
View File

@ -15,10 +15,10 @@ redirect_from: /API_docs/constructors/account_authorizationForm.html
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required types|
|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values|
|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|Errors|
|users|Array of [User](../types/User.md) | Yes|Users|
|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|

2
docs/API_docs/constructors/account.authorizations.md
View File

@ -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|

12
docs/API_docs/constructors/account.contentSettings.md
View File

@ -1,6 +1,6 @@
---
title: account.contentSettings
description: account.contentSettings attributes, type and example
description: Sensitive content settings
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/constructors/account_contentSettings.html
---
@ -9,12 +9,14 @@ redirect_from: /API_docs/constructors/account_contentSettings.html
Sensitive content settings
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|sensitive\_enabled|[Bool](../types/Bool.md) | Optional|
|sensitive\_can\_change|[Bool](../types/Bool.md) | Optional|
| 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|

4
docs/API_docs/constructors/account.passwordSettings.md
View File

@ -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,7 +9,7 @@ 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:

6
docs/API_docs/constructors/account.privacyRules.md
View File

@ -15,9 +15,9 @@ Privacy rules
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules|
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats allowed?|
|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|

2
docs/API_docs/constructors/account.themes.md
View File

@ -15,7 +15,7 @@ Installed themes
| 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)|
|hash|[int](../types/int.md) | Yes|
|themes|Array of [Theme](../types/Theme.md) | Yes|Themes|

2
docs/API_docs/constructors/account.wallPapers.md
View File

@ -15,7 +15,7 @@ Installed wallpapers
| 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)|
|hash|[int](../types/int.md) | Yes|
|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers|

2
docs/API_docs/constructors/account.webAuthorizations.md
View File

@ -15,7 +15,7 @@ Web authorizations
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Authorizations|
|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Web authorization list|
|users|Array of [User](../types/User.md) | Yes|Users|

4
docs/API_docs/constructors/auth.exportedAuthorization.md
View File

@ -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|

12
docs/API_docs/constructors/auth.loginToken.md
View File

@ -1,6 +1,6 @@
---
title: auth.loginToken
description: auth.loginToken attributes, type and example
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
---
@ -9,12 +9,14 @@ redirect_from: /API_docs/constructors/auth_loginToken.html
Login token (for [QR code login](https://core.telegram.org/api/qr-login))
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|expires|[int](../types/int.md) | Yes|
|token|[bytes](../types/bytes.md) | Yes|
| 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|

12
docs/API_docs/constructors/auth.loginTokenMigrateTo.md
View File

@ -1,6 +1,6 @@
---
title: auth.loginTokenMigrateTo
description: auth.loginTokenMigrateTo attributes, type and example
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
---
@ -9,12 +9,14 @@ redirect_from: /API_docs/constructors/auth_loginTokenMigrateTo.html
Repeat the query to the specified DC
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|dc\_id|[int](../types/int.md) | Yes|
|token|[bytes](../types/bytes.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|token|[bytes](../types/bytes.md) | Yes|Token to use for login|

10
docs/API_docs/constructors/auth.loginTokenSuccess.md
View File

@ -1,6 +1,6 @@
---
title: auth.loginTokenSuccess
description: auth.loginTokenSuccess attributes, type and example
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
---
@ -9,11 +9,13 @@ redirect_from: /API_docs/constructors/auth_loginTokenSuccess.html
Login via token (QR code) succeded!
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|authorization|[auth.Authorization](../constructors/auth.Authorization.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|authorization|[auth.Authorization](../constructors/auth.Authorization.md) | Yes|Authorization info|

2
docs/API_docs/constructors/autoDownloadSettings.md
View File

@ -21,7 +21,7 @@ Autodownload settings
|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||
|video\_upload\_maxbitrate|[int](../types/int.md) | Yes|Maximum suggested bitrate for **uploading** videos|

12
docs/API_docs/constructors/bankCardOpenUrl.md
View File

@ -1,6 +1,6 @@
---
title: bankCardOpenUrl
description: bankCardOpenUrl attributes, type and example
description: Credit card info URL provided by the bank
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: bankCardOpenUrl
@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Credit card info URL provided by the bank
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|url|[string](../types/string.md) | Yes|
|name|[string](../types/string.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|url|[string](../types/string.md) | Yes|Info URL|
|name|[string](../types/string.md) | Yes|Bank name|

4
docs/API_docs/constructors/baseThemeArctic.md
View File

@ -1,6 +1,6 @@
---
title: baseThemeArctic
description: baseThemeArctic attributes, type and example
description: Arctic theme
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: baseThemeArctic
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Arctic theme

4
docs/API_docs/constructors/baseThemeClassic.md
View File

@ -1,6 +1,6 @@
---
title: baseThemeClassic
description: baseThemeClassic attributes, type and example
description: Classic theme
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: baseThemeClassic
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Classic theme

4
docs/API_docs/constructors/baseThemeDay.md
View File

@ -1,6 +1,6 @@
---
title: baseThemeDay
description: baseThemeDay attributes, type and example
description: Day theme
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: baseThemeDay
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Day theme

4
docs/API_docs/constructors/baseThemeNight.md
View File

@ -1,6 +1,6 @@
---
title: baseThemeNight
description: baseThemeNight attributes, type and example
description: Night theme
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: baseThemeNight
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Night theme

4
docs/API_docs/constructors/baseThemeTinted.md
View File

@ -1,6 +1,6 @@
---
title: baseThemeTinted
description: baseThemeTinted attributes, type and example
description: Tinted theme
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: baseThemeTinted
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Tinted theme

2
docs/API_docs/constructors/botInfo.md
View File

@ -16,7 +16,7 @@ Info about bots (available bot commands, etc)
|----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|ID of the bot|
|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|

2
docs/API_docs/constructors/botInlineMessageMediaAuto.md
View File

@ -15,7 +15,7 @@ Send whatever media is attached to the [botInlineMediaResult](../constructors/bo
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[string](../types/string.md) | Yes|Caption|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|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|

2
docs/API_docs/constructors/botInlineMessageText.md
View File

@ -16,7 +16,7 @@ Send a simple text message
|----------|---------------|----------|-------------|
|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|Entities|
|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|

2
docs/API_docs/constructors/cdnConfig.md
View File

@ -14,7 +14,7 @@ Configuration for [CDN](https://core.telegram.org/cdn) file downloads.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|public\_keys|Array of [CdnPublicKey](../types/CdnPublicKey.md) | Yes|Public keys|
|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.|

4
docs/API_docs/constructors/channel.md
View File

@ -31,9 +31,9 @@ Channel/supergroup info
|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`)|
|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Restriction 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))|

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

@ -18,7 +18,7 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we set the channel's username?|
|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can we [associate](../methods/channels.setStickers.md) a stickerpack to the supergroup?|
|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Is the history before we joined hidden to us?|
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user call [messages.getStatsURL](../methods/messages.getStatsURL.md) on this channel|
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user view [channel statistics](https://core.telegram.org/api/stats) for this channel|
|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can we set the geolocation of this group (for geogroups)|
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available|
|id|[int](../types/int.md) | Yes|ID of the channel|
@ -34,18 +34,18 @@ Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
|chat\_photo|[Photo](../types/Photo.md) | Optional|Channel picture|
|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|Folder ID|
|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||
|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|

2
docs/API_docs/constructors/channelMessagesFilter.md
View File

@ -15,7 +15,7 @@ Filter for getting only certain types of channel messages
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|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|

6
docs/API_docs/constructors/channels.adminLogResults.md
View File

@ -15,9 +15,9 @@ Admin log events
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes|Events|
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|users|Array of [User](../types/User.md) | Yes|Users|
|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|

2
docs/API_docs/constructors/channels.channelParticipants.md
View File

@ -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|

4
docs/API_docs/constructors/chatFull.md
View File

@ -22,9 +22,9 @@ Detailed chat info
|chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo|
|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) | Optional|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|Folder ID|
|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

2
docs/API_docs/constructors/chatInvite.md
View File

@ -21,7 +21,7 @@ Chat invite info
|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|Participants|
|participants|Array of [User](../types/User.md) | Optional|A few of the participants that are in the group|

2
docs/API_docs/constructors/chatParticipants.md
View File

@ -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|

2
docs/API_docs/constructors/config.md
View File

@ -25,7 +25,7 @@ Current configuration
|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)|

4
docs/API_docs/constructors/contacts.blocked.md
View File

@ -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|

4
docs/API_docs/constructors/contacts.blockedSlice.md
View File

@ -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|

4
docs/API_docs/constructors/contacts.contacts.md
View File

@ -15,9 +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|
|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|Users|
|users|Array of [User](../types/User.md) | Yes|User list|

8
docs/API_docs/constructors/contacts.found.md
View File

@ -15,10 +15,10 @@ Users found by name substring and auxiliary data.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|my\_results|Array of [Peer](../types/Peer.md) | Yes|My results|
|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|

8
docs/API_docs/constructors/contacts.importedContacts.md
View File

@ -15,10 +15,10 @@ Info on succesfully imported contacts.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|Imported|
|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes|Popular invites|
|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.<br>Parameter added in [Layer 13](https://core.telegram.org/api/layers#layer-13)|
|users|Array of [User](../types/User.md) | Yes|List of users|

2
docs/API_docs/constructors/contacts.topPeers.md
View File

@ -15,7 +15,7 @@ Top peers
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes|Categories|
|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|

44
docs/API_docs/constructors/decryptedDataBlock.md
View File

@ -1,44 +0,0 @@
---
title: decryptedDataBlock
description: Decrypted data block
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: decryptedDataBlock
[Back to constructors index](index.md)
Decrypted data block
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|voice\_call\_id|[int128](../types/int128.md) | Optional|Voice call ID|
|in\_seq\_no|[int](../types/int.md) | Optional|In seq no|
|out\_seq\_no|[int](../types/int.md) | Optional|Out seq no|
|recent\_received\_mask|[int](../types/int.md) | Optional|Recent received mask|
|proto|[int](../types/int.md) | Optional|Proto|
|extra|[string](../types/string.md) | Optional|Extra|
|raw\_data|[string](../types/string.md) | Optional|Raw data|
### Type: [DecryptedDataBlock](../types/DecryptedDataBlock.md)
### Example:
```php
$decryptedDataBlock = ['_' => 'decryptedDataBlock', 'voice_call_id' => int128, 'in_seq_no' => int, 'out_seq_no' => int, 'recent_received_mask' => int, 'proto' => int, 'extra' => 'string', 'raw_data' => 'string'];
```
Or, if you're into Lua:
```lua
decryptedDataBlock={_='decryptedDataBlock', voice_call_id=int128, in_seq_no=int, out_seq_no=int, recent_received_mask=int, proto=int, extra='string', raw_data='string'}
```

2
docs/API_docs/constructors/decryptedMessageActionDeleteMessages_8.md
View File

@ -14,7 +14,7 @@ Deleted messages.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|random\_ids|Array of [long](../types/long.md) | Yes|Random IDs|
|random\_ids|Array of [long](../types/long.md) | Yes|List of deleted message IDs|

2
docs/API_docs/constructors/decryptedMessageActionReadMessages_8.md
View File

@ -14,7 +14,7 @@ Messages marked as read.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|random\_ids|Array of [long](../types/long.md) | Yes|Random IDs|
|random\_ids|Array of [long](../types/long.md) | Yes|List of message IDs|

2
docs/API_docs/constructors/decryptedMessageActionRequestKey_20.md
View File

@ -15,7 +15,7 @@ Request rekeying, see [rekeying process](https://core.telegram.org/api/end-to-en
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|exchange\_id|[long](../types/long.md) | Yes|Exchange ID|
|g\_a|[bytes](../types/bytes.md) | Yes|G\_a, see [rekeying process](https://core.telegram.org/api/end-to-end/pfs)|
|g\_a|[bytes](../types/bytes.md) | Yes|g\_a, see [rekeying process](https://core.telegram.org/api/end-to-end/pfs)|

2
docs/API_docs/constructors/decryptedMessageActionScreenshotMessages_8.md
View File

@ -14,7 +14,7 @@ A screenshot was taken.
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|random\_ids|Array of [long](../types/long.md) | Yes|Random IDs|
|random\_ids|Array of [long](../types/long.md) | Yes|List of affected message ids (that appeared on the screenshot)|

2
docs/API_docs/constructors/decryptedMessageMediaDocument_45.md
View File

@ -19,7 +19,7 @@ Document attached to a message in a secret chat.
|thumb\_h|[int](../types/int.md) | Yes|Thumbnail height|
|mime\_type|[string](../types/string.md) | Yes|File MIME-type|
|size|[int](../types/int.md) | Yes|Document size|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Document attributes for media types|
|caption|[string](../types/string.md) | Yes|Caption|

2
docs/API_docs/constructors/decryptedMessageMediaDocument_8.md
View File

@ -17,7 +17,7 @@ Document attached to a message in a secret chat.
|thumb|[bytes](../types/bytes.md) | Yes|Thumbnail-file contents (JPEG-file, quality 55, set in a 90x90 square)|
|thumb\_w|[int](../types/int.md) | Yes|Thumbnail width|
|thumb\_h|[int](../types/int.md) | Yes|Thumbnail height|
|file\_name|[string](../types/string.md) | Yes|File name|
|file\_name|[string](../types/string.md) | Yes|
|mime\_type|[string](../types/string.md) | Yes|File MIME-type|
|size|[int](../types/int.md) | Yes|Document size|

4
docs/API_docs/constructors/decryptedMessageMediaExternalDocument_23.md
View File

@ -15,13 +15,13 @@ Non-e2e documented forwarded from non-secret chat
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[long](../types/long.md) | Yes|Document ID|
|access\_hash|[long](../types/long.md) | Yes|Access hash|
|access\_hash|[long](../types/long.md) | Yes|access hash|
|date|[int](../types/int.md) | Yes|Date|
|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|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes for media types|

2
docs/API_docs/constructors/decryptedMessage_45.md
View File

@ -17,7 +17,7 @@ Contents of an encrypted message.
|ttl|[int](../types/int.md) | Yes|Message lifetime. Has higher priority than [decryptedMessageActionSetMessageTTL](../constructors/decryptedMessageActionSetMessageTTL.md).<br>Parameter added in [Layer 17](https://core.telegram.org/api/layers#layer-17).|
|message|[string](../types/string.md) | Yes|Message text|
|media|[DecryptedMessageMedia](../types/DecryptedMessageMedia.md) | Optional|Media content|
|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 (parameter added in layer 45)|
|via\_bot\_name|[string](../types/string.md) | Optional|Specifies the ID of the inline bot that generated the message (parameter added in layer 45)|
|reply\_to\_random\_id|[long](../types/long.md) | Optional|Random message ID of the message this message replies to (parameter added in layer 45)|

2
docs/API_docs/constructors/decryptedMessage_73.md
View File

@ -17,7 +17,7 @@ Contents of an encrypted message.
|ttl|[int](../types/int.md) | Yes|Message lifetime. Has higher priority than [decryptedMessageActionSetMessageTTL](../constructors/decryptedMessageActionSetMessageTTL.md).<br>Parameter added in [Layer 17](https://core.telegram.org/api/layers#layer-17).|
|message|[string](../types/string.md) | Yes|Message text|
|media|[DecryptedMessageMedia](../types/DecryptedMessageMedia.md) | Optional|Media content|
|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 (parameter added in layer 45)|
|via\_bot\_name|[string](../types/string.md) | Optional|Specifies the ID of the inline bot that generated the message (parameter added in layer 45)|
|reply\_to\_random\_id|[long](../types/long.md) | Optional|Random message ID of the message this message replies to (parameter added in layer 45)|
|grouped\_id|[long](../types/long.md) | Optional|Random group ID, assigned by the author of message.<br>Multiple encrypted messages with a photo attached and with the same group ID indicate an album (parameter added in layer 45)|

2
docs/API_docs/constructors/dialog.md
View File

@ -25,7 +25,7 @@ Chat
|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|Folder ID|
|folder\_id|[int](../types/int.md) | Optional|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

36
docs/API_docs/constructors/dialogFilter.md
View File

@ -1,6 +1,6 @@
---
title: dialogFilter
description: dialogFilter attributes, type and example
description: Dialog filter AKA [folder](https://core.telegram.org/api/folders)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: dialogFilter
@ -8,24 +8,26 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Dialog filter AKA [folder](https://core.telegram.org/api/folders)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|contacts|[Bool](../types/Bool.md) | Optional|
|non\_contacts|[Bool](../types/Bool.md) | Optional|
|groups|[Bool](../types/Bool.md) | Optional|
|broadcasts|[Bool](../types/Bool.md) | Optional|
|bots|[Bool](../types/Bool.md) | Optional|
|exclude\_muted|[Bool](../types/Bool.md) | Optional|
|exclude\_read|[Bool](../types/Bool.md) | Optional|
|exclude\_archived|[Bool](../types/Bool.md) | Optional|
|id|[int](../types/int.md) | Yes|
|title|[string](../types/string.md) | Yes|
|emoticon|[string](../types/string.md) | Optional|
|pinned\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|
|include\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|
|exclude\_peers|Array of [InputPeer](../types/InputPeer.md) | Yes|
| 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)|

12
docs/API_docs/constructors/dialogFilterSuggested.md
View File

@ -1,6 +1,6 @@
---
title: dialogFilterSuggested
description: dialogFilterSuggested attributes, type and example
description: Suggested [folders](https://core.telegram.org/api/folders)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: dialogFilterSuggested
@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Suggested [folders](https://core.telegram.org/api/folders)
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|filter|[DialogFilter](../types/DialogFilter.md) | Yes|
|description|[string](../types/string.md) | Yes|
| 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|

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

@ -1,6 +1,6 @@
---
title: dialogPeerFolder
description: Folder
description: [Peer folder](https://core.telegram.org/api/folders#peer-folders)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: dialogPeerFolder
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Folder
[Peer folder](https://core.telegram.org/api/folders#peer-folders)
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|folder\_id|[int](../types/int.md) | Yes|Folder ID|
|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

2
docs/API_docs/constructors/draftMessage.md
View File

@ -17,7 +17,7 @@ Represents a message [draft](https://core.telegram.org/api/drafts).
|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|Entities|
|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.|

2
docs/API_docs/constructors/emojiKeyword.md
View File

@ -15,7 +15,7 @@ Emoji keyword
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|keyword|[string](../types/string.md) | Yes|Keyword|
|emoticons|Array of [string](../types/string.md) | Yes|Emoticons|
|emoticons|Array of [string](../types/string.md) | Yes|Emojis associated to keyword|

2
docs/API_docs/constructors/emojiKeywordDeleted.md
View File

@ -15,7 +15,7 @@ Deleted emoji keyword
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|keyword|[string](../types/string.md) | Yes|Keyword|
|emoticons|Array of [string](../types/string.md) | Yes|Emoticons|
|emoticons|Array of [string](../types/string.md) | Yes|Emojis that were associated to keyword|

2
docs/API_docs/constructors/emojiKeywordsDifference.md
View File

@ -17,7 +17,7 @@ Changes to emoji keywords
|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|Keywords|
|keywords|Array of [EmojiKeyword](../types/EmojiKeyword.md) | Yes|Emojis associated to keywords|

2
docs/API_docs/constructors/encryptedMessage.md
View File

@ -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|

2
docs/API_docs/constructors/encryptedMessageService.md
View File

@ -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|

14
docs/API_docs/constructors/fileLocationUnavailable_23.md
View File

@ -1,6 +1,6 @@
---
title: fileLocationUnavailable
description: File location unavailable
description: fileLocationUnavailable attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: fileLocationUnavailable\_23
@ -8,15 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
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|
| Name | Type | Required |
|----------|---------------|----------|
|volume\_id|[long](../types/long.md) | Yes|
|local\_id|[int](../types/int.md) | Yes|
|secret|[long](../types/long.md) | Yes|

16
docs/API_docs/constructors/fileLocation_23.md
View File

@ -1,6 +1,6 @@
---
title: fileLocation
description: File location
description: fileLocation attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: fileLocation\_23
@ -8,16 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
File location
### 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|
| Name | Type | Required |
|----------|---------------|----------|
|dc\_id|[int](../types/int.md) | Yes|
|volume\_id|[long](../types/long.md) | Yes|
|local\_id|[int](../types/int.md) | Yes|
|secret|[long](../types/long.md) | Yes|

2
docs/API_docs/constructors/folderPeer.md
View File

@ -15,7 +15,7 @@ Peer in a folder
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Peer](../types/Peer.md) | Yes|Folder peer info|
|folder\_id|[int](../types/int.md) | Yes|Folder ID|
|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

4
docs/API_docs/constructors/help.appUpdate.md
View File

@ -19,8 +19,8 @@ An update is available for the application.
|id|[int](../types/int.md) | Yes|Update ID|
|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|Entities|
|document|[Document](../types/Document.md) | Optional|Attached document|
|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|

2
docs/API_docs/constructors/help.deepLinkInfo.md
View File

@ -17,7 +17,7 @@ Deep linking info
|----------|---------------|----------|-------------|
|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|Entities|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|[Message entities for styled text](https://core.telegram.org/api/entities)|

6
docs/API_docs/constructors/help.inviteText.md
View File

@ -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|

2
docs/API_docs/constructors/help.passportConfig.md
View File

@ -15,7 +15,7 @@ Telegram [passport](https://core.telegram.org/passport) configuration
| 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)|
|hash|[int](../types/int.md) | Yes|
|countries\_langs|[DataJSON](../types/DataJSON.md) | Yes|Localization|

45
docs/API_docs/constructors/help.promoData.md Normal file
View File

@ -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'}
```

39
docs/API_docs/constructors/help.promoDataEmpty.md Normal file
View File

@ -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}
```

2
docs/API_docs/constructors/help.termsOfService.md
View File

@ -18,7 +18,7 @@ Info about the latest telegram Terms Of Service
|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|Entities|
|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.|

2
docs/API_docs/constructors/help.userInfo.md
View File

@ -16,7 +16,7 @@ Internal use
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[string](../types/string.md) | Yes|Info|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities|
|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|

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

@ -408,9 +408,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$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), \];<a name="dcOption"></a>
***
<br><br>[$decryptedDataBlock](../constructors/decryptedDataBlock.md) = \['voice_call_id' => [int128](../types/int128.md), 'in_seq_no' => [int](../types/int.md), 'out_seq_no' => [int](../types/int.md), 'recent_received_mask' => [int](../types/int.md), 'proto' => [int](../types/int.md), 'extra' => [string](../types/string.md), 'raw_data' => [string](../types/string.md), \];<a name="decryptedDataBlock"></a>
***
<br><br>[$decryptedMessage\_73](../constructors/decryptedMessage_73.md) = \['ttl' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [DecryptedMessageMedia](../types/DecryptedMessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'via_bot_name' => [string](../types/string.md), 'reply_to_random_id' => [long](../types/long.md), 'grouped_id' => [long](../types/long.md), \];<a name="decryptedMessage_73"></a>
@ -643,10 +640,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$help.passportConfigNotModified](../constructors/help.passportConfigNotModified.md) = \[\];<a name="help.passportConfigNotModified"></a>
***
<br><br>[$help.proxyDataEmpty](../constructors/help.proxyDataEmpty.md) = \['expires' => [int](../types/int.md), \];<a name="help.proxyDataEmpty"></a>
<br><br>[$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), \];<a name="help.promoData"></a>
***
<br><br>[$help.proxyDataPromo](../constructors/help.proxyDataPromo.md) = \['expires' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="help.proxyDataPromo"></a>
<br><br>[$help.promoDataEmpty](../constructors/help.promoDataEmpty.md) = \['expires' => [int](../types/int.md), \];<a name="help.promoDataEmpty"></a>
***
<br><br>[$help.recentMeUrls](../constructors/help.recentMeUrls.md) = \['urls' => \[[RecentMeUrl](../types/RecentMeUrl.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="help.recentMeUrls"></a>
@ -808,7 +805,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$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), \];<a name="inputMediaContact"></a>
***
<br><br>[$inputMediaDice](../constructors/inputMediaDice.md) = \[\];<a name="inputMediaDice"></a>
<br><br>[$inputMediaDice](../constructors/inputMediaDice.md) = \['emoticon' => [string](../types/string.md), \];<a name="inputMediaDice"></a>
***
<br><br>[$inputMediaDocument](../constructors/inputMediaDocument.md) = \['id' => [InputDocument](../types/InputDocument.md), 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaDocument"></a>
@ -841,7 +838,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md) = \['url' => [string](../types/string.md), 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaPhotoExternal"></a>
***
<br><br>[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'correct_answers' => \[[bytes](../types/bytes.md)\], \];<a name="inputMediaPoll"></a>
<br><br>[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'correct_answers' => \[[bytes](../types/bytes.md)\], 'solution' => [string](../types/string.md), 'solution_entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];<a name="inputMediaPoll"></a>
***
<br><br>[$inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) = \['nosound_video' => [Bool](../types/Bool.md), 'file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \];<a name="inputMediaUploadedDocument"></a>
@ -1069,7 +1066,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$inputStickerSetAnimatedEmoji](../constructors/inputStickerSetAnimatedEmoji.md) = \[\];<a name="inputStickerSetAnimatedEmoji"></a>
***
<br><br>[$inputStickerSetDice](../constructors/inputStickerSetDice.md) = \[\];<a name="inputStickerSetDice"></a>
<br><br>[$inputStickerSetDice](../constructors/inputStickerSetDice.md) = \['emoticon' => [string](../types/string.md), \];<a name="inputStickerSetDice"></a>
***
<br><br>[$inputStickerSetEmpty](../constructors/inputStickerSetEmpty.md) = \[\];<a name="inputStickerSetEmpty"></a>
@ -1342,7 +1339,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$messageEntityUrl](../constructors/messageEntityUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityUrl"></a>
***
<br><br>[$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), \];<a name="messageFwdHeader"></a>
<br><br>[$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), \];<a name="messageFwdHeader"></a>
***
<br><br>[$messageInteractionCounters](../constructors/messageInteractionCounters.md) = \['msg_id' => [int](../types/int.md), 'views' => [int](../types/int.md), 'forwards' => [int](../types/int.md), \];<a name="messageInteractionCounters"></a>
@ -1351,7 +1348,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$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), \];<a name="messageMediaContact"></a>
***
<br><br>[$messageMediaDice](../constructors/messageMediaDice.md) = \['value' => [int](../types/int.md), \];<a name="messageMediaDice"></a>
<br><br>[$messageMediaDice](../constructors/messageMediaDice.md) = \['value' => [int](../types/int.md), 'emoticon' => [string](../types/string.md), \];<a name="messageMediaDice"></a>
***
<br><br>[$messageMediaDocument](../constructors/messageMediaDocument.md) = \['document' => [Document](../types/Document.md), 'ttl_seconds' => [int](../types/int.md), \];<a name="messageMediaDocument"></a>
@ -1456,10 +1453,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$messages.favedStickersNotModified](../constructors/messages.favedStickersNotModified.md) = \[\];<a name="messages.favedStickersNotModified"></a>
***
<br><br>[$messages.featuredStickers](../constructors/messages.featuredStickers.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], 'unread' => \[[long](../types/long.md)\], \];<a name="messages.featuredStickers"></a>
<br><br>[$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)\], \];<a name="messages.featuredStickers"></a>
***
<br><br>[$messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) = \[\];<a name="messages.featuredStickersNotModified"></a>
<br><br>[$messages.featuredStickersNotModified](../constructors/messages.featuredStickersNotModified.md) = \['count' => [int](../types/int.md), \];<a name="messages.featuredStickersNotModified"></a>
***
<br><br>[$messages.foundGifs](../constructors/messages.foundGifs.md) = \['next_offset' => [int](../types/int.md), 'results' => \[[FoundGif](../types/FoundGif.md)\], \];<a name="messages.foundGifs"></a>
@ -1786,7 +1783,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$photos.photosSlice](../constructors/photos.photosSlice.md) = \['count' => [int](../types/int.md), 'photos' => \[[Photo](../types/Photo.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="photos.photosSlice"></a>
***
<br><br>[$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)\], \];<a name="poll"></a>
<br><br>[$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), \];<a name="poll"></a>
***
<br><br>[$pollAnswer](../constructors/pollAnswer.md) = \['text' => [string](../types/string.md), 'option' => [bytes](../types/bytes.md), \];<a name="pollAnswer"></a>
@ -1795,7 +1792,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
<br><br>[$pollAnswerVoters](../constructors/pollAnswerVoters.md) = \['chosen' => [Bool](../types/Bool.md), 'correct' => [Bool](../types/Bool.md), 'option' => [bytes](../types/bytes.md), 'voters' => [int](../types/int.md), \];<a name="pollAnswerVoters"></a>
***
<br><br>[$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)\], \];<a name="pollResults"></a>
<br><br>[$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)\], \];<a name="pollResults"></a>
***
<br><br>[$popularContact](../constructors/popularContact.md) = \['client_id' => [long](../types/long.md), 'importers' => [int](../types/int.md), \];<a name="popularContact"></a>
@ -2037,9 +2034,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$shippingOption](../constructors/shippingOption.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'prices' => \[[LabeledPrice](../types/LabeledPrice.md)\], \];<a name="shippingOption"></a>
***
<br><br>[$simpleDataBlock](../constructors/simpleDataBlock.md) = \['raw_data' => [string](../types/string.md), \];<a name="simpleDataBlock"></a>
***
<br><br>[$stats.broadcastStats](../constructors/stats.broadcastStats.md) = \['period' => [StatsDateRangeDays](../types/StatsDateRangeDays.md), 'followers' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'views_per_post' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'shares_per_post' => [StatsAbsValueAndPrev](../types/StatsAbsValueAndPrev.md), 'enabled_notifications' => [StatsPercentValue](../types/StatsPercentValue.md), 'growth_graph' => [StatsGraph](../types/StatsGraph.md), 'followers_graph' => [StatsGraph](../types/StatsGraph.md), 'mute_graph' => [StatsGraph](../types/StatsGraph.md), 'top_hours_graph' => [StatsGraph](../types/StatsGraph.md), 'interactions_graph' => [StatsGraph](../types/StatsGraph.md), 'iv_interactions_graph' => [StatsGraph](../types/StatsGraph.md), 'views_by_source_graph' => [StatsGraph](../types/StatsGraph.md), 'new_followers_by_source_graph' => [StatsGraph](../types/StatsGraph.md), 'languages_graph' => [StatsGraph](../types/StatsGraph.md), 'recent_message_interactions' => \[[MessageInteractionCounters](../types/MessageInteractionCounters.md)\], \];<a name="stats.broadcastStats"></a>
@ -2568,3 +2562,4 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$webPagePending](../constructors/webPagePending.md) = \['id' => [long](../types/long.md), 'date' => [int](../types/int.md), \];<a name="webPagePending"></a>

2
docs/API_docs/constructors/inputBotInlineMessageMediaAuto.md
View File

@ -15,7 +15,7 @@ A media
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[string](../types/string.md) | Yes|Caption|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|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|

2
docs/API_docs/constructors/inputBotInlineMessageText.md
View File

@ -16,7 +16,7 @@ Simple text message
|----------|---------------|----------|-------------|
|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|Entities|
|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|

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

@ -1,6 +1,6 @@
---
title: inputDialogPeerFolder
description: All peers in a folder
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
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
All peers in a folder
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|Folder ID|
|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

2
docs/API_docs/constructors/inputFolderPeer.md
View File

@ -15,7 +15,7 @@ Peer in a folder
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer|
|folder\_id|[int](../types/int.md) | Yes|Folder ID|
|folder\_id|[int](../types/int.md) | Yes|[Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders)|

4
docs/API_docs/constructors/inputGameID.md
View File

@ -14,8 +14,8 @@ Indicates an already sent game
| 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|
|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|

13
docs/API_docs/constructors/inputMediaDice.md
View File

@ -1,6 +1,6 @@
---
title: inputMediaDice
description: inputMediaDice attributes, type and example
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
@ -8,6 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
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|
@ -17,14 +24,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
### Example:
```php
$inputMediaDice = ['_' => 'inputMediaDice'];
$inputMediaDice = ['_' => 'inputMediaDice', 'emoticon' => 'string'];
```
Or, if you're into Lua:
```lua
inputMediaDice={_='inputMediaDice'}
inputMediaDice={_='inputMediaDice', emoticon='string'}
```

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

@ -15,7 +15,9 @@ A poll
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|poll|[Poll](../types/Poll.md) | Yes|The poll to send|
|correct\_answers|Array of [bytes](../types/bytes.md) | Optional||
|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)|
@ -25,14 +27,14 @@ A poll
### Example:
```php
$inputMediaPoll = ['_' => 'inputMediaPoll', 'poll' => Poll, 'correct_answers' => ['bytes', 'bytes']];
$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'}}
inputMediaPoll={_='inputMediaPoll', poll=Poll, correct_answers={'bytes'}, solution='string', solution_entities={MessageEntity}}
```

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

@ -18,8 +18,8 @@ New document
|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|
|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Stickers|
|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|

2
docs/API_docs/constructors/inputMediaUploadedPhoto.md
View File

@ -15,7 +15,7 @@ Photo
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|file|[File path or InputFile](../types/InputFile.md) | Yes|The [uploaded file](https://core.telegram.org/api/files)|
|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Stickers|
|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|

4
docs/API_docs/constructors/inputPhotoLegacyFileLocation.md
View File

@ -1,6 +1,6 @@
---
title: inputPhotoLegacyFileLocation
description: Legacy file location
description: Legacy photo file location
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: inputPhotoLegacyFileLocation
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Legacy file location
Legacy photo file location
### Attributes:

2
docs/API_docs/constructors/inputPrivacyValueAllowChatParticipants.md
View File

@ -14,7 +14,7 @@ Allow only participants of certain chats
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|chats|Array of [int](../types/int.md) | Yes|Chats|
|chats|Array of [int](../types/int.md) | Yes|Allowed chat IDs|

2
docs/API_docs/constructors/inputPrivacyValueAllowUsers.md
View File

@ -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|

2
docs/API_docs/constructors/inputPrivacyValueDisallowChatParticipants.md
View File

@ -14,7 +14,7 @@ Disallow only participants of certain chats
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|chats|Array of [int](../types/int.md) | Yes|CHats|
|chats|Array of [int](../types/int.md) | Yes|Disallowed chat IDs|

2
docs/API_docs/constructors/inputPrivacyValueDisallowUsers.md
View File

@ -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|

4
docs/API_docs/constructors/inputSecureValue.md
View File

@ -19,8 +19,8 @@ Secure value, [for more info see the passport docs »](https://core.telegram.org
|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|Translation|
|files|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional|Files|
|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|

2
docs/API_docs/constructors/inputSingleMedia.md
View File

@ -16,7 +16,7 @@ A single media in an album sent with [messages.sendMultiMedia](../methods/messag
|----------|---------------|----------|-------------|
|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|Entities|
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Message [entities](https://core.telegram.org/api/entities) for styled text|

13
docs/API_docs/constructors/inputStickerSetDice.md
View File

@ -1,6 +1,6 @@
---
title: inputStickerSetDice
description: inputStickerSetDice attributes, type and example
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
@ -8,6 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
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|
@ -17,14 +24,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
### Example:
```php
$inputStickerSetDice = ['_' => 'inputStickerSetDice'];
$inputStickerSetDice = ['_' => 'inputStickerSetDice', 'emoticon' => 'string'];
```
Or, if you're into Lua:
```lua
inputStickerSetDice={_='inputStickerSetDice'}
inputStickerSetDice={_='inputStickerSetDice', emoticon='string'}
```

20
docs/API_docs/constructors/inputThemeSettings.md
View File

@ -1,6 +1,6 @@
---
title: inputThemeSettings
description: inputThemeSettings attributes, type and example
description: Theme settings
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: inputThemeSettings
@ -8,16 +8,18 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Theme settings
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes|
|accent\_color|[int](../types/int.md) | Yes|
|message\_top\_color|[int](../types/int.md) | Optional|
|message\_bottom\_color|[int](../types/int.md) | Optional|
|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Optional|
|wallpaper\_settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|
| 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|

4
docs/API_docs/constructors/inputWallPaperNoFile.md
View File

@ -1,6 +1,6 @@
---
title: inputWallPaperNoFile
description: inputWallPaperNoFile attributes, type and example
description: Wallpaper with no file
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: inputWallPaperNoFile
@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Wallpaper with no file

2
docs/API_docs/constructors/inputWebDocument.md
View File

@ -17,7 +17,7 @@ The document
|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|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes for media types|

2
docs/API_docs/constructors/invoice.md
View File

@ -23,7 +23,7 @@ Invoice
|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|Prices|
|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.)|

2
docs/API_docs/constructors/jsonArray.md
View File

@ -14,7 +14,7 @@ JSON array
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|value|Array of [JSONValue](../types/JSONValue.md) | Yes|Value|
|value|Array of [JSONValue](../types/JSONValue.md) | Yes|JSON values|

4
docs/API_docs/constructors/jsonNull.md
View File

@ -1,6 +1,6 @@
---
title: jsonNull
description: Null JSON value
description: null JSON value
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: jsonNull
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
Null JSON value
null JSON value

2
docs/API_docs/constructors/jsonObject.md
View File

@ -14,7 +14,7 @@ JSON object value
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|value|Array of [JSONObjectValue](../types/JSONObjectValue.md) | Yes|Value|
|value|Array of [JSONObjectValue](../types/JSONObjectValue.md) | Yes|Values|

12
docs/API_docs/constructors/keyboardButtonRequestPoll.md
View File

@ -1,6 +1,6 @@
---
title: keyboardButtonRequestPoll
description: keyboardButtonRequestPoll attributes, type and example
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
@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
A button that allows the user to create and send a poll when pressed; available only in private
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|quiz|[Bool](../types/Bool.md) | Optional|
|text|[string](../types/string.md) | Yes|
| 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|

2
docs/API_docs/constructors/keyboardButtonRow.md
View File

@ -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|

2
docs/API_docs/constructors/langPackDifference.md
View File

@ -17,7 +17,7 @@ Changes to the app's localization pack
|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|Strings|
|strings|Array of [LangPackString](../types/LangPackString.md) | Yes|Localized strings|

16
docs/API_docs/constructors/maskCoords.md
View File

@ -4,10 +4,10 @@ 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
- 0 =&gt; Relative to the forehead
- 1 =&gt; Relative to the eyes
- 2 =&gt; Relative to the mouth
- 3 =&gt; Relative to the chin
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: maskCoords
@ -19,10 +19,10 @@ 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
- 0 =&gt; Relative to the forehead
- 1 =&gt; Relative to the eyes
- 2 =&gt; Relative to the mouth
- 3 =&gt; Relative to the chin
### Attributes:

4
docs/API_docs/constructors/message.md
View File

@ -32,12 +32,12 @@ A 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|Restriction reason|
|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Contains the reason why access to this message must be restricted.|

2
docs/API_docs/constructors/messageActionChatAddUser.md
View File

@ -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|

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