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

Improve documentation

Browse Source
This commit is contained in:
Daniil Gentili 2018-08-29 11:18:25 +02:00
parent 2dc6793d16
commit a0090a2c56
3967 changed files with 16993 additions and 16966 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/API_docs/methods/account_acceptAuthorization.md
View File

@ -11,13 +11,13 @@ Accept telegram passport authorization
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|bot\_id|[int](../types/int.md) | Yes|Bot ID|
|scope|[string](../types/string.md) | Yes|Scope|
|public\_key|[string](../types/string.md) | Yes|The bot's RSA public key|
|value\_hashes|Array of [SecureValueHash](../types/SecureValueHash.md) | Yes|Hashes of the encrypted credentials|
|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Yes|Encrypted secure credentials|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|bot\_id|[int](../types/int.md) | Bot ID | Yes|
|scope|[string](../types/string.md) | Scope | Yes|
|public\_key|[string](../types/string.md) | The bot's RSA public key | Yes|
|value\_hashes|Array of [SecureValueHash](../types/SecureValueHash.md) | Hashes of the encrypted credentials | Yes|
|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Encrypted secure credentials | Yes|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/account_changePhone.md
View File

@ -11,11 +11,11 @@ Change the phone number associated to this account
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode|
|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | Phone number | Yes|
|phone\_code\_hash|[string](../types/string.md) | Phone code hash returned by account.sendChangePhoneCode | Yes|
|phone\_code|[string](../types/string.md) | The phone code sent by account.sendChangePhoneCode | Yes|
### Return type: [User](../types/User.md)

6
docs/API_docs/methods/account_checkUsername.md
View File

@ -11,9 +11,9 @@ Check if this username is available
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|username|[string](../types/string.md) | Yes|The username to check|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|username|[string](../types/string.md) | The username to check | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_confirmPhone.md
View File

@ -11,10 +11,10 @@ Confirm this phone number is associated to this account, obtain phone_code_hash
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode|
|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_code\_hash|[string](../types/string.md) | obtain phone_code_hash from sendConfirmPhoneCode | Yes|
|phone\_code|[string](../types/string.md) | The code sent by sendConfirmPhoneCode | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_deleteAccount.md
View File

@ -11,9 +11,9 @@ Delete this account
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|reason|[string](../types/string.md) | Yes|Why are you going away? :(|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|reason|[string](../types/string.md) | Why are you going away? :( | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_deleteSecureValue.md
View File

@ -11,9 +11,9 @@ Delete secure telegram passport value
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|The values to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|types|Array of [SecureValueType](../types/SecureValueType.md) | The values to delete | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_finishTakeoutSession.md
View File

@ -11,9 +11,9 @@ Finish account exporting session
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|success|[Bool](../types/Bool.md) | Optional|Did the data export succeed?|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|success|[Bool](../types/Bool.md) | Did the data export succeed? | Optional|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/account_getAuthorizationForm.md
View File

@ -11,11 +11,11 @@ Bots only: get telegram passport authorization form
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|bot\_id|[int](../types/int.md) | Yes|Bot ID|
|scope|[string](../types/string.md) | Yes|Scope|
|public\_key|[string](../types/string.md) | Yes|Bot's public key|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|bot\_id|[int](../types/int.md) | Bot ID | Yes|
|scope|[string](../types/string.md) | Scope | Yes|
|public\_key|[string](../types/string.md) | Bot's public key | Yes|
### Return type: [account\_AuthorizationForm](../types/account_AuthorizationForm.md)

6
docs/API_docs/methods/account_getNotifySettings.md
View File

@ -11,9 +11,9 @@ Get notification settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source |
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Notification source | Yes|
### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md)

6
docs/API_docs/methods/account_getPasswordSettings.md
View File

@ -11,9 +11,9 @@ Get the current 2FA settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|current\_password\_hash|[bytes](../types/bytes.md) | Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);` | Yes|
### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md)

6
docs/API_docs/methods/account_getPrivacy.md
View File

@ -11,9 +11,9 @@ Get privacy settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Privacy setting key | Yes|
### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md)

6
docs/API_docs/methods/account_getSecureValue.md
View File

@ -11,9 +11,9 @@ Get secure value for telegram passport
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|Get telegram passport secure parameters|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|types|Array of [SecureValueType](../types/SecureValueType.md) | Get telegram passport secure parameters | Yes|
### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md)

8
docs/API_docs/methods/account_getTmpPassword.md
View File

@ -11,10 +11,10 @@ Get temporary password for buying products through bots
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash|
|period|[int](../types/int.md) | Yes|The validity period|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|password\_hash|[bytes](../types/bytes.md) | The password hash | Yes|
|period|[int](../types/int.md) | The validity period | Yes|
### Return type: [account\_TmpPassword](../types/account_TmpPassword.md)

18
docs/API_docs/methods/account_initTakeoutSession.md
View File

@ -11,15 +11,15 @@ Start account exporting session
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|contacts|[Bool](../types/Bool.md) | Optional|Export contacts?|
|message\_users|[Bool](../types/Bool.md) | Optional|Export users?|
|message\_chats|[Bool](../types/Bool.md) | Optional|Export chats?|
|message\_megagroups|[Bool](../types/Bool.md) | Optional|Export supergroups?|
|message\_channels|[Bool](../types/Bool.md) | Optional|Export channel messages?|
|files|[Bool](../types/Bool.md) | Optional|Export files?|
|file\_max\_size|[int](../types/int.md) | Optional|Export only files smaller than this size|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|contacts|[Bool](../types/Bool.md) | Export contacts? | Optional|
|message\_users|[Bool](../types/Bool.md) | Export users? | Optional|
|message\_chats|[Bool](../types/Bool.md) | Export chats? | Optional|
|message\_megagroups|[Bool](../types/Bool.md) | Export supergroups? | Optional|
|message\_channels|[Bool](../types/Bool.md) | Export channel messages? | Optional|
|files|[Bool](../types/Bool.md) | Export files? | Optional|
|file\_max\_size|[int](../types/int.md) | Export only files smaller than this size | Optional|
### Return type: [account\_Takeout](../types/account_Takeout.md)

14
docs/API_docs/methods/account_registerDevice.md
View File

@ -11,13 +11,13 @@ Register device for push notifications
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info|
|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info|
|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|secret|[bytes](../types/bytes.md) | Yes|Secret|
|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|token\_type|[int](../types/int.md) | Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info | Yes|
|token|[string](../types/string.md) | Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info | Yes|
|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes|
|secret|[bytes](../types/bytes.md) | Secret | Yes|
|other\_uids|Array of [int](../types/int.md) | Other UIDs | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_reportPeer.md
View File

@ -11,10 +11,10 @@ Report for spam
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report|
|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional|
|reason|[ReportReason](../types/ReportReason.md) | Why are you reporting this peer | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_resetAuthorization.md
View File

@ -11,9 +11,9 @@ Delete a certain session
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|hash|[long](../types/long.md) | The session hash, obtained from $MadelineProto->account->getAuthorizations | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_resetWebAuthorization.md
View File

@ -11,9 +11,9 @@ Delete a certain telegram web login authorization
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|hash|[long](../types/long.md) | Yes|The authorization's hash|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|hash|[long](../types/long.md) | The authorization's hash | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_saveSecureValue.md
View File

@ -11,10 +11,10 @@ Save telegram passport secure value
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|value|[InputSecureValue](../types/InputSecureValue.md) | Yes|Encrypted value|
|secure\_secret\_id|[long](../types/long.md) | Yes|Secret|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|value|[InputSecureValue](../types/InputSecureValue.md) | Encrypted value | Yes|
|secure\_secret\_id|[long](../types/long.md) | Secret | Yes|
### Return type: [SecureValue](../types/SecureValue.md)

10
docs/API_docs/methods/account_sendChangePhoneCode.md
View File

@ -11,11 +11,11 @@ Change the phone number
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?|
|phone\_number|[string](../types/string.md) | Yes|New phone number|
|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|allow\_flashcall|[Bool](../types/Bool.md) | Can the code be sent using a flash call instead of an SMS? | Optional|
|phone\_number|[string](../types/string.md) | New phone number | Yes|
|current\_number|[Bool](../types/Bool.md) | Current phone number | Optional|
### Return type: [auth\_SentCode](../types/auth_SentCode.md)

10
docs/API_docs/methods/account_sendConfirmPhoneCode.md
View File

@ -11,11 +11,11 @@ Send confirmation phone code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?|
|hash|[string](../types/string.md) | Yes|The hash|
|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|allow\_flashcall|[Bool](../types/Bool.md) | Can telegram call you instead of sending an SMS? | Optional|
|hash|[string](../types/string.md) | The hash | Yes|
|current\_number|[Bool](../types/Bool.md) | The current phone number | Optional|
### Return type: [auth\_SentCode](../types/auth_SentCode.md)

6
docs/API_docs/methods/account_sendVerifyEmailCode.md
View File

@ -11,9 +11,9 @@ Send email verification code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|email|[string](../types/string.md) | Yes|Email|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|email|[string](../types/string.md) | Email | Yes|
### Return type: [account\_SentEmailCode](../types/account_SentEmailCode.md)

10
docs/API_docs/methods/account_sendVerifyPhoneCode.md
View File

@ -11,11 +11,11 @@ Send phone verification code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Allow phone calls?|
|phone\_number|[string](../types/string.md) | Yes|The phone number|
|current\_number|[Bool](../types/Bool.md) | Optional|Is this the current number?|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|allow\_flashcall|[Bool](../types/Bool.md) | Allow phone calls? | Optional|
|phone\_number|[string](../types/string.md) | The phone number | Yes|
|current\_number|[Bool](../types/Bool.md) | Is this the current number? | Optional|
### Return type: [auth\_SentCode](../types/auth_SentCode.md)

6
docs/API_docs/methods/account_setAccountTTL.md
View File

@ -11,9 +11,9 @@ Set account TTL
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Time To Live of account | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_setPrivacy.md
View File

@ -11,10 +11,10 @@ Set privacy settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting|
|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Privacy setting | Yes|
|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Privacy settings | Yes|
### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md)

10
docs/API_docs/methods/account_unregisterDevice.md
View File

@ -11,11 +11,11 @@ Stop sending PUSH notifications to app
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info|
|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info|
|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|token\_type|[int](../types/int.md) | Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info | Yes|
|token|[string](../types/string.md) | Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info | Yes|
|other\_uids|Array of [int](../types/int.md) | Other UIDs | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_updateDeviceLocked.md
View File

@ -11,9 +11,9 @@ Disable all notifications for a certain period
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|period|[int](../types/int.md) | Yes|For how long should notifications be disabled|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|period|[int](../types/int.md) | For how long should notifications be disabled | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_updateNotifySettings.md
View File

@ -11,10 +11,10 @@ Change notification settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied|
|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | The peers to which the notification settings should be applied | Yes|
|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Notification settings | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/account_updatePasswordSettings.md
View File

@ -11,10 +11,10 @@ Update the 2FA password settings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`|
|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|current\_password\_hash|[bytes](../types/bytes.md) | Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);` | Yes|
|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | New 2FA settings | Yes|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/account_updateProfile.md
View File

@ -11,11 +11,11 @@ Update profile info
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|first\_name|[string](../types/string.md) | Optional|The first name|
|last\_name|[string](../types/string.md) | Optional|The last name|
|about|[string](../types/string.md) | Optional|The bio/about field|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|first\_name|[string](../types/string.md) | The first name | Optional|
|last\_name|[string](../types/string.md) | The last name | Optional|
|about|[string](../types/string.md) | The bio/about field | Optional|
### Return type: [User](../types/User.md)

6
docs/API_docs/methods/account_updateStatus.md
View File

@ -11,9 +11,9 @@ Update online status
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|offline|[Bool](../types/Bool.md) | offline to set the status to offline | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/account_updateUsername.md
View File

@ -11,9 +11,9 @@ Update this user's username
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|username|[string](../types/string.md) | Yes|The new username|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|username|[string](../types/string.md) | The new username | Yes|
### Return type: [User](../types/User.md)

8
docs/API_docs/methods/account_verifyEmail.md
View File

@ -11,10 +11,10 @@ Verify email address
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|email|[string](../types/string.md) | Yes|The email address|
|code|[string](../types/string.md) | Yes|The received code|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|email|[string](../types/string.md) | The email address | Yes|
|code|[string](../types/string.md) | The received code | Yes|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/account_verifyPhone.md
View File

@ -11,11 +11,11 @@ Verify phone number
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|The phone number|
|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash returned by account.sendVerifyPhoneCode|
|phone\_code|[string](../types/string.md) | Yes|The phone code type returned by account.sendVerifyPhoneCode|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | The phone number | Yes|
|phone\_code\_hash|[string](../types/string.md) | The phone code hash returned by account.sendVerifyPhoneCode | Yes|
|phone\_code|[string](../types/string.md) | The phone code type returned by account.sendVerifyPhoneCode | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/auth_cancelCode.md
View File

@ -11,10 +11,10 @@ Invalidate sent phone code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | Phone number | Yes|
|phone\_code\_hash|[string](../types/string.md) | Phone code hash | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/auth_dropTempAuthKeys.md
View File

@ -11,9 +11,9 @@ Delete all temporary authorization keys except the ones provided
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|except\_auth\_keys|Array of [long](../types/long.md) | The temporary authorization keys to keep | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/auth_recoverPassword.md
View File

@ -11,9 +11,9 @@ Use the code that was emailed to you after running $MadelineProto->auth->request
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|code|[string](../types/string.md) | Yes|The code that was emailed to you|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|code|[string](../types/string.md) | The code that was emailed to you | Yes|
### Return type: [auth\_Authorization](../types/auth_Authorization.md)

8
docs/API_docs/methods/auth_resendCode.md
View File

@ -11,10 +11,10 @@ Resend the SMS verification code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|The phone number|
|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | The phone number | Yes|
|phone\_code\_hash|[string](../types/string.md) | The phone code hash | Yes|
### Return type: [auth\_SentCode](../types/auth_SentCode.md)

8
docs/API_docs/methods/bots_answerWebhookJSONQuery.md
View File

@ -11,10 +11,10 @@ Send webhook request via bot API
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|query\_id|[long](../types/long.md) | Yes|The query ID|
|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|query\_id|[long](../types/long.md) | The query ID | Yes|
|data|[DataJSON](../types/DataJSON.md) | The parameters | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/bots_sendCustomRequest.md
View File

@ -11,10 +11,10 @@ Send a custom request to the bot API
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|custom\_method|[string](../types/string.md) | Yes|The method to call|
|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|custom\_method|[string](../types/string.md) | The method to call | Yes|
|params|[DataJSON](../types/DataJSON.md) | Method parameters | Yes|
### Return type: [DataJSON](../types/DataJSON.md)

8
docs/API_docs/methods/channels_checkUsername.md
View File

@ -11,10 +11,10 @@ Check if this username is free and can be assigned to a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|username|[string](../types/string.md) | The new username for this channel/supergroup | Yes|
### Return type: [Bool](../types/Bool.md)

12
docs/API_docs/methods/channels_createChannel.md
View File

@ -11,12 +11,12 @@ Create channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel|
|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup|
|title|[string](../types/string.md) | Yes|Supergroup/channel title|
|about|[string](../types/string.md) | Yes|About text|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|broadcast|[Bool](../types/Bool.md) | Set this to true to create a channel | Optional|
|megagroup|[Bool](../types/Bool.md) | Set this to true to create a supergroup | Optional|
|title|[string](../types/string.md) | Supergroup/channel title | Yes|
|about|[string](../types/string.md) | About text | Yes|
### Return type: [Updates](../types/Updates.md)

6
docs/API_docs/methods/channels_deleteChannel.md
View File

@ -11,9 +11,9 @@ Delete a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup to delete | Optional|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_deleteHistory.md
View File

@ -11,10 +11,10 @@ Delete the history of a supergroup/channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|max\_id|[int](../types/int.md) | Yes|Maximum message ID to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|max\_id|[int](../types/int.md) | Maximum message ID to delete | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/channels_deleteMessages.md
View File

@ -11,10 +11,10 @@ Delete channel/supergroup messages
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|id|Array of [int](../types/int.md) | The IDs of messages to delete | Yes|
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)

8
docs/API_docs/methods/channels_deleteUserHistory.md
View File

@ -11,10 +11,10 @@ Delete all messages of a user in a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional|
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)

8
docs/API_docs/methods/channels_editAbout.md
View File

@ -11,10 +11,10 @@ Edit the about text of a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|about|[string](../types/string.md) | Yes|The new about text|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|about|[string](../types/string.md) | The new about text | Yes|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/channels_editAdmin.md
View File

@ -11,11 +11,11 @@ Edit admin permissions of a user in a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional|
|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | The new admin rights | Yes|
### Return type: [Updates](../types/Updates.md)

10
docs/API_docs/methods/channels_editBanned.md
View File

@ -11,11 +11,11 @@ Kick or ban a user from a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban|
|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to kick/ban | Optional|
|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Banned/kicked permissions | Yes|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_editPhoto.md
View File

@ -11,10 +11,10 @@ Edit the photo of a supergroup/channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new photo | Optional|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_editTitle.md
View File

@ -11,10 +11,10 @@ Edit the title of a supergroup/channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|title|[string](../types/string.md) | Yes|The new channel/supergroup title|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|title|[string](../types/string.md) | The new channel/supergroup title | Yes|
### Return type: [Updates](../types/Updates.md)

6
docs/API_docs/methods/channels_exportInvite.md
View File

@ -11,9 +11,9 @@ Export the invite link of a channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)

10
docs/API_docs/methods/channels_exportMessageLink.md
View File

@ -11,11 +11,11 @@ Get the link of a message in a channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|[int](../types/int.md) | Yes|The ID of the message|
|grouped|[Bool](../types/Bool.md) | Yes|Is this an album?|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|id|[int](../types/int.md) | The ID of the message | Yes|
|grouped|[Bool](../types/Bool.md) | Is this an album? | Yes|
### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md)

18
docs/API_docs/methods/channels_getAdminLog.md
View File

@ -11,15 +11,15 @@ Get admin log of a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|q|[string](../types/string.md) | Yes|Search query|
|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter|
|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins|
|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch|
|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch|
|limit|[int](../types/int.md) | Yes|Number of results to fetch|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|q|[string](../types/string.md) | Search query | Yes|
|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Event filter | Optional|
|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Fetch only actions from these admins | Optional|
|max\_id|[long](../types/long.md) | Maximum message ID to fetch | Yes|
|min\_id|[long](../types/long.md) | Minimum message ID to fetch | Yes|
|limit|[int](../types/int.md) | Number of results to fetch | Yes|
### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md)

6
docs/API_docs/methods/channels_getChannels.md
View File

@ -11,9 +11,9 @@ Get info about multiple channels/supergroups
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup MTProto IDs | Yes|
### Return type: [messages\_Chats](../types/messages_Chats.md)

6
docs/API_docs/methods/channels_getLeftChannels.md
View File

@ -11,9 +11,9 @@ Get all channels you left
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|offset|[int](../types/int.md) | Offset | Yes|
### Return type: [messages\_Chats](../types/messages_Chats.md)

8
docs/API_docs/methods/channels_getMessages.md
View File

@ -11,10 +11,10 @@ Get channel/supergroup messages
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The message IDs|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The message IDs | Yes|
### Return type: [messages\_Messages](../types/messages_Messages.md)

8
docs/API_docs/methods/channels_getParticipant.md
View File

@ -11,10 +11,10 @@ Get info about a certain channel/supergroup participant
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to fetch info about | Optional|
### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md)

14
docs/API_docs/methods/channels_getParticipants.md
View File

@ -11,13 +11,13 @@ Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_cha
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter|
|offset|[int](../types/int.md) | Yes|Offset|
|limit|[int](../types/int.md) | Yes|Limit|
|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Member filter | Yes|
|offset|[int](../types/int.md) | Offset | Yes|
|limit|[int](../types/int.md) | Limit | Yes|
|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched participant IDs) | Yes|
### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)

8
docs/API_docs/methods/channels_inviteToChannel.md
View File

@ -11,10 +11,10 @@ Add users to channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add | Yes|
### Return type: [Updates](../types/Updates.md)

6
docs/API_docs/methods/channels_joinChannel.md
View File

@ -11,9 +11,9 @@ Join a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup to join | Optional|
### Return type: [Updates](../types/Updates.md)

6
docs/API_docs/methods/channels_leaveChannel.md
View File

@ -11,9 +11,9 @@ Leave a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup to leave | Optional|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_readHistory.md
View File

@ -11,10 +11,10 @@ Mark channel/supergroup history as read
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/channels_readMessageContents.md
View File

@ -11,10 +11,10 @@ Mark channel/supergroup messages as read
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|id|Array of [int](../types/int.md) | Yes|List of message IDs|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|id|Array of [int](../types/int.md) | List of message IDs | Yes|
### Return type: [Bool](../types/Bool.md)

10
docs/API_docs/methods/channels_reportSpam.md
View File

@ -11,11 +11,11 @@ Report a message in a supergroup/channel for spam
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages|
|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that sent the messages | Optional|
|id|Array of [int](../types/int.md) | The IDs of messages to report | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/channels_setStickers.md
View File

@ -11,10 +11,10 @@ Set the supergroup/channel stickerpack
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup|
|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergoup | Optional|
|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/channels_toggleInvites.md
View File

@ -11,10 +11,10 @@ Allow or disallow any user to invite users to this channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|enabled|[Bool](../types/Bool.md) | Allow or disallow | Yes|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_togglePreHistoryHidden.md
View File

@ -11,10 +11,10 @@ Enable or disable hidden history for new channel/supergroup users
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|enabled|[Bool](../types/Bool.md) | Enable or disable hidden history for new channel/supergroup users | Yes|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_toggleSignatures.md
View File

@ -11,10 +11,10 @@ Toggle channel signatures
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|enabled|[Bool](../types/Bool.md) | Enable or disable channel signatures? | Yes|
### Return type: [Updates](../types/Updates.md)

10
docs/API_docs/methods/channels_updatePinnedMessage.md
View File

@ -11,11 +11,11 @@ Set the pinned message of a channel/supergroup
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|silent|[Bool](../types/Bool.md) | Optional|Pin silently|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|[int](../types/int.md) | Yes|The ID of the message to pin|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|silent|[Bool](../types/Bool.md) | Pin silently | Optional|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|id|[int](../types/int.md) | The ID of the message to pin | Yes|
### Return type: [Updates](../types/Updates.md)

8
docs/API_docs/methods/channels_updateUsername.md
View File

@ -11,10 +11,10 @@ Update the username of a supergroup/channel
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|username|[string](../types/string.md) | Yes|The new username|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|username|[string](../types/string.md) | The new username | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/contacts_block.md
View File

@ -11,9 +11,9 @@ Block a user
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to block|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to block | Optional|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/contacts_deleteContact.md
View File

@ -11,9 +11,9 @@ Delete a contact
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The contact to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contact to delete | Optional|
### Return type: [contacts\_Link](../types/contacts_Link.md)

6
docs/API_docs/methods/contacts_deleteContacts.md
View File

@ -11,9 +11,9 @@ Delete multiple contacts
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The contacts to delete|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contacts to delete | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/contacts_getBlocked.md
View File

@ -11,10 +11,10 @@ Get blocked users
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched|
|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|offset|[int](../types/int.md) | Initially 0, then set to the number of blocked contacts previously fetched | Yes|
|limit|[int](../types/int.md) | How many blocked contacts to fetch | Yes|
### Return type: [contacts\_Blocked](../types/contacts_Blocked.md)

6
docs/API_docs/methods/contacts_getContacts.md
View File

@ -11,9 +11,9 @@ Get all contacts
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|hash|[int](../types/int.md) | $ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);` | Yes|
### Return type: [contacts\_Contacts](../types/contacts_Contacts.md)

