Rename
This commit is contained in:
parent
4f734f859b
commit
3dd0584ee7
GPG Key ID:
8C1BE3B34B230CA7
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: account.authorizationForm
|
||||
description: [Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizationForm
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
[Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required types|
|
||||
|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values|
|
||||
|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|Errors|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|privacy\_policy\_url|[string](../types/string.md) | Optional|URL of the service's privacy policy|
|
||||
|
||||
|
||||
|
||||
### Type: [account.AuthorizationForm](../types/account.AuthorizationForm.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.authorizationForm={_='account.authorizationForm', required_types={SecureRequiredType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: account.authorizations
|
||||
description: Logged-in sessions
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Logged-in sessions
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Authorizations|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Authorizations](../types/account.Authorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.authorizations = ['_' => 'account.authorizations', 'authorizations' => [Authorization, Authorization]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.authorizations={_='account.authorizations', authorizations={Authorization}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: account.autoDownloadSettings
|
||||
description: Media autodownload settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.autoDownloadSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Media autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low data usage preset|
|
||||
|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium data usage preset|
|
||||
|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High data usage preset|
|
||||
|
||||
|
||||
|
||||
### Type: [account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.autoDownloadSettings={_='account.autoDownloadSettings', low=AutoDownloadSettings, medium=AutoDownloadSettings, high=AutoDownloadSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: account.password
|
||||
description: Configuration for two-factor authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.password
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Configuration for two-factor authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|has\_recovery|[Bool](../types/Bool.md) | Optional|Whether the user has a recovery method configured|
|
||||
|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Whether telegram [passport](https://core.telegram.org/passport) is enabled|
|
||||
|has\_password|[Bool](../types/Bool.md) | Optional|Whether the user has a password|
|
||||
|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) of the current password|
|
||||
|srp\_B|[bytes](../types/bytes.md) | Optional|Srp B param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|srp\_id|[long](../types/long.md) | Optional|Srp ID param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](../types/string.md) | Optional|Text hint for the password|
|
||||
|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|A [password recovery email](https://core.telegram.org/api/srp#email-verification) with the specified [pattern](https://core.telegram.org/api/pattern) is still awaiting verification|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) to use when creating new passwords|
|
||||
|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|The KDF algorithm for telegram [passport](https://core.telegram.org/passport)|
|
||||
|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random string|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Password](../types/account.Password.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'has_password' => Bool, 'current_algo' => PasswordKdfAlgo, 'srp_B' => 'bytes', 'srp_id' => long, 'hint' => 'string', 'email_unconfirmed_pattern' => 'string', 'new_algo' => PasswordKdfAlgo, 'new_secure_algo' => SecurePasswordKdfAlgo, 'secure_random' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.password={_='account.password', 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'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: account.passwordInputSettings
|
||||
description: Settings for setting up a new password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordInputSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Settings for setting up a new password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [SRP algorithm](https://core.telegram.org/api/srp) to use|
|
||||
|new\_password\_hash|[bytes](../types/bytes.md) | Optional|The [computed password hash](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](../types/string.md) | Optional|Text hint for the password|
|
||||
|email|[string](../types/string.md) | Optional|Password recovery email|
|
||||
|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PasswordInputSettings](../types/account.PasswordInputSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.passwordInputSettings={_='account.passwordInputSettings', new_algo=PasswordKdfAlgo, new_password_hash='bytes', hint='string', email='string', new_secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.passwordSettings
|
||||
description: Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email|[string](../types/string.md) | Optional|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)|
|
||||
|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PasswordSettings](../types/account.PasswordSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.passwordSettings={_='account.passwordSettings', email='string', secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: account.privacyRules
|
||||
description: Privacy rules
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.privacyRules
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Privacy rules
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats allowed?|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account.PrivacyRules](../types/account.PrivacyRules.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.privacyRules={_='account.privacyRules', rules={PrivacyRule}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.sentEmailCode
|
||||
description: The sent email code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.sentEmailCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The sent email code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](../types/string.md) | Yes|The email (to which the code was sent) must match this [pattern](https://core.telegram.org/api/pattern)|
|
||||
|length|[int](../types/int.md) | Yes|The length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [account.SentEmailCode](../types/account.SentEmailCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: account.takeout
|
||||
description: Takout info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.takeout
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Takout info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](../types/long.md) | Yes|Takeout ID|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Takeout](../types/account.Takeout.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.takeout = ['_' => 'account.takeout', 'id' => long];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.takeout={_='account.takeout', id=long}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.themes
|
||||
description: Installed themes
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themes
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Installed themes
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|themes|Array of [Theme](../types/Theme.md) | Yes|Themes|
|
||||
|
||||
|
||||
|
||||
### Type: [account.Themes](../types/account.Themes.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.themes = ['_' => 'account.themes', 'hash' => int, 'themes' => [Theme, Theme]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.themes={_='account.themes', hash=int, themes={Theme}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: account.themesNotModified
|
||||
description: No new themes were installed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themesNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new themes were installed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.Themes](../types/account.Themes.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.themesNotModified = ['_' => 'account.themesNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.themesNotModified={_='account.themesNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.tmpPassword
|
||||
description: Temporary payment password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.tmpPassword
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Temporary payment password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password|
|
||||
|valid\_until|[int](../types/int.md) | Yes|Validity period|
|
||||
|
||||
|
||||
|
||||
### Type: [account.TmpPassword](../types/account.TmpPassword.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.wallPapers
|
||||
description: Installed wallpapers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Installed wallpapers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers|
|
||||
|
||||
|
||||
|
||||
### Type: [account.WallPapers](../types/account.WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.wallPapers = ['_' => 'account.wallPapers', 'hash' => int, 'wallpapers' => [WallPaper, WallPaper]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.wallPapers={_='account.wallPapers', hash=int, wallpapers={WallPaper}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: account.wallPapersNotModified
|
||||
description: No new wallpapers were found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapersNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new wallpapers were found
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account.WallPapers](../types/account.WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.wallPapersNotModified = ['_' => 'account.wallPapersNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.wallPapersNotModified={_='account.wallPapersNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.webAuthorizations
|
||||
description: Web authorizations
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.webAuthorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Web authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Authorizations|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account.WebAuthorizations](../types/account.WebAuthorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account.webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account.webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
title: account.authorizationForm
|
||||
description: [Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizationForm
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
[Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required types|
|
||||
|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values|
|
||||
|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|Errors|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|privacy\_policy\_url|[string](../types/string.md) | Optional|URL of the service's privacy policy|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_AuthorizationForm](../types/account_AuthorizationForm.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_authorizationForm={_='account.authorizationForm', required_types={SecureRequiredType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: account.authorizations
|
||||
description: Logged-in sessions
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Logged-in sessions
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Authorizations|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Authorizations](../types/account_Authorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_authorizations = ['_' => 'account.authorizations', 'authorizations' => [Authorization, Authorization]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_authorizations={_='account.authorizations', authorizations={Authorization}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: account.autoDownloadSettings
|
||||
description: Media autodownload settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.autoDownloadSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Media autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low data usage preset|
|
||||
|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium data usage preset|
|
||||
|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High data usage preset|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_AutoDownloadSettings](../types/account_AutoDownloadSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_autoDownloadSettings={_='account.autoDownloadSettings', low=AutoDownloadSettings, medium=AutoDownloadSettings, high=AutoDownloadSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
---
|
||||
title: account.password
|
||||
description: Configuration for two-factor authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.password
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Configuration for two-factor authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|has\_recovery|[Bool](../types/Bool.md) | Optional|Whether the user has a recovery method configured|
|
||||
|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Whether telegram [passport](https://core.telegram.org/passport) is enabled|
|
||||
|has\_password|[Bool](../types/Bool.md) | Optional|Whether the user has a password|
|
||||
|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) of the current password|
|
||||
|srp\_B|[bytes](../types/bytes.md) | Optional|Srp B param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|srp\_id|[long](../types/long.md) | Optional|Srp ID param for [SRP authorization](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](../types/string.md) | Optional|Text hint for the password|
|
||||
|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|A [password recovery email](https://core.telegram.org/api/srp#email-verification) with the specified [pattern](https://core.telegram.org/api/pattern) is still awaiting verification|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) to use when creating new passwords|
|
||||
|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|The KDF algorithm for telegram [passport](https://core.telegram.org/passport)|
|
||||
|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random string|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Password](../types/account_Password.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'has_password' => Bool, 'current_algo' => PasswordKdfAlgo, 'srp_B' => 'bytes', 'srp_id' => long, 'hint' => 'string', 'email_unconfirmed_pattern' => 'string', 'new_algo' => PasswordKdfAlgo, 'new_secure_algo' => SecurePasswordKdfAlgo, 'secure_random' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_password={_='account.password', 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'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
title: account.passwordInputSettings
|
||||
description: Settings for setting up a new password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordInputSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Settings for setting up a new password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [SRP algorithm](https://core.telegram.org/api/srp) to use|
|
||||
|new\_password\_hash|[bytes](../types/bytes.md) | Optional|The [computed password hash](https://core.telegram.org/api/srp)|
|
||||
|hint|[string](../types/string.md) | Optional|Text hint for the password|
|
||||
|email|[string](../types/string.md) | Optional|Password recovery email|
|
||||
|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PasswordInputSettings](../types/account_PasswordInputSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_passwordInputSettings={_='account.passwordInputSettings', new_algo=PasswordKdfAlgo, new_password_hash='bytes', hint='string', email='string', new_secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.passwordSettings
|
||||
description: Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email|[string](../types/string.md) | Optional|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)|
|
||||
|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PasswordSettings](../types/account_PasswordSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_passwordSettings={_='account.passwordSettings', email='string', secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: account.privacyRules
|
||||
description: Privacy rules
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.privacyRules
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Privacy rules
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats allowed?|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PrivacyRules](../types/account_PrivacyRules.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_privacyRules={_='account.privacyRules', rules={PrivacyRule}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.sentEmailCode
|
||||
description: The sent email code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.sentEmailCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The sent email code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](../types/string.md) | Yes|The email (to which the code was sent) must match this [pattern](https://core.telegram.org/api/pattern)|
|
||||
|length|[int](../types/int.md) | Yes|The length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_SentEmailCode](../types/account_SentEmailCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: account.takeout
|
||||
description: Takout info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.takeout
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Takout info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](../types/long.md) | Yes|Takeout ID|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Takeout](../types/account_Takeout.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_takeout = ['_' => 'account.takeout', 'id' => long];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_takeout={_='account.takeout', id=long}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.themes
|
||||
description: Installed themes
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themes
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Installed themes
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|themes|Array of [Theme](../types/Theme.md) | Yes|Themes|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Themes](../types/account_Themes.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_themes = ['_' => 'account.themes', 'hash' => int, 'themes' => [Theme, Theme]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_themes={_='account.themes', hash=int, themes={Theme}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: account.themesNotModified
|
||||
description: No new themes were installed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themesNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new themes were installed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Themes](../types/account_Themes.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_themesNotModified = ['_' => 'account.themesNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_themesNotModified={_='account.themesNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.tmpPassword
|
||||
description: Temporary payment password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.tmpPassword
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Temporary payment password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password|
|
||||
|valid\_until|[int](../types/int.md) | Yes|Validity period|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_TmpPassword](../types/account_TmpPassword.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.wallPapers
|
||||
description: Installed wallpapers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Installed wallpapers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WallPapers](../types/account_WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_wallPapers = ['_' => 'account.wallPapers', 'hash' => int, 'wallpapers' => [WallPaper, WallPaper]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_wallPapers={_='account.wallPapers', hash=int, wallpapers={WallPaper}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: account.wallPapersNotModified
|
||||
description: No new wallpapers were found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapersNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new wallpapers were found
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WallPapers](../types/account_WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_wallPapersNotModified = ['_' => 'account.wallPapersNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_wallPapersNotModified={_='account.wallPapersNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: account.webAuthorizations
|
||||
description: Web authorizations
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.webAuthorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Web authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Authorizations|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WebAuthorizations](../types/account_WebAuthorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: auth.authorization
|
||||
description: Contains user authorization info.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains user authorization info.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions|
|
||||
|user|[User](../types/User.md) | Optional|Info on authorized user|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.Authorization](../types/auth.Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.authorization={_='auth.authorization', tmp_sessions=int, user=User}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.authorizationSignUpRequired
|
||||
description: An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorizationSignUpRequired
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Optional|Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.Authorization](../types/auth.Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.authorizationSignUpRequired = ['_' => 'auth.authorizationSignUpRequired', 'terms_of_service' => help.TermsOfService];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.authorizationSignUpRequired={_='auth.authorizationSignUpRequired', terms_of_service=help.TermsOfService}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeCall
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](../types/auth.CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.codeTypeCall = ['_' => 'auth.codeTypeCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.codeTypeCall={_='auth.codeTypeCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeFlashCall
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](../types/auth.CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.codeTypeFlashCall={_='auth.codeTypeFlashCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeSms
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth.CodeType](../types/auth.CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.codeTypeSms = ['_' => 'auth.codeTypeSms'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.codeTypeSms={_='auth.codeTypeSms'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: auth.exportedAuthorization
|
||||
description: Data for copying of authorization between data centres.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.exportedAuthorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Data for copying of authorization between data centres.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|Current user identifier|
|
||||
|bytes|[bytes](../types/bytes.md) | Yes|Authorizes key|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => int, 'bytes' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.exportedAuthorization={_='auth.exportedAuthorization', id=int, bytes='bytes'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.passwordRecovery
|
||||
description: 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).
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.passwordRecovery
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
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](../types/string.md) | Yes|The email to which the recovery code was sent must match this [pattern](https://core.telegram.org/api/pattern).|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.PasswordRecovery](../types/auth.PasswordRecovery.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.passwordRecovery={_='auth.passwordRecovery', email_pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: auth.sentCode
|
||||
description: Contains info about a sent verification code.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains info about a sent verification code.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|type|[auth.SentCodeType](../constructors/auth.SentCodeType.md) | Yes|Phone code type|
|
||||
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash, to be stored and later re-used with [auth.signIn](../methods/auth.signIn.md)|
|
||||
|next\_type|[auth.CodeType](../constructors/auth.CodeType.md) | Optional|Phone code type that will be sent next, if the phone code is not received within `timeout` seconds: to send it use [auth.resendCode](../methods/auth.resendCode.md)|
|
||||
|timeout|[int](../types/int.md) | Optional|Timeout for reception of the phone code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCode](../types/auth.SentCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.sentCode = ['_' => 'auth.sentCode', 'type' => auth.SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth.CodeType, 'timeout' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.sentCode={_='auth.sentCode', type=auth.SentCodeType, phone_code_hash='string', next_type=auth.CodeType, timeout=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeApp
|
||||
description: The code was sent through the telegram app
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeApp
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code was sent through the telegram app
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](../types/auth.SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeCall
|
||||
description: The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](../types/auth.SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeFlashCall
|
||||
description: The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|pattern|[string](../types/string.md) | Yes|[pattern](https://core.telegram.org/api/pattern) to match|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](../types/auth.SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeSms
|
||||
description: The code was sent via SMS
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code was sent via SMS
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth.SentCodeType](../types/auth.SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth.sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth.sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: auth.authorization
|
||||
description: Contains user authorization info.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains user authorization info.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions|
|
||||
|user|[User](../types/User.md) | Optional|Info on authorized user|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_Authorization](../types/auth_Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_authorization={_='auth.authorization', tmp_sessions=int, user=User}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.authorizationSignUpRequired
|
||||
description: An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorizationSignUpRequired
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|terms\_of\_service|[help\_TermsOfService](../types/help_TermsOfService.md) | Optional|Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_Authorization](../types/auth_Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_authorizationSignUpRequired = ['_' => 'auth.authorizationSignUpRequired', 'terms_of_service' => help_TermsOfService];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_authorizationSignUpRequired={_='auth.authorizationSignUpRequired', terms_of_service=help_TermsOfService}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: auth.codeTypeCall
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeCall = ['_' => 'auth.codeTypeCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeCall={_='auth.codeTypeCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: auth.codeTypeFlashCall
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeFlashCall={_='auth.codeTypeFlashCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: auth.codeTypeSms
|
||||
description: Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeSms = ['_' => 'auth.codeTypeSms'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeSms={_='auth.codeTypeSms'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: auth.exportedAuthorization
|
||||
description: Data for copying of authorization between data centres.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.exportedAuthorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Data for copying of authorization between data centres.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|Current user identifier|
|
||||
|bytes|[bytes](../types/bytes.md) | Yes|Authorizes key|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => int, 'bytes' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_exportedAuthorization={_='auth.exportedAuthorization', id=int, bytes='bytes'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.passwordRecovery
|
||||
description: 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).
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.passwordRecovery
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
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](../types/string.md) | Yes|The email to which the recovery code was sent must match this [pattern](https://core.telegram.org/api/pattern).|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_PasswordRecovery](../types/auth_PasswordRecovery.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_passwordRecovery={_='auth.passwordRecovery', email_pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: auth.sentCode
|
||||
description: Contains info about a sent verification code.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains info about a sent verification code.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|type|[auth\_SentCodeType](../types/auth_SentCodeType.md) | Yes|Phone code type|
|
||||
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash, to be stored and later re-used with [auth.signIn](../methods/auth.signIn.md)|
|
||||
|next\_type|[auth\_CodeType](../types/auth_CodeType.md) | Optional|Phone code type that will be sent next, if the phone code is not received within `timeout` seconds: to send it use [auth.resendCode](../methods/auth.resendCode.md)|
|
||||
|timeout|[int](../types/int.md) | Optional|Timeout for reception of the phone code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCode](../types/auth_SentCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCode = ['_' => 'auth.sentCode', 'type' => auth_SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth_CodeType, 'timeout' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCode={_='auth.sentCode', type=auth_SentCodeType, phone_code_hash='string', next_type=auth_CodeType, timeout=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.sentCodeTypeApp
|
||||
description: The code was sent through the telegram app
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeApp
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code was sent through the telegram app
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.sentCodeTypeCall
|
||||
description: The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the verification code|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.sentCodeTypeFlashCall
|
||||
description: The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|pattern|[string](../types/string.md) | Yes|[pattern](https://core.telegram.org/api/pattern) to match|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
title: auth.sentCodeTypeSms
|
||||
description: The code was sent via SMS
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The code was sent via SMS
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: channels.adminLogResults
|
||||
description: Admin log events
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.adminLogResults
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Admin log events
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes|Events|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels.AdminLogResults](../types/channels.AdminLogResults.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels.adminLogResults = ['_' => 'channels.adminLogResults', 'events' => [ChannelAdminLogEvent, ChannelAdminLogEvent], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels.adminLogResults={_='channels.adminLogResults', events={ChannelAdminLogEvent}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: channels.channelParticipant
|
||||
description: Represents a channel participant
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipant
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents a channel participant
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The channel participant|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels.ChannelParticipant](../types/channels.ChannelParticipant.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels.channelParticipant = ['_' => 'channels.channelParticipant', 'participant' => ChannelParticipant, 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels.channelParticipant={_='channels.channelParticipant', participant=ChannelParticipant, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: channels.channelParticipants
|
||||
description: Represents multiple channel participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipants
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents multiple channel participants
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|count|[int](../types/int.md) | Yes|Total number of participants that correspond to the given query|
|
||||
|participants|Array of [ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participants|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels.channelParticipants = ['_' => 'channels.channelParticipants', 'count' => int, 'participants' => [ChannelParticipant, ChannelParticipant], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels.channelParticipants={_='channels.channelParticipants', count=int, participants={ChannelParticipant}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: channels.channelParticipantsNotModified
|
||||
description: No new participant info could be found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipantsNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new participant info could be found
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels.channelParticipantsNotModified = ['_' => 'channels.channelParticipantsNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels.channelParticipantsNotModified={_='channels.channelParticipantsNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: channels.adminLogResults
|
||||
description: Admin log events
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.adminLogResults
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Admin log events
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes|Events|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels_adminLogResults = ['_' => 'channels.adminLogResults', 'events' => [ChannelAdminLogEvent, ChannelAdminLogEvent], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels_adminLogResults={_='channels.adminLogResults', events={ChannelAdminLogEvent}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: channels.channelParticipant
|
||||
description: Represents a channel participant
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipant
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents a channel participant
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The channel participant|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels_channelParticipant = ['_' => 'channels.channelParticipant', 'participant' => ChannelParticipant, 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels_channelParticipant={_='channels.channelParticipant', participant=ChannelParticipant, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: channels.channelParticipants
|
||||
description: Represents multiple channel participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipants
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Represents multiple channel participants
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|count|[int](../types/int.md) | Yes|Total number of participants that correspond to the given query|
|
||||
|participants|Array of [ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participants|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels_channelParticipants = ['_' => 'channels.channelParticipants', 'count' => int, 'participants' => [ChannelParticipant, ChannelParticipant], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels_channelParticipants={_='channels.channelParticipants', count=int, participants={ChannelParticipant}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: channels.channelParticipantsNotModified
|
||||
description: No new participant info could be found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipantsNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No new participant info could be found
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channels_channelParticipantsNotModified = ['_' => 'channels.channelParticipantsNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channels_channelParticipantsNotModified={_='channels.channelParticipantsNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: contacts.blocked
|
||||
description: Full list of blocked users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.blocked
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Full list of blocked users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.Blocked](../types/contacts.Blocked.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.blocked = ['_' => 'contacts.blocked', 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.blocked={_='contacts.blocked', blocked={ContactBlocked}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: contacts.blockedSlice
|
||||
description: Incomplete list of blocked users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.blockedSlice
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Incomplete list of blocked users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|count|[int](../types/int.md) | Yes|Total number of elements in the list|
|
||||
|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.Blocked](../types/contacts.Blocked.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.blockedSlice={_='contacts.blockedSlice', count=int, blocked={ContactBlocked}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: contacts.contacts
|
||||
description: The current user's contact list and info on users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.contacts
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The current user's contact list and info on users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [Contact](../types/Contact.md) | Yes|Contacts|
|
||||
|saved\_count|[int](../types/int.md) | Yes|Number of contacts that were saved successfully|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.Contacts](../types/contacts.Contacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'saved_count' => int, 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.contacts={_='contacts.contacts', contacts={Contact}, saved_count=int, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: contacts.contactsNotModified
|
||||
description: Contact list on the server is the same as the list on the client.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.contactsNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contact list on the server is the same as the list on the client.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.Contacts](../types/contacts.Contacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.contactsNotModified = ['_' => 'contacts.contactsNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.contactsNotModified={_='contacts.contactsNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: contacts.found
|
||||
description: Users found by name substring and auxiliary data.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.found
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Users found by name substring and auxiliary data.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|my\_results|Array of [Peer](../types/Peer.md) | Yes|My results|
|
||||
|results|Array of [Peer](../types/Peer.md) | Yes|Results|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.Found](../types/contacts.Found.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.found = ['_' => 'contacts.found', 'my_results' => [Peer, Peer], 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.found={_='contacts.found', my_results={Peer}, results={Peer}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: contacts.importedContacts
|
||||
description: Info on succesfully imported contacts.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.importedContacts
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Info on succesfully imported contacts.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|Imported|
|
||||
|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes|Popular invites|
|
||||
|retry\_contacts|Array of [long](../types/long.md) | Yes|Retry importing contacts whose client IDs appear here|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.ImportedContacts](../types/contacts.ImportedContacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'popular_invites' => [PopularContact, PopularContact], 'retry_contacts' => [long, long], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.importedContacts={_='contacts.importedContacts', imported={ImportedContact}, popular_invites={PopularContact}, retry_contacts={long}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: contacts.resolvedPeer
|
||||
description: Resolved peer
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.resolvedPeer
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Resolved peer
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Peer](../types/Peer.md) | Yes|The peer|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.ResolvedPeer](../types/contacts.ResolvedPeer.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.resolvedPeer = ['_' => 'contacts.resolvedPeer', 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.resolvedPeer={_='contacts.resolvedPeer', peer=Peer, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: contacts.topPeers
|
||||
description: Top peers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes|Categories|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.TopPeers](../types/contacts.TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.topPeers = ['_' => 'contacts.topPeers', 'categories' => [TopPeerCategoryPeers, TopPeerCategoryPeers], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.topPeers={_='contacts.topPeers', categories={TopPeerCategoryPeers}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: contacts.topPeersDisabled
|
||||
description: Top peers disabled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeersDisabled
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peers disabled
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.TopPeers](../types/contacts.TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.topPeersDisabled = ['_' => 'contacts.topPeersDisabled'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.topPeersDisabled={_='contacts.topPeersDisabled'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: contacts.topPeersNotModified
|
||||
description: Top peer info hasn't changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeersNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peer info hasn't changed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts.TopPeers](../types/contacts.TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts.topPeersNotModified = ['_' => 'contacts.topPeersNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts.topPeersNotModified={_='contacts.topPeersNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: contacts.blocked
|
||||
description: Full list of blocked users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.blocked
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Full list of blocked users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Blocked](../types/contacts_Blocked.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_blocked = ['_' => 'contacts.blocked', 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_blocked={_='contacts.blocked', blocked={ContactBlocked}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: contacts.blockedSlice
|
||||
description: Incomplete list of blocked users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.blockedSlice
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Incomplete list of blocked users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|count|[int](../types/int.md) | Yes|Total number of elements in the list|
|
||||
|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Blocked](../types/contacts_Blocked.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_blockedSlice={_='contacts.blockedSlice', count=int, blocked={ContactBlocked}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: contacts.contacts
|
||||
description: The current user's contact list and info on users.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.contacts
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
The current user's contact list and info on users.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [Contact](../types/Contact.md) | Yes|Contacts|
|
||||
|saved\_count|[int](../types/int.md) | Yes|Number of contacts that were saved successfully|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Contacts](../types/contacts_Contacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'saved_count' => int, 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_contacts={_='contacts.contacts', contacts={Contact}, saved_count=int, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contacts.contactsNotModified
|
||||
description: Contact list on the server is the same as the list on the client.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.contactsNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contact list on the server is the same as the list on the client.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Contacts](../types/contacts_Contacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_contactsNotModified = ['_' => 'contacts.contactsNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_contactsNotModified={_='contacts.contactsNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: contacts.found
|
||||
description: Users found by name substring and auxiliary data.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.found
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Users found by name substring and auxiliary data.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|my\_results|Array of [Peer](../types/Peer.md) | Yes|My results|
|
||||
|results|Array of [Peer](../types/Peer.md) | Yes|Results|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Found](../types/contacts_Found.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_found = ['_' => 'contacts.found', 'my_results' => [Peer, Peer], 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_found={_='contacts.found', my_results={Peer}, results={Peer}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: contacts.importedContacts
|
||||
description: Info on succesfully imported contacts.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.importedContacts
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Info on succesfully imported contacts.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|Imported|
|
||||
|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes|Popular invites|
|
||||
|retry\_contacts|Array of [long](../types/long.md) | Yes|Retry importing contacts whose client IDs appear here|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'popular_invites' => [PopularContact, PopularContact], 'retry_contacts' => [long, long], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_importedContacts={_='contacts.importedContacts', imported={ImportedContact}, popular_invites={PopularContact}, retry_contacts={long}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: contacts.resolvedPeer
|
||||
description: Resolved peer
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.resolvedPeer
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Resolved peer
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Peer](../types/Peer.md) | Yes|The peer|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_ResolvedPeer](../types/contacts_ResolvedPeer.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_resolvedPeer = ['_' => 'contacts.resolvedPeer', 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_resolvedPeer={_='contacts.resolvedPeer', peer=Peer, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: contacts.topPeers
|
||||
description: Top peers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes|Categories|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_topPeers = ['_' => 'contacts.topPeers', 'categories' => [TopPeerCategoryPeers, TopPeerCategoryPeers], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_topPeers={_='contacts.topPeers', categories={TopPeerCategoryPeers}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contacts.topPeersDisabled
|
||||
description: Top peers disabled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeersDisabled
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peers disabled
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_topPeersDisabled = ['_' => 'contacts.topPeersDisabled'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_topPeersDisabled={_='contacts.topPeersDisabled'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contacts.topPeersNotModified
|
||||
description: Top peer info hasn't changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.topPeersNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Top peer info hasn't changed
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_topPeersNotModified = ['_' => 'contacts.topPeersNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_topPeersNotModified={_='contacts.topPeersNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: help.appUpdate
|
||||
description: An update is available for the application.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.appUpdate
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
An update is available for the application.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_not\_skip|[Bool](../types/Bool.md) | Optional|Unskippable, the new info must be shown to the user (with a popup or something else)|
|
||||
|id|[int](../types/int.md) | Yes|Update ID|
|
||||
|version|[string](../types/string.md) | Yes|New version name|
|
||||
|text|[string](../types/string.md) | Yes|Text description of the update|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities|
|
||||
|document|[Document](../types/Document.md) | Optional|Attached document|
|
||||
|url|[string](../types/string.md) | Optional|Application download URL|
|
||||
|
||||
|
||||
|
||||
### Type: [help.AppUpdate](../types/help.AppUpdate.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.appUpdate = ['_' => 'help.appUpdate', 'can_not_skip' => Bool, 'id' => int, 'version' => 'string', 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'document' => Document, 'url' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.appUpdate={_='help.appUpdate', can_not_skip=Bool, id=int, version='string', text='string', entities={MessageEntity}, document=Document, url='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: help.configSimple
|
||||
description: Config simple
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.configSimple
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Config simple
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|expires|[int](../types/int.md) | Yes|Expires|
|
||||
|rules|Array of [AccessPointRule](../types/AccessPointRule.md) | Yes|Rules|
|
||||
|
||||
|
||||
|
||||
### Type: [help.ConfigSimple](../types/help.ConfigSimple.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.configSimple = ['_' => 'help.configSimple', 'date' => int, 'expires' => int, 'rules' => [AccessPointRule, AccessPointRule]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.configSimple={_='help.configSimple', date=int, expires=int, rules={AccessPointRule}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: help.deepLinkInfo
|
||||
description: Deep linking info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.deepLinkInfo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Deep linking info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|update\_app|[Bool](../types/Bool.md) | Optional|An update of the app is required to parse this link|
|
||||
|message|[string](../types/string.md) | Yes|Message to show to the user|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|
||||
|
||||
|
||||
|
||||
### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.deepLinkInfo = ['_' => 'help.deepLinkInfo', 'update_app' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.deepLinkInfo={_='help.deepLinkInfo', update_app=Bool, message='string', entities={MessageEntity}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: help.deepLinkInfoEmpty
|
||||
description: Deep link info empty
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.deepLinkInfoEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Deep link info empty
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.deepLinkInfoEmpty = ['_' => 'help.deepLinkInfoEmpty'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.deepLinkInfoEmpty={_='help.deepLinkInfoEmpty'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: help.inviteText
|
||||
description: Text of a text message with an invitation to install application.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.inviteText
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Text of a text message with an invitation to install application.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[string](../types/string.md) | Yes|Text of a message|
|
||||
|
||||
|
||||
|
||||
### Type: [help.InviteText](../types/help.InviteText.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.inviteText = ['_' => 'help.inviteText', 'message' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.inviteText={_='help.inviteText', message='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: help.noAppUpdate
|
||||
description: No updates are available for the application.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.noAppUpdate
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No updates are available for the application.
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [help.AppUpdate](../types/help.AppUpdate.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.noAppUpdate = ['_' => 'help.noAppUpdate'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.noAppUpdate={_='help.noAppUpdate'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: help.passportConfig
|
||||
description: Telegram [passport](https://core.telegram.org/passport) configuration
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.passportConfig
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Telegram [passport](https://core.telegram.org/passport) configuration
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)|
|
||||
|countries\_langs|[DataJSON](../types/DataJSON.md) | Yes|Localization|
|
||||
|
||||
|
||||
|
||||
### Type: [help.PassportConfig](../types/help.PassportConfig.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.passportConfig = ['_' => 'help.passportConfig', 'hash' => int, 'countries_langs' => DataJSON];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.passportConfig={_='help.passportConfig', hash=int, countries_langs=DataJSON}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: help.passportConfigNotModified
|
||||
description: Password configuration not modified
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.passportConfigNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Password configuration not modified
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [help.PassportConfig](../types/help.PassportConfig.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.passportConfigNotModified = ['_' => 'help.passportConfigNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.passportConfigNotModified={_='help.passportConfigNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: help.proxyDataEmpty
|
||||
description: No proxy was used to connect to tg (or none was provided to [initConnection](../methods/initConnection.md), or the used proxy doesn't have a promotion channel associated to it)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.proxyDataEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No proxy was used to connect to tg (or none was provided to [initConnection](../methods/initConnection.md), or the used proxy doesn't have a promotion channel associated to it)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|expires|[int](../types/int.md) | Yes|Expiration date of proxy info, will have to be refetched in `expires` seconds|
|
||||
|
||||
|
||||
|
||||
### Type: [help.ProxyData](../types/help.ProxyData.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.proxyDataEmpty = ['_' => 'help.proxyDataEmpty', 'expires' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.proxyDataEmpty={_='help.proxyDataEmpty', expires=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: help.proxyDataPromo
|
||||
description: Promotion channel associated to a certain MTProxy
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.proxyDataPromo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Promotion channel associated to a certain MTProxy
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|expires|[int](../types/int.md) | Yes|Expiration date of proxy info, will have to be refetched in `expires` seconds|
|
||||
|peer|[Peer](../types/Peer.md) | Yes|The promoted channel|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [help.ProxyData](../types/help.ProxyData.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.proxyDataPromo = ['_' => 'help.proxyDataPromo', 'expires' => int, 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.proxyDataPromo={_='help.proxyDataPromo', expires=int, peer=Peer, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: help.recentMeUrls
|
||||
description: Recent t.me URLs
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.recentMeUrls
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Recent t.me URLs
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|urls|Array of [RecentMeUrl](../types/RecentMeUrl.md) | Yes|URLs|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [help.RecentMeUrls](../types/help.RecentMeUrls.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.recentMeUrls = ['_' => 'help.recentMeUrls', 'urls' => [RecentMeUrl, RecentMeUrl], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.recentMeUrls={_='help.recentMeUrls', urls={RecentMeUrl}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: help.support
|
||||
description: Info on support user.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.support
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Info on support user.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|
||||
|user|[User](../types/User.md) | Optional|User|
|
||||
|
||||
|
||||
|
||||
### Type: [help.Support](../types/help.Support.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.support = ['_' => 'help.support', 'phone_number' => 'string', 'user' => User];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.support={_='help.support', phone_number='string', user=User}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: help.supportName
|
||||
description: Localized name for telegram support
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.supportName
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Localized name for telegram support
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|name|[string](../types/string.md) | Yes|Localized name|
|
||||
|
||||
|
||||
|
||||
### Type: [help.SupportName](../types/help.SupportName.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.supportName = ['_' => 'help.supportName', 'name' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.supportName={_='help.supportName', name='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: help.termsOfService
|
||||
description: Info about the latest telegram Terms Of Service
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.termsOfService
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Info about the latest telegram Terms Of Service
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|popup|[Bool](../types/Bool.md) | Optional|Whether a prompt must be showed to the user, in order to accept the new terms.|
|
||||
|id|[DataJSON](../types/DataJSON.md) | Yes|ID of the new terms|
|
||||
|text|[string](../types/string.md) | Yes|Text of the new terms|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities|
|
||||
|min\_age\_confirm|[int](../types/int.md) | Optional|Minimum age required to sign up to telegram, the user must confirm that they is older than the minimum age.|
|
||||
|
||||
|
||||
|
||||
### Type: [help.TermsOfService](../types/help.TermsOfService.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.termsOfService = ['_' => 'help.termsOfService', 'popup' => Bool, 'id' => DataJSON, 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'min_age_confirm' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.termsOfService={_='help.termsOfService', popup=Bool, id=DataJSON, text='string', entities={MessageEntity}, min_age_confirm=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: help.termsOfServiceUpdate
|
||||
description: Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update"
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.termsOfServiceUpdate
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update"
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds|
|
||||
|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Yes|New terms of service|
|
||||
|
||||
|
||||
|
||||
### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.termsOfServiceUpdate = ['_' => 'help.termsOfServiceUpdate', 'expires' => int, 'terms_of_service' => help.TermsOfService];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.termsOfServiceUpdate={_='help.termsOfServiceUpdate', expires=int, terms_of_service=help.TermsOfService}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: help.termsOfServiceUpdateEmpty
|
||||
description: No changes were made to telegram's terms of service
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.termsOfServiceUpdateEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No changes were made to telegram's terms of service
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds|
|
||||
|
||||
|
||||
|
||||
### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.termsOfServiceUpdateEmpty = ['_' => 'help.termsOfServiceUpdateEmpty', 'expires' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.termsOfServiceUpdateEmpty={_='help.termsOfServiceUpdateEmpty', expires=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: help.userInfo
|
||||
description: Internal use
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.userInfo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Internal use
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[string](../types/string.md) | Yes|Info|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities|
|
||||
|author|[string](../types/string.md) | Yes|Author|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|
||||
|
||||
|
||||
### Type: [help.UserInfo](../types/help.UserInfo.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.userInfo = ['_' => 'help.userInfo', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'author' => 'string', 'date' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.userInfo={_='help.userInfo', message='string', entities={MessageEntity}, author='string', date=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: help.userInfoEmpty
|
||||
description: Internal use
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: help.userInfoEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Internal use
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [help.UserInfo](../types/help.UserInfo.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$help.userInfoEmpty = ['_' => 'help.userInfoEmpty'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
help.userInfoEmpty={_='help.userInfoEmpty'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue