mirror of
https://github.com/danog/MadelineProtoDocs.git
synced 2024-11-26 12:25:08 +01:00
Bump
This commit is contained in:
commit
5b40777530
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
_site
|
||||
.jekyll-cache
|
31
.woodpecker.yml
Normal file
31
.woodpecker.yml
Normal file
@ -0,0 +1,31 @@
|
||||
steps:
|
||||
build:
|
||||
image: danog/gojekyll
|
||||
when:
|
||||
branch: master
|
||||
event: push
|
||||
secrets:
|
||||
- DEPLOY_KEY
|
||||
commands:
|
||||
- apt-get update && apt-get -y install openssh-client git
|
||||
- mkdir -p $HOME/.ssh
|
||||
- ssh-keyscan -t rsa github.com >> $HOME/.ssh/known_hosts
|
||||
- echo "$DEPLOY_KEY" > $HOME/.ssh/id_rsa
|
||||
- chmod 0600 $HOME/.ssh/id_rsa
|
||||
- git config --global user.email "daniil@daniil.it"
|
||||
- git config --global user.name "Daniil Gentili"
|
||||
- git remote add o git@github.com:danog/MadelineProtoDocs.git
|
||||
- git fetch o gh-pages
|
||||
- cd docs
|
||||
- gojekyll clean
|
||||
- gojekyll build
|
||||
- rm -rf /tmp/_site
|
||||
- cp -a _site /tmp/
|
||||
- cd ..
|
||||
- git fetch o gh-pages
|
||||
- git checkout gh-pages
|
||||
- rm -rf *
|
||||
- cp -a /tmp/_site/* .
|
||||
- git add -A
|
||||
- git commit -am 'Update'
|
||||
- git push o gh-pages
|
9
docs/.well-known/amphtml/apikey.pub
Normal file
9
docs/.well-known/amphtml/apikey.pub
Normal file
@ -0,0 +1,9 @@
|
||||
-----BEGIN PUBLIC KEY-----
|
||||
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwGcqZ+kZ2QFmGLlQTrZQ
|
||||
vkJscTcn0RS09H62yhrwhnbHzQ0LSgJxSiPBdZB/prGPV6FgsMvcqXi4jfqHVef6
|
||||
tat/x8X7zEdYEBfrI05B/TmGN0QQkoN5OQ0hsEjWUzkv5R0GaYB6RtpQ5RcZiHll
|
||||
bDZCn0Dyir0PttyKooXHDIQWMOXz4HkzboJk0FaqgddKHX/CE1VUZdOZPDCG7O7A
|
||||
+HJIEXkVCua5YepDQs19r8RPifgfVOKxhFe0RP/e2jZw816gMQFlI7+jNAJG7IFH
|
||||
vE3UrvTmyR3gQPugzDipxLdgRjm3rCKcHFWO51jjTMpxwnUitPjBPX93aRzqJ0kV
|
||||
oQIDAQAB
|
||||
-----END PUBLIC KEY-----
|
34
docs/API_docs/constructors/account.authorizationForm.md
Normal file
34
docs/API_docs/constructors/account.authorizationForm.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "account.authorizationForm"
|
||||
description: "Telegram Passport authorization form"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
[Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|required\_types|Array of [SecureRequiredType](/API_docs/types/SecureRequiredType.html) | Yes|Required [Telegram Passport](https://core.telegram.org/passport) documents|
|
||||
|values|Array of [SecureValue](/API_docs/types/SecureValue.html) | Yes|Already submitted [Telegram Passport](https://core.telegram.org/passport) documents|
|
||||
|errors|Array of [SecureValueError](/API_docs/types/SecureValueError.html) | Yes|[Telegram Passport](https://core.telegram.org/passport) errors|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Info about the bot to which the form will be submitted|
|
||||
|privacy\_policy\_url|[string](/API_docs/types/string.html) | Optional|URL of the service's privacy policy|
|
||||
|
||||
|
||||
|
||||
### Type: [account.AuthorizationForm](/API_docs/types/account.AuthorizationForm.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string'];
|
||||
```
|
31
docs/API_docs/constructors/account.authorizations.md
Normal file
31
docs/API_docs/constructors/account.authorizations.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.authorizations"
|
||||
description: "Logged-in sessions"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_authorizations.html
|
||||
---
|
||||
# Constructor: account.authorizations
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Logged-in sessions
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorization\_ttl\_days|[int](/API_docs/types/int.html) | Yes|Time-to-live of session|
|
||||
|authorizations|Array of [Authorization](/API_docs/types/Authorization.html) | Yes|Logged-in sessions|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Authorizations](/API_docs/types/account.Authorizations.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_authorizations = ['_' => 'account.authorizations', 'authorization_ttl_days' => int, 'authorizations' => [Authorization, Authorization]];
|
||||
```
|
32
docs/API_docs/constructors/account.autoDownloadSettings.md
Normal file
32
docs/API_docs/constructors/account.autoDownloadSettings.md
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "account.autoDownloadSettings"
|
||||
description: "Media autodownload settings"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Media autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|low|[AutoDownloadSettings](/API_docs/types/AutoDownloadSettings.html) | Yes|Low data usage preset|
|
||||
|medium|[AutoDownloadSettings](/API_docs/types/AutoDownloadSettings.html) | Yes|Medium data usage preset|
|
||||
|high|[AutoDownloadSettings](/API_docs/types/AutoDownloadSettings.html) | Yes|High data usage preset|
|
||||
|
||||
|
||||
|
||||
### Type: [account.AutoDownloadSettings](/API_docs/types/account.AutoDownloadSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings];
|
||||
```
|
35
docs/API_docs/constructors/account.autoSaveSettings.md
Normal file
35
docs/API_docs/constructors/account.autoSaveSettings.md
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "account.autoSaveSettings"
|
||||
description: "Contains media autosave settings"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_autoSaveSettings.html
|
||||
---
|
||||
# Constructor: account.autoSaveSettings
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Contains media autosave settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|users\_settings|[AutoSaveSettings](/API_docs/types/AutoSaveSettings.html) | Yes|Default media autosave settings for private chats|
|
||||
|chats\_settings|[AutoSaveSettings](/API_docs/types/AutoSaveSettings.html) | Yes|Default media autosave settings for [groups and supergroups](https://core.telegram.org/api/channel)|
|
||||
|broadcasts\_settings|[AutoSaveSettings](/API_docs/types/AutoSaveSettings.html) | Yes|Default media autosave settings for [channels](https://core.telegram.org/api/channel)|
|
||||
|exceptions|Array of [AutoSaveException](/API_docs/types/AutoSaveException.html) | Yes|Peer-specific granular autosave settings|
|
||||
|chats|Array of [Chat](/API_docs/types/Chat.html) | Yes|Chats mentioned in the peer-specific granular autosave settings|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Users mentioned in the peer-specific granular autosave settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account.AutoSaveSettings](/API_docs/types/account.AutoSaveSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_autoSaveSettings = ['_' => 'account.autoSaveSettings', 'users_settings' => AutoSaveSettings, 'chats_settings' => AutoSaveSettings, 'broadcasts_settings' => AutoSaveSettings, 'exceptions' => [AutoSaveException, AutoSaveException], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
30
docs/API_docs/constructors/account.businessChatLinks.md
Normal file
30
docs/API_docs/constructors/account.businessChatLinks.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.businessChatLinks"
|
||||
description: "account.businessChatLinks attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_businessChatLinks.html
|
||||
---
|
||||
# Constructor: account.businessChatLinks
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|links|Array of [BusinessChatLink](/API_docs/types/BusinessChatLink.html) | Yes|
|
||||
|chats|Array of [Chat](/API_docs/types/Chat.html) | Yes|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|
|
||||
|
||||
|
||||
|
||||
### Type: [account.BusinessChatLinks](/API_docs/types/account.BusinessChatLinks.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_businessChatLinks = ['_' => 'account.businessChatLinks', 'links' => [BusinessChatLink, BusinessChatLink], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
29
docs/API_docs/constructors/account.connectedBots.md
Normal file
29
docs/API_docs/constructors/account.connectedBots.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "account.connectedBots"
|
||||
description: "account.connectedBots attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_connectedBots.html
|
||||
---
|
||||
# Constructor: account.connectedBots
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|connected\_bots|Array of [ConnectedBot](/API_docs/types/ConnectedBot.html) | Yes|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|
|
||||
|
||||
|
||||
|
||||
### Type: [account.ConnectedBots](/API_docs/types/account.ConnectedBots.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_connectedBots = ['_' => 'account.connectedBots', 'connected_bots' => [ConnectedBot, ConnectedBot], 'users' => [User, User]];
|
||||
```
|
31
docs/API_docs/constructors/account.contentSettings.md
Normal file
31
docs/API_docs/constructors/account.contentSettings.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.contentSettings"
|
||||
description: "Sensitive content settings"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Sensitive content settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|sensitive\_enabled|[Bool](/API_docs/types/Bool.html) | Optional|Whether viewing of sensitive (NSFW) content is enabled|
|
||||
|sensitive\_can\_change|[Bool](/API_docs/types/Bool.html) | Optional|Whether the current client can change the sensitive content settings to view NSFW content|
|
||||
|
||||
|
||||
|
||||
### Type: [account.ContentSettings](/API_docs/types/account.ContentSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_contentSettings = ['_' => 'account.contentSettings', 'sensitive_enabled' => Bool, 'sensitive_can_change' => Bool];
|
||||
```
|
30
docs/API_docs/constructors/account.emailVerified.md
Normal file
30
docs/API_docs/constructors/account.emailVerified.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.emailVerified"
|
||||
description: "The email was verified correctly."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_emailVerified.html
|
||||
---
|
||||
# Constructor: account.emailVerified
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The email was verified correctly.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email|[string](/API_docs/types/string.html) | Yes|The verified email address.|
|
||||
|
||||
|
||||
|
||||
### Type: [account.EmailVerified](/API_docs/types/account.EmailVerified.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_emailVerified = ['_' => 'account.emailVerified', 'email' => 'string'];
|
||||
```
|
31
docs/API_docs/constructors/account.emailVerifiedLogin.md
Normal file
31
docs/API_docs/constructors/account.emailVerifiedLogin.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.emailVerifiedLogin"
|
||||
description: "The email was verified correctly, and a login code was just sent to it."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_emailVerifiedLogin.html
|
||||
---
|
||||
# Constructor: account.emailVerifiedLogin
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The email was verified correctly, and a login code was just sent to it.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email|[string](/API_docs/types/string.html) | Yes|The verified email address.|
|
||||
|sent\_code|[auth.SentCode](/API_docs/constructors/auth.SentCode.html) | Yes|Info about the sent [login code](https://core.telegram.org/api/auth)|
|
||||
|
||||
|
||||
|
||||
### Type: [account.EmailVerified](/API_docs/types/account.EmailVerified.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_emailVerifiedLogin = ['_' => 'account.emailVerifiedLogin', 'email' => 'string', 'sent_code' => auth.SentCode];
|
||||
```
|
31
docs/API_docs/constructors/account.emojiStatuses.md
Normal file
31
docs/API_docs/constructors/account.emojiStatuses.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.emojiStatuses"
|
||||
description: "A list of emoji statuses"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_emojiStatuses.html
|
||||
---
|
||||
# Constructor: account.emojiStatuses
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
A list of [emoji statuses](https://core.telegram.org/api/emoji-status)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|statuses|Array of [EmojiStatus](/API_docs/types/EmojiStatus.html) | Yes|[Emoji statuses](https://core.telegram.org/api/emoji-status)|
|
||||
|
||||
|
||||
|
||||
### Type: [account.EmojiStatuses](/API_docs/types/account.EmojiStatuses.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_emojiStatuses = ['_' => 'account.emojiStatuses', 'hash' => long, 'statuses' => [EmojiStatus, EmojiStatus]];
|
||||
```
|
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.emojiStatusesNotModified"
|
||||
description: "The server-side list of emoji statuses hasn't changed"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_emojiStatusesNotModified.html
|
||||
---
|
||||
# Constructor: account.emojiStatusesNotModified
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The server-side list of [emoji statuses](https://core.telegram.org/api/emoji-status) hasn't changed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.EmojiStatuses](/API_docs/types/account.EmojiStatuses.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_emojiStatusesNotModified = ['_' => 'account.emojiStatusesNotModified'];
|
||||
```
|
42
docs/API_docs/constructors/account.password.md
Normal file
42
docs/API_docs/constructors/account.password.md
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
title: "account.password"
|
||||
description: "Configuration for two-factor authorization"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_password.html
|
||||
---
|
||||
# Constructor: account.password
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Configuration for two-factor authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|has\_recovery|[Bool](/API_docs/types/Bool.html) | Optional|Whether the user has a recovery method configured|
|
||||
|has\_secure\_values|[Bool](/API_docs/types/Bool.html) | Optional|Whether telegram [passport](https://core.telegram.org/passport) is enabled|
|
||||
|has\_password|[Bool](/API_docs/types/Bool.html) | Optional|Whether the user has a password|
|
||||
|current\_algo|[PasswordKdfAlgo](/API_docs/types/PasswordKdfAlgo.html) | Optional|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) of the current password|
|
||||
|srp\_B|[bytes](/API_docs/types/bytes.html) | Optional|Srp B param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|srp\_id|[long](/API_docs/types/long.html) | Optional|Srp ID param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](/API_docs/types/string.html) | Optional|Text hint for the password|
|
||||
|email\_unconfirmed\_pattern|[string](/API_docs/types/string.html) | 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](/API_docs/types/PasswordKdfAlgo.html) | 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](/API_docs/types/SecurePasswordKdfAlgo.html) | Yes|The KDF algorithm for telegram [passport](https://core.telegram.org/passport)|
|
||||
|secure\_random|[bytes](/API_docs/types/bytes.html) | Yes|Secure random string|
|
||||
|pending\_reset\_date|[int](/API_docs/types/int.html) | Optional|The 2FA password will be automatically removed at this date, unless the user cancels the operation|
|
||||
|login\_email\_pattern|[string](/API_docs/types/string.html) | Optional|A verified login email with the specified [pattern](https://core.telegram.org/api/pattern) is configured|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Password](/API_docs/types/account.Password.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$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', 'pending_reset_date' => int, 'login_email_pattern' => 'string'];
|
||||
```
|
34
docs/API_docs/constructors/account.passwordInputSettings.md
Normal file
34
docs/API_docs/constructors/account.passwordInputSettings.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "account.passwordInputSettings"
|
||||
description: "Settings for setting up a new password"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_passwordInputSettings.html
|
||||
---
|
||||
# Constructor: account.passwordInputSettings
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Settings for setting up a new password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_algo|[PasswordKdfAlgo](/API_docs/types/PasswordKdfAlgo.html) | Optional|The [SRP algorithm](https://core.telegram.org/api/srp) to use|
|
||||
|new\_password\_hash|[bytes](/API_docs/types/bytes.html) | Optional|The [computed password hash](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](/API_docs/types/string.html) | Optional|Text hint for the password|
|
||||
|email|[string](/API_docs/types/string.html) | Optional|Password recovery email|
|
||||
|new\_secure\_settings|[SecureSecretSettings](/API_docs/types/SecureSecretSettings.html) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PasswordInputSettings](/API_docs/types/account.PasswordInputSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings];
|
||||
```
|
31
docs/API_docs/constructors/account.passwordSettings.md
Normal file
31
docs/API_docs/constructors/account.passwordSettings.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.passwordSettings"
|
||||
description: "Private info associated to the password info (recovery email, telegram passport info & so on)"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_passwordSettings.html
|
||||
---
|
||||
# Constructor: account.passwordSettings
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
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](/API_docs/types/string.html) | Optional|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)|
|
||||
|secure\_settings|[SecureSecretSettings](/API_docs/types/SecureSecretSettings.html) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PasswordSettings](/API_docs/types/account.PasswordSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings];
|
||||
```
|
32
docs/API_docs/constructors/account.privacyRules.md
Normal file
32
docs/API_docs/constructors/account.privacyRules.md
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "account.privacyRules"
|
||||
description: "Privacy rules"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_privacyRules.html
|
||||
---
|
||||
# Constructor: account.privacyRules
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Privacy rules
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|rules|Array of [PrivacyRule](/API_docs/types/PrivacyRule.html) | Yes|Privacy rules|
|
||||
|chats|Array of [Chat](/API_docs/types/Chat.html) | Yes|Chats to which the rules apply|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Users to which the rules apply|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PrivacyRules](/API_docs/types/account.PrivacyRules.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.resetPasswordFailedWait"
|
||||
description: "You recently requested a password reset that was canceled, please wait until the specified date before requesting another reset."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_resetPasswordFailedWait.html
|
||||
---
|
||||
# Constructor: account.resetPasswordFailedWait
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
You recently requested a password reset that was canceled, please wait until the specified date before requesting another reset.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|retry\_date|[int](/API_docs/types/int.html) | Yes|Wait until this date before requesting another reset.|
|
||||
|
||||
|
||||
|
||||
### Type: [account.ResetPasswordResult](/API_docs/types/account.ResetPasswordResult.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_resetPasswordFailedWait = ['_' => 'account.resetPasswordFailedWait', 'retry_date' => int];
|
||||
```
|
25
docs/API_docs/constructors/account.resetPasswordOk.md
Normal file
25
docs/API_docs/constructors/account.resetPasswordOk.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.resetPasswordOk"
|
||||
description: "The 2FA password was reset successfully."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_resetPasswordOk.html
|
||||
---
|
||||
# Constructor: account.resetPasswordOk
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The 2FA password was reset successfully.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.ResetPasswordResult](/API_docs/types/account.ResetPasswordResult.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_resetPasswordOk = ['_' => 'account.resetPasswordOk'];
|
||||
```
|
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.resetPasswordRequestedWait"
|
||||
description: "You successfully requested a password reset, please wait until the specified date before finalizing the reset."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_resetPasswordRequestedWait.html
|
||||
---
|
||||
# Constructor: account.resetPasswordRequestedWait
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
You successfully requested a password reset, please wait until the specified date before finalizing the reset.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|until\_date|[int](/API_docs/types/int.html) | Yes|Wait until this date before finalizing the reset.|
|
||||
|
||||
|
||||
|
||||
### Type: [account.ResetPasswordResult](/API_docs/types/account.ResetPasswordResult.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_resetPasswordRequestedWait = ['_' => 'account.resetPasswordRequestedWait', 'until_date' => int];
|
||||
```
|
@ -0,0 +1,93 @@
|
||||
---
|
||||
title: "account.resolvedBusinessChatLinks"
|
||||
description: "account.resolvedBusinessChatLinks attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_resolvedBusinessChatLinks.html
|
||||
---
|
||||
# Constructor: account.resolvedBusinessChatLinks
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[long](/API_docs/types/long.html) | Yes|
|
||||
|message|[string](/API_docs/types/string.html) | Yes|
|
||||
|entities|Array of [MessageEntity](/API_docs/types/MessageEntity.html) | Optional|
|
||||
|parse\_mode| [string](/API_docs/types/string.html) | Whether to parse HTML or Markdown markup in the message| Optional |
|
||||
|chats|Array of [Chat](/API_docs/types/Chat.html) | Yes|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|
|
||||
|
||||
|
||||
|
||||
### Type: [account.ResolvedBusinessChatLinks](/API_docs/types/account.ResolvedBusinessChatLinks.html)
|
||||
|
||||
|
||||
|
||||
## Usage of parse_mode:
|
||||
|
||||
Set parse_mode to html to enable HTML parsing of the message.
|
||||
|
||||
Set parse_mode to Markdown to enable markdown parsing of the message.
|
||||
|
||||
The following tags are currently supported:
|
||||
|
||||
```html
|
||||
<br>a newline
|
||||
<b><i>bold works ok, internal tags are stripped</i> </b>
|
||||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
<a href="tg://user?id=186785362">Mention by user id</a>
|
||||
Custom emoji: <emoji id="5368324170671202286">👍</emoji>
|
||||
Custom emoji: <tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
|
||||
<pre language="json">Pre tags can have a language attribute</pre>
|
||||
<spoiler>Spoiler</spoiler>
|
||||
<tg-spoiler>Spoiler</tg-spoiler>
|
||||
```
|
||||
|
||||
You can also use normal markdown ([bot API MarkdownV2 syntax](https://core.telegram.org/bots/api#markdownv2-style)), note that to create mentions you can also use the `mention:` syntax like in html:
|
||||
|
||||
```markdown
|
||||
*bold \*text*
|
||||
_italic \*text_
|
||||
__underline__
|
||||
~strikethrough~
|
||||
||spoiler||
|
||||
*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
|
||||
[inline URL](http://www.example.com/)
|
||||
[inline mention of a user](tg://user?id=123456789)
|
||||
![👍](tg://emoji?id=5368324170671202286)
|
||||
\`inline fixed-width code\`
|
||||
\`\`\`
|
||||
pre-formatted fixed-width code block
|
||||
\`\`\`
|
||||
\`\`\`php
|
||||
pre-formatted fixed-width code block written in the PHP programming language
|
||||
\`\`\`
|
||||
|
||||
[Mention by username](mention:@danogentili)
|
||||
[Mention by user id](mention:186785362)
|
||||
[Mention by user id](tg://user?id=186785362)
|
||||
[👍](emoji:5368324170671202286)
|
||||
[👍](tg://emoji?id=5368324170671202286)
|
||||
```
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_resolvedBusinessChatLinks = ['_' => 'account.resolvedBusinessChatLinks', 'peer' => long, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]parse_mode: 'string', , 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
25
docs/API_docs/constructors/account.savedRingtone.md
Normal file
25
docs/API_docs/constructors/account.savedRingtone.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.savedRingtone"
|
||||
description: "The notification sound was already in MP3 format and was saved without any modification"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_savedRingtone.html
|
||||
---
|
||||
# Constructor: account.savedRingtone
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The notification sound was already in MP3 format and was saved without any modification
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.SavedRingtone](/API_docs/types/account.SavedRingtone.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_savedRingtone = ['_' => 'account.savedRingtone'];
|
||||
```
|
30
docs/API_docs/constructors/account.savedRingtoneConverted.md
Normal file
30
docs/API_docs/constructors/account.savedRingtoneConverted.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.savedRingtoneConverted"
|
||||
description: "The notification sound was not in MP3 format and was successfully converted and saved, use the returned Document to refer to the notification sound from now on"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_savedRingtoneConverted.html
|
||||
---
|
||||
# Constructor: account.savedRingtoneConverted
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The notification sound was not in MP3 format and was successfully converted and saved, use the returned [Document](../types/Document.html) to refer to the notification sound from now on
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|document|[Document](/API_docs/types/Document.html) | Optional|The converted notification sound|
|
||||
|
||||
|
||||
|
||||
### Type: [account.SavedRingtone](/API_docs/types/account.SavedRingtone.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_savedRingtoneConverted = ['_' => 'account.savedRingtoneConverted', 'document' => Document];
|
||||
```
|
31
docs/API_docs/constructors/account.savedRingtones.md
Normal file
31
docs/API_docs/constructors/account.savedRingtones.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.savedRingtones"
|
||||
description: "A list of saved notification sounds"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_savedRingtones.html
|
||||
---
|
||||
# Constructor: account.savedRingtones
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
A list of saved notification sounds
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|ringtones|Array of [Document](/API_docs/types/Document.html) | Yes|Saved notification sounds|
|
||||
|
||||
|
||||
|
||||
### Type: [account.SavedRingtones](/API_docs/types/account.SavedRingtones.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_savedRingtones = ['_' => 'account.savedRingtones', 'hash' => long, 'ringtones' => [Document, Document]];
|
||||
```
|
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.savedRingtonesNotModified"
|
||||
description: "The notification sound list hasn't changed."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/account_savedRingtonesNotModified.html
|
||||
---
|
||||
# Constructor: account.savedRingtonesNotModified
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The notification sound list hasn't changed.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.SavedRingtones](/API_docs/types/account.SavedRingtones.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_savedRingtonesNotModified = ['_' => 'account.savedRingtonesNotModified'];
|
||||
```
|
31
docs/API_docs/constructors/account.sentEmailCode.md
Normal file
31
docs/API_docs/constructors/account.sentEmailCode.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.sentEmailCode"
|
||||
description: "The sent email code"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The sent email code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](/API_docs/types/string.html) | Yes|The email (to which the code was sent) must match this [pattern](https://core.telegram.org/api/pattern)|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|The length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [account.SentEmailCode](/API_docs/types/account.SentEmailCode.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int];
|
||||
```
|
30
docs/API_docs/constructors/account.takeout.md
Normal file
30
docs/API_docs/constructors/account.takeout.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "account.takeout"
|
||||
description: "Takeout info"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Takeout info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](/API_docs/types/long.html) | Yes|Takeout ID|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Takeout](/API_docs/types/account.Takeout.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_takeout = ['_' => 'account.takeout', 'id' => long];
|
||||
```
|
31
docs/API_docs/constructors/account.themes.md
Normal file
31
docs/API_docs/constructors/account.themes.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.themes"
|
||||
description: "Installed themes"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Installed themes
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|themes|Array of [Theme](/API_docs/types/Theme.html) | Yes|Themes|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Themes](/API_docs/types/account.Themes.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_themes = ['_' => 'account.themes', 'hash' => long, 'themes' => [Theme, Theme]];
|
||||
```
|
25
docs/API_docs/constructors/account.themesNotModified.md
Normal file
25
docs/API_docs/constructors/account.themesNotModified.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.themesNotModified"
|
||||
description: "No new themes were installed"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
No new themes were installed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.Themes](/API_docs/types/account.Themes.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_themesNotModified = ['_' => 'account.themesNotModified'];
|
||||
```
|
31
docs/API_docs/constructors/account.tmpPassword.md
Normal file
31
docs/API_docs/constructors/account.tmpPassword.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.tmpPassword"
|
||||
description: "Temporary payment password"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Temporary payment password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_password|[bytes](/API_docs/types/bytes.html) | Yes|Temporary password|
|
||||
|valid\_until|[int](/API_docs/types/int.html) | Yes|Validity period|
|
||||
|
||||
|
||||
|
||||
### Type: [account.TmpPassword](/API_docs/types/account.TmpPassword.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int];
|
||||
```
|
31
docs/API_docs/constructors/account.wallPapers.md
Normal file
31
docs/API_docs/constructors/account.wallPapers.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.wallPapers"
|
||||
description: "Installed wallpapers"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Installed [wallpapers](https://core.telegram.org/api/wallpapers)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|wallpapers|Array of [WallPaper](/API_docs/types/WallPaper.html) | Yes|[Wallpapers](https://core.telegram.org/api/wallpapers)|
|
||||
|
||||
|
||||
|
||||
### Type: [account.WallPapers](/API_docs/types/account.WallPapers.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_wallPapers = ['_' => 'account.wallPapers', 'hash' => long, 'wallpapers' => [WallPaper, WallPaper]];
|
||||
```
|
25
docs/API_docs/constructors/account.wallPapersNotModified.md
Normal file
25
docs/API_docs/constructors/account.wallPapersNotModified.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "account.wallPapersNotModified"
|
||||
description: "No new wallpapers were found"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
No new [wallpapers](https://core.telegram.org/api/wallpapers) were found
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.WallPapers](/API_docs/types/account.WallPapers.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_wallPapersNotModified = ['_' => 'account.wallPapersNotModified'];
|
||||
```
|
31
docs/API_docs/constructors/account.webAuthorizations.md
Normal file
31
docs/API_docs/constructors/account.webAuthorizations.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "account.webAuthorizations"
|
||||
description: "Web authorizations"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Web authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [WebAuthorization](/API_docs/types/WebAuthorization.html) | Yes|Web authorization list|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account.WebAuthorizations](/API_docs/types/account.WebAuthorizations.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$account_webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]];
|
||||
```
|
29
docs/API_docs/constructors/accountDaysTTL.md
Normal file
29
docs/API_docs/constructors/accountDaysTTL.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "accountDaysTTL"
|
||||
description: "Time to live in days of the current account"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: accountDaysTTL
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Time to live in days of the current account
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|days|[int](/API_docs/types/int.html) | Yes|This account will self-destruct in the specified number of days|
|
||||
|
||||
|
||||
|
||||
### Type: [AccountDaysTTL](/API_docs/types/AccountDaysTTL.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$accountDaysTTL = ['_' => 'accountDaysTTL', 'days' => int];
|
||||
```
|
29
docs/API_docs/constructors/appWebViewResultUrl.md
Normal file
29
docs/API_docs/constructors/appWebViewResultUrl.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "appWebViewResultUrl"
|
||||
description: "Contains the link that must be used to open a direct link Mini App."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: appWebViewResultUrl
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Contains the link that must be used to open a [direct link Mini App](https://core.telegram.org/api/bots/webapps#direct-link-mini-apps).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|url|[string](/API_docs/types/string.html) | Yes|The URL to open|
|
||||
|
||||
|
||||
|
||||
### Type: [AppWebViewResult](/API_docs/types/AppWebViewResult.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$appWebViewResultUrl = ['_' => 'appWebViewResultUrl', 'url' => 'string'];
|
||||
```
|
40
docs/API_docs/constructors/attachMenuBot.md
Normal file
40
docs/API_docs/constructors/attachMenuBot.md
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "attachMenuBot"
|
||||
description: "Represents a bot mini app that can be launched from the attachment/side menu »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBot
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Represents a [bot mini app that can be launched from the attachment/side menu »](https://core.telegram.org/api/bots/attach)
|
||||
|
||||
At least one of the `show_in_attach_menu` or the `show_in_side_menu` flags will always be set.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|inactive|[Bool](/API_docs/types/Bool.html) | Optional|If set, before launching the mini app the client should ask the user to add the mini app to the attachment/side menu, and only if the user accepts, after invoking [messages.toggleBotInAttachMenu](../methods/messages.toggleBotInAttachMenu.html) the app should be opened.|
|
||||
|has\_settings|[Bool](/API_docs/types/Bool.html) | Optional|Deprecated flag, can be ignored.|
|
||||
|request\_write\_access|[Bool](/API_docs/types/Bool.html) | Optional|Whether the bot would like to send messages to the user.|
|
||||
|show\_in\_attach\_menu|[Bool](/API_docs/types/Bool.html) | Optional|Whether, when installed, an attachment menu entry should be shown for the Mini App.|
|
||||
|show\_in\_side\_menu|[Bool](/API_docs/types/Bool.html) | Optional|Whether, when installed, an entry in the main view side menu should be shown for the Mini App.|
|
||||
|side\_menu\_disclaimer\_needed|[Bool](/API_docs/types/Bool.html) | Optional|If `inactive` if set and the user hasn't previously accepted the third-party mini apps [Terms of Service](https://telegram.org/tos/mini-apps) for this bot, when showing the mini app installation prompt, an additional mandatory checkbox to accept the [mini apps TOS](https://telegram.org/tos/mini-apps) and a disclaimer indicating that this Mini App is not affiliated to Telegram should be shown.|
|
||||
|bot\_id|[long](/API_docs/types/long.html) | Yes|Bot ID|
|
||||
|short\_name|[string](/API_docs/types/string.html) | Yes|Attachment menu item name|
|
||||
|peer\_types|Array of [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html) | Optional|List of dialog types where this attachment menu entry should be shown|
|
||||
|icons|Array of [AttachMenuBotIcon](/API_docs/types/AttachMenuBotIcon.html) | Yes|List of platform-specific static icons and animations to use for the attachment menu button|
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBot](/API_docs/types/AttachMenuBot.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBot = ['_' => 'attachMenuBot', 'inactive' => Bool, 'has_settings' => Bool, 'request_write_access' => Bool, 'show_in_attach_menu' => Bool, 'show_in_side_menu' => Bool, 'side_menu_disclaimer_needed' => Bool, 'bot_id' => long, 'short_name' => 'string', 'peer_types' => [AttachMenuPeerType, AttachMenuPeerType], 'icons' => [AttachMenuBotIcon, AttachMenuBotIcon]];
|
||||
```
|
31
docs/API_docs/constructors/attachMenuBotIcon.md
Normal file
31
docs/API_docs/constructors/attachMenuBotIcon.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "attachMenuBotIcon"
|
||||
description: "Represents an attachment menu icon for bot mini apps »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBotIcon
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Represents an attachment menu icon for [bot mini apps »](https://core.telegram.org/api/bots/attach)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|name|[string](/API_docs/types/string.html) | Yes|One of the following values: note that animated icons must be played when the user clicks on the button, activating the bot mini app. <br><br>`default_static` \- Default attachment menu icon in SVG format <br>`placeholder_static` \- Default placeholder for opened Web Apps in SVG format <br>`ios_static` \- Attachment menu icon in SVG format for the official iOS app <br>`ios_animated` \- Animated attachment menu icon in TGS format for the official iOS app <br>`android_animated` \- Animated attachment menu icon in TGS format for the official Android app <br>`macos_animated` \- Animated attachment menu icon in TGS format for the official native Mac OS app <br>`ios_side_menu_static` \- Side menu icon in PNG format for the official iOS app <br>`android_side_menu_static` \- Side menu icon in SVG format for the official android app <br>`macos_side_menu_static` \- Side menu icon in PNG format for the official native Mac OS app|
|
||||
|icon|[Document](/API_docs/types/Document.html) | Optional|The actual icon file.|
|
||||
|colors|Array of [AttachMenuBotIconColor](/API_docs/types/AttachMenuBotIconColor.html) | Optional|Attachment menu icon colors.|
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBotIcon](/API_docs/types/AttachMenuBotIcon.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBotIcon = ['_' => 'attachMenuBotIcon', 'name' => 'string', 'icon' => Document, 'colors' => [AttachMenuBotIconColor, AttachMenuBotIconColor]];
|
||||
```
|
30
docs/API_docs/constructors/attachMenuBotIconColor.md
Normal file
30
docs/API_docs/constructors/attachMenuBotIconColor.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "attachMenuBotIconColor"
|
||||
description: "Represents an attachment menu icon color for bot mini apps »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBotIconColor
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Represents an attachment menu icon color for [bot mini apps »](https://core.telegram.org/api/bots/attach)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|name|[string](/API_docs/types/string.html) | Yes|One of the following values: <br>`light_icon` \- Color of the attachment menu icon (light mode) <br>`light_text` \- Color of the attachment menu label, once selected (light mode) <br>`dark_icon` \- Color of the attachment menu icon (dark mode) <br>`dark_text` \- Color of the attachment menu label, once selected (dark mode)|
|
||||
|color|[int](/API_docs/types/int.html) | Yes|Color in RGB24 format|
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBotIconColor](/API_docs/types/AttachMenuBotIconColor.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBotIconColor = ['_' => 'attachMenuBotIconColor', 'name' => 'string', 'color' => int];
|
||||
```
|
31
docs/API_docs/constructors/attachMenuBots.md
Normal file
31
docs/API_docs/constructors/attachMenuBots.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "attachMenuBots"
|
||||
description: "Represents a list of bot mini apps that can be launched from the attachment menu »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBots
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Represents a list of [bot mini apps that can be launched from the attachment menu »](https://core.telegram.org/api/bots/attach)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|bots|Array of [AttachMenuBot](/API_docs/types/AttachMenuBot.html) | Yes|List of [bot mini apps that can be launched from the attachment menu »](https://core.telegram.org/api/bots/attach)|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Info about related users/bots|
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBots](/API_docs/types/AttachMenuBots.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBots = ['_' => 'attachMenuBots', 'hash' => long, 'bots' => [AttachMenuBot, AttachMenuBot], 'users' => [User, User]];
|
||||
```
|
30
docs/API_docs/constructors/attachMenuBotsBot.md
Normal file
30
docs/API_docs/constructors/attachMenuBotsBot.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "attachMenuBotsBot"
|
||||
description: "Represents a bot mini app that can be launched from the attachment menu »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBotsBot
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Represents a [bot mini app that can be launched from the attachment menu »](https://core.telegram.org/api/bots/attach)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|bot|[AttachMenuBot](/API_docs/types/AttachMenuBot.html) | Yes|Represents a [bot mini app that can be launched from the attachment menu »](https://core.telegram.org/api/bots/attach)<br>|
|
||||
|users|Array of [User](/API_docs/types/User.html) | Yes|Info about related users and bots|
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBotsBot](/API_docs/types/AttachMenuBotsBot.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBotsBot = ['_' => 'attachMenuBotsBot', 'bot' => AttachMenuBot, 'users' => [User, User]];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuBotsNotModified.md
Normal file
24
docs/API_docs/constructors/attachMenuBotsNotModified.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuBotsNotModified"
|
||||
description: "The list of bot mini apps hasn't changed"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuBotsNotModified
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The list of bot mini apps hasn't changed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuBots](/API_docs/types/AttachMenuBots.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuBotsNotModified = ['_' => 'attachMenuBotsNotModified'];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuPeerTypeBotPM.md
Normal file
24
docs/API_docs/constructors/attachMenuPeerTypeBotPM.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuPeerTypeBotPM"
|
||||
description: "The bot attachment menu entry is available in private chats with other bots (excluding the bot that offers the current attachment menu)"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuPeerTypeBotPM
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The bot attachment menu entry is available in private chats with other bots (excluding the bot that offers the current attachment menu)
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuPeerTypeBotPM = ['_' => 'attachMenuPeerTypeBotPM'];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuPeerTypeBroadcast.md
Normal file
24
docs/API_docs/constructors/attachMenuPeerTypeBroadcast.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuPeerTypeBroadcast"
|
||||
description: "The bot attachment menu entry is available in channels"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuPeerTypeBroadcast
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The bot attachment menu entry is available in channels
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuPeerTypeBroadcast = ['_' => 'attachMenuPeerTypeBroadcast'];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuPeerTypeChat.md
Normal file
24
docs/API_docs/constructors/attachMenuPeerTypeChat.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuPeerTypeChat"
|
||||
description: "The bot attachment menu entry is available in groups and supergroups"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuPeerTypeChat
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The bot attachment menu entry is available in [groups and supergroups](https://core.telegram.org/api/channel)
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuPeerTypeChat = ['_' => 'attachMenuPeerTypeChat'];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuPeerTypePM.md
Normal file
24
docs/API_docs/constructors/attachMenuPeerTypePM.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuPeerTypePM"
|
||||
description: "The bot attachment menu entry is available in private chats with other users (not bots)"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuPeerTypePM
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The bot attachment menu entry is available in private chats with other users (not bots)
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuPeerTypePM = ['_' => 'attachMenuPeerTypePM'];
|
||||
```
|
24
docs/API_docs/constructors/attachMenuPeerTypeSameBotPM.md
Normal file
24
docs/API_docs/constructors/attachMenuPeerTypeSameBotPM.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "attachMenuPeerTypeSameBotPM"
|
||||
description: "The bot attachment menu entry is available in the chat with the bot that offers it"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: attachMenuPeerTypeSameBotPM
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The bot attachment menu entry is available in the chat with the bot that offers it
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [AttachMenuPeerType](/API_docs/types/AttachMenuPeerType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$attachMenuPeerTypeSameBotPM = ['_' => 'attachMenuPeerTypeSameBotPM'];
|
||||
```
|
34
docs/API_docs/constructors/auth.authorization.md
Normal file
34
docs/API_docs/constructors/auth.authorization.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "auth.authorization"
|
||||
description: "Contains user authorization info."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_authorization.html
|
||||
---
|
||||
# Constructor: auth.authorization
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Contains user authorization info.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|setup\_password\_required|[Bool](/API_docs/types/Bool.html) | Optional|Suggests the user to set up a 2-step verification password to be able to log in again|
|
||||
|otherwise\_relogin\_days|[int](/API_docs/types/int.html) | Optional|Iff setup\_password\_required is set and the user declines to set a 2-step verification password, they will be able to log into their account via SMS again only after this many days pass.|
|
||||
|tmp\_sessions|[int](/API_docs/types/int.html) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions|
|
||||
|future\_auth\_token|[bytes](/API_docs/types/bytes.html) | Optional|A [future auth token](https://core.telegram.org/api/auth#future-auth-tokens)|
|
||||
|user|[User](/API_docs/types/User.html) | Optional|Info on authorized user|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.Authorization](/API_docs/types/auth.Authorization.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_authorization = ['_' => 'auth.authorization', 'setup_password_required' => Bool, 'otherwise_relogin_days' => int, 'tmp_sessions' => int, 'future_auth_token' => 'bytes', 'user' => User];
|
||||
```
|
@ -0,0 +1,30 @@
|
||||
---
|
||||
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"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
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](/API_docs/constructors/help.TermsOfService.html) | Optional|Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.Authorization](/API_docs/types/auth.Authorization.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_authorizationSignUpRequired = ['_' => 'auth.authorizationSignUpRequired', 'terms_of_service' => help.TermsOfService];
|
||||
```
|
25
docs/API_docs/constructors/auth.codeTypeCall.md
Normal file
25
docs/API_docs/constructors/auth.codeTypeCall.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "auth.codeTypeCall"
|
||||
description: "The next time, the authentication code is to be delivered via an outgoing phone call."
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The next time, the authentication code is to be delivered via an outgoing phone call.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](/API_docs/types/auth.CodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_codeTypeCall = ['_' => 'auth.codeTypeCall'];
|
||||
```
|
25
docs/API_docs/constructors/auth.codeTypeFlashCall.md
Normal file
25
docs/API_docs/constructors/auth.codeTypeFlashCall.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "auth.codeTypeFlashCall"
|
||||
description: "The next time, the authentication code will be delivered via an immediately canceled incoming call."
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The next time, the authentication code will be delivered via an immediately canceled incoming call.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](/API_docs/types/auth.CodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall'];
|
||||
```
|
25
docs/API_docs/constructors/auth.codeTypeFragmentSms.md
Normal file
25
docs/API_docs/constructors/auth.codeTypeFragmentSms.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "auth.codeTypeFragmentSms"
|
||||
description: "The next time, the authentication code will be delivered via fragment.com"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_codeTypeFragmentSms.html
|
||||
---
|
||||
# Constructor: auth.codeTypeFragmentSms
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The next time, the authentication code will be delivered via [fragment.com](https://fragment.com)
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](/API_docs/types/auth.CodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_codeTypeFragmentSms = ['_' => 'auth.codeTypeFragmentSms'];
|
||||
```
|
25
docs/API_docs/constructors/auth.codeTypeMissedCall.md
Normal file
25
docs/API_docs/constructors/auth.codeTypeMissedCall.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "auth.codeTypeMissedCall"
|
||||
description: "The next time, the authentication code will be delivered via an immediately canceled incoming call, handled manually by the user."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_codeTypeMissedCall.html
|
||||
---
|
||||
# Constructor: auth.codeTypeMissedCall
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The next time, the authentication code will be delivered via an immediately canceled incoming call, handled manually by the user.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](/API_docs/types/auth.CodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_codeTypeMissedCall = ['_' => 'auth.codeTypeMissedCall'];
|
||||
```
|
25
docs/API_docs/constructors/auth.codeTypeSms.md
Normal file
25
docs/API_docs/constructors/auth.codeTypeSms.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "auth.codeTypeSms"
|
||||
description: "The next time, the authentication code will be delivered via an immediately canceled incoming call."
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The next time, the authentication code will be delivered via an immediately canceled incoming call.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](/API_docs/types/auth.CodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_codeTypeSms = ['_' => 'auth.codeTypeSms'];
|
||||
```
|
31
docs/API_docs/constructors/auth.exportedAuthorization.md
Normal file
31
docs/API_docs/constructors/auth.exportedAuthorization.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.exportedAuthorization"
|
||||
description: "Data for copying of authorization between data centers."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_exportedAuthorization.html
|
||||
---
|
||||
# Constructor: auth.exportedAuthorization
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Data for copying of authorization between data centers.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](/API_docs/types/long.html) | Yes|current user identifier|
|
||||
|bytes|[bytes](/API_docs/types/bytes.html) | Yes|authorizes key|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.ExportedAuthorization](/API_docs/types/auth.ExportedAuthorization.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => long, 'bytes' => 'bytes'];
|
||||
```
|
30
docs/API_docs/constructors/auth.loggedOut.md
Normal file
30
docs/API_docs/constructors/auth.loggedOut.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.loggedOut"
|
||||
description: "Future auth token » to be used on subsequent authorizations"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_loggedOut.html
|
||||
---
|
||||
# Constructor: auth.loggedOut
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
[Future auth token »](https://core.telegram.org/api/auth#future-auth-tokens) to be used on subsequent authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|future\_auth\_token|[bytes](/API_docs/types/bytes.html) | Optional|[Future auth token »](https://core.telegram.org/api/auth#future-auth-tokens) to be used on subsequent authorizations|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.LoggedOut](/API_docs/types/auth.LoggedOut.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_loggedOut = ['_' => 'auth.loggedOut', 'future_auth_token' => 'bytes'];
|
||||
```
|
31
docs/API_docs/constructors/auth.loginToken.md
Normal file
31
docs/API_docs/constructors/auth.loginToken.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.loginToken"
|
||||
description: "Login token (for QR code login)"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Login token (for [QR code login](https://core.telegram.org/api/qr-login))
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|expires|[int](/API_docs/types/int.html) | Yes|Expiration date of QR code|
|
||||
|token|[bytes](/API_docs/types/bytes.html) | Yes|Token to render in QR code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.LoginToken](/API_docs/types/auth.LoginToken.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_loginToken = ['_' => 'auth.loginToken', 'expires' => int, 'token' => 'bytes'];
|
||||
```
|
31
docs/API_docs/constructors/auth.loginTokenMigrateTo.md
Normal file
31
docs/API_docs/constructors/auth.loginTokenMigrateTo.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.loginTokenMigrateTo"
|
||||
description: "Repeat the query to the specified DC"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Repeat the query to the specified DC
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|dc\_id|[int](/API_docs/types/int.html) | Yes|DC ID|
|
||||
|token|[bytes](/API_docs/types/bytes.html) | Yes|Token to use for login|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.LoginToken](/API_docs/types/auth.LoginToken.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_loginTokenMigrateTo = ['_' => 'auth.loginTokenMigrateTo', 'dc_id' => int, 'token' => 'bytes'];
|
||||
```
|
30
docs/API_docs/constructors/auth.loginTokenSuccess.md
Normal file
30
docs/API_docs/constructors/auth.loginTokenSuccess.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.loginTokenSuccess"
|
||||
description: "Login via token (QR code) succeeded!"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Login via token (QR code) succeeded!
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorization|[auth.Authorization](/API_docs/constructors/auth.Authorization.html) | Yes|Authorization info|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.LoginToken](/API_docs/types/auth.LoginToken.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_loginTokenSuccess = ['_' => 'auth.loginTokenSuccess', 'authorization' => auth.Authorization];
|
||||
```
|
30
docs/API_docs/constructors/auth.passwordRecovery.md
Normal file
30
docs/API_docs/constructors/auth.passwordRecovery.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.passwordRecovery"
|
||||
description: "Recovery info of a 2FA password, only for accounts with a recovery email configured."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_passwordRecovery.html
|
||||
---
|
||||
# Constructor: auth.passwordRecovery
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Recovery info 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).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](/API_docs/types/string.html) | Yes|The email to which the recovery code was sent must match this [pattern](https://core.telegram.org/api/pattern).|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.PasswordRecovery](/API_docs/types/auth.PasswordRecovery.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string'];
|
||||
```
|
33
docs/API_docs/constructors/auth.sentCode.md
Normal file
33
docs/API_docs/constructors/auth.sentCode.md
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "auth.sentCode"
|
||||
description: "Contains info about a sent verification code."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCode.html
|
||||
---
|
||||
# Constructor: auth.sentCode
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Contains info about a sent verification code.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|type|[auth.SentCodeType](/API_docs/constructors/auth.SentCodeType.html) | Yes|Phone code type|
|
||||
|phone\_code\_hash|[string](/API_docs/types/string.html) | Yes|Phone code hash, to be stored and later re-used with [auth.signIn](../methods/auth.signIn.html)|
|
||||
|next\_type|[auth.CodeType](/API_docs/constructors/auth.CodeType.html) | 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.html)|
|
||||
|timeout|[int](/API_docs/types/int.html) | Optional|Timeout for reception of the phone code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCode](/API_docs/types/auth.SentCode.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCode = ['_' => 'auth.sentCode', 'type' => auth.SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth.CodeType, 'timeout' => int];
|
||||
```
|
30
docs/API_docs/constructors/auth.sentCodeSuccess.md
Normal file
30
docs/API_docs/constructors/auth.sentCodeSuccess.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.sentCodeSuccess"
|
||||
description: "The user successfully authorized using future auth tokens"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeSuccess.html
|
||||
---
|
||||
# Constructor: auth.sentCodeSuccess
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The user successfully authorized using [future auth tokens](https://core.telegram.org/api/auth#future-auth-tokens)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorization|[auth.Authorization](/API_docs/constructors/auth.Authorization.html) | Yes|Authorization info|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCode](/API_docs/types/auth.SentCode.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeSuccess = ['_' => 'auth.sentCodeSuccess', 'authorization' => auth.Authorization];
|
||||
```
|
30
docs/API_docs/constructors/auth.sentCodeTypeApp.md
Normal file
30
docs/API_docs/constructors/auth.sentCodeTypeApp.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeApp"
|
||||
description: "The code was sent through the telegram app"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The code was sent through the telegram app
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int];
|
||||
```
|
30
docs/API_docs/constructors/auth.sentCodeTypeCall.md
Normal file
30
docs/API_docs/constructors/auth.sentCodeTypeCall.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
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."
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
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](/API_docs/types/int.html) | Yes|Length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int];
|
||||
```
|
35
docs/API_docs/constructors/auth.sentCodeTypeEmailCode.md
Normal file
35
docs/API_docs/constructors/auth.sentCodeTypeEmailCode.md
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeEmailCode"
|
||||
description: "The code was sent via the previously configured login email »"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeEmailCode.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeEmailCode
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The code was sent via the [previously configured login email »](https://core.telegram.org/api/auth#email-verification)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|apple\_signin\_allowed|[Bool](/API_docs/types/Bool.html) | Optional|Whether authorization through Apple ID is allowed|
|
||||
|google\_signin\_allowed|[Bool](/API_docs/types/Bool.html) | Optional|Whether authorization through Google ID is allowed|
|
||||
|email\_pattern|[string](/API_docs/types/string.html) | Yes|[Pattern](https://core.telegram.org/api/pattern) of the email|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the sent verification code|
|
||||
|reset\_available\_period|[int](/API_docs/types/int.html) | Optional|Clients should wait for the specified amount of seconds before allowing the user to invoke [auth.resetLoginEmail](../methods/auth.resetLoginEmail.html) (will be 0 for [Premium](https://core.telegram.org/api/premium) users).|
|
||||
|reset\_pending\_date|[int](/API_docs/types/int.html) | Optional|An email reset was already requested, and will occur at the specified date.|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeEmailCode = ['_' => 'auth.sentCodeTypeEmailCode', 'apple_signin_allowed' => Bool, 'google_signin_allowed' => Bool, 'email_pattern' => 'string', 'length' => int, 'reset_available_period' => int, 'reset_pending_date' => int];
|
||||
```
|
33
docs/API_docs/constructors/auth.sentCodeTypeFirebaseSms.md
Normal file
33
docs/API_docs/constructors/auth.sentCodeTypeFirebaseSms.md
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeFirebaseSms"
|
||||
description: "An authentication code should be delivered via SMS after Firebase attestation, as described in the auth documentation »."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeFirebaseSms.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeFirebaseSms
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
An authentication code should be delivered via SMS after Firebase attestation, as described in the [auth documentation »](https://core.telegram.org/api/auth).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|nonce|[bytes](/API_docs/types/bytes.html) | Optional|On Android, the nonce to be used as described in the [auth documentation »](https://core.telegram.org/api/auth)|
|
||||
|receipt|[string](/API_docs/types/string.html) | Optional|On iOS, must be compared with the `receipt` extracted from the received push notification.|
|
||||
|push\_timeout|[int](/API_docs/types/int.html) | Optional|On iOS: if a push notification with the `ios_push_secret` isn't received within `push_timeout` seconds, the `next_type` authentication method must be used, with [auth.resendCode](../methods/auth.resendCode.html).|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the code that will be delivered.|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeFirebaseSms = ['_' => 'auth.sentCodeTypeFirebaseSms', 'nonce' => 'bytes', 'receipt' => 'string', 'push_timeout' => int, 'length' => int];
|
||||
```
|
30
docs/API_docs/constructors/auth.sentCodeTypeFlashCall.md
Normal file
30
docs/API_docs/constructors/auth.sentCodeTypeFlashCall.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
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."
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
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](/API_docs/types/string.html) | Yes|[pattern](https://core.telegram.org/api/pattern) to match|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string'];
|
||||
```
|
31
docs/API_docs/constructors/auth.sentCodeTypeFragmentSms.md
Normal file
31
docs/API_docs/constructors/auth.sentCodeTypeFragmentSms.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeFragmentSms"
|
||||
description: "The code was delivered via fragment.com."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeFragmentSms.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeFragmentSms
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The code was delivered via [fragment.com](https://fragment.com).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|url|[string](/API_docs/types/string.html) | Yes|Open the specified URL to log into [fragment.com](https://fragment.com) with the wallet that owns the specified phone number and view the code.|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the delivered code.|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeFragmentSms = ['_' => 'auth.sentCodeTypeFragmentSms', 'url' => 'string', 'length' => int];
|
||||
```
|
31
docs/API_docs/constructors/auth.sentCodeTypeMissedCall.md
Normal file
31
docs/API_docs/constructors/auth.sentCodeTypeMissedCall.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeMissedCall"
|
||||
description: "The code will be sent via a flash phone call, that will be closed immediately. The last digits of the phone number that calls are the code that must be entered manually by the user."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeMissedCall.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeMissedCall
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The code will be sent via a flash phone call, that will be closed immediately. The last digits of the phone number that calls are the code that must be entered manually by the user.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prefix|[string](/API_docs/types/string.html) | Yes|Prefix of the phone number from which the call will be made|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeMissedCall = ['_' => 'auth.sentCodeTypeMissedCall', 'prefix' => 'string', 'length' => int];
|
||||
```
|
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeSetUpEmailRequired"
|
||||
description: "The user should add and verify an email address in order to login as described here »."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeSetUpEmailRequired.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSetUpEmailRequired
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The user should add and verify an email address in order to login as described [here »](https://core.telegram.org/api/auth#email-verification).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|apple\_signin\_allowed|[Bool](/API_docs/types/Bool.html) | Optional|Whether authorization through Apple ID is allowed|
|
||||
|google\_signin\_allowed|[Bool](/API_docs/types/Bool.html) | Optional|Whether authorization through Google ID is allowed|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeSetUpEmailRequired = ['_' => 'auth.sentCodeTypeSetUpEmailRequired', 'apple_signin_allowed' => Bool, 'google_signin_allowed' => Bool];
|
||||
```
|
30
docs/API_docs/constructors/auth.sentCodeTypeSms.md
Normal file
30
docs/API_docs/constructors/auth.sentCodeTypeSms.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeSms"
|
||||
description: "The code was sent via SMS"
|
||||
nav_exclude: true
|
||||
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](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The code was sent via SMS
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](/API_docs/types/int.html) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int];
|
||||
```
|
28
docs/API_docs/constructors/auth.sentCodeTypeSmsPhrase.md
Normal file
28
docs/API_docs/constructors/auth.sentCodeTypeSmsPhrase.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeSmsPhrase"
|
||||
description: "auth.sentCodeTypeSmsPhrase attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeSmsPhrase.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSmsPhrase
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|beginning|[string](/API_docs/types/string.html) | Optional|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeSmsPhrase = ['_' => 'auth.sentCodeTypeSmsPhrase', 'beginning' => 'string'];
|
||||
```
|
28
docs/API_docs/constructors/auth.sentCodeTypeSmsWord.md
Normal file
28
docs/API_docs/constructors/auth.sentCodeTypeSmsWord.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "auth.sentCodeTypeSmsWord"
|
||||
description: "auth.sentCodeTypeSmsWord attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
redirect_from: /API_docs/constructors/auth_sentCodeTypeSmsWord.html
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSmsWord
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|beginning|[string](/API_docs/types/string.html) | Optional|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](/API_docs/types/auth.SentCodeType.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$auth_sentCodeTypeSmsWord = ['_' => 'auth.sentCodeTypeSmsWord', 'beginning' => 'string'];
|
||||
```
|
46
docs/API_docs/constructors/authorization.md
Normal file
46
docs/API_docs/constructors/authorization.md
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
title: "authorization"
|
||||
description: "Logged-in session"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authorization
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Logged-in session
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|current|[Bool](/API_docs/types/Bool.html) | Optional|Whether this is the current session|
|
||||
|official\_app|[Bool](/API_docs/types/Bool.html) | Optional|Whether the session is from an official app|
|
||||
|password\_pending|[Bool](/API_docs/types/Bool.html) | Optional|Whether the session is still waiting for a 2FA password|
|
||||
|encrypted\_requests\_disabled|[Bool](/API_docs/types/Bool.html) | Optional|Whether this session will accept encrypted chats|
|
||||
|call\_requests\_disabled|[Bool](/API_docs/types/Bool.html) | Optional|Whether this session will accept phone calls|
|
||||
|unconfirmed|[Bool](/API_docs/types/Bool.html) | Optional|Whether the session is [unconfirmed, see here »](https://core.telegram.org/api/auth#confirming-login) for more info.|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|Identifier|
|
||||
|device\_model|[string](/API_docs/types/string.html) | Yes|Device model|
|
||||
|platform|[string](/API_docs/types/string.html) | Yes|Platform|
|
||||
|system\_version|[string](/API_docs/types/string.html) | Yes|System version|
|
||||
|api\_id|[int](/API_docs/types/int.html) | Yes|[API ID](https://core.telegram.org/api/obtaining_api_id)|
|
||||
|app\_name|[string](/API_docs/types/string.html) | Yes|App name|
|
||||
|app\_version|[string](/API_docs/types/string.html) | Yes|App version|
|
||||
|date\_created|[int](/API_docs/types/int.html) | Yes|When was the session created|
|
||||
|date\_active|[int](/API_docs/types/int.html) | Yes|When was the session last active|
|
||||
|ip|[string](/API_docs/types/string.html) | Yes|Last known IP|
|
||||
|country|[string](/API_docs/types/string.html) | Yes|Country determined from IP|
|
||||
|region|[string](/API_docs/types/string.html) | Yes|Region determined from IP|
|
||||
|
||||
|
||||
|
||||
### Type: [Authorization](/API_docs/types/Authorization.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$authorization = ['_' => 'authorization', 'current' => Bool, 'official_app' => Bool, 'password_pending' => Bool, 'encrypted_requests_disabled' => Bool, 'call_requests_disabled' => Bool, 'unconfirmed' => 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'];
|
||||
```
|
39
docs/API_docs/constructors/autoDownloadSettings.md
Normal file
39
docs/API_docs/constructors/autoDownloadSettings.md
Normal file
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "autoDownloadSettings"
|
||||
description: "Autodownload settings"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: autoDownloadSettings
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|disabled|[Bool](/API_docs/types/Bool.html) | Optional|Disable automatic media downloads?|
|
||||
|video\_preload\_large|[Bool](/API_docs/types/Bool.html) | Optional|Whether to preload the first seconds of videos larger than the specified limit|
|
||||
|audio\_preload\_next|[Bool](/API_docs/types/Bool.html) | Optional|Whether to preload the next audio track when you're listening to music|
|
||||
|phonecalls\_less\_data|[Bool](/API_docs/types/Bool.html) | Optional|Whether to enable data saving mode in phone calls|
|
||||
|stories\_preload|[Bool](/API_docs/types/Bool.html) | Optional|Whether to preload [stories](https://core.telegram.org/api/stories); in particular, the first [documentAttributeVideo](../constructors/documentAttributeVideo.html).`preload_prefix_size` bytes of story videos should be preloaded.|
|
||||
|photo\_size\_max|[int](/API_docs/types/int.html) | Yes|Maximum size of photos to preload|
|
||||
|video\_size\_max|[long](/API_docs/types/long.html) | Yes|Maximum size of videos to preload|
|
||||
|file\_size\_max|[long](/API_docs/types/long.html) | Yes|Maximum size of other files to preload|
|
||||
|video\_upload\_maxbitrate|[int](/API_docs/types/int.html) | Yes|Maximum suggested bitrate for **uploading** videos|
|
||||
|small\_queue\_active\_operations\_max|[int](/API_docs/types/int.html) | Yes|A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files smaller than 20MB.|
|
||||
|large\_queue\_active\_operations\_max|[int](/API_docs/types/int.html) | Yes|A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files bigger than 20MB.|
|
||||
|
||||
|
||||
|
||||
### Type: [AutoDownloadSettings](/API_docs/types/AutoDownloadSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'stories_preload' => Bool, 'photo_size_max' => int, 'video_size_max' => long, 'file_size_max' => long, 'video_upload_maxbitrate' => int, 'small_queue_active_operations_max' => int, 'large_queue_active_operations_max' => int];
|
||||
```
|
30
docs/API_docs/constructors/autoSaveException.md
Normal file
30
docs/API_docs/constructors/autoSaveException.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "autoSaveException"
|
||||
description: "Peer-specific media autosave settings"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: autoSaveException
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Peer-specific media autosave settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[long](/API_docs/types/long.html) | Yes|The peer|
|
||||
|settings|[AutoSaveSettings](/API_docs/types/AutoSaveSettings.html) | Yes|Media autosave settings|
|
||||
|
||||
|
||||
|
||||
### Type: [AutoSaveException](/API_docs/types/AutoSaveException.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$autoSaveException = ['_' => 'autoSaveException', 'peer' => long, 'settings' => AutoSaveSettings];
|
||||
```
|
31
docs/API_docs/constructors/autoSaveSettings.md
Normal file
31
docs/API_docs/constructors/autoSaveSettings.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
title: "autoSaveSettings"
|
||||
description: "Media autosave settings"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: autoSaveSettings
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Media autosave settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|photos|[Bool](/API_docs/types/Bool.html) | Optional|Whether photos should be autosaved to the gallery.|
|
||||
|videos|[Bool](/API_docs/types/Bool.html) | Optional|Whether videos should be autosaved to the gallery.|
|
||||
|video\_max\_size|[long](/API_docs/types/long.html) | Optional|If set, specifies a size limit for autosavable videos|
|
||||
|
||||
|
||||
|
||||
### Type: [AutoSaveSettings](/API_docs/types/AutoSaveSettings.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$autoSaveSettings = ['_' => 'autoSaveSettings', 'photos' => Bool, 'videos' => Bool, 'video_max_size' => long];
|
||||
```
|
39
docs/API_docs/constructors/availableReaction.md
Normal file
39
docs/API_docs/constructors/availableReaction.md
Normal file
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "availableReaction"
|
||||
description: "Animations associated with a message reaction"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: availableReaction
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Animations associated with a message reaction
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|inactive|[Bool](/API_docs/types/Bool.html) | Optional|If not set, the reaction can be added to new messages and enabled in chats.|
|
||||
|premium|[Bool](/API_docs/types/Bool.html) | Optional|Whether this reaction can only be used by Telegram Premium users|
|
||||
|reaction|[string](/API_docs/types/string.html) | Yes|Reaction emoji|
|
||||
|title|[string](/API_docs/types/string.html) | Yes|Reaction description|
|
||||
|static\_icon|[Document](/API_docs/types/Document.html) | Optional|Static icon for the reaction|
|
||||
|appear\_animation|[Document](/API_docs/types/Document.html) | Optional|The animated sticker to show when the user opens the reaction dropdown|
|
||||
|select\_animation|[Document](/API_docs/types/Document.html) | Optional|The animated sticker to show when the user hovers over the reaction|
|
||||
|activate\_animation|[Document](/API_docs/types/Document.html) | Optional|The animated sticker to show when the reaction is chosen and activated|
|
||||
|effect\_animation|[Document](/API_docs/types/Document.html) | Optional|The background effect (still an animated sticker) to play under the `activate_animation`, when the reaction is chosen and activated|
|
||||
|around\_animation|[Document](/API_docs/types/Document.html) | Optional|The animation that plays around the button when you press an existing reaction (played together with `center_icon`).|
|
||||
|center\_icon|[Document](/API_docs/types/Document.html) | Optional|The animation of the emoji inside the button when you press an existing reaction (played together with `around_animation`).|
|
||||
|
||||
|
||||
|
||||
### Type: [AvailableReaction](/API_docs/types/AvailableReaction.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$availableReaction = ['_' => 'availableReaction', 'inactive' => Bool, 'premium' => Bool, 'reaction' => 'string', 'title' => 'string', 'static_icon' => Document, 'appear_animation' => Document, 'select_animation' => Document, 'activate_animation' => Document, 'effect_animation' => Document, 'around_animation' => Document, 'center_icon' => Document];
|
||||
```
|
30
docs/API_docs/constructors/bankCardOpenUrl.md
Normal file
30
docs/API_docs/constructors/bankCardOpenUrl.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "bankCardOpenUrl"
|
||||
description: "Credit card info URL provided by the bank"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: bankCardOpenUrl
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Credit card info URL provided by the bank
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|url|[string](/API_docs/types/string.html) | Yes|Info URL|
|
||||
|name|[string](/API_docs/types/string.html) | Yes|Bank name|
|
||||
|
||||
|
||||
|
||||
### Type: [BankCardOpenUrl](/API_docs/types/BankCardOpenUrl.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$bankCardOpenUrl = ['_' => 'bankCardOpenUrl', 'url' => 'string', 'name' => 'string'];
|
||||
```
|
24
docs/API_docs/constructors/baseThemeArctic.md
Normal file
24
docs/API_docs/constructors/baseThemeArctic.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "baseThemeArctic"
|
||||
description: "Arctic theme"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: baseThemeArctic
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Arctic theme
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BaseTheme](/API_docs/types/BaseTheme.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$baseThemeArctic = ['_' => 'baseThemeArctic'];
|
||||
```
|
24
docs/API_docs/constructors/baseThemeClassic.md
Normal file
24
docs/API_docs/constructors/baseThemeClassic.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "baseThemeClassic"
|
||||
description: "Classic theme"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: baseThemeClassic
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Classic theme
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BaseTheme](/API_docs/types/BaseTheme.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$baseThemeClassic = ['_' => 'baseThemeClassic'];
|
||||
```
|
24
docs/API_docs/constructors/baseThemeDay.md
Normal file
24
docs/API_docs/constructors/baseThemeDay.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "baseThemeDay"
|
||||
description: "Day theme"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: baseThemeDay
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Day theme
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BaseTheme](/API_docs/types/BaseTheme.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$baseThemeDay = ['_' => 'baseThemeDay'];
|
||||
```
|
24
docs/API_docs/constructors/baseThemeNight.md
Normal file
24
docs/API_docs/constructors/baseThemeNight.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "baseThemeNight"
|
||||
description: "Night theme"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: baseThemeNight
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Night theme
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BaseTheme](/API_docs/types/BaseTheme.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$baseThemeNight = ['_' => 'baseThemeNight'];
|
||||
```
|
24
docs/API_docs/constructors/baseThemeTinted.md
Normal file
24
docs/API_docs/constructors/baseThemeTinted.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "baseThemeTinted"
|
||||
description: "Tinted theme"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: baseThemeTinted
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Tinted theme
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BaseTheme](/API_docs/types/BaseTheme.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$baseThemeTinted = ['_' => 'baseThemeTinted'];
|
||||
```
|
29
docs/API_docs/constructors/birthday.md
Normal file
29
docs/API_docs/constructors/birthday.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "birthday"
|
||||
description: "birthday attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: birthday
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|day|[int](/API_docs/types/int.html) | Yes|
|
||||
|month|[int](/API_docs/types/int.html) | Yes|
|
||||
|year|[int](/API_docs/types/int.html) | Optional|
|
||||
|
||||
|
||||
|
||||
### Type: [Birthday](/API_docs/types/Birthday.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$birthday = ['_' => 'birthday', 'day' => int, 'month' => int, 'year' => int];
|
||||
```
|
10
docs/API_docs/constructors/boolFalse.md
Normal file
10
docs/API_docs/constructors/boolFalse.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: boolFalse
|
||||
description: Represents a boolean with value equal to false
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolFalse
|
||||
[Back to constructor index](index.html)
|
||||
|
||||
Represents a boolean with value equal to `false`.
|
10
docs/API_docs/constructors/boolTrue.md
Normal file
10
docs/API_docs/constructors/boolTrue.md
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
title: boolTrue
|
||||
description: Represents a boolean with value equal to true
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolTrue
|
||||
[Back to constructor index](index.html)
|
||||
|
||||
Represents a boolean with value equal to `true`.
|
38
docs/API_docs/constructors/boost.md
Normal file
38
docs/API_docs/constructors/boost.md
Normal file
@ -0,0 +1,38 @@
|
||||
---
|
||||
title: "boost"
|
||||
description: "Info about one or more boosts applied by a specific user."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: boost
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Info about one or more [boosts](https://core.telegram.org/api/boost) applied by a specific user.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|gift|[Bool](/API_docs/types/Bool.html) | Optional|Whether this boost was applied because the channel [directly gifted a subscription to the user](https://core.telegram.org/api/giveaways).|
|
||||
|giveaway|[Bool](/API_docs/types/Bool.html) | Optional|Whether this boost was applied because the user was chosen in a [giveaway started by the channel](https://core.telegram.org/api/giveaways).|
|
||||
|unclaimed|[Bool](/API_docs/types/Bool.html) | Optional|If set, the user hasn't yet invoked [payments.applyGiftCode](../methods/payments.applyGiftCode.html) to claim a subscription gifted [directly or in a giveaway by the channel](https://core.telegram.org/api/giveaways).|
|
||||
|id|[string](/API_docs/types/string.html) | Yes|Unique ID for this set of boosts.|
|
||||
|user\_id|[long](/API_docs/types/long.html) | Optional|ID of the user that applied the boost.|
|
||||
|giveaway\_msg\_id|[int](/API_docs/types/int.html) | Optional|The message ID of the [giveaway](https://core.telegram.org/api/giveaways)|
|
||||
|date|[int](/API_docs/types/int.html) | Yes|When was the boost applied|
|
||||
|expires|[int](/API_docs/types/int.html) | Yes|When does the boost expire|
|
||||
|used\_gift\_slug|[string](/API_docs/types/string.html) | Optional|The created Telegram Premium gift code, only set if either `gift` or `giveaway` are set AND it is either a gift code for the currently logged in user or if it was already claimed.|
|
||||
|multiplier|[int](/API_docs/types/int.html) | Optional|If set, this boost counts as `multiplier` boosts, otherwise it counts as a single boost.|
|
||||
|
||||
|
||||
|
||||
### Type: [Boost](/API_docs/types/Boost.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$boost = ['_' => 'boost', 'gift' => Bool, 'giveaway' => Bool, 'unclaimed' => Bool, 'id' => 'string', 'user_id' => long, 'giveaway_msg_id' => int, 'date' => int, 'expires' => int, 'used_gift_slug' => 'string', 'multiplier' => int];
|
||||
```
|
36
docs/API_docs/constructors/botApp.md
Normal file
36
docs/API_docs/constructors/botApp.md
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: "botApp"
|
||||
description: "Contains information about a direct link Mini App."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botApp
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Contains information about a [direct link Mini App](https://core.telegram.org/api/bots/webapps#direct-link-mini-apps).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](/API_docs/types/long.html) | Yes|bot mini app ID|
|
||||
|access\_hash|[long](/API_docs/types/long.html) | Yes|bot mini app access hash|
|
||||
|short\_name|[string](/API_docs/types/string.html) | Yes|bot mini app short name, used to generate [Direct Mini App deep links](https://core.telegram.org/api/links#direct-mini-app-links).|
|
||||
|title|[string](/API_docs/types/string.html) | Yes|bot mini app title.|
|
||||
|description|[string](/API_docs/types/string.html) | Yes|bot mini app description.|
|
||||
|photo|[Photo](/API_docs/types/Photo.html) | Optional|bot mini app photo.|
|
||||
|document|[Document](/API_docs/types/Document.html) | Optional|bot mini app animation.|
|
||||
|hash|[long](/API_docs/types/long.html) | Yes|Hash to pass to [messages.getBotApp](../methods/messages.getBotApp.html), to avoid refetching bot app info if it hasn't changed.|
|
||||
|
||||
|
||||
|
||||
### Type: [BotApp](/API_docs/types/BotApp.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botApp = ['_' => 'botApp', 'id' => long, 'access_hash' => long, 'short_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'document' => Document, 'hash' => long];
|
||||
```
|
24
docs/API_docs/constructors/botAppNotModified.md
Normal file
24
docs/API_docs/constructors/botAppNotModified.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "botAppNotModified"
|
||||
description: "Bot app info hasn't changed."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botAppNotModified
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Bot app info hasn't changed.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BotApp](/API_docs/types/BotApp.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botAppNotModified = ['_' => 'botAppNotModified'];
|
||||
```
|
32
docs/API_docs/constructors/botBusinessConnection.md
Normal file
32
docs/API_docs/constructors/botBusinessConnection.md
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "botBusinessConnection"
|
||||
description: "botBusinessConnection attributes, type and example"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botBusinessConnection
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|can\_reply|[Bool](/API_docs/types/Bool.html) | Optional|
|
||||
|disabled|[Bool](/API_docs/types/Bool.html) | Optional|
|
||||
|connection\_id|[string](/API_docs/types/string.html) | Yes|
|
||||
|user\_id|[long](/API_docs/types/long.html) | Yes|
|
||||
|dc\_id|[int](/API_docs/types/int.html) | Yes|
|
||||
|date|[int](/API_docs/types/int.html) | Yes|
|
||||
|
||||
|
||||
|
||||
### Type: [BotBusinessConnection](/API_docs/types/BotBusinessConnection.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botBusinessConnection = ['_' => 'botBusinessConnection', 'can_reply' => Bool, 'disabled' => Bool, 'connection_id' => 'string', 'user_id' => long, 'dc_id' => int, 'date' => int];
|
||||
```
|
30
docs/API_docs/constructors/botCommand.md
Normal file
30
docs/API_docs/constructors/botCommand.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "botCommand"
|
||||
description: "Describes a bot command that can be used in a chat"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommand
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Describes a bot command that can be used in a chat
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|command|[string](/API_docs/types/string.html) | Yes|`/command` name|
|
||||
|description|[string](/API_docs/types/string.html) | Yes|Description of the command|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommand](/API_docs/types/BotCommand.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommand = ['_' => 'botCommand', 'command' => 'string', 'description' => 'string'];
|
||||
```
|
24
docs/API_docs/constructors/botCommandScopeChatAdmins.md
Normal file
24
docs/API_docs/constructors/botCommandScopeChatAdmins.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "botCommandScopeChatAdmins"
|
||||
description: "The specified bot commands will be valid only for chat administrators, in all groups and supergroups."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopeChatAdmins
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will be valid only for chat administrators, in all [groups and supergroups](https://core.telegram.org/api/channel).
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopeChatAdmins = ['_' => 'botCommandScopeChatAdmins'];
|
||||
```
|
24
docs/API_docs/constructors/botCommandScopeChats.md
Normal file
24
docs/API_docs/constructors/botCommandScopeChats.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "botCommandScopeChats"
|
||||
description: "The specified bot commands will be valid in all groups and supergroups."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopeChats
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will be valid in all [groups and supergroups](https://core.telegram.org/api/channel).
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopeChats = ['_' => 'botCommandScopeChats'];
|
||||
```
|
24
docs/API_docs/constructors/botCommandScopeDefault.md
Normal file
24
docs/API_docs/constructors/botCommandScopeDefault.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "botCommandScopeDefault"
|
||||
description: "The commands will be valid in all dialogs"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopeDefault
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The commands will be valid in all dialogs
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopeDefault = ['_' => 'botCommandScopeDefault'];
|
||||
```
|
29
docs/API_docs/constructors/botCommandScopePeer.md
Normal file
29
docs/API_docs/constructors/botCommandScopePeer.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "botCommandScopePeer"
|
||||
description: "The specified bot commands will be valid only in a specific dialog."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopePeer
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will be valid only in a specific dialog.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[InputPeer](/API_docs/types/InputPeer.html) | Optional|The dialog|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopePeer = ['_' => 'botCommandScopePeer', 'peer' => InputPeer];
|
||||
```
|
29
docs/API_docs/constructors/botCommandScopePeerAdmins.md
Normal file
29
docs/API_docs/constructors/botCommandScopePeerAdmins.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
title: "botCommandScopePeerAdmins"
|
||||
description: "The specified bot commands will be valid for all admins of the specified group or supergroup."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopePeerAdmins
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will be valid for all admins of the specified [group or supergroup](https://core.telegram.org/api/channel).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[InputPeer](/API_docs/types/InputPeer.html) | Optional|The chat|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopePeerAdmins = ['_' => 'botCommandScopePeerAdmins', 'peer' => InputPeer];
|
||||
```
|
30
docs/API_docs/constructors/botCommandScopePeerUser.md
Normal file
30
docs/API_docs/constructors/botCommandScopePeerUser.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "botCommandScopePeerUser"
|
||||
description: "The specified bot commands will be valid only for a specific user in the specified group or supergroup."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopePeerUser
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will be valid only for a specific user in the specified [group or supergroup](https://core.telegram.org/api/channel).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[InputPeer](/API_docs/types/InputPeer.html) | Optional|The chat|
|
||||
|user\_id|[InputUser](/API_docs/types/InputUser.html) | Optional|The user|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopePeerUser = ['_' => 'botCommandScopePeerUser', 'peer' => InputPeer, 'user_id' => InputUser];
|
||||
```
|
24
docs/API_docs/constructors/botCommandScopeUsers.md
Normal file
24
docs/API_docs/constructors/botCommandScopeUsers.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "botCommandScopeUsers"
|
||||
description: "The specified bot commands will only be valid in all private chats with users."
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommandScopeUsers
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
The specified bot commands will only be valid in all private chats with users.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommandScope](/API_docs/types/BotCommandScope.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botCommandScopeUsers = ['_' => 'botCommandScopeUsers'];
|
||||
```
|
34
docs/API_docs/constructors/botInfo.md
Normal file
34
docs/API_docs/constructors/botInfo.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
title: "botInfo"
|
||||
description: "Info about bots (available bot commands, etc)"
|
||||
nav_exclude: true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInfo
|
||||
[Back to constructors index](/API_docs/constructors/index.html)
|
||||
|
||||
|
||||
|
||||
Info about bots (available bot commands, etc)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[long](/API_docs/types/long.html) | Optional|ID of the bot|
|
||||
|description|[string](/API_docs/types/string.html) | Optional|Description of the bot|
|
||||
|description\_photo|[Photo](/API_docs/types/Photo.html) | Optional|Description photo|
|
||||
|description\_document|[Document](/API_docs/types/Document.html) | Optional|Description animation in MPEG4 format|
|
||||
|commands|Array of [BotCommand](/API_docs/types/BotCommand.html) | Optional|Bot commands that can be used in the chat|
|
||||
|menu\_button|[BotMenuButton](/API_docs/types/BotMenuButton.html) | Optional|Indicates the action to execute when pressing the in-UI menu button for bots|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInfo](/API_docs/types/BotInfo.html)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```
|
||||
$botInfo = ['_' => 'botInfo', 'user_id' => long, 'description' => 'string', 'description_photo' => Photo, 'description_document' => Document, 'commands' => [BotCommand, BotCommand], 'menu_button' => BotMenuButton];
|
||||
```
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user