22
docs/API_docs/methods/contacts_getTopPeers.md
View File

@ -11,17 +11,17 @@ Get most used chats
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?|
|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?|
|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?|
|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?|
|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?|
|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?|
|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`|
|limit|[int](../types/int.md) | Yes|How many results to fetch|
|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|correspondents|[Bool](../types/Bool.md) | Fetch users? | Optional|
|bots\_pm|[Bool](../types/Bool.md) | Fetch bots? | Optional|
|bots\_inline|[Bool](../types/Bool.md) | Fetch inline bots? | Optional|
|phone\_calls|[Bool](../types/Bool.md) | Fetch phone calls? | Optional|
|groups|[Bool](../types/Bool.md) | Fetch groups? | Optional|
|channels|[Bool](../types/Bool.md) | Fetch channels and supergroups? | Optional|
|offset|[int](../types/int.md) | Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];` | Yes|
|limit|[int](../types/int.md) | How many results to fetch | Yes|
|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(previously fetched peer ids); | Yes|
### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md)

6
docs/API_docs/methods/contacts_importCard.md
View File

@ -11,9 +11,9 @@ Import card as contact
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|export\_card|Array of [int](../types/int.md) | Yes|The card|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|export\_card|Array of [int](../types/int.md) | The card | Yes|
### Return type: [User](../types/User.md)

