New docs
This commit is contained in:
parent
336c4d4aa0
commit
d942d12323
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: accountDaysTTL
|
||||
description: Account TTL in days
|
||||
description: Time to live in days of the current account
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: accountDaysTTL
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Account TTL in days
|
||||
Time to live in days of the current account
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|days|[int](../types/int.md) | Yes|Days|
|
||||
|days|[int](../types/int.md) | Yes|This account will self-destruct in the specified number of days|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.authorizationForm
|
||||
description: Telegram passport authorization form
|
||||
description: [Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizationForm
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Telegram passport authorization form
|
||||
[Telegram Passport](https://core.telegram.org/passport) authorization form
|
||||
|
||||
### Attributes:
|
||||
|
||||
@ -18,7 +18,7 @@ Telegram passport authorization form
|
||||
|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|Privacy policy URL|
|
||||
|privacy\_policy\_url|[string](../types/string.md) | Optional|URL of the service's privacy policy|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.authorizations
|
||||
description: Authorized clients for this account
|
||||
description: Logged-in sessions
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizations
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Authorized clients for this account
|
||||
Logged-in sessions
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.autoDownloadSettings
|
||||
description: Autodownload settings
|
||||
description: Media autodownload settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.autoDownloadSettings
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Autodownload settings
|
||||
Media autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low preset?|
|
||||
|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium preset?|
|
||||
|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High preset?|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.password
|
||||
description: Password
|
||||
description: Configuration for two-factor authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.password
|
||||
@ -8,23 +8,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Password
|
||||
Configuration for two-factor authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|has\_recovery|[Bool](../types/Bool.md) | Optional|Has recovery?|
|
||||
|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Has secure values?|
|
||||
|has\_password|[Bool](../types/Bool.md) | Optional|Has password?|
|
||||
|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|Current algo|
|
||||
|srp\_B|[bytes](../types/bytes.md) | Optional|Srp b|
|
||||
|srp\_id|[long](../types/long.md) | Optional|Srp ID|
|
||||
|hint|[string](../types/string.md) | Optional|Hint|
|
||||
|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|Email unconfirmed pattern|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|New algo|
|
||||
|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|New secure algo|
|
||||
|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.passwordInputSettings
|
||||
description: 2FA password settings
|
||||
description: Settings for setting up a new password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordInputSettings
|
||||
@ -8,17 +8,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
2FA password settings
|
||||
Settings for setting up a new password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|New algo|
|
||||
|new\_password\_hash|[bytes](../types/bytes.md) | Optional|`hash('sha256', $new_salt.$new_password.$new_salt, true)`|
|
||||
|hint|[string](../types/string.md) | Optional|Hint|
|
||||
|email|[string](../types/string.md) | Optional|Email|
|
||||
|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|New secure settings|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.passwordSettings
|
||||
description: Password settings
|
||||
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
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Password settings
|
||||
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|Email|
|
||||
|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Secure settings|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.sentEmailCode
|
||||
description: Sent email code
|
||||
description: The sent email code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.sentEmailCode
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent email code
|
||||
The sent email code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](../types/string.md) | Yes|Email pattern|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.takeout
|
||||
description: Takeout
|
||||
description: Takout info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.takeout
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Takeout
|
||||
Takout info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](../types/long.md) | Yes|ID|
|
||||
|id|[long](../types/long.md) | Yes|Takeout ID|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.themes
|
||||
description: Themes
|
||||
description: Installed themes
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themes
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Themes
|
||||
Installed themes
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|Hash|
|
||||
|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|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.themesNotModified
|
||||
description: Themes not modified
|
||||
description: No new themes were installed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.themesNotModified
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Themes not modified
|
||||
No new themes were installed
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.tmpPassword
|
||||
description: Tmp password
|
||||
description: Temporary payment password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.tmpPassword
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Tmp password
|
||||
Temporary payment password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_password|[bytes](../types/bytes.md) | Yes|Tmp password|
|
||||
|valid\_until|[int](../types/int.md) | Yes|Valid until|
|
||||
|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password|
|
||||
|valid\_until|[int](../types/int.md) | Yes|Validity period|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.wallPapers
|
||||
description: Wallpapers
|
||||
description: Installed wallpapers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapers
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Wallpapers
|
||||
Installed wallpapers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|Hash|
|
||||
|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|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.wallPapersNotModified
|
||||
description: No wallpapers were modified
|
||||
description: No new wallpapers were found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapersNotModified
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
No wallpapers were modified
|
||||
No new wallpapers were found
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: account.webAuthorizations
|
||||
description: Telegram login authorizations
|
||||
description: Web authorizations
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.webAuthorizations
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Telegram login authorizations
|
||||
Web authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.authorization
|
||||
description: Authorization
|
||||
description: Contains user authorization info.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorization
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Authorization
|
||||
Contains user authorization info.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_sessions|[int](../types/int.md) | Optional|Temporary sessions|
|
||||
|user|[User](../types/User.md) | Optional|User|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.authorizationSignUpRequired
|
||||
description: Signup is required
|
||||
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
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Signup is required
|
||||
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|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.codeTypeCall
|
||||
description: Auth code type: call
|
||||
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
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Auth code type: call
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.codeTypeFlashCall
|
||||
description: Auth code type: flash call
|
||||
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
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Auth code type: flash call
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.codeTypeSms
|
||||
description: Auth code type: SMS
|
||||
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
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Auth code type: SMS
|
||||
Type of verification code that will be sent next if you call the resendCode method: SMS code
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.exportedAuthorization
|
||||
description: Exported authorization
|
||||
description: Data for copying of authorization between data centres.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.exportedAuthorization
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Exported authorization
|
||||
Data for copying of authorization between data centres.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|bytes|[bytes](../types/bytes.md) | Yes|Bytes|
|
||||
|id|[int](../types/int.md) | Yes|current user identifier|
|
||||
|bytes|[bytes](../types/bytes.md) | Yes|authorizes key|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.passwordRecovery
|
||||
description: Password recovery
|
||||
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
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Password recovery
|
||||
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|Email pattern|
|
||||
|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).|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.sentCode
|
||||
description: Sent code
|
||||
description: Contains info about a sent verification code.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCode
|
||||
@ -8,16 +8,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent code
|
||||
Contains info about a sent verification code.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|type|[auth\_SentCodeType](../types/auth_SentCodeType.md) | Yes|Type|
|
||||
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash|
|
||||
|next\_type|[auth\_CodeType](../types/auth_CodeType.md) | Optional|Next type|
|
||||
|timeout|[int](../types/int.md) | Optional|Timeout|
|
||||
|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|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.sentCodeTypeApp
|
||||
description: Sent code type app
|
||||
description: The code was sent through the telegram app
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeApp
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent code type app
|
||||
The code was sent through the telegram app
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.sentCodeTypeCall
|
||||
description: Sent code type call
|
||||
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
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent code type call
|
||||
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|
|
||||
|length|[int](../types/int.md) | Yes|Length of the verification code|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.sentCodeTypeFlashCall
|
||||
description: Sent code type flash call
|
||||
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
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent code type flash call
|
||||
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|
|
||||
|pattern|[string](../types/string.md) | Yes|[pattern](https://core.telegram.org/api/pattern) to match|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: auth.sentCodeTypeSms
|
||||
description: Sent code type sms
|
||||
description: The code was sent via SMS
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSms
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Sent code type sms
|
||||
The code was sent via SMS
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|length|[int](../types/int.md) | Yes|Length of the code in bytes|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: authorization
|
||||
description: Authorization
|
||||
description: Logged-in session
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authorization
|
||||
@ -8,27 +8,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Authorization
|
||||
Logged-in session
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|current|[Bool](../types/Bool.md) | Optional|Current?|
|
||||
|official\_app|[Bool](../types/Bool.md) | Optional|Official app?|
|
||||
|password\_pending|[Bool](../types/Bool.md) | Optional|Password pending?|
|
||||
|hash|[long](../types/long.md) | Yes|Hash|
|
||||
|current|[Bool](../types/Bool.md) | Optional|Whether this is the current session|
|
||||
|official\_app|[Bool](../types/Bool.md) | Optional|Whether the session is from an official app|
|
||||
|password\_pending|[Bool](../types/Bool.md) | Optional|Whether the session is still waiting for a 2FA password|
|
||||
|hash|[long](../types/long.md) | Yes|Identifier|
|
||||
|device\_model|[string](../types/string.md) | Yes|Device model|
|
||||
|platform|[string](../types/string.md) | Yes|Platform|
|
||||
|system\_version|[string](../types/string.md) | Yes|System version|
|
||||
|api\_id|[int](../types/int.md) | Yes|Api ID|
|
||||
|api\_id|[int](../types/int.md) | Yes|[API ID](https://core.telegram.org/api/obtaining_api_id)|
|
||||
|app\_name|[string](../types/string.md) | Yes|App name|
|
||||
|app\_version|[string](../types/string.md) | Yes|App version|
|
||||
|date\_created|[int](../types/int.md) | Yes|Date created|
|
||||
|date\_active|[int](../types/int.md) | Yes|Date active|
|
||||
|ip|[string](../types/string.md) | Yes|Ip|
|
||||
|country|[string](../types/string.md) | Yes|Country|
|
||||
|region|[string](../types/string.md) | Yes|Region|
|
||||
|date\_created|[int](../types/int.md) | Yes|When was the session created|
|
||||
|date\_active|[int](../types/int.md) | Yes|When was the session last active|
|
||||
|ip|[string](../types/string.md) | Yes|Last known IP|
|
||||
|country|[string](../types/string.md) | Yes|Country determined from IP|
|
||||
|region|[string](../types/string.md) | Yes|Region determined from IP|
|
||||
|
||||
|
||||
|
||||
|
@ -14,13 +14,13 @@ Autodownload settings
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|disabled|[Bool](../types/Bool.md) | Optional|Disabled?|
|
||||
|video\_preload\_large|[Bool](../types/Bool.md) | Optional|Preload large videos?|
|
||||
|audio\_preload\_next|[Bool](../types/Bool.md) | Optional|Preload audios?|
|
||||
|phonecalls\_less\_data|[Bool](../types/Bool.md) | Optional|Use less data in phonecalls?|
|
||||
|photo\_size\_max|[int](../types/int.md) | Yes|Maximum photo file size to preload|
|
||||
|video\_size\_max|[int](../types/int.md) | Yes|Maximum video file size to preload|
|
||||
|file\_size\_max|[int](../types/int.md) | Yes|Maximum file size to preload|
|
||||
|disabled|[Bool](../types/Bool.md) | Optional|Disable automatic media downloads?|
|
||||
|video\_preload\_large|[Bool](../types/Bool.md) | Optional|Whether to preload the first seconds of videos larger than the specified limit|
|
||||
|audio\_preload\_next|[Bool](../types/Bool.md) | Optional|Whether to preload the next audio track when you're listening to music|
|
||||
|phonecalls\_less\_data|[Bool](../types/Bool.md) | Optional|Whether to enable data saving mode in phone calls|
|
||||
|photo\_size\_max|[int](../types/int.md) | Yes|Maximum size of photos to preload|
|
||||
|video\_size\_max|[int](../types/int.md) | Yes|Maximum size of videos to preload|
|
||||
|file\_size\_max|[int](../types/int.md) | Yes|Maximum size of other files to preload|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInfo
|
||||
description: Bot info
|
||||
description: Info about bots (available bot commands, etc)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInfo
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot info
|
||||
Info about bots (available bot commands, etc)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|description|[string](../types/string.md) | Yes|Description|
|
||||
|user\_id|[int](../types/int.md) | Yes|ID of the bot|
|
||||
|description|[string](../types/string.md) | Yes|Description of the bot|
|
||||
|commands|Array of [BotCommand](../types/BotCommand.md) | Yes|Commands|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMediaResult
|
||||
description: Bot inline media result
|
||||
description: Media result
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMediaResult
|
||||
@ -8,19 +8,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline media result
|
||||
Media result
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[string](../types/string.md) | Yes|ID|
|
||||
|type|[string](../types/string.md) | Yes|Type|
|
||||
|photo|[Photo](../types/Photo.md) | Optional|Photo|
|
||||
|document|[Document](../types/Document.md) | Optional|Document|
|
||||
|title|[string](../types/string.md) | Optional|Title|
|
||||
|id|[string](../types/string.md) | Yes|Result ID|
|
||||
|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))|
|
||||
|photo|[Photo](../types/Photo.md) | Optional|If type is `photo`, the photo to send|
|
||||
|document|[Document](../types/Document.md) | Optional|If type is `document`, the document to send|
|
||||
|title|[string](../types/string.md) | Optional|Result title|
|
||||
|description|[string](../types/string.md) | Optional|Description|
|
||||
|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Send message|
|
||||
|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Depending on the `type` and on the [constructor](../types/BotInlineMessage.md), contains the caption of the media or the content of the message to be sent **instead** of the media|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMessageMediaAuto
|
||||
description: Bot inline message media auto
|
||||
description: Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaAuto
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline message media auto
|
||||
Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[string](../types/string.md) | Yes|Message|
|
||||
|message|[string](../types/string.md) | Yes|Caption|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMessageMediaContact
|
||||
description: Bot inline message media contact
|
||||
description: Send a contact
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaContact
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline message media contact
|
||||
Send a contact
|
||||
|
||||
### Attributes:
|
||||
|
||||
@ -17,8 +17,8 @@ Bot inline message media contact
|
||||
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|
||||
|first\_name|[string](../types/string.md) | Yes|First name|
|
||||
|last\_name|[string](../types/string.md) | Yes|Last name|
|
||||
|vcard|[string](../types/string.md) | Yes|Vcard|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|vcard|[string](../types/string.md) | Yes|VCard info|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMessageMediaGeo
|
||||
description: Bot inline message media geo
|
||||
description: Send a geolocation
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaGeo
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline message media geo
|
||||
Send a geolocation
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geo|
|
||||
|period|[int](../types/int.md) | Yes|Period|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation|
|
||||
|period|[int](../types/int.md) | Yes|Validity period|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMessageMediaVenue
|
||||
description: Bot inline message media venue
|
||||
description: Send a venue
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaVenue
|
||||
@ -8,19 +8,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline message media venue
|
||||
Send a venue
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geo|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation of venue|
|
||||
|title|[string](../types/string.md) | Yes|Venue name|
|
||||
|address|[string](../types/string.md) | Yes|Address|
|
||||
|provider|[string](../types/string.md) | Yes|Provider|
|
||||
|venue\_id|[string](../types/string.md) | Yes|Venue ID|
|
||||
|venue\_type|[string](../types/string.md) | Yes|Venue type|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported|
|
||||
|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database|
|
||||
|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineMessageText
|
||||
description: Bot inline message text
|
||||
description: Send a simple text message
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageText
|
||||
@ -8,16 +8,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline message text
|
||||
Send a simple text message
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|no\_webpage|[Bool](../types/Bool.md) | Optional|No webpage?|
|
||||
|message|[string](../types/string.md) | Yes|Message|
|
||||
|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview|
|
||||
|message|[string](../types/string.md) | Yes|The message|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: botInlineResult
|
||||
description: Bot inline result
|
||||
description: Generic result
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineResult
|
||||
@ -8,19 +8,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Bot inline result
|
||||
Generic result
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[string](../types/string.md) | Yes|ID|
|
||||
|type|[string](../types/string.md) | Yes|Type|
|
||||
|title|[string](../types/string.md) | Optional|Title|
|
||||
|description|[string](../types/string.md) | Optional|Description|
|
||||
|url|[string](../types/string.md) | Optional|URL|
|
||||
|thumb|[WebDocument](../types/WebDocument.md) | Optional|Thumbnailnail|
|
||||
|content|[WebDocument](../types/WebDocument.md) | Optional|Content|
|
||||
|id|[string](../types/string.md) | Yes|Result ID|
|
||||
|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))|
|
||||
|title|[string](../types/string.md) | Optional|Result title|
|
||||
|description|[string](../types/string.md) | Optional|Result description|
|
||||
|url|[string](../types/string.md) | Optional|URL of article or webpage|
|
||||
|thumb|[WebDocument](../types/WebDocument.md) | Optional|Thumbnail for the result|
|
||||
|content|[WebDocument](../types/WebDocument.md) | Optional|Content of the result|
|
||||
|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Message to send|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: cdnConfig
|
||||
description: CDN configuration
|
||||
description: Configuration for [CDN](https://core.telegram.org/cdn) file downloads.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: cdnConfig
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
CDN configuration
|
||||
Configuration for [CDN](https://core.telegram.org/cdn) file downloads.
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: cdnPublicKey
|
||||
description: Cdn public key
|
||||
description: Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: cdnPublicKey
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Cdn public key
|
||||
Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|
||||
|public\_key|[string](../types/string.md) | Yes|Public key|
|
||||
|dc\_id|[int](../types/int.md) | Yes|[CDN DC](https://core.telegram.org/cdn) ID|
|
||||
|public\_key|[string](../types/string.md) | Yes|RSA public key|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channel
|
||||
description: Channel
|
||||
description: Channel/supergroup info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channel
|
||||
@ -8,36 +8,36 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel
|
||||
Channel/supergroup info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|creator|[Bool](../types/Bool.md) | Optional|Creator?|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Left?|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast?|
|
||||
|verified|[Bool](../types/Bool.md) | Optional|Verified?|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Megagroup?|
|
||||
|restricted|[Bool](../types/Bool.md) | Optional|Restricted?|
|
||||
|signatures|[Bool](../types/Bool.md) | Optional|Signatures?|
|
||||
|min|[Bool](../types/Bool.md) | Optional|Min?|
|
||||
|scam|[Bool](../types/Bool.md) | Optional|Scam channel|
|
||||
|has\_link|[Bool](../types/Bool.md) | Optional|Has linked chat?|
|
||||
|has\_geo|[Bool](../types/Bool.md) | Optional|Whether this is a geogroup|
|
||||
|slowmode\_enabled|[Bool](../types/Bool.md) | Optional|Whether slowmode is enabled|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of this channel|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Whether the current user has left this channel|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel?|
|
||||
|verified|[Bool](../types/Bool.md) | Optional|Is this channel verified by telegram?|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup?|
|
||||
|restricted|[Bool](../types/Bool.md) | Optional|Whether viewing/writing in this channel for a reason (see `restriction_reason`|
|
||||
|signatures|[Bool](../types/Bool.md) | Optional|Whether signatures are enabled (channels)|
|
||||
|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)|
|
||||
|scam|[Bool](../types/Bool.md) | Optional|This channel/supergroup is probably a scam|
|
||||
|has\_link|[Bool](../types/Bool.md) | Optional|Whether this channel has a private join link|
|
||||
|has\_geo|[Bool](../types/Bool.md) | Optional|Whether this chanel has a geoposition|
|
||||
|slowmode\_enabled|[Bool](../types/Bool.md) | Optional|Whether slow mode is enabled for groups to prevent flood in chat|
|
||||
|id|[int](../types/int.md) | Yes|ID of the channel|
|
||||
|access\_hash|[long](../types/long.md) | Optional|Access hash|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|username|[string](../types/string.md) | Optional|Username|
|
||||
|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Photo|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|version|[int](../types/int.md) | Yes|Version|
|
||||
|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Profile photo|
|
||||
|date|[int](../types/int.md) | Yes|Creation date|
|
||||
|version|[int](../types/int.md) | Yes|Version of the channel (always `0`)|
|
||||
|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Restriction reason|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of current user|
|
||||
|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Banned rights of current user|
|
||||
|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Global chat banned rights|
|
||||
|participants\_count|[int](../types/int.md) | Optional|Participants count|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))|
|
||||
|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Banned rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))|
|
||||
|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Default chat rights (see [rights](https://core.telegram.org/api/rights))|
|
||||
|participants\_count|[int](../types/int.md) | Optional|Participant count|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEvent
|
||||
description: Channel admin log event
|
||||
description: Admin log event
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEvent
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel admin log event
|
||||
Admin log event
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](../types/long.md) | Yes|ID|
|
||||
|id|[long](../types/long.md) | Yes|Event ID|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|action|[ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) | Yes|Action|
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeAbout
|
||||
description: Change about text
|
||||
description: The description was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeAbout
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Change about text
|
||||
The description was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Previous value|
|
||||
|new\_value|[string](../types/string.md) | Yes|New value|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Previous description|
|
||||
|new\_value|[string](../types/string.md) | Yes|New description|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeLinkedChat
|
||||
description: Linked chat was changed
|
||||
description: The linked chat was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeLinkedChat
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Linked chat was changed
|
||||
The linked chat was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[int](../types/int.md) | Yes|Old linked chat|
|
||||
|prev\_value|[int](../types/int.md) | Yes|Previous linked chat|
|
||||
|new\_value|[int](../types/int.md) | Yes|New linked chat|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeLocation
|
||||
description: Channel location changed
|
||||
description: The geogroup location was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeLocation
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel location changed
|
||||
The geogroup location was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|Previous value|
|
||||
|new\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|New value|
|
||||
|prev\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|Previous location|
|
||||
|new\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|New location|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangePhoto
|
||||
description: Change photo
|
||||
description: The channel/supergroup's picture was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangePhoto
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Change photo
|
||||
The channel/supergroup's picture was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_photo|[Photo](../types/Photo.md) | Optional|Old photo|
|
||||
|new\_photo|[Photo](../types/Photo.md) | Optional|New photo|
|
||||
|prev\_photo|[Photo](../types/Photo.md) | Optional|Previous picture|
|
||||
|new\_photo|[Photo](../types/Photo.md) | Optional|New picture|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeStickerSet
|
||||
description: Change stickerset
|
||||
description: The supergroup's stickerset was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeStickerSet
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Change stickerset
|
||||
The supergroup's stickerset was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeTitle
|
||||
description: Change title
|
||||
description: Channel/supergroup title was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeTitle
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Change title
|
||||
Channel/supergroup title was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Previous value|
|
||||
|new\_value|[string](../types/string.md) | Yes|New value|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Previous title|
|
||||
|new\_value|[string](../types/string.md) | Yes|New title|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionChangeUsername
|
||||
description: Change username
|
||||
description: Channel/supergroup username was changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeUsername
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Change username
|
||||
Channel/supergroup username was changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Prev value|
|
||||
|new\_value|[string](../types/string.md) | Yes|New value|
|
||||
|prev\_value|[string](../types/string.md) | Yes|Old username|
|
||||
|new\_value|[string](../types/string.md) | Yes|New username|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionDefaultBannedRights
|
||||
description: Changed global chat rights
|
||||
description: The default banned rights were modified
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionDefaultBannedRights
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Changed global chat rights
|
||||
The default banned rights were modified
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Previous Banned rights of current user|
|
||||
|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New Banned rights of current user|
|
||||
|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Previous global [banned rights](https://core.telegram.org/api/rights)|
|
||||
|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New glboal [banned rights](https://core.telegram.org/api/rights).|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionDeleteMessage
|
||||
description: Delete message
|
||||
description: A message was deleted
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionDeleteMessage
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Delete message
|
||||
A message was deleted
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[Message](../types/Message.md) | Optional|Message|
|
||||
|message|[Message](../types/Message.md) | Optional|The message that was deleted|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionEditMessage
|
||||
description: Edit message
|
||||
description: A message was edited
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionEditMessage
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Edit message
|
||||
A message was edited
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_message|[Message](../types/Message.md) | Optional|Prev message|
|
||||
|prev\_message|[Message](../types/Message.md) | Optional|Old message|
|
||||
|new\_message|[Message](../types/Message.md) | Optional|New message|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionParticipantInvite
|
||||
description: Invite participant
|
||||
description: A user was invited to the group
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionParticipantInvite
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Invite participant
|
||||
A user was invited to the group
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participant|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The user that was invited|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionParticipantJoin
|
||||
description: Joined participant
|
||||
description: A user has joined the group (in the case of big groups, info of the user that has joined isn't shown)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionParticipantJoin
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Joined participant
|
||||
A user has joined the group (in the case of big groups, info of the user that has joined isn't shown)
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionParticipantLeave
|
||||
description: Left participant
|
||||
description: A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionParticipantLeave
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Left participant
|
||||
A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown)
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionParticipantToggleAdmin
|
||||
description: Admin toggled
|
||||
description: The admin [rights](https://core.telegram.org/api/rights) of a user were changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionParticipantToggleAdmin
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Admin toggled
|
||||
The admin [rights](https://core.telegram.org/api/rights) of a user were changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Prev participant|
|
||||
|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New participant|
|
||||
|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Previous admin rights|
|
||||
|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New admin rights|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionParticipantToggleBan
|
||||
description: User banned
|
||||
description: The banned [rights](https://core.telegram.org/api/rights) of a user were changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionParticipantToggleBan
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
User banned
|
||||
The banned [rights](https://core.telegram.org/api/rights) of a user were changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Prev participant|
|
||||
|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New participant|
|
||||
|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Old banned rights of user|
|
||||
|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New banned rights of user|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionStopPoll
|
||||
description: Stopped poll
|
||||
description: A poll was stopped
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionStopPoll
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Stopped poll
|
||||
A poll was stopped
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[Message](../types/Message.md) | Optional|Message|
|
||||
|message|[Message](../types/Message.md) | Optional|The poll that was stopped|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionToggleInvites
|
||||
description: Invite setting toggled
|
||||
description: Invites were enabled/disabled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionToggleInvites
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Invite setting toggled
|
||||
Invites were enabled/disabled
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionTogglePreHistoryHidden
|
||||
description: Previous history hidden
|
||||
description: The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionTogglePreHistoryHidden
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Previous history hidden
|
||||
The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md)
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionToggleSignatures
|
||||
description: Toggle channel signatures
|
||||
description: Channel signatures were enabled/disabled
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionToggleSignatures
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Toggle channel signatures
|
||||
Channel signatures were enabled/disabled
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_value|[Bool](../types/Bool.md) | Yes|New value?|
|
||||
|new\_value|[Bool](../types/Bool.md) | Yes|New value|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionToggleSlowMode
|
||||
description: Channel admin log event action toggle slow mode
|
||||
description: [Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionToggleSlowMode
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel admin log event action toggle slow mode
|
||||
[Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[int](../types/int.md) | Yes|Prev value|
|
||||
|new\_value|[int](../types/int.md) | Yes|New value|
|
||||
|prev\_value|[int](../types/int.md) | Yes|Previous slow mode value|
|
||||
|new\_value|[int](../types/int.md) | Yes|New slow mode value|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventActionUpdatePinned
|
||||
description: Message pinned
|
||||
description: A message was pinned
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionUpdatePinned
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Message pinned
|
||||
A message was pinned
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[Message](../types/Message.md) | Optional|Message|
|
||||
|message|[Message](../types/Message.md) | Optional|The message that was pinned|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelAdminLogEventsFilter
|
||||
description: Event filter
|
||||
description: Filter only certain admin log events
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventsFilter
|
||||
@ -8,26 +8,26 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Event filter
|
||||
Filter only certain admin log events
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|join|[Bool](../types/Bool.md) | Optional|Join users events|
|
||||
|leave|[Bool](../types/Bool.md) | Optional|Left users events|
|
||||
|invite|[Bool](../types/Bool.md) | Optional|Invite users events|
|
||||
|ban|[Bool](../types/Bool.md) | Optional|Ban events|
|
||||
|unban|[Bool](../types/Bool.md) | Optional|Unban events|
|
||||
|kick|[Bool](../types/Bool.md) | Optional|Kicked users events|
|
||||
|unkick|[Bool](../types/Bool.md) | Optional|Unkick events|
|
||||
|promote|[Bool](../types/Bool.md) | Optional|Admin promotion events|
|
||||
|demote|[Bool](../types/Bool.md) | Optional|Demote admin events|
|
||||
|info|[Bool](../types/Bool.md) | Optional|Change info events|
|
||||
|settings|[Bool](../types/Bool.md) | Optional|Setting changes|
|
||||
|pinned|[Bool](../types/Bool.md) | Optional|Pinned message events|
|
||||
|edit|[Bool](../types/Bool.md) | Optional|Edit message events|
|
||||
|delete|[Bool](../types/Bool.md) | Optional|Delete message events|
|
||||
|join|[Bool](../types/Bool.md) | Optional|[Join events](../constructors/channelAdminLogEventActionParticipantJoin.md)|
|
||||
|leave|[Bool](../types/Bool.md) | Optional|[Leave events](../constructors/channelAdminLogEventActionParticipantLeave.md)|
|
||||
|invite|[Bool](../types/Bool.md) | Optional|[Invite events](../constructors/channelAdminLogEventActionParticipantInvite.md)|
|
||||
|ban|[Bool](../types/Bool.md) | Optional|[Ban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)|
|
||||
|unban|[Bool](../types/Bool.md) | Optional|[Unban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)|
|
||||
|kick|[Bool](../types/Bool.md) | Optional|[Kick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)|
|
||||
|unkick|[Bool](../types/Bool.md) | Optional|[Unkick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)|
|
||||
|promote|[Bool](../types/Bool.md) | Optional|[Admin promotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)|
|
||||
|demote|[Bool](../types/Bool.md) | Optional|[Admin demotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)|
|
||||
|info|[Bool](../types/Bool.md) | Optional|Info change events (when [about](../constructors/channelAdminLogEventActionChangeAbout.md), [linked chat](../constructors/channelAdminLogEventActionChangeLinkedChat.md), [location](../constructors/channelAdminLogEventActionChangeLocation.md), [photo](../constructors/channelAdminLogEventActionChangePhoto.md), [stickerset](../constructors/channelAdminLogEventActionChangeStickerSet.md), [title](../constructors/channelAdminLogEventActionChangeTitle.md) or [username](../constructors/channelAdminLogEventActionChangeUsername.md) data of a channel gets modified)|
|
||||
|settings|[Bool](../types/Bool.md) | Optional|Settings change events ([invites](../constructors/channelAdminLogEventActionToggleInvites.md), [hidden prehistory](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md), [signatures](../constructors/channelAdminLogEventActionToggleSignatures.md), [default banned rights](../constructors/channelAdminLogEventActionDefaultBannedRights.md))|
|
||||
|pinned|[Bool](../types/Bool.md) | Optional|[Message pin events](../constructors/channelAdminLogEventActionUpdatePinned.md)|
|
||||
|edit|[Bool](../types/Bool.md) | Optional|[Message edit events](../constructors/channelAdminLogEventActionEditMessage.md)|
|
||||
|delete|[Bool](../types/Bool.md) | Optional|[Message deletion events](../constructors/channelAdminLogEventActionDeleteMessage.md)|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelForbidden
|
||||
description: Forbidden channel
|
||||
description: Indicates a channel/supergroup we can't access because we were banned, or for some other reason.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelForbidden
|
||||
@ -8,18 +8,18 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Forbidden channel
|
||||
Indicates a channel/supergroup we can't access because we were banned, or for some other reason.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast?|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Megagroup?|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup|
|
||||
|id|[int](../types/int.md) | Yes|Channel ID|
|
||||
|access\_hash|[long](../types/long.md) | Yes|Access hash|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|until\_date|[int](../types/int.md) | Optional|Until date|
|
||||
|until\_date|[int](../types/int.md) | Optional|The ban is valid until the specified date|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelFull
|
||||
description: Full channel
|
||||
description: Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelFull
|
||||
@ -8,44 +8,44 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Full channel
|
||||
Full info about a [channel/supergroup](https://core.telegram.org/api/channel)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_view\_participants|[Bool](../types/Bool.md) | Optional|Can view participants?|
|
||||
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can set username?|
|
||||
|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can set group stickerset?|
|
||||
|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Hidden prehistory?|
|
||||
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can view stats?|
|
||||
|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can set location?|
|
||||
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Has scheduled messages?|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|about|[string](../types/string.md) | Yes|About|
|
||||
|participants\_count|[int](../types/int.md) | Optional|Participants count|
|
||||
|admins\_count|[int](../types/int.md) | Optional|Admins count|
|
||||
|kicked\_count|[int](../types/int.md) | Optional|Kicked count|
|
||||
|banned\_count|[int](../types/int.md) | Optional|Banned count|
|
||||
|online\_count|[int](../types/int.md) | Optional|Online count|
|
||||
|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Read inbox max ID|
|
||||
|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Read outbox max ID|
|
||||
|unread\_count|[int](../types/int.md) | Yes|Unread count|
|
||||
|chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo|
|
||||
|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notify settings|
|
||||
|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Exported invite|
|
||||
|can\_view\_participants|[Bool](../types/Bool.md) | Optional|Can we vew the participant list?|
|
||||
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we set the channel's username?|
|
||||
|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can we [associate](../methods/channels.setStickers.md) a stickerpack to the supergroup?|
|
||||
|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Is the history before we joined hidden to us?|
|
||||
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user call [messages.getStatsURL](../methods/messages.getStatsURL.md) on this channel|
|
||||
|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can we set the geolocation of this group (for geogroups)|
|
||||
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available|
|
||||
|id|[int](../types/int.md) | Yes|ID of the channel|
|
||||
|about|[string](../types/string.md) | Yes|Info about the channel|
|
||||
|participants\_count|[int](../types/int.md) | Optional|Number of participants of the channel|
|
||||
|admins\_count|[int](../types/int.md) | Optional|Number of channel admins|
|
||||
|kicked\_count|[int](../types/int.md) | Optional|Number of users [kicked](https://core.telegram.org/api/rights) from the channel|
|
||||
|banned\_count|[int](../types/int.md) | Optional|Number of users [banned](https://core.telegram.org/api/rights) from the channel|
|
||||
|online\_count|[int](../types/int.md) | Optional|Number of users currently online|
|
||||
|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.|
|
||||
|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.|
|
||||
|unread\_count|[int](../types/int.md) | Yes|Count of unread messages|
|
||||
|chat\_photo|[Photo](../types/Photo.md) | Optional|Channel picture|
|
||||
|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings|
|
||||
|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Invite link|
|
||||
|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes|Bot info|
|
||||
|migrated\_from\_chat\_id|[int](../types/int.md) | Optional|Migrated from chat ID|
|
||||
|migrated\_from\_max\_id|[int](../types/int.md) | Optional|Migrated from max ID|
|
||||
|pinned\_msg\_id|[int](../types/int.md) | Optional|Pinned msg ID|
|
||||
|stickerset|[StickerSet](../types/StickerSet.md) | Optional|Stickerset|
|
||||
|available\_min\_id|[int](../types/int.md) | Optional|Available min ID|
|
||||
|migrated\_from\_chat\_id|[int](../types/int.md) | Optional|The chat ID from which this group was [migrated](https://core.telegram.org/api/channel)|
|
||||
|migrated\_from\_max\_id|[int](../types/int.md) | Optional|The message ID in the original chat at which this group was [migrated](https://core.telegram.org/api/channel)|
|
||||
|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message|
|
||||
|stickerset|[StickerSet](../types/StickerSet.md) | Optional|Associated stickerset|
|
||||
|available\_min\_id|[int](../types/int.md) | Optional|Identifier of a maximum unavailable message in a channel due to hidden history.|
|
||||
|folder\_id|[int](../types/int.md) | Optional|Folder ID|
|
||||
|linked\_chat\_id|[int](../types/int.md) | Optional|Linked chat ID|
|
||||
|location|[ChannelLocation](../types/ChannelLocation.md) | Optional|Location|
|
||||
|linked\_chat\_id|[int](../types/int.md) | Optional|ID of the linked discussion chat for channels|
|
||||
|location|[ChannelLocation](../types/ChannelLocation.md) | Optional|Location of the geogroup|
|
||||
|slowmode\_seconds|[int](../types/int.md) | Optional|If specified, users in supergroups will only be able to send one message every `slowmode_seconds` seconds|
|
||||
|slowmode\_next\_send\_date|[int](../types/int.md) | Optional| Indicates when the user will be allowed to send another message in the supergroup (unixdate)|
|
||||
|pts|[int](../types/int.md) | Yes|PTS|
|
||||
|slowmode\_next\_send\_date|[int](../types/int.md) | Optional|Indicates when the user will be allowed to send another message in the supergroup (unixdate)|
|
||||
|pts|[int](../types/int.md) | Yes|Latest [PTS](https://core.telegram.org/api/updates) for this channel|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelLocation
|
||||
description: Physical location (getchats)
|
||||
description: Geographical location of supergroup (geogroups)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelLocation
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Physical location (getchats)
|
||||
Geographical location of supergroup (geogroups)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|geo\_point|[GeoPoint](../types/GeoPoint.md) | Optional|Geo point|
|
||||
|address|[string](../types/string.md) | Yes|Physical address|
|
||||
|geo\_point|[GeoPoint](../types/GeoPoint.md) | Optional|Geographical location of supergrup|
|
||||
|address|[string](../types/string.md) | Yes|Textual description of the address|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelLocationEmpty
|
||||
description: No physical location (normal chat/channel)
|
||||
description: No location (normal supergroup)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelLocationEmpty
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
No physical location (normal chat/channel)
|
||||
No location (normal supergroup)
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelMessagesFilter
|
||||
description: Channel messages filter
|
||||
description: Filter for getting only certain types of channel messages
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMessagesFilter
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel messages filter
|
||||
Filter for getting only certain types of channel messages
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|exclude\_new\_messages|[Bool](../types/Bool.md) | Optional|Exclude new messages?|
|
||||
|exclude\_new\_messages|[Bool](../types/Bool.md) | Optional|Whether to exclude new messages from the search|
|
||||
|ranges|Array of [MessageRange](../types/MessageRange.md) | Yes|Ranges|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelMessagesFilterEmpty
|
||||
description: Empty channel messages filter
|
||||
description: No filter
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelMessagesFilterEmpty
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Empty channel messages filter
|
||||
No filter
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipant
|
||||
description: Channel participant
|
||||
description: Channel/supergroup participant
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipant
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant
|
||||
Channel/supergroup participant
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|user\_id|[int](../types/int.md) | Yes|Pariticipant user ID|
|
||||
|date|[int](../types/int.md) | Yes|Date joined|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantAdmin
|
||||
description: Channel participant admin
|
||||
description: Admin
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantAdmin
|
||||
@ -8,20 +8,20 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant admin
|
||||
Admin
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_edit|[Bool](../types/Bool.md) | Optional|Can edit?|
|
||||
|self|[Bool](../types/Bool.md) | Optional|Is this the current user?|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|inviter\_id|[int](../types/int.md) | Optional|Inviter ID|
|
||||
|promoted\_by|[int](../types/int.md) | Yes|Promoted by|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|Admin rights|
|
||||
|rank|[string](../types/string.md) | Optional|Admin's rank, an arbitrary string|
|
||||
|can\_edit|[Bool](../types/Bool.md) | Optional|Can this admin promote other admins with the same permissions?|
|
||||
|self|[Bool](../types/Bool.md) | Optional|Is this the current user|
|
||||
|user\_id|[int](../types/int.md) | Yes|Admin user ID|
|
||||
|inviter\_id|[int](../types/int.md) | Optional|User that invited the admin to the channel/group|
|
||||
|promoted\_by|[int](../types/int.md) | Yes|User that promoted the user to admin|
|
||||
|date|[int](../types/int.md) | Yes|When did the user join|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|Admin [rights](https://core.telegram.org/api/rights)|
|
||||
|rank|[string](../types/string.md) | Optional|The role (rank) of the admin in the group: just an arbitrary string, `admin` by default|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantBanned
|
||||
description: Channel participant banned
|
||||
description: Banned/kicked user
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantBanned
|
||||
@ -8,17 +8,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant banned
|
||||
Banned/kicked user
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Left?|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Whether the user has left the group|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|kicked\_by|[int](../types/int.md) | Yes|Kicked by|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Banned rights|
|
||||
|kicked\_by|[int](../types/int.md) | Yes|User was kicked by the specified admin|
|
||||
|date|[int](../types/int.md) | Yes|When did the user join the group|
|
||||
|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Banned [rights](https://core.telegram.org/api/rights)|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantCreator
|
||||
description: Channel participant creator
|
||||
description: Channel/supergroup creator
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantCreator
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant creator
|
||||
Channel/supergroup creator
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|rank|[string](../types/string.md) | Optional|Creator rank, an arbitrary string|
|
||||
|rank|[string](../types/string.md) | Optional|The role (rank) of the group creator in the group: just an arbitrary string, `admin` by default|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantSelf
|
||||
description: Channel participant self
|
||||
description: Myself
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantSelf
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant self
|
||||
Myself
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|Inviter ID|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|User that invited me to the channel/supergroup|
|
||||
|date|[int](../types/int.md) | Yes|When did I join the channel/supergroup|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsAdmins
|
||||
description: Channel participants admins
|
||||
description: Fetch only admin participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsAdmins
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants admins
|
||||
Fetch only admin participants
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsBanned
|
||||
description: Channel participants banned
|
||||
description: Fetch only banned participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsBanned
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants banned
|
||||
Fetch only banned participants
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|q|[string](../types/string.md) | Yes|Query|
|
||||
|q|[string](../types/string.md) | Yes|Optional filter for searching banned participants by name (otherwise empty)|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsBots
|
||||
description: Channel participants bots
|
||||
description: Fetch only bot participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsBots
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants bots
|
||||
Fetch only bot participants
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsContacts
|
||||
description: Contacts
|
||||
description: Fetch only participants that are also contacts
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsContacts
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Contacts
|
||||
Fetch only participants that are also contacts
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|q|[string](../types/string.md) | Yes|Query|
|
||||
|q|[string](../types/string.md) | Yes|Optional search query for searching contact participants by name|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsKicked
|
||||
description: Channel participants kicked
|
||||
description: Fetch only kicked participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsKicked
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants kicked
|
||||
Fetch only kicked participants
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|q|[string](../types/string.md) | Yes|Query|
|
||||
|q|[string](../types/string.md) | Yes|Optional filter for searching kicked participants by name (otherwise empty)|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsRecent
|
||||
description: Channel participants recent
|
||||
description: Fetch only recent participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsRecent
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants recent
|
||||
Fetch only recent participants
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channelParticipantsSearch
|
||||
description: Channel participants search
|
||||
description: Query participants by name
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelParticipantsSearch
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants search
|
||||
Query participants by name
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|q|[string](../types/string.md) | Yes|Query|
|
||||
|q|[string](../types/string.md) | Yes|Search query|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channels.adminLogResults
|
||||
description: Admin log results
|
||||
description: Admin log events
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.adminLogResults
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Admin log results
|
||||
Admin log events
|
||||
|
||||
### Attributes:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channels.channelParticipant
|
||||
description: Channel participant
|
||||
description: Represents a channel participant
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipant
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participant
|
||||
Represents a channel participant
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participant|
|
||||
|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The channel participant|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channels.channelParticipants
|
||||
description: Channel participants
|
||||
description: Represents multiple channel participants
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipants
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants
|
||||
Represents multiple channel participants
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|count|[int](../types/int.md) | Yes|Count|
|
||||
|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|
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: channels.channelParticipantsNotModified
|
||||
description: Channel participants not modified
|
||||
description: No new participant info could be found
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channels.channelParticipantsNotModified
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Channel participants not modified
|
||||
No new participant info could be found
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chat
|
||||
description: Chat
|
||||
description: Info about a group
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chat
|
||||
@ -8,25 +8,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat
|
||||
Info about a group
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|creator|[Bool](../types/Bool.md) | Optional|Creator?|
|
||||
|kicked|[Bool](../types/Bool.md) | Optional|Kicked?|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Left?|
|
||||
|deactivated|[Bool](../types/Bool.md) | Optional|Deactivated?|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of the group|
|
||||
|kicked|[Bool](../types/Bool.md) | Optional|Whether the current user was kicked from the group|
|
||||
|left|[Bool](../types/Bool.md) | Optional|Whether the current user has left the group|
|
||||
|deactivated|[Bool](../types/Bool.md) | Optional|Whether the group was [migrated](https://core.telegram.org/api/channel)|
|
||||
|id|[int](../types/int.md) | Yes|ID of the group|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Photo|
|
||||
|participants\_count|[int](../types/int.md) | Yes|Participants count|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|version|[int](../types/int.md) | Yes|Version|
|
||||
|migrated\_to|[InputChannel](../types/InputChannel.md) | Optional|Migrated to|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of current user|
|
||||
|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Global chat banned rights|
|
||||
|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Chat photo|
|
||||
|participants\_count|[int](../types/int.md) | Yes|Participant count|
|
||||
|date|[int](../types/int.md) | Yes|Date of creation of the group|
|
||||
|version|[int](../types/int.md) | Yes|Used in basic groups to reorder updates and make sure that all of them were received.|
|
||||
|migrated\_to|[InputChannel](../types/InputChannel.md) | Optional|Means this chat was [upgraded](https://core.telegram.org/api/channel) to a supergroup|
|
||||
|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|[Admin rights](https://core.telegram.org/api/rights) of the user in the group|
|
||||
|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|[Default banned rights](https://core.telegram.org/api/rights) of all users in the group|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatAdminRights
|
||||
description: Admin rights
|
||||
description: Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel).
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatAdminRights
|
||||
@ -8,20 +8,20 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Admin rights
|
||||
Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel).
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|change\_info|[Bool](../types/Bool.md) | Optional|Can change info?|
|
||||
|post\_messages|[Bool](../types/Bool.md) | Optional|Can post messages?|
|
||||
|edit\_messages|[Bool](../types/Bool.md) | Optional|Can edit messages?|
|
||||
|delete\_messages|[Bool](../types/Bool.md) | Optional|Can delete messages?|
|
||||
|ban\_users|[Bool](../types/Bool.md) | Optional|Can ban users?|
|
||||
|invite\_users|[Bool](../types/Bool.md) | Optional|Can invite users?|
|
||||
|pin\_messages|[Bool](../types/Bool.md) | Optional|Can pin messages?|
|
||||
|add\_admins|[Bool](../types/Bool.md) | Optional|Can add other admins?|
|
||||
|change\_info|[Bool](../types/Bool.md) | Optional|If set, allows the admin to modify the description of the [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|post\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to post messages in the [channel](https://core.telegram.org/api/channel)|
|
||||
|edit\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also edit messages from other admins in the [channel](https://core.telegram.org/api/channel)|
|
||||
|delete\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also delete messages from other admins in the [channel](https://core.telegram.org/api/channel)|
|
||||
|ban\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to ban users from the [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|invite\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to invite users in the [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to pin messages in the [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|add\_admins|[Bool](../types/Bool.md) | Optional|If set, allows the admin to add other admins with the same (or more limited) permissions in the [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatBannedRights
|
||||
description: Banned rights (when true, the user will NOT be able to do that thing)
|
||||
description: Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatBannedRights
|
||||
@ -8,25 +8,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Banned rights (when true, the user will NOT be able to do that thing)
|
||||
Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|view\_messages|[Bool](../types/Bool.md) | Optional|Can view messages?|
|
||||
|send\_messages|[Bool](../types/Bool.md) | Optional|Can send messages?|
|
||||
|send\_media|[Bool](../types/Bool.md) | Optional|Can send media?|
|
||||
|send\_stickers|[Bool](../types/Bool.md) | Optional|Can send stickers?|
|
||||
|send\_gifs|[Bool](../types/Bool.md) | Optional|Can send gifs?|
|
||||
|send\_games|[Bool](../types/Bool.md) | Optional|Can send games?|
|
||||
|send\_inline|[Bool](../types/Bool.md) | Optional|Can use inline bots?|
|
||||
|embed\_links|[Bool](../types/Bool.md) | Optional|Can embed links?|
|
||||
|send\_polls|[Bool](../types/Bool.md) | Optional|Can send polls?|
|
||||
|change\_info|[Bool](../types/Bool.md) | Optional|Can change info?|
|
||||
|invite\_users|[Bool](../types/Bool.md) | Optional|Can invite users?|
|
||||
|pin\_messages|[Bool](../types/Bool.md) | Optional|Can pin messages?|
|
||||
|until\_date|[int](../types/int.md) | Yes|Until date (0 = forever)|
|
||||
|view\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to view messages in a [supergroup/channel/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send messages in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_media|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send any media in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_stickers|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_gifs|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send gifs in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_games|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send games in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_inline|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to use inline bots in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|embed\_links|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to embed links in the messages of a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|send\_polls|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|change\_info|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to change the description of a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|invite\_users|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to invite users in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to pin messages in a [supergroup/chat](https://core.telegram.org/api/channel)|
|
||||
|until\_date|[int](../types/int.md) | Yes|Validity of said permissions (0 = forever, forever = 2^31-1 for now).|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatEmpty
|
||||
description: Empty chat
|
||||
description: Empty constructor, group doesn't exist
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatEmpty
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Empty chat
|
||||
Empty constructor, group doesn't exist
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|id|[int](../types/int.md) | Yes|Group identifier|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatForbidden
|
||||
description: Chat forbidden
|
||||
description: A group to which the user has no access. E.g., because the user was kicked from the group.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatForbidden
|
||||
@ -8,14 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat forbidden
|
||||
A group to which the user has no access. E.g., because the user was kicked from the group.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|id|[int](../types/int.md) | Yes|User identifier|
|
||||
|title|[string](../types/string.md) | Yes|Group name|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatFull
|
||||
description: Chat full
|
||||
description: Detailed chat info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatFull
|
||||
@ -8,22 +8,22 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat full
|
||||
Detailed chat info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can set username?|
|
||||
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Has scheduled messages?|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|about|[string](../types/string.md) | Yes|Chat about|
|
||||
|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Participants|
|
||||
|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we change the username of this chat|
|
||||
|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available|
|
||||
|id|[int](../types/int.md) | Yes|ID of the chat|
|
||||
|about|[string](../types/string.md) | Yes|About string for this chat|
|
||||
|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Participant list|
|
||||
|chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo|
|
||||
|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notify settings|
|
||||
|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Exported invite|
|
||||
|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings|
|
||||
|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Chat invite|
|
||||
|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Optional|Bot info|
|
||||
|pinned\_msg\_id|[int](../types/int.md) | Optional|Pinned msg ID|
|
||||
|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message|
|
||||
|folder\_id|[int](../types/int.md) | Optional|Folder ID|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatInvite
|
||||
description: Chat invite
|
||||
description: Chat invite info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatInvite
|
||||
@ -8,19 +8,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat invite
|
||||
Chat invite info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|channel|[Bool](../types/Bool.md) | Optional|Channel?|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast?|
|
||||
|public|[Bool](../types/Bool.md) | Optional|Public?|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Megagroup?|
|
||||
|title|[string](../types/string.md) | Yes|Title|
|
||||
|photo|[Photo](../types/Photo.md) | Optional|Photo|
|
||||
|participants\_count|[int](../types/int.md) | Yes|Participants count|
|
||||
|channel|[Bool](../types/Bool.md) | Optional|Whether this is a [channel/supergroup](https://core.telegram.org/api/channel) or a [normal group](https://core.telegram.org/api/channel)|
|
||||
|broadcast|[Bool](../types/Bool.md) | Optional|Whether this is a [channel](https://core.telegram.org/api/channel)|
|
||||
|public|[Bool](../types/Bool.md) | Optional|Whether this is a public [channel/supergroup](https://core.telegram.org/api/channel)|
|
||||
|megagroup|[Bool](../types/Bool.md) | Optional|Whether this is a [supergroup](https://core.telegram.org/api/channel)|
|
||||
|title|[string](../types/string.md) | Yes|Chat/supergroup/channel title|
|
||||
|photo|[Photo](../types/Photo.md) | Optional|Chat/supergroup/channel photo|
|
||||
|participants\_count|[int](../types/int.md) | Yes|Participant count|
|
||||
|participants|Array of [User](../types/User.md) | Optional|Participants|
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatInviteAlready
|
||||
description: Invite of a chat of which I am already member
|
||||
description: The user has already joined this chat
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatInviteAlready
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Invite of a chat of which I am already member
|
||||
The user has already joined this chat
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|chat|[Chat](../types/Chat.md) | Optional|Chat|
|
||||
|chat|[Chat](../types/Chat.md) | Optional|The chat connected to the invite|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatInviteEmpty
|
||||
description: Empty chat invite
|
||||
description: No info is associated to the chat invite
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatInviteEmpty
|
||||
@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Empty chat invite
|
||||
No info is associated to the chat invite
|
||||
|
||||
|
||||
|
||||
|
@ -14,7 +14,7 @@ Exported chat invite
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|link|[string](../types/string.md) | Yes|Link|
|
||||
|link|[string](../types/string.md) | Yes|Chat invitation link|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatOnlines
|
||||
description: Chat onlines
|
||||
description: Number of online users in a chat
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatOnlines
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat onlines
|
||||
Number of online users in a chat
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|onlines|[int](../types/int.md) | Yes|Onlines|
|
||||
|onlines|[int](../types/int.md) | Yes|Number of online users|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatParticipant
|
||||
description: Chat participant
|
||||
description: Group member.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatParticipant
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat participant
|
||||
Group member.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|Inviter ID|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|user\_id|[int](../types/int.md) | Yes|Member user ID|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|ID of the user that added the member to the group|
|
||||
|date|[int](../types/int.md) | Yes|Date added to the group|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatParticipantAdmin
|
||||
description: Chat participant admin
|
||||
description: Chat admin
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatParticipantAdmin
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat participant admin
|
||||
Chat admin
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|Inviter ID|
|
||||
|date|[int](../types/int.md) | Yes|Date|
|
||||
|user\_id|[int](../types/int.md) | Yes|ID of a group member that is admin|
|
||||
|inviter\_id|[int](../types/int.md) | Yes|ID of the user that added the member to the group|
|
||||
|date|[int](../types/int.md) | Yes|Date when the user was added|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatParticipantCreator
|
||||
description: Chat participant creator
|
||||
description: Represents the creator of the group
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatParticipantCreator
|
||||
@ -8,13 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat participant creator
|
||||
Represents the creator of the group
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|user\_id|[int](../types/int.md) | Yes|ID of the user that created the group|
|
||||
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: chatParticipants
|
||||
description: Chat participants
|
||||
description: Group members.
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: chatParticipants
|
||||
@ -8,15 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
|
||||
|
||||
|
||||
Chat participants
|
||||
Group members.
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|chat\_id|[int](../types/int.md) | Yes|Chat ID|
|
||||
|chat\_id|[int](../types/int.md) | Yes|Group identifier|
|
||||
|participants|Array of [ChatParticipant](../types/ChatParticipant.md) | Yes|Participants|
|
||||
|version|[int](../types/int.md) | Yes|Version|
|
||||
|version|[int](../types/int.md) | Yes|Group version number|
|
||||
|
||||
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user