6
docs/API_docs/methods/contacts_importContacts.md
View File

@ -11,9 +11,9 @@ Add phone number as contact
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes|
### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md)

8
docs/API_docs/methods/contacts_resetTopPeerRating.md
View File

@ -11,10 +11,10 @@ Reset top peer rating for a certain category/peer
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category |
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|category|[TopPeerCategory](../types/TopPeerCategory.md) | The category | Yes|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/contacts_search.md
View File

@ -11,10 +11,10 @@ Search contacts
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|q|[string](../types/string.md) | Yes|The search query|
|limit|[int](../types/int.md) | Yes|How many results should be returned|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|q|[string](../types/string.md) | The search query | Yes|
|limit|[int](../types/int.md) | How many results should be returned | Yes|
### Return type: [contacts\_Found](../types/contacts_Found.md)

6
docs/API_docs/methods/contacts_toggleTopPeers.md
View File

@ -11,9 +11,9 @@ Toggle top peers
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable top peer|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|enabled|[Bool](../types/Bool.md) | Enable or disable top peer | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/contacts_unblock.md
View File

@ -11,9 +11,9 @@ Unblock a user
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to unblock|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to unblock | Optional|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/help_acceptTermsOfService.md
View File

@ -11,9 +11,9 @@ Accept telegram's TOS
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[DataJSON](../types/DataJSON.md) | Yes|TOS|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[DataJSON](../types/DataJSON.md) | TOS | Yes|
### Return type: [Bool](../types/Bool.md)

6
docs/API_docs/methods/help_getAppChangelog.md
View File

@ -11,9 +11,9 @@ Get the changelog of this app
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|prev\_app\_version|[string](../types/string.md) | Previous app version | Yes|
### Return type: [Updates](../types/Updates.md)

6
docs/API_docs/methods/help_getDeepLinkInfo.md
View File

@ -11,9 +11,9 @@ Get deep link info
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|path|[string](../types/string.md) | Yes|Deep link|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|path|[string](../types/string.md) | Deep link | Yes|
### Return type: [help\_DeepLinkInfo](../types/help_DeepLinkInfo.md)

6
docs/API_docs/methods/help_getRecentMeUrls.md
View File

@ -11,9 +11,9 @@ Get recent t.me URLs
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|referer|[string](../types/string.md) | Yes|Referrer|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|referer|[string](../types/string.md) | Referrer | Yes|
### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md)

6
docs/API_docs/methods/help_saveAppLog.md
View File

@ -11,9 +11,9 @@ Log data for developer of this app
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Event list | Yes|
### Return type: [Bool](../types/Bool.md)

8
docs/API_docs/methods/help_setBotUpdatesStatus.md
View File

@ -11,10 +11,10 @@ Set the update status of webhook
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count|
|message|[string](../types/string.md) | Yes|Message|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|pending\_updates\_count|[int](../types/int.md) | Pending update count | Yes|
|message|[string](../types/string.md) | Message | Yes|
### Return type: [Bool](../types/Bool.md)

22
docs/API_docs/methods/initConnection.md
View File

@ -11,17 +11,17 @@ Initializes connection and save information on the user's device and application
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|api\_id|[int](../types/int.md) | Yes|Application identifier|
|device\_model|[string](../types/string.md) | Yes|Device model|
|system\_version|[string](../types/string.md) | Yes|System version|
|app\_version|[string](../types/string.md) | Yes|App version|
|system\_lang\_code|[string](../types/string.md) | Yes|Language code|
|lang\_pack|[string](../types/string.md) | Yes|Language pack to use|
|lang\_code|[string](../types/string.md) | Yes|Language code to set|
|proxy|[InputClientProxy](../types/InputClientProxy.md) | Optional|The current proxy|
|query|[!X](../types/!X.md) | Yes|Nested query|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|api\_id|[int](../types/int.md) | Application identifier | Yes|
|device\_model|[string](../types/string.md) | Device model | Yes|
|system\_version|[string](../types/string.md) | System version | Yes|
|app\_version|[string](../types/string.md) | App version | Yes|
|system\_lang\_code|[string](../types/string.md) | Language code | Yes|
|lang\_pack|[string](../types/string.md) | Language pack to use | Yes|
|lang\_code|[string](../types/string.md) | Language code to set | Yes|
|proxy|[InputClientProxy](../types/InputClientProxy.md) | The current proxy | Optional|
|query|[!X](../types/!X.md) | Nested query | Yes|
### Return type: [X](../types/X.md)

8
docs/API_docs/methods/invokeAfterMsg.md
View File

@ -11,10 +11,10 @@ Invokes a query after successfull completion of one of the previous queries.
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends|
|query|[!X](../types/!X.md) | Yes|The query itself|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|msg\_id|[long](../types/long.md) | Message identifier on which a current query depends | Yes|
|query|[!X](../types/!X.md) | The query itself | Yes|
### Return type: [X](../types/X.md)

8
docs/API_docs/methods/invokeAfterMsgs.md
View File

@ -11,10 +11,10 @@ Result type returned by a current query.
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends|
|query|[!X](../types/!X.md) | Yes|The query itself|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|msg\_ids|Array of [long](../types/long.md) | List of messages on which a current query depends | Yes|
|query|[!X](../types/!X.md) | The query itself | Yes|
### Return type: [X](../types/X.md)

8
docs/API_docs/methods/invokeWithLayer.md
View File

@ -11,10 +11,10 @@ Invoke this method with layer X
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|layer|[int](../types/int.md) | Yes|The layer version|
|query|[!X](../types/!X.md) | Yes|The query|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|layer|[int](../types/int.md) | The layer version | Yes|
|query|[!X](../types/!X.md) | The query | Yes|
### Return type: [X](../types/X.md)

8
docs/API_docs/methods/invokeWithMessagesRange.md
View File

@ -11,10 +11,10 @@ Invoke with messages range
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|range|[MessageRange](../types/MessageRange.md) | Yes|The range|
|query|[!X](../types/!X.md) | Yes|The query|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|range|[MessageRange](../types/MessageRange.md) | The range | Yes|
|query|[!X](../types/!X.md) | The query | Yes|
### Return type: [X](../types/X.md)

8
docs/API_docs/methods/invokeWithTakeout.md
View File

@ -11,10 +11,10 @@ Invoke method from takeout session
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|takeout\_id|[long](../types/long.md) | Yes|The takeout session ID|
|query|[!X](../types/!X.md) | Yes|The query|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|takeout\_id|[long](../types/long.md) | The takeout session ID | Yes|
|query|[!X](../types/!X.md) | The query | Yes|
### Return type: [X](../types/X.md)

6
docs/API_docs/methods/invokeWithoutUpdates.md
View File

@ -11,9 +11,9 @@ Invoke with method without returning updates in the socket
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|query|[!X](../types/!X.md) | Yes|The query|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|query|[!X](../types/!X.md) | The query | Yes|
### Return type: [X](../types/X.md)

6
docs/API_docs/methods/langpack_getDifference.md
View File

@ -11,9 +11,9 @@ Get language pack updates
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|from\_version|[int](../types/int.md) | Yes|Previous version|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|from\_version|[int](../types/int.md) | Previous version | Yes|
### Return type: [LangPackDifference](../types/LangPackDifference.md)

6
docs/API_docs/methods/langpack_getLangPack.md
View File

@ -11,9 +11,9 @@ Get language pack
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|lang\_code|[string](../types/string.md) | Yes|Language code|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|lang\_code|[string](../types/string.md) | Language code | Yes|
### Return type: [LangPackDifference](../types/LangPackDifference.md)

8
docs/API_docs/methods/langpack_getStrings.md
View File

@ -11,10 +11,10 @@ Get language pack strings
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|lang\_code|[string](../types/string.md) | Yes|Language code|
|keys|Array of [string](../types/string.md) | Yes|Keys|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|lang\_code|[string](../types/string.md) | Language code | Yes|
|keys|Array of [string](../types/string.md) | Keys | Yes|
### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md)

10
docs/API_docs/methods/messages_addChatUser.md
View File

@ -11,11 +11,11 @@ Add a user to a normal chat (use channels->inviteToChannel for supergroups)
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite|
|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see|
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to invite users | Optional|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to invite | Optional|
|fwd\_limit|[int](../types/int.md) | Number of old messages the user will see | Yes|
### Return type: [Updates](../types/Updates.md)